Handbuch durchsuchen:

- Startseite
- Einleitung
- Hallo Welt!
- Grundlagen
  - Erstellen eines Layoutregelwerks
  - Aufbau der Datendatei und des Layoutregelwerks
  - Objekte ausgeben
  - Raster
  - Bereiche auf der Seite (PositioningArea)
  - Dateiorganisation
  - Silbentrennung / Spracheinstellungen
  - Einbinden von Schriftarten
  - Textformate
  - Textformatierung
  - Farben
- Programmierung
- Bilder einbinden
- Tabellen
- Fortgeschrittene Themen
  - Lesezeichen (Bookmarks)
  - Erzeugen von XML-Strukturen
  - Druckausgabe / Schnittmarken
  - CSS
  - Gruppen (virtuelle Objekte)
  - Virtuelle Seiten
  - Rotieren von Inhalten
  - Sortieren von Daten
  - Umfließen von Bildern
  - Seitentypen
  - Starten des Publishers über den Hotfolder
  - Lua-Filter / Datenvorverarbeitung
  - Schemavalidierung
  - Qualitätssicherung (PDF-Vergleich)
  - Fehlersuche / Debugging
  - Servermodus
  - Steuerung des Layouts beim Aufruf des Publishers
  - Bilder mit MetaPost erstellen und einbinden
- Kochbuch
  - Daumenregister
  - Mehrseitige PDF-Dateien einbinden
  - Layoutoptimierung mithilfe von Gruppen
  - Aufzählungslisten nachahmen
  - Verzeichnisse erstellen
  - Inhaltsverzeichnis in einem Durchlauf erstellen
  - Seitenzahlen: Seite x von y
- Installationsanleitung
- Dateinamen im Publisher
- Voreinstellungen im speedata Publisher
- Starten des Publishers über die Kommandozeile
- Konfiguration des Publishers
- Längenangaben und Maßeinheiten
- XPath- und Layoutfunktionen
- Interne Variablen
- XML Editor mit Schema verbinden
  - Visual Studio Code
  - OxygenXML
  - Atom
- Liste der Änderungen
- Glossar
- Kompatibilität mit anderer Software
- Befehlsreferenz
  - A
  - Action
  - AddSearchpath
  - AtPageCreation
  - AtPageShipout
  - AttachFile
  - Attribute
  - B
  - Barcode
  - Bold
  - BoldItalic
  - Bookmark
  - Box
  - Br
  - Case
  - Circle
  - Color
  - Column
  - Columns
  - Compatibility
  - Contents
  - Copy-of
  - DefineColor
  - DefineColorprofile
  - DefineFontalias
  - DefineFontfamily
  - DefineGraphic
  - DefineMatter
  - DefineTextformat
  - Element
  - Fallback
  - Fontface
  - ForAll
  - Frame
  - Grid
  - Group
  - Groupcontents
  - HSpace
  - Hyphenation
  - I
  - Image
  - Include
  - Initial
  - InsertPages
  - Italic
  - Layout
  - Li
  - LoadDataset
  - LoadFontfile
  - Loop
  - Makeindex
  - Margin
  - Mark
  - Message
  - NewPage
  - NextFrame
  - NextRow
  - NoBreak
  - Ol
  - Options
  - Otherwise
  - Output
  - Overlay
  - Pageformat
  - Pagetype
  - Paragraph
  - PDFOptions
  - PlaceObject
  - Position
  - PositioningArea
  - PositioningFrame
  - ProcessNode
  - Record
  - Regular
  - Rule
  - SaveDataset
  - SavePages
  - SetGrid
  - SetVariable
  - SortSequence
  - Stylesheet
  - Span
  - Sub
  - Sup
  - Switch
  - Table
  - TableNewPage
  - Tablefoot
  - Tablehead
  - Tablerule
  - Td
  - Text
  - Textblock
  - Tr
  - Trace
  - Transformation
  - U
  - Ul
  - Until
  - URL
  - Value
  - VSpace
  - While

Version 4.4.1
Handbuch durchsuchen

- Startseite
- Einleitung
- Hallo Welt!
- Grundlagen
  - Erstellen eines Layoutregelwerks
  - Aufbau der Datendatei und des Layoutregelwerks
  - Objekte ausgeben
  - Raster
  - Bereiche auf der Seite (PositioningArea)
  - Dateiorganisation
  - Silbentrennung / Spracheinstellungen
  - Einbinden von Schriftarten
  - Textformate
  - Textformatierung
  - Farben
