Block Text

CARIS HPD : Portrayal : Paper Chart Marginalia : How Marginalia Works : Block Text

Block Text

A text file can also be applied as marginalia. Text must be in RTF (Rich Text Format).

By default, marginalia block text is located in C:\Program Files\CARIS\HPD\<version>\system\PCEConfig\marginaliafiless

An example of a basic block text marginalia file is shown below.

<Object Acronym=”$marga”>

<Filter>

<AttributeValueIsEqualTo Acronym=”$lckey” Value=”TopRight”/>

</Filter>

<CreateAnnotation AnnotationType=”BLOCK_TEXT” Acronym=”$text” File=”Related-Publications.rtf” HJust=”Right” VJust=”Bottom” XOffset=”2.0” YOffset=”0.0” Angle=”0” >

</CreateAnnotation>

</Object>

The key attributes are described in the table below.

Tag	Description
<Object />	The feature to which the annotation is associated. Attribute: `Acronym`: For marginalia, the value is $marga.
<Filter>	Parent tag for the filter.
<AttributeValueIsEqualTo />	Filter for associating marginalia information with an anchor point. Attributes: `Acronym`: The location key ($lckey) position of the marginalia anchor point. `Value`: The value of the $lckey attribute. Eight default values are: • `Top` • `TopRight` • `Right` • `BottomRight` • `Bottom` • `BottomLeft` • `Left` • `TopLeft`
<CreateAnnotation>	Positioning information for the marginalia text. Attributes: • `Acronym`: The feature name assigned to the marginalia feature. For text marginalia, it is always $text. • `AnnotationType`: The type of annotation. For text from a file, the value is set to "BLOCK_TEXT" • `File`: Name of the RTF file. • `HJust`: Horizontal justification (aligned to the offset position): Left, Centre, Right. • `VJust`: Vertical justification (aligned to the offset position): Top, Centre, Bottom . • `XOffset:` The horizontal offset (in mm) of the text from its reference point. • `YOffset`: The vertical offset (in mm) of the text from its reference point. • `Angle`: The angle of rotation of the text (degrees).