Options sind eine durch Semikolon getrennte Liste von Angaben im Format
keyword:value
Der String wird von links nach rechts ausgewertet, spätere Angaben überschreiben also frühere.
Die Werte (value) haben jeweils einen festgelegten Datentyp :
| Typ | Beschreibung |
| int | |
| float, points | Trennzeichen ist ein Punkt. Für Grössenangaben wird der Typ points verwendet, sie sind - Überraschung- immer in Punkten. |
| boolean | mögliche Werte sind 0 | 1, true | false, On | Off, Yes | No...
Um genau zu sein: alles, was (case insensitiv) anders ist als 0, OFF, NO, OMIT, FALSE, SKIP wird als TRUE interpretiert. |
| String | Werte können, müssen aber nicht gequotet sein. Ausnahme: Layernamen in der layers-Option müssen gequoted sein. |
Beispiel eines Option-Strings
xmlversion:3.0;content:tagged,plain;svg:bbox;svg-text:full;layers:+"Den zeigen",-"Und den hier nicht";
Im folgenden werden die für die verschiedenen Anwendungsbereiche definierten Optionen beschrieben. Die Angabe von Optionen im falschen Kontext ist erlaubt. Die Einstellung wird in diesem Fall einfach ignoriert.
Funktionen
Document.create
| Option | Datentyp | Beschreibung |
| pages | int | Anzahl Seiten im Dokument |
| pages-per-spread | int | Anzahl Seiten / Spread |
Funktionen
Document.create Document.setup Document.execTemplate
| Option | Datentyp | Beschreibung |
| size | points [points] | Dokumentgröße, Breite und Höhe oder Breite = Höhe |
| width | points | Breite |
| height | Höhe | |
| margin | points | Seitenrand |
| margin-top | ||
| margin-bottom | ||
| margin-left | ||
| margin-right | ||
| margin-outer | ||
| margin-inner | ||
| margin-insideleft | ||
| margin-outsideright | ||
| bleed | points | Anschnitt |
| bleed-top | ||
| bleed-bottom | ||
| bleed-left | ||
| bleed-right | ||
| bleed-outer | ||
| bleed-inner | ||
| bleed-insideleft | ||
| bleed-outsideright | ||
| slug | points | Infobereich |
| slug-top | ||
| slug-bottom | ||
| slug-left | ||
| slug-right | ||
| slug-outer | ||
| slug-inner | ||
| slug-insideleft | ||
| slug-outsideright |
Funktionen
Document.execTemplate
| Option | Datentyp | Beschreibung |
| offset | points [points] | Position des Templates relative zur Seite |
| offset-x | points | |
| offset-y | points | |
| layer | String | Zielebene, siehe hier. In diesem Fall sollte nur eine Ebene angegeben werden. |
Funktionen
placeTemplate insertGroup replaceGroup ...
| Option | Datentyp | Beschreibung |
| snap-to-grid | boolean | In Raster einpassen |
| snap-to-template | In Seitentemplate einpassen | |
| layer | String | Zielebene, siehe hier. In diesem Fall sollte nur eine Ebene angegeben werden. |
| auto-load | boolean | [ab v3.3 R3030 für placeTemplate] Soll das Template sofort geladen werden oder nicht.
Default : false |
Funktionen
??? CHRISTOPH ???
| Option | Datentyp | Beschreibung |
| format | String | Format : jpeg | tiff | gif |
| scale | float | Skalierung X/Y |
| scale-x | Skalierung X | |
| scale-y | Skalierung Y | |
| greek-below | points | Schrift kleiner als ausgrauen |
| transparency | String | Transparenzqualität : low | medium | high | maximum |
| quality | Qualität : low | good | great | excellent | |
| encoding | Encoding: baseline | progressive | |
| color-space | Farbraum: rgb | cmyk | lab | gray | |
| antialiasing | boolean | Antialiasing? (No) |
| fullres | Grafiken hochauflösend? (Yes) | |
| add-alpha | nur GIF - Alphakanal hinzufügen? (No) | |
| palette | nur GIF ubd TIFF - Palette: exact/adaptive | win | mac | web | none | |
| interlaced | nur GIF - Interlaced? Yes | |
| combine-groups | Untergruppen einbeziehen (nur bei Previews von Cometgruppen)? (Yes) | |
| layers | String | Zielebene, siehe hier. In diesem Fall sollte nur eine Ebene angegeben werden. |
Funktionen
server::get_spreads
server::get_cometgroups
server::get_elements
server::get_placeholders
server::get_notes
server::get_template
| Option | Datentyp | Beschreibung |
| xmlschema | boolean | XML Schema Referenz und Namespaces ausgeben? (Yes) |
| xmlindent | Zeilenumbrüche und Einrückungen in die Ausgabe einfügen? (false) | |
| xmlversion | float | XML Version: 2.9 | 3.0. Die Version 2.9 ist deprecated und wird nur noch aus Kompatibilitätsgründen unterstützt! |
| content | String | (Elemente, Platzhalter): Format des Inhalts. Gültige Werte sind plain und tagged, der Inhalt kann auch mehrfach ausgegeben werden:
content:plain,tagged; |
| svg | String | Optionen für SVG Export: full | bbox | none, entsprechend: alles (bbox und area) | nur bbox | gar nichts.
Die Option setzt den Wert für Gruppen, Rahmen und Text (Paragraphen) |
| svg-group | wie svg, aber nur für Cometgruppen | |
| svg-frame | wie svg, aber nur für Rahmen | |
| svg-text | wie svg, aber nur für Absätze | |
| placeholders | boolean | (Elemente) Platzhalter ausgeben? (Yes) |
| eval-sync | (Platzhalter) Syncstatus aktualisieren? (No) | |
| mark-changes | (Platzhalter) Änderungen markieren: noch nicht unterstützt! | |
| combine-groups | Untergruppen einbeziehen? (Yes) | |
| oversets | Übersatz berechnen und ausgeben? (No) | |
| layers | String | Anzuzeigende Ebenen, siehe hier. |
Funktionen
Element.moveTo Element.moveBy ...
| Option | Datentyp | Beschreibung |
| move-relative | boolean | |
| move-absolute |
Die Option layers ist eine (Komma-separierte) Liste anzuzeigender oder auszublendender Layer. Die Option wirkt sich auf XML, Previews und PDF aus. Ausgangspunkt ist jeweils die Dokument-Einstellung, sofern die Option leer ist oder fehlt werden die beim Öffnen des Dokuments (Server) oder aktuell (Desktop) angezeigten Layer berücksichtigt.
Jeder Eintrag der Liste beginnt mit dem Operator + (anzeigen) oder - (ausblenden), gefolgt von einem Layernamen (in doppelten Anführungszeichen) oder * für alle Layer.
Die Syntax ist darauf ausgelegt, dass von CometServer möglichst knapp die für einen Request erforderlichen Layer-Einstellungen übertragen werden können (im Serverbetrieb können ja verschiedene Sessions mit unterschiedlicher Sichtbarkeit arbeiten).
Alle Ebenen
layers:+*;
Keine Ebenen
layers:-*;
aktuelle Einstellung (Desktop) bzw. die beim Öffnen des Dokuments (Server) + einige mehr
layers:+"den hier auch",+"und den auch";
aktuelle Einstellung (Desktop) bzw. die beim Öffnen des Dokuments (Server) - einige weniger
layers:-"den hier nicht",-"und den auch nicht";
nur ganz bestimmte. Der Trick ist, im ersten Schritt alle Ebenen mit -* auszublenden und dann einzelne Layer zu verstecken
layers:-*,+"nur den",+"und diesen hier";
nur ganz bestimmte nicht. Der Trick ist, im ersten Schritt alle Ebenen mit -* auszublenden und dann einzelne Layer wieder sichtbarzumachen
layers:+*,-"aber den nicht",+"und den auch nicht";