- Programmierung
- Bilder einbinden
- Tabellen
- Fortgeschrittene Themen
  - Lesezeichen (Bookmarks)
  - Erzeugen von XML-Strukturen
  - Druckausgabe / Schnittmarken
  - CSS
  - Gruppen (virtuelle Objekte)
  - Virtuelle Seiten
  - Rotieren von Inhalten
  - Sortieren von Daten
  - Umfließen von Bildern
  - Seitentypen
  - Starten des Publishers über den Hotfolder
  - Lua-Filter / Datenvorverarbeitung
  - Schemavalidierung
  - Qualitätssicherung (PDF-Vergleich)
  - Fehlersuche / Debugging
  - Servermodus
  - Steuerung des Layouts beim Aufruf des Publishers
  - Bilder mit MetaPost erstellen und einbinden
- Kochbuch
  - Daumenregister
  - Mehrseitige PDF-Dateien einbinden
  - Layoutoptimierung mithilfe von Gruppen
  - Aufzählungslisten nachahmen
  - Verzeichnisse erstellen
  - Inhaltsverzeichnis in einem Durchlauf erstellen
  - Seitenzahlen: Seite x von y
- Installationsanleitung
- Dateinamen im Publisher
- Voreinstellungen im speedata Publisher
- Starten des Publishers über die Kommandozeile
- Konfiguration des Publishers
- Längenangaben und Maßeinheiten
- XPath- und Layoutfunktionen
- Interne Variablen
- XML Editor mit Schema verbinden
  - Visual Studio Code
  - OxygenXML
  - Atom
- Liste der Änderungen
- Glossar
- Kompatibilität mit anderer Software
- Befehlsreferenz
  - A
  - Action
  - AddSearchpath
  - AtPageCreation
  - AtPageShipout
  - AttachFile
  - Attribute
  - B
  - Barcode
  - Bold
  - BoldItalic
  - Bookmark
  - Box
  - Br
  - Case
  - Circle
  - Color
  - Column
  - Columns
  - Compatibility
  - Contents
  - Copy-of
  - DefineColor
  - DefineColorprofile
  - DefineFontalias
  - DefineFontfamily
  - DefineGraphic
  - DefineMatter
  - DefineTextformat
  - Element
  - Fallback
  - Fontface
  - ForAll
  - Frame
  - Grid
  - Group
  - Groupcontents
  - HSpace
  - Hyphenation
  - I
  - Image
  - Include
  - Initial
  - InsertPages
  - Italic
  - Layout
  - Li
  - LoadDataset
  - LoadFontfile
  - Loop
  - Makeindex
  - Margin
  - Mark
  - Message
  - NewPage
  - NextFrame
  - NextRow
  - NoBreak
  - Ol
  - Options
  - Otherwise
  - Output
  - Overlay
  - Pageformat
  - Pagetype
  - Paragraph
  - PDFOptions
  - PlaceObject
  - Position
  - PositioningArea
  - PositioningFrame
  - ProcessNode
  - Record
  - Regular
  - Rule
  - SaveDataset
  - SavePages
  - SetGrid
  - SetVariable
  - SortSequence
  - Stylesheet
  - Span
  - Sub
  - Sup
  - Switch
  - Table
  - TableNewPage
  - Tablefoot
  - Tablehead
  - Tablerule
  - Td
  - Text
  - Textblock
  - Tr
  - Trace
  - Transformation
  - U
  - Ul
  - Until
  - URL
  - Value
  - VSpace
  - While

- This manual in English

# Objekte ausgeben

Es gibt zwei Befehle, Objekte auszugeben. Der eine heißt `<Output>` und wird nur für Text benutzt, der auf mehrere Seiten umbrechen soll. Alle anderen Objekte (Bilder, Tabellen, Barcodes, …​) werden über den Befehl `<PlaceObject>` ausgegeben. Die Parameter werden im Detail in der Befehlsreferenz (siehe Befehl `<PlaceObject>`) aufgeführt. Hier folgen einige Beispiele und Anwendungsmöglichkeiten.

Im einfachsten Fall ist der Befehl wie folgt zu benutzen:

    <Record element="data">
      <PlaceObject>
        <Image file="_samplea.pdf" width="5"/>
      </PlaceObject>
    </Record>

Hier wird ein Bild eingebunden mit dem angegebenen Dateinamen und einer vorgegebenen Breite. Das Bild `_samplea.pdf` (mit Unterstrich am Anfang) ist in der Distribution enthalten und kann als Platzhalter benutzt werden.

### Rasterbasierte Platzierung von Objekten

Im Abschnitt Raster wird ausführlich auf das Gestaltungsraster eingegangen. Hier soll nur soviel erwähnt werden: Das Raster hilft einerseits beim Positionieren der Objekte (leichtes Anordnen der Objekte) als auch bei der Suche nach dem passenden Platz. Rasterzellen werden nicht von zwei Objekten gleichzeitig belegt, außer man erlaubt dies explizit.

Dies ist ein Beispiel für die rasterbasierte Ausgabe. Die Angaben bei `row` und `column` sind Koordinaten im Seitenraster, wobei die linke obere Ecke die Position 1,1 ist.

    <PlaceObject row="4" column="5">
        <Image file="_samplea.pdf" width="5"/>
    </PlaceObject>

### Reihenfolge der Objekte

Die Reihenfolge der Ausgabe der einzelnen Objekte ist wichtig: die Objekte werden übereinander gezeichnet. Das heißt, Objekte, die später ausgegeben werden, überdecken die vorhergehenden Objekte. Das kann man sich bei Hintergrundbildern zunutze machen. In `<AtPageCreation>` kann man ein Briefpapier oder Seitenkopf ausgeben, der dann in der eigentlichen Datenverarbeitung mit echtem Inhalt überschrieben wird. Oder man kann eine vorgefertigte Seite einbinden und mit der korrekten Seitenzahl versehen:

    <Layout xmlns="urn:speedata.de:2009/publisher/en"
      xmlns:sd="urn:speedata:2009/publisher/functions/en">

      <Record element="data">
        <PlaceObject row="1" column="1">
          <Image file="agb.pdf" width="180mm" height="280mm"/>
        </PlaceObject>
        <PlaceObject
          column="1"
          row="{sd:number-of-rows()}">
          <Textblock textformat="right">
            <Paragraph>
              <Value select="sd:current-page()"/>
            </Paragraph>
          </Textblock>
        </PlaceObject>
      </Record>
    </Layout>

Hier wird erst die Seite eingebunden und dann in der letzten Zeile rechtsbündig die aktuelle Seitenzahl »eingedruckt«.

### Höhe und Breite der Objekte

Bilder, Barcodes, Boxen etc. haben feste Breiten und Höhen. Texte und Tabellen nutzen die noch vorhandene Breite aus. D. h. die Breite ist die Differenz zwischen Anzahl der Rasterzellen und der Startspalte plus 1. Bei einer exemplarischen Breite von 15 Rasterkästchen und einer Startspalte von 6 ist die Textbreite 10, sofern keine andere Angabe gemacht wird.

Benötigt ein Objekt (wie z. B. Bilder) eine Breiten- oder Höhenangabe, kann diese entweder absolut (z. B. 5cm) gegeben werden oder in Rasterzellen.

## Textblock

Das ist ein rechteckiger Textbereich, der nicht auf mehrere Seiten umbrochen wird. Textblöcke sind ideal für Seitenzahlen, kurze Beschreibungen, Kolumnentitel und alle anderen Einheiten, wo ein Seitenumbruch nicht erwünscht ist.

Ein `<Textblock>` kann einen oder mehrere Absätze (`<Paragraph>`) enthalten. Sowohl der Textblock selbst als auch Absätze können Informationen über die benutzte Schriftart, Farben und Textformate enthalten. Sind diese in den Absätzen deklariert, so haben die Vorrang vor denen, die im Textblock angegeben sind.

    <Textblock color="blue">
      <Paragraph color="green">
        <Value>green text</Value>
      </Paragraph>
      <Paragraph>
        <Value>this text is in blue (given by Textblock)</Value>
      </Paragraph>
    </Textblock>

Weitere Formatierungsmöglichkeiten sind im Abschnitt Einbinden von Schriftarten und Textformatierung beschrieben.

Angaben in den Absätzen überschreiben die Werte im Textblock

Die vollständige Beschreibung von `<Textblock>` ist in der Referenz (Abschnitt Textblock) zu finden. Für Texte, die über Seitengrenzen hinweg umbrechen dürfen, gibt es den Befehl `<Text>` als Kindelement von `<Output>`, beschrieben im nächsten Abschnitt.

## Texte mit Seitenumbruch

Texte mit Seitenumbruch werden nicht wie die anderen Objekte mit `<PlaceObject>`, sondern mit `<Output>` ausgegeben. Die Syntax dafür ist

    <Output>
      <Text>
        <Paragraph>
          <Value>...</Value>
        </Paragraph>
        <Paragraph>
          <Value>...</Value>
        </Paragraph>
      </Text>
    </Output>

Neben der Besonderheit, dass dieser Text auf mehrere Seiten umbrechen kann, ist er auch in der Lage, Objekte zu umfließen. Eine detaillierte Beschreibung dieser Eigenschaft ist im Abschnitt Umfließen von Bildern gegeben.

## Einführung in Tabellen

Das im Publisher benutzte Tabellenmodell entspricht in etwa dem von HTML bekannten Modell. Die Zeilen werden mit `<Tr>` angegeben und die einzelnen Spalten mit `<Td>`.

Die Struktur einer einfachen Tabelle ohne Spaltendeklaration, Kopf- und Fußzeile sieht wie folgt aus:

    <PlaceObject>
      <Table>
        <Tr>
          <Td>...</Td>
          <Td>...</Td>
        </Tr>
        <Tr>
          <Td>...</Td>
          <Td>...</Td>
        </Tr>
      </Table>
    </PlaceObject>

Die Inhalte der Tabellenzellen können Absätze, Bilder und andere Objekte sein.

    <Td>
      <Paragraph>
        <Value>...</Value>
      </Paragraph>
    </Td>

    <Td>
      <Image file="ocean.pdf" width="4"/>
    </Td>

Eine praktische Eigenschaft der Tabellen ist, dass sie über mehrere Seiten laufen können, auch mit wiederholenden Kopf- und Fußzeilen. In den Tabellenzellen können Texte, Bilder, Barcodes, etc. stehen; also alles, was auch in `<PlaceObject>` enthalten sein kann. Einzelne Zellen werden niemals auf mehrere Seiten umbrochen, d. h. sie werden als rechteckiges Kästchen gesetzt, auch wenn die Inhalte einen Umbruch erlauben würden (z. B. Texte oder Tabellen).

Dem Thema Tabellen ist ein eigenes Kapitel gewidmet.

## Bilder

Bilder einbinden ist, wie schon eingangs gezeigt, sehr leicht. Der Befehl dafür lautet `<Image>`:

    <PlaceObject>
        <Image file="_samplea.pdf" width="5cm"/>
    </PlaceObject>

Bilder können in den Formaten PDF, JPEG und PNG vorliegen und eingebunden werden. Alle anderen Formate wie z. B. Tiff oder SVG müssen vorher konvertiert werden.

Der Befehl zum Einbinden der Bilder ist sehr mächtig und wird ausführlich in einem eigenen Abschnitt (Kapitel Bilder einbinden) beschrieben. Die Referenz enthält eine kurze Beschreibung aller Möglichkeiten.

## Rechteckige Flächen (`<Box>`)

Rechteckige Flächen werden mit dem Befehl `<Box>` erzeugt.

    <PlaceObject>
      <Box width="4" height="3" backgroundcolor="limegreen"/>
    </PlaceObject>

Ein buntes Kästchen, ausgegeben mit `<Box>`

Oftmals werden Kästchen für farbige Flächen hinter einem Text oder einer Tabelle benutzt. Dann muss die Belegung der Rasterzellen ausgeschaltet werden (`allocate="no"` bei `<PlaceObject>`), sonst kommt es zu einer Warnung wegen der doppelt belegten Fläche im PDF (siehe Abschnitt Raster). Ein Beispiel für die Nutzung von Boxen als Hintergrund ist im Abschnitt über Daumenregister zu finden. Dort wird auch der Parameter `bleed` erläutert, der dazu dient, den Kasten in eine oder mehrere Richtungen zu vergrößern, sofern sich diese am Seitenrand befinden.

## Kreis

Kreise werden mit dem Befehl `<Circle>` ausgegeben:

    <Record element="data">
      <PlaceObject column="5" row="5">
        <Circle radiusx="3" backgroundcolor="goldenrod"/>
      </PlaceObject>
      <PlaceObject column="5" row="5">
        <Circle radiusx="1pt" backgroundcolor="black"/>
      </PlaceObject>
    </Record>

In diesem Beispiel ist der Radius des großen Kreises 3 Rasterkästchen und der Mittelpunkt des Kreises liegt in der linken oberen Ecke des Kästchens (5,5). Damit fängt er in der zweiten Spalte und in der zweiten Zeile an und erstreckt sich bis zur siebten Spalte und Zeile. Kreise haben die besondere Eigenschaft, dass keine Rasterzellen als belegt markiert werden.

Kreis mit Radius 3 und Mittelpunkt bei (5,5)

## Linien (`<Rule>`)

Es gibt horizontale und vertikale Linien. Diese können eine Liniendicke haben, eine Farbe und eine Länge. Linien können durchgezogen und gestrichelt sein:

    <PlaceObject column="2" row="2">
      <Rule direction="horizontal" length="4" dashed="yes"/>
    </PlaceObject>

Linien werden immer oben links im Kästchen ausgerichtet.

Eine gestrichelte Linie.

## Rahmen

Der Rahmen (wie die Transformation weiter unten) ist ein besonderes Objekt, das man über ein anderes Objekt legt. Ein Rahmen (`<Frame>`) beinhaltet immer ein anderes Objekt, beispielsweise ein Bild.

    <PlaceObject>
      <Frame
        border-bottom-left-radius="8pt"
        border-bottom-right-radius="8pt"
        border-top-left-radius="8pt"
        border-top-right-radius="8pt"
        framecolor="darkseagreen"
        rulewidth="2pt">
        <Image file="_samplea.pdf" width="4"/>
      </Frame>
    </PlaceObject>

Man sieht, dass der Rahmen als Clipping-Pfad funktioniert, die Teile außerhalb werden ausgeblendet. Den Rahmen (`rulewidth`) kann man auch auf Null setzen und somit unsichtbar machen, dann wird nur der Inhalt beschnitten.

Rahmen mit Radius 8pt und Linienstärke von 2 Punkt.

## Transformation

Die vier grundlegenden Transformationen (aus der PDF-Spezifikation)

Wie der Rahmen ist die Transformation ein umschließendes Element. Das bedeutet, dass das Element noch einen Inhalt haben muss, wie z. B. ein Bild.

Man gibt bei der Transformation eine Matrix an, die aus sechs Zahlen besteht in der Form »a b c d e f«. Die Transformation von einem Koordinatensystem in ein anderes wird über folgende 3x3 Matrix abgebildet:

Wenn man aus den Koordinaten x und y die neuen Koordinaten x' und y' errechnen will, kann man das auch über die folgende Formeln machen:

Es gibt folgende grundlegende Transformationsarten (siehe Abbildung Die vier grundlegenden Transformationen (aus der PDF-Spezifikation)):

1. Verschiebungen (translation) werden mit den Werten 1 0 0 1 tx ty beschrieben
2. Die Skalierung (scaling) wird mit sx 0 0 sy 0 0 angegeben
3. Drehungen (rotation) können mit cos θ sin θ −sin θ cos θ 0 0 erreicht werden
4. Verschiefungen (skew) sind durch 1 tan α tan β 1 0 0 beschrieben.
5. Die unverändernde Transformation ist 1 0 0 1 0 0 (identische Abbildung).

    <PlaceObject>
      <Transformation matrix="1.8 0.2 0.2 0.8 0 0 ">
        <Image file="ocean.pdf" width="4"/>
      </Transformation>
    </PlaceObject>

Verschiefung und Skalierung durch die Transformationsmatrix.

## Barcodes, QR-Codes

Barcodes bzw. QR-Codes werden über den Befehl `<Barcode>` eingebunden:

    <PlaceObject>
      <Barcode select="'Hello world'" type="QRCode" width="5"/>
    </PlaceObject>

Die Ausgabe ist wie erwartet

Hallo Welt in Pixeln

Es lassen sich Barcodes in der Kodierung »EAN13« und »Code 128« ausgeben.

- Aufbau der Datendatei und des Layoutregelwerks
- Raster