CARIS HPD : Portrayal : Portrayals : Portrayal Control File
 

Portrayal Control File

The Portrayal Control File links portrayals to files required for presentation. These files include lookup tables (line, area or point), symbol files, and colour tables.

The default file (portrayalcontrol.xml) is located in C:\Program Files\CARIS\HPD\<version>\system.

The structure of the control file is shown here:

This table describes the tags in the file:

Tag

Description

<PresentationControlFile>

Root tag for all tags and elements in the file.

Attributes:

Version= The version of the file.

<PresentationOptions>

Parent tag for a specific portrayal.

Type: S-52, INT1, S-101

Attributes:

Type= The portrayal standard for chart display.

Name= The specific presentation. Each presentation has its own set of portrayal files.

Description= A brief description of the presentation.

<LookupTables>

Parent tag for the lookup tables for areas, lines, points, and where necessary, text.

Type: S-52, INT1,

<AreaLookup/>

The file that controls symbology, colour and other display properties of area features. This tag is a child tag of <LookupTables>.

Type: S-52, INT1

Attributes:

File= The path and name of the area lookup table.

SymbolizedBoundaries=True/False. When set to True, areas are symbolized with a complex line style, if available; when set to False, areas are drawn with a simple line style.

<LineLookup/>

The file that controls the symbology, colour and other display properties of line features. This tag is a child tag of <LookupTables>.

Type: S-52, INT1

Attributes:

File= The path and name of the line lookup table.

<PointLookup/>

The file that controls the symbology, colour and other display properties of line features. This is a child tag of <LookupTables>

Type: S-52, INT1

Attributes:

File= The path and name of the point lookup table.

<TextLookup/>

The file that controls text properties in INT1 charts. This is a child tag of <LookupTables>

Type: INT1

Attributes:

File= The path and name of the point lookup table.

<SymbolFiles/>

Folder containing symbol files for S-52 features.

Type: S-52

Attributes:

Directory= Path for the folder containing symbol files.

<SymbolFile/>

Name of the binary file containing INT1 symbols for paper charts.

Type: INT1

Attributes:

File= The path and name of binary symbol file.

<ColourFiles/>

Folder containing colour tables based on ECDIS display modes. Each file contains colour tokens for displaying features.

Type: S-52

Attributes:

Directory= Path for the folder containing display mode files.

<ColourFile/>

The path for the file containing colour tokens for INT1 display in paper charts.

Type: INT1

Attributes:

File= The path and name of the file.

<FeatureCodeColourMapFile/>

The colour table associates symbolization codes in the ih_master file with colour tokens for INT1 paper chart display.

Type: INT1

Attributes:

File= The path and name of the file.

<SymbolOrientation>

Flag to set all symbols and soundings to North up. This tag is normally commented out.

See below.

<SymbolOrientation>NorthUp</SymbolOrientation>

<MaskingRulesFile/>

The Masking Rules File contains rules for dynamic and priority masking.

Type: INT1

Attributes:

File= The path and name of the file.

<RasterLayersFile/>

The Raster Layers file controls what raster layers are drawn in a panel and the draw order those layers. It also controls how dynamic masking is applied.

Type: INT1

Attributes:

File= The path and name of the file.

<Annotations>

Parent tag for annotation tags

Type: INT1

<AnnotationControlFile/>

The Annotation Control File lists all files that are responsible for displaying annotations in a chart.

Type: INT1

Attributes:

File= Path and name of the file.

<AnnotationRules>

<MasterFile/>

A text file that contains CARIS symbolization codes.

Type: INT1

Attributes:

File= The path and name of the file.

<PatternFile/>

The pattern definition file for adding fill patterns to area features.

Type: INT1

Attributes:

File= Path and name for the file.

<ConditionalProcedureAnnotationFiles/>

Folder that contains conditional symbology instructions.

Type: INT1

Attributes:

Directory= Path to the folder with files for drawing customized features.

<XSLTRules/>

The files that are responsible for dynamic cartography

This tag is normally inactive. To make it active, remove the comment tags.

Type: INT1

Attributes:

Profile= Path and name of the XML that lists meta features and features to which dynamic cartography can be applied.

Rulefile= Path and name of the XSLT file(s) that contains dynamic cartography instructions.

<CartoEditTemplate/>

File that contains templates for dynamic cartography.

Type: INT1 (dynamic cartography and vector masking)

Attributes:

File= Path to the template file.

<VectorMaskingRulesFile/>

File containing rules for vector masking

Type: INT1 (dynamic cartography and vector masking)

Attributes:

File= Path to the vector masking rules file.

<InputICCProfile/>

International Colour Consortium profile for encoding colours in charts. Note: This tag is not included in the default portrayal file and must be added manually.

Type: INT1

Attributes:

File= path to the ICC profile file

<CompositeSymbolSet>

Locations of multiple symbol files. Note: This tag is not included in the default portrayal file and must be added manually.

Type: INT1

An example is shown below.

<CompositeSymbolSet>
  <SymbolFile File="%uslXsymbol_5%" />

  <SymbolFile File="C:\MyCustomSymbols\ttfComposite.xml"/>

</CompositeSymbolSet>

<SoundingSymbolization> must be used if this tag is used.

<SoundingSymbolization>

Location of the sounding symbolization file. Only required if <CompositeSymbolSet> is used.

<SoundingSymbolization>

   <SymbolFile File="%uslXsymbol_5%" />

</SoundingSymbolization>

<TranslationFile>

The folder containing the Extensible Stylesheet Transformations (XSLT) files for defining S-101 features.

Type: S-101

<SymbolFiles/>

Symbols for features.

Type: S-101

Attributes:

Directory= The path for the folder containing Scalable Vector Graphics (SVG) files for S-100 symbology.

Type="SVG" The type of symbol file, in this case, SVG.

<LineStyles/>

Files for drawing line styles.

Type: S-101

Attributes:

Directory= The path for the folder containing XML files for line feature drawing instructions.

Schema= The path of the Schema Definition File (XSD) that defines elements in the LineStyle XML files.

<AreaFills/>

Files for area fills.

Type: S-101

Attributes:

Directory= The path for the folder containing XML files for area fills.

Schema= The path of the Schema Definition File (XSD) that defines elements in the AreaFills XML files.

<ColourFiles/>

Folder containing colour tables based on ECDIS display modes. Each file contains colour tokens for displaying features.

Type: S-52, S-101

Attributes:

Directory= Path for the folder containing display mode files.