The CreateMarginalia process adds marginalia annotations to a panel border of a database or PCC chart.
Input
HPD URI with a Chart Version ID, Project ID, and Panel Number; or a PCC chart with a Chart Version ID and Panel Number.
Note that Chart Version ID is always set to 1 for PCC charts.
Output
The same chart with marginalia annotations on panel borders.
Syntax
carisbatch --run CreateMarginalia --marginalia-control-file <value> --marginalia-data-files <value> --annotation-rules-id <value> <input>
Options
Long | Short | Description | Can Repeat | Notes |
|---|---|---|---|---|
--marginalia-control-file | -Q | Path and name of the marginalia control file. This file lists the marginalia rules and associated block text and images for each rule. | FALSE | Required |
--marginalia-data-files | -D | Path to the folder containing images and block text for marginalia | FALSE | Required |
--annotation-rules-id | -A | The annotation rule in the marginalia control file that is to be applied to the panel. | FALSE | Required |
Examples
Database Chart | ||
Objective | Add marginalia to panel 1 in a database chart by applying the marginalia rule “Marginalia Sample-INT Chart” found in the | |
Description | Command Line Syntax | |
Path to | C:\Program Files\CARIS\HPD\4.0\System\PCEConfig\Annotations\marginaliacontrol.xml" | |
Path to the folder containing block text or images related to the Marginalia Sample-INT Chart marginalia rule. | C:\Program Files\CARIS\HPD\4.0\System\PCEConfig\MarginaliaFiles | |
The marginalia rule to be applied by the process. | Marginalia Sample-INT Chart | |
Marginalia is to be applied to panel 1 in the database chart identified by the chart version ID 4 | hpd://username:password@OracleDB/db?ChartVersionId=4;ProjectId=1;PanelNumber=1 | |
Command Line | carisbatch --run CreateMarginalia --marginalia-control-file "C:\Program Files\CARIS\HPD\4.0\System\PCEConfig\Annotations\marginaliacontrol.xml" --marginalia-data-files "C:\Program Files\CARIS\HPD\4.0\System\PCEConfig\MarginaliaFiles" --annotation-rules-id "Marginalia Sample-INT Chart" hpd://username:password@OracleDB/db?ChartVersionId=4;ProjectId=1;PanelNumber=1 | |
Stand-Alone Chart | ||
Objective | Add marginalia to panel 1 in the | |
Description | Command Line Syntax | |
Path to marginaliacontrol.xml | C:\Program Files\CARIS\HPD\4.0\System\PCEConfig\Annotations\marginaliacontrol.xml | |
Path to the folder containing block text or images related to marginalia annotations. | C:\Program Files\CARIS\HPD\4.0\System\PCEConfig\MarginaliaFiles | |
The marginalia rule to be applied by the process. | Marginalia Sample-INT Chart | |
Marginalia is to be applied to panel 1 in the database chart identified by the chart version ID 1 | D:/AllMyCharts/MyChart.pcc?ChartVersionId=1&PanelNumber=1 | |
Command Line | carisbatch --run CreateMarginalia --marginalia-control-file "C:\Program Files\CARIS\HPD\3.2\System\PCEConfig\Annotations\marginaliacontrol.xml" --marginalia-data-files "C:\Program Files\CARIS\HPD\3.2\System\PCEConfig\MarginaliaFiles" --annotation-rules-id "Marginalia Sample-INT Chart" file:///D:/AllMyCharts/MyChart.pcc?ChartVersionId=1&PanelNumber=1 | |