Options are a semicolon separated list of specifications of the form
keyword:value
The string is evaluated left to right, later specifications override earlier ones.
The value have a fixed data type:
| Type | Description |
| int | |
| float, points | The decimal point is a period (.). Sizes are in points. |
| boolean | Valid values are 0|1, true|false, On|Off, yes|No ...
To be precise: everything other than (case insensitive) 0, OFF, NO, OMIT, FALSE, SKIP is interpreted as TRUE. |
| String | Values may be quoted, but don't have to be, with the exception of layer names in the layers option, which have to be quoted. |
Example for an option string:
xmlversion:3.0;content:tagged,plain;svg:bbox;svg-text:full;layers:+"Show this one",-"But not this one";
In the following, the options defined for different contexts are described. Specifying options in the wrong context is allowed, though these specifications will be ignored.
Functions
Document.create
| Option | Data type | Description |
| pages | int | number of pages in the document |
| pages-per-spread | int | Number of pages / Spread |
Functions
Document.create Document.setup Document.execTemplate
| Option | Data type | Description |
| size | points [points] | Document size, width and height, or width = height |
| width | points | Width |
| height | Height | |
| margin | points | Page margin |
| margin-top | ||
| margin-bottom | ||
| margin-left | ||
| margin-right | ||
| margin-outer | ||
| margin-inner | ||
| margin-insideleft | ||
| margin-outsideright | ||
| bleed | points | Bleed |
| bleed-top | ||
| bleed-bottom | ||
| bleed-left | ||
| bleed-right | ||
| bleed-outer | ||
| bleed-inner | ||
| bleed-insideleft | ||
| bleed-outsideright | ||
| slug | points | Information area |
| slug-top | ||
| slug-bottom | ||
| slug-left | ||
| slug-right | ||
| slug-outer | ||
| slug-inner | ||
| slug-insideleft | ||
| slug-outsideright |
Functions
Document.execTemplate
| Option | Data type | Description |
| offset | points [points] | Template position relative to the page |
| offset-x | points | |
| offset-y | points | |
| layer | String | Target layer, see here. In this case, only one layer should be specified. |
Functions
placeTemplate insertGroup replaceGroup ...
| Option | Data type | Description |
| snap-to-grid | boolean | Snap to grid |
| snap-to-template | Snap to page template | |
| layer | String | Target layer, see here. In this case, only one layer should be specified. |
| auto-load | boolean | [since v3.3 R3030 for placeTemplate] Should the template be loaded immediately?
Default : false |
Functions
??? CHRISTOPH ???
| Option | Data type | Description |
| format | String | Format : jpeg | tiff | gif |
| scale | float | Scale X/Y |
| scale-x | Scale X | |
| scale-y | Scale Y | |
| greek-below | points | Gray out text smaller than this font size |
| transparency | String | Transparency Quality : low | medium | high | maximum |
| quality | Quality : low | good | great | excellent | |
| encoding | Encoding: baseline | progressive | |
| color-space | Color Space: rgb | cmyk | lab | gray | |
| antialiasing | boolean | Antialiasing? (No) |
| fullres | High resolutioin graphics? (Yes) | |
| add-alpha | GIF only - Add alpha channel? (No) | |
| palette | GIF and TIFF only - Palette: exact/adaptive | win | mac | web | none | |
| interlaced | GIF only - Interlaced? Yes | |
| combine-groups | Include subgroups (Previews of Cometgruppen only)? (Yes) | |
| layers | String | Target layer, see here. In this case, only one layer should be specified. |
Functions
server::get_spreads
server::get_cometgroups
server::get_elements
server::get_placeholders
server::get_notes
server::get_template
| Option | Data type | Description |
| xmlschema | boolean | Output XML Schema Reference and Namespaces? (Yes) |
| xmlindent | Include newlines and indentation in output? (false) | |
| xmlversion | float | XML Version: 2.9 | 3.0. Version 2.9 is deprecated and only supported for backwards compatibility! |
| content | String | (Elements, Placeholders): Content format. Valid values are plain and tagged, Content may be put out multiple times:
content:plain,tagged; |
| svg | String | Options for SVG Export: full | bbox | none.
This Option sets the value for Groups, frames and Text (Paragraphs) |
| svg-group | Like svg, only affects comet groups | |
| svg-frame | Like svg, only affects frames | |
| svg-text | Like svg, only affects paragraphs | |
| placeholders | boolean | Output (Elements) placeholders? (Yes) |
| eval-sync | Update (Placeholder) Syncstatus? (No) | |
| mark-changes | Mark (placeholder) changes: not yet supported! | |
| combine-groups | Include sub groups? (Yes) | |
| oversets | Calculate and output overset? (No) | |
| layers | String | Layer to be output, see here. |
Functions
Element.moveTo Element.moveBy ...
| Option | Data type | Description |
| move-relative | boolean | |
| move-absolute |
The layers option is a (comma separated) list of layers that should be shown or hidden. The option affects XML, previews and PDF. The basis is always the document settings, if the option is empty or missing, the currently visible layers (Desktop) / the layers visible when opening the document (Server) are considered.
Each entry in the list starts with the operator + (show) or - (hide), followed by a layer name (in double quotes) or * for all Layers.
The syntax is oriented towards concise layer settings in a request (because, on servers, multiple sessions may use different visibilities).
All Layers
layers:+*;
No Layers
layers:-*;
Current settings (Desktop) or the settings when opening (Server) + some more
layers:+"also show this",+"and this";
Current settings (Desktop) or the settings when opening (Server) - some more
layers:-"don't show this",-"or this";
Only specific ones. The trick is to first disable all layers with -* and then hiding individual ones
layers:-*,+"only this one",+"and this one";
All except specific ones.The trick is to first enable all layers with +* and then hiding individual ones
layers:+*,-"except this one",+"and this one";