pydev-ts

[mDoc.git] / doc / README

diff --git a/doc/README b/doc/README
new file mode 100644 (file)
index 0000000..fb03237
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,30 @@
+mDoc-Dokumentenerstellung
+=========================
+
+mDoc wandelt ein Docbook-XML in ein beliebiges anderes Format anhand eines gleichfalls in
+XML vorliegenden Templates.
+
+Dabei gelten folgende Regeln:
+
+- Das Template hat den Namen <Zielformat>.tpl
+- Der oberste Knoten des Templates hat folgendes Format:
+  <mdoc format="<Zielformat>" extension="<Dateiextension des Ziels>">
+- Soll ein Knoten des Docbooks zu einer Ausgabe im Zielformat führen, muss das XML-Tag im
+  Template gefunden werden. Das Template hat zwei Sektionen:
+ x <global>:
+   Hier finden sich Definitionen, die in jeder XML-Tiefe auftreten dürfen
+ x <hierarchical>
+   Hier finden sich Definitionen in derselben hierarchischen Ordnung wie im Docbook
+- XML-Tags im Template können das "position"-Attribut haben:
+ x position="first" positioniert den tpl-Wert vor die weitere Verarbeitung
+ x Ohne Attribut wird mit der Ausgabe des Docbookinhalts fortgefahren.
+   Bei der Weiterverarbeitung wird zuerst der (allfällige) Wert des Docbook-Tags ausgegeben,
+   dann weitere Untertags verarbeitet.
+ x position="last" positioiniert den Wert nach die Verarbeitung
+- <verbatim target="format"> kann jeder Stelle verwendet werden. Falls "format" das aktuelle
+  Ausgabeformat ist, wird der Inhalt wörtlich übernommen.
+- Vorne im Template können Funktionen definiert werden.
+ x Input: Sie können direkt auf die Variablen value (der Wert des tags) und source (das XML-
+   Dokument) zugreifen.
+ x Output: Der Wert der Variablen out wird in die Zieldatei kopiert
+