Befehlsreferenz – speedata Publisher
Description: Alle Befehle der Layoutdatei, nach Themen geordnet. Die Seitenleiste führt die Befehle alphabetisch auf, eine Übersicht über alle Attribute gibt der …

Version 5.9.2

# Befehlsreferenz

Alle Befehle der Layoutdatei, nach Themen geordnet. Die Seitenleiste führt die Befehle alphabetisch auf, eine Übersicht über alle Attribute gibt der Attribut-Index.

## Grundstruktur und Einstellungen

`Layout`
  Das Layout-Element ist das Wurzelelement im Layoutregelwerk.
`Include` (veraltet)
  Toplevel Element für eingebundene Layoutdateien.
`Section`
  Gruppiert Layoutanweisungen.
`Compatibility`
  Setze Kompatibilität für ältere Layoutregeln
`Options`
  Setzt Publisher-spezifische Optionen.
`AddSearchpath`
  Ein Verzeichnis auf der Festplatte, das zum Suchpfad des Publishers hinzugefügt wird.
`Message`
  Gibt eine Textmeldung auf der Konsole und in der Protokolldatei aus.
`Trace`
  Setze Debugging-Schalter

## Datenverarbeitung

`Record`
  Enthält die Anweisungen, die bei dem angegebenen Datensatz ausgeführt werden sollen.
`ProcessNode`
  Bearbeitet alle angegebenen Datensätze.
`ForAll`
  Ruft die Kindelemente für alle Daten-Elemente auf, die auf das Muster bei select passen.
`Copy-of`
  Ersetzt dieses Element mit dem Inhalt von select als Elementstruktur.
`Value`
  Beinhaltet einen Textinhalt, der an das umgebende Element übergeben wird.
`SortSequence`
  Sortiert eine Liste.
`LoadDataset`
  Lädt eine Datensatzdatei, die in einem vorherigen Durchlauf des Publishers erzeugt wurde (Attribut name), oder eine reguläre XML-Datei (Attribut filename).
`SaveDataset`
  Speichert eine XML-Datei auf Festplatte.
`Element`
  Erzeugt eine Datenstruktur, die mithilfe von SaveDataset auf Festplatte gespeichert werden kann.
`Attribute`
  Erzeugt ein Attribut für die Element Datenstruktur, die mithilfe von SaveDataset auf Festplatte gespeichert werden kann.

## Programmierung

`SetVariable`
  Weist einer Variablen einen Wert zu.
`Function`
  Definiere eine Funktion
`Param`
  Lege einen Parameter für eine Funktionsdefinition fest.
`Switch`
  Erzeugt eine „Wenn-Dann-Abfrage“.
`Case`
  Stellt einen Fall einer Fallunterscheidung (Switch) dar.
`Otherwise`
  Zweig, der bei Switch ausgeführt wird, wenn kein Case wahr ist.
`Loop`
  Wiederhole den Inhalt dieses Elements mehrfach.
`While`
  Erzeugt eine Schleife, die wiederholt durchlaufen wird.
`Until`
  Erzeugt eine Schleife.

## Seiten und Raster

`Pageformat`
  Legt die Größe des Ausgabemediums (z.B. DIN A4) fest.
`Pagetype`
  Definiert eine Seitenvorlage.
`Margin`
  Enthält die Angaben über den Seitenrand des zu druckbaren Bereich.
`AtPageCreation`
  Die Inhalte des Elements AtPageCreation werden ausgeführt, sobald das erste Mal auf die Seite zugegriffen wird.
`AtPageShipout`
  Die innerhalb dieses Befehls definierten Anweisungen werden ausgeführt, sobald die Seite ins PDF ausgegeben wird.
`ClearPage`
  Beendet die Ausgabe auf der aktuellen Seite.
`DefineMatter`
  Definiere einen neuen Abschnitt im Dokument.
`InsertPages`
  Fügt zuvor gespeicherte Seiten ein oder reserviert Raum für zukünftig erzeugte Seiten.
`SavePages`
  Dieser Befehl ist für zwei unterschiedliche Szenarien gedacht: 1: Alle Ausgaben innerhalb von SavePages werden intern gespeichert und nicht ins PDF ausgegeben.
`PositioningArea`
  Beschreibt einen Platzierungsbereich, der mehrere Platzierungsrahmen beinhalten kann.
`PositioningFrame`
  Beschreibt einen rechteckigen Bereich, in dem Elemente platziert werden können.
`SetGrid`
  Setzt die Größe und Höhe eines Rasterkästchens.
`Grid`
  Überschreibt das allgemeine Raster aus SetGrid.
`NextRow`
  Der virtuelle Cursor wird auf die nächste freie Zeile gesetzt.
`NextFrame`
  Schaltet auf den nächsten freien Rahmen eines Platzierungsbereichs um.

## Ausgabe von Objekten

`PlaceObject`
  Gibt ein rechteckiges Objekt (Bild, Tabelle, Box, Barcode oder Textblock) aus.
`Textblock`
  Erzeugt einen rechteckigen Bereich mit Text.
`Text`
  Erzeugt einen Text, der über die Grenzen von Positionierungsrahmen umbrechen kann.
`Output`
  Dieser Befehl ist ähnlich zu PlaceObject und dient derzeit nur dazu, Text auszugeben, der auf mehrere Seite umbrochen werden kann und sich dem freien Platz auf der Seite anpassen kann.
`Image`
  Bindet eine externe Grafik ein.
`Box`
  Erzeugt einen rechteckigen gefärbten Bereich.
`Circle`
  Erzeugt einen Kreis oder eine Ellipse.
`Rule`
  Zeichnet eine horizontale oder vertikale Linie im Raster.
`Barcode`
  Erzeugt einen 1D oder 2D Strichcode (barcode), der in PlaceObject ausgegeben werden kann.
`Frame`
  Um ein Objekt ein Rahmen zeichnen.
`Clip`
  Beschneide ein Bild oder eine andere Ausgabe
`Transformation`
  Das Aussehen eines Objekts manipulieren, in dem eine Matrix-Operation angewendet wird.
`Overlay`
  Überlagert das erste Element mit den nachfolgenden »Positionen«.
`Position`
  Ein Element zum aktuellen Overlay hinzufügen.
`Group`
  Erzeugt einen virtuellen Bereich, in dem Elemente platziert werden können.
`Groupcontents`
  Fügt den Inhalt der Gruppe ein (einer virtuellen Fläche)
`Contents`
  Kennzeichnet den Inhalt einer Group, einer virtuellen Fläche.
`DefineGraphic`
  Definiere eine Metapost-Grafik die in Box benutzt werden kann.

## Text und Absätze

`Paragraph`
  Erzeugt einen Absatz innerhalb eines Textblocks.
`B`
  Schaltet auf »Fett« um.
`I`
  Schaltet auf »Kursiv« um.
`U`
  Schaltet »Unterstreichen« ein.
`Sub`
  Erzeugt tiefgestellten Text.
`Sup`
  Erzeugt hochgestellten Text.
`Math`
  Setzt eine mathematische Formel.
`Span`
  Text mit Style-Optionen umgeben.
`Br`
  Fügt einen Zeilenumbruch ein
`NoBreak`
  Kein Umbruch innerhalb des Elements erlauben
`Initial`
  Einige Zeichen erscheinen in einer größeren Schriftart am Absatzanfang.
`HSpace`
  Zwei Modi: bei einer gegebenen Breite wird ein Leerraum mit dieser Breite erzeugt.
`VSpace`
  Erzeugt einen vertikal dehnbaren Leerraum.
`URL`
  Ermöglicht ein sinnvolles Umbrechen einer URL.
`Hyphenation`
  Erzeugt einen Trennvorschlag für die automatische Silbentrennung.
`DefineTextformat`
  Definiert ein Textformat.

## Schriften

`DefineFontfamily`
  Das Element DefineFontfamily definiert eine Schriftfamilie, auf in den Elementen Paragraph, Textblock, Fontface und Table mit dem Attribut fontfamily zugegriffen werden kann.
`Regular`
  Dient als Festlegung des Schriftschnittes, wenn keine Formatierung angegeben ist.
`Bold`
  Name der Schriftart, die für den Schnitt Fett benutzt werden soll.
`Italic`
  Dient als Festlegung des Schriftschnittes, wenn Formatierung I (Kursiv) angegeben ist.
`BoldItalic`
  Name der Schriftart, die für den Schnitt Fett-Kursiv benutzt werden soll.
`DefineFontalias`
  Definiert einen Alias für die Verwendung bei DefineFontfamily.
`Fallback`
  Definiere ein Fallback für LoadFontfile
`LoadFontfile`
  Der Befehl LoadFontfile weist einer physikalischen Schriftdatei einen internen Namen zu.
`Fontface`
  Schaltet vorübergehend auf eine andere Schriftfamilie um.
`Axis`
  Setzt eine Designachse einer variablen Schriftart auf einen bestimmten Wert.

## Farben

`DefineColor`
  Definiert Farben, die später im Layout benutzt werden können
`Color`
  Auf eine andere Textfarbe wechseln

## Tabellen

`Table`
  Erzeugt eine Tabelle, die in etwa dem HTML Tabellenmodell entspricht.
`Columns`
  Legt die Spaltenbreiten und andere Eigenschaften einer Tabelle fest.
`Column`
  Gibt die Eigenschaften einer Spalte in einer Tabelle an.
`Tablehead`
  Gibt den Tabellenkopf an.
`Tablefoot`
  Gibt den Tabellenfuß an.
`Tr`
  Erstellt eine Tabellenzeile
`Td`
  Erstellt eine Tabellenzelle, wie in HTML
`Tablerule`
  Erzeugt eine horizontale Linie in einer Tabelle
`TableNewPage`
  Wechselt auf eine neue Seite innerhalb einer Tabelle.

## Listen

`Ol`
  Erzeugt eine nummerierte Aufzählungsliste wie in HTML
`Ul`
  Erzeugt eine Stichpunktliste mit Aufzählungspunkten
`Li`
  Listeneintrag in einer Aufzählungsliste (mit Aufzählungspunkten oder nummerierten Punkten).

## Verzeichnisse und Verweise

`Mark`
  Setzt eine unsichtbare Markierung in die Ausgabe.
`Makeindex`
  Eine Liste von Elementen sortieren und aufteilen um einen Index zu erzeugen.
`Bookmark`
  Erstellt ein Lesezeichen für den PDF Betrachter (z.B. Adobe Reader).
`A`
  Hyperlink auf eine URL einfügen.

## HTML und CSS

`HTML`
  Erzeugt HTML-Ausgabe
`Stylesheet`
  Lädt eine CSS-Datei oder definiert CSS-Eigenschaften

## PDF-Ausgabe

`PDFOptions`
  Setze PDF Optionen wie Anzahl der Kopien
`DefineColorprofile`
  Weist einem externen Farbprofil einem Namen zu.
`AttachFile`
  Hänge eine Datei an das PDF an.
`StructureElement`
  Erzeugt eine hierarchische Struktur für tagged-PDF

#### Inhalt