Versionsgeschichten
(Auszug aus "DocBook-XML: Medienneutrales und plattformunabhängiges Publizieren" von Thomas Schraitle)
Mit Hilfe des Elements revhistory erstellen Sie eine so genannte "Versionsgeschichte". Für gewöhnlich wird revhistory als Metainformation verwendet (erlaubt in info, bookinfo, partinfo, chapterinfo usw.) Setzen Sie dieses Element ein, wenn Sie Ihre Leser über die Änderungen im entsprechenden Element informieren möchten. Ein Beispiel, wie Sie revhistory einsetzen:
Beispiel: Eine typische Versionsgeschichte mit revhistory
<revhistory>
<revision>
<revnumber>1.0</revnumber>
<date>Okt. 2002</date>
<authorinitials>tux</authorinitials>
<revdescription>
<para>...</para>
</revdescription>
</revision>
<!-- evtl. weitere <revision> Elemente -->
</revhistory>Zeile 2: Das Elternelement revhistory enthält mindestens ein Element revision.
Zeile 3: Die Revisionsnummer. Dies kann ein beliebiger Wert sein.
Zeile 4: Datum zur Revisionsnummer
Zeile 5: Initialen des Autors
Zeile 6: längere Beschreibung der Revision; für kürzere Texte ist auch revremark möglich.
Aufgrund eines Versehens bis zur Version 4.2 kann dieses Element auch an einigen anderen "exotischen" Stellen auftreten, wie in seealso, lineannotation, title, link und quote. Verwenden Sie es dort nicht, da es in DocBook 5 entfernt wurde!
Hinweis: Automatische Versionsgeschichte mit Subversion
Verwenden Sie Subversion als Versionsverwaltung, lässt sich eine Versionsgeschichte automatisch erstellen. Gerade wenn sich Ihre Dokumente häufig ändern, ist dies eine große Arbeitserleichterung. Für interessierte Anwender gibt es ein Stylesheet, das die Ausgabe von svn log in ein revhistory überführt. Mit Hilfe von XIncludes oder externe Entities lässt sich die so erzeugte Datei an der gewünschten Stelle einbinden.
Eine weitere, dazu passende Ergänzung ist das Attribut revision. Dieses Attribut ist in jedem Element verfügbar (Version 4 bzw. 5). Wenn Sie Ihre Texte mit Hilfe CVS oder Subversion verwalten, lässt sich die aktuelle Version in einem revision-Attribut unterbringen. Fügen Sie Markierungen wie $Id:$, $Date:$ oder $Revision:$ hinzu, ergänzt das Versionsverwaltungssystem dies durch den den oder die aktuellen Werte:
<chapter revision="$Id: db-elements-block.xml 973 2009-07-12 19:20:52Z tom $">Copyright © 2009 Millin Verlag
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "DocBook-XML: Medienneutrales und plattformunabhängiges Publizieren" denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.
Millin Verlag, Siebengebirgsring 36, 53797 Lohmar, info(at)millin.de