Inhaltsverzeichnis
Zusammenfassung
zpub-Dokumente sind DocBook 4.5-Dokumente[1]. Der aktuelle Workflow von zpub geht von dieser DocBook-Version aus und die Stylesheets für die Ausgabeformate erwarten ein valides DocBook-4.5-Dokument. Die offizielle Dokumentation zu DocBook 4.5 existiert http://www.docbook.org/tdg/en/html/docbook.html online.
Ein neues Dokument besteht aus einem Verzeichnis, der DocBook-Datei sowie optional einem images-Verzeichnis. Das Verzeichnislayout lautet wie folgt:
`-- Verzeichnisnameǀ-- images
ǀ ǀ-- bild_01.png ǀ `-- bild_02.png `-- Dokumentname.xml
| Projektverzeichnis. Verzeichnisname wird für die Benennung des Projekts auf der zpub-Webseite genutzt. Es ist nicht zwingend notwendig, dass Projektverzeichnisname und Dokumentdateiname übereinstimmen, bietet sich jedoch an. |
| Verzeichnis für die Ablage von Grafiken, die im DocBook-Dokument verlinkt werden. |
| Das DocBook-Dokument. Dateiname wird ebenfalls für die Ausgabeformate genutzt. |
Ein (minimales) Grundgerüst einer (zpub-)DocBook4.5-Datei ist im folgenden dargestellt:
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []>
<book lang="de">
<title>Dokumenttitel</title>
<chapter>
<title>Kapiteltitel</title>
<para>Inhalt</para>
</chapter>
</book>Die Verzeichnisstruktur inklusive der Dateien (DocBook-Datei sowie eventuell Grafiken) wird zpub durch das Hinzufügen zum SVN-Repository sowie dem anschließenden commit bekannt gemacht. Der Commit der Datei(en) stößt bei zpub die Generierung der konfigurierten Ausgabeformate, die Versionierung und das Update der zpub-Webseite an.
[1] Ein Hinweis zur Nutzung von Serna Free mit DocBook5 findet sich z.B. auf https://wiki.hpdd.intel.com/.