fo:root

(Auszug aus "XSL-FO ― Die Referenz" von Manuel Montero Pineda & Steffen Herkert, 2016, dpunkt.verlag)

A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z

Recommendationnummer: 6.4.2

Kategorie: 6.4 Declarations and Pagination and Layout Formatting Objects

Beschreibung

Das Wurzelelement bzw. der Dokumentknoten eines XSL-FO-Dokuments.

XSL-FO Version: 1.0

Kindelemente

<fo:bookmark-tree> Dieses Element beinhaltet eine Liste der Zugangspunkte im Dokument, wie z.B. ein Inhaltsverzeichnis, eine Liste von Abbildungen oder Tabellen. Jeder dieser Zugangspunkte wird durch ein Lesezeichen dargestellt.
<fo:declarations> Globale Deklarationen werden mit diesem Element erzeugt.
<fo:layout-master-set> In diesem Element werden alle Vorlagen für die zu verwendenden Seiten(-folgen) erstellt.
<fo:page-sequence> In diesem Element wird festgelegt, wie die Seitenfolge(n) innerhalb eines Dokuments verwendet werden. Außerdem wird hier der Inhalt des Dokuments in die Seitenfolge eingebettet.
<fo:page-sequence-wrapper> Dieses Element legt geerbte Eigenschaften für eine Gruppe von fo:page-sequence-Formatierungsobjekten fest. Es enthält keine zusätzliche Formatierungssemantik.

Attribute

id Dieses Attribut dient der eindeutigen Kennzeichnung eines Objekts, auf das dann von anderen Objekten aus verwiesen werden kann.
index-class Mit diesem Attribut lässt sich eine Indexklasse für einzelne Indexeinträge (index-key) oder für einen ganzen Bereich definieren. Alle Indexeinträge in dem entsprechenden Bereich gehören dann dieser Indexklasse an. Wird nun auf Indexeinträge referenziert (fo:index-key-reference), die verschiedenen Klassen angehören, werden die entsprechenden Seitenzahlen getrennt voneinander aufgeführt, selbst wenn sie auf aufeinanderfolgenden Seiten stehen. Beispielsweise wird "1-8" durch "1-4,5-8" ersetzt, wenn die Einträge auf den Seiten 1-4 alle derselben Klasse angehören und die Seiten 5-8 einer anderen Klasse. Dies kann zur Anwendung kommen, wenn Seiten in unterschiedliche Bereiche mit unterschiedlichen Nummerierungen gegliedert werden. Eine Nummerierung wie "I-14" kann so vermieden und durch "I-V,1-14" ersetzt werden.
index-key Mit diesem Attribut lässt sich ein Indexeintrag definieren. Der übergebene Wert wird als Bezeichner des Indexeintrags verwendet. Über eine Referenz eines Indexeintrags (fo:index-key-reference) kann auf alle Einträge mit diesem Bezeichner referenziert und deren Seitenzahlen können so einer Liste von Seitenzahlreferenzen (fo:index-page-citation-list) hinzugefügt werden.
media-usage Im Wurzelelement (fo:root) lässt sich bestimmen, ob der gesamte Inhalt in einer Folge von Seiten ausgegeben wird (paginate), dem Verarbeitungssystem überlassen wird (auto), auf eine "Endlos"-Seite mit fester Breite oder Höhe gesetzt wird (bounded-in-one-dimension) oder ob das Seitenformat nach Websiten-Vorbild vom Ausgabemedium bestimmt werden soll (unbounded). Diese Eigenschaft wird von keinem gängigen Formatierer unterstützt.
role Mit diesem Attribut lassen sich inhaltsbezogene Bezeichner anlegen, die alternativen Ausgabegeräten (z. B. Tonausgabe) Angaben zum Inhalt des verwendeten XML-Elements liefern.
source-document Mit diesem Attribut kann ein XML-Dokument als Quelldokument gekennzeichnet werden. Sollte das FO-Dokument vom Renderer z. B. bei einer theoretischen Sprachausgabe nicht ausgewertet werden können, so kann dann zusätzlich das Quelldokument hinzugezogen werden. Spielt in der Praxis keine Rolle.

Unterstützung:

Conformance Level Antenna House FOP RenderX XEP Altsoft XML2PDF Compart DocBridge
Basic J J J J J

XSL-FO Beispiel:

Als Gregor Samsa eines Morgens aus unruhigen Träumen erwachte, fand er sich in seinem Bett zu einem ungeheueren Ungeziefer verwandelt. Er lag auf seinem panzerartig harten Rücken und sah, wenn er den Kopf ein wenig hob, seinen gewölbten, braunen, von bogenförmigen Versteifungen geteilten Bauch, auf dessen Höhe sich die Bettdecke, zum gänzlichen Niedergleiten bereit, kaum noch erhalten konnte. Seine vielen, im Vergleich zu seinem sonstigen Umfang kläglich dünnen Beine flimmerten ihm hilflos vor den Augen.

</fo:flow>

</fo:root>

Download der Beispiele

Darstellung des Elementes in der XSL-FO-Referenz

In der Ausgabe:

Auszug aus der W3C recommendation:

Tipp der data2type-Redaktion:
Zum Thema XSL-FO bieten wir auch folgende Schulungen zur Vertiefung und professionellen Fortbildung an: