doc/README

   1 mDoc-Dokumentenerstellung
   2 =========================
   3
   4 mDoc wandelt ein Docbook-XML in ein beliebiges anderes Format anhand eines gleichfalls in
   5 XML vorliegenden Templates.
   6
   7 Dabei gelten folgende Regeln:
   8
   9 - Das Template hat den Namen <Zielformat>.tpl
  10 - Der oberste Knoten des Templates hat folgendes Format:
  11   <mdoc format="<Zielformat>" extension="<Dateiextension des Ziels>">
  12 - Soll ein Knoten des Docbooks zu einer Ausgabe im Zielformat führen, muss das XML-Tag im
  13   Template gefunden werden. Das Template hat zwei Sektionen:
  14  x <global>:
  15    Hier finden sich Definitionen, die in jeder XML-Tiefe auftreten dürfen
  16  x <hierarchical>
  17    Hier finden sich Definitionen in derselben hierarchischen Ordnung wie im Docbook
  18 - XML-Tags unter <global> können das "position"-Attribut haben:
  19  x position="first" positioniert den tpl-Wert vor die weitere Verarbeitung
  20  x Ohne Attribut wird mit der Ausgabe des Docbookinhalts fortgefahren.
  21    Bei der Weiterverarbeitung wird zuerst der (allfällige) Wert des Docbook-Tags ausgegeben,
  22    dann weitere Untertags verarbeitet.
  23  x position="last" positioiniert den Wert nach die Verarbeitung
  24 - <verbatim target="format"> kann jeder Stelle verwendet werden. Falls "format" das aktuelle
  25   Ausgabeformat ist, wird der Inhalt wörtlich übernommen.
  26 - Vorne im Template können Funktionen definiert werden.
  27  x Input: Sie können direkt auf die Variablen value (der Wert des tags) und source (das XML-
  28    Dokument) zugreifen.
  29  x Output: Der Wert der Variablen out wird in die Zieldatei kopiert
  30 - mDoc-spezifische Tags (Docbook-Erweiterung)
  31  x <line>: Einzelne Zeilen innerhalb eines Paragraphen
  32  x <item>: Definition von Testbausteinen, wenn im Paragraphen auch Hervorhebungs-Tags (wie
  33    <emphasis>) vorkommen.
  34