DocBook Textverarbeitung mit XML

Größe: px

Ab Seite anzeigen:

Download "DocBook Textverarbeitung mit XML"

Adolf Kaiser
vor 9 Jahren
Abrufe

1 DocBook Textverarbeitung mit XML Peter Eisentraut

2 Persönlich PostgreSQL-Entwickler Maintainer PostgreSQL-Dokumentation Debian-Entwickler Debian XML/SGML Group Maintainer DocBook DSSSL Stylesheets Buchautor DocBook 1

3 Was ist DocBook? XML-Vokabular für technische Dokumente Stylesheets und viele Tools OASIS-Standard DocBook 2

4 Ein einfaches Beispiel <?xml version="1.0"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" " <book lang="de"> <title>ein sehr einfaches Buch</title> <chapter> <title>einführung</title> <para>hallo Welt!</para> </chapter> </book> DocBook 3

5 Verarbeitungsbeispiel $ xsltproc /usr/share/xml/docbook/stylesheet/nwalsh/html/docbook.xsl \ beispiel.xml > beispiel.html DocBook 4

6 Vorteile von DocBook Inhalt und Format getrennt mehrere Ausgabeformate XML als standardisiertes Format erweiterbar, anpassbar läuft auf vielen Plattformen DocBook 5

7 Ausgabeformate HTML, XHTML PDF, PostScript HTML Help, JavaHelp RTF Manpages Plain Text... DocBook 6

8 Nachteile von DocBook kein WYSIWYG kein DTP-Ersatz nicht einfach viele Tags (HTML: 90, DocBook: 400) strikte Struktur viele kooperierende Tools perfekte Druckergebnisse schwierig DocBook 7

9 Einsatzbereiche wiederholte Releases verteilte Autorenschaft große, komplexe Dokumente mehrere Ausgabeformate automatische Verarbeitung DocBook 8

10 Aktuelle Anwender GNOME, KDE, FreeBSD, Linux-Kernel, LDP, PostgreSQL, Debian, OpenLDAP, PHP, SuSE, Red Hat, Sun, O Reilly,... DocBook 9

11 Verarbeitung Umwandlung von DocBook in Zielformat Dokument Prozessor HTML, RTF,... DTD Stylesheet DocBook 10

12 Verarbeitung Umwandlung von DocBook ber Zwischenformat in Zielformat Dokument Prozessor XSL-FO, TeX Prozessor DTD Stylesheet PDF, PS DocBook 11

13 Die DocBook DTDs Document Type Definition legt die Dokumentstruktur fest für XML und SGML Aktuell Version 4.4 Veröffentlicht von OASIS Zukünftig (Version 5): Relax NG Schemas XML Schemas (experimentell) DocBook 12

14 DTD-Beispiel <!ELEMENT Chapter ((DocInfo?, Title, Subtitle?, TitleAbbrev?), ToCchap?, (((CalloutList GlossList ItemizedList OrderedList SegmentedList SimpleList VariableList Caution Important Note Tip Warning LiteralLayout ProgramListing ProgramListingCO Screen ScreenCO ScreenShot Synopsis CmdSynopsis FuncSynopsis FormalPara Para SimPara Address BlockQuote Graphic GraphicCO MediaObject MediaObjectCO InformalEquation InformalExample InformalFigure InformalTable Equation Example Figure Table MsgSet Procedure Sidebar QandASet Anchor BridgeHead Comment Highlights Abstract AuthorBlurb Epigraph IndexTerm)+, (Sect1* (RefEntry)* SimpleSect* Section*)) (Sect1+ (RefEntry)+ SimpleSect+ Section+)), (Index Glossary Bibliography)*) > DocBook 13

ScreenCO ScreenShot Synopsis CmdSynopsis FuncSynopsis FormalPara Para SimPara Address BlockQuote Graphic GraphicCO MediaObject MediaObjectCO InformalEquation InformalExample

15 Stylesheets XSLT-Stylesheets W3C-Standard nur für XML DTD Ausgabe: HTML, XHTML, HTML Help, XSL-FO,... DSSSL-Stylesheets ISO-Standard für XML und SGML DTDs Ausgabe: HTML, TEX, RTF DocBook 14

16 XSLT-Beispiel DocBook: Schreiben Sie an <xsl:template match=" "> <xsl:call-template name="inline.monoseq"> <xsl:with-param name="content"> <xsl:text><</xsl:text> <a> <xsl:attribute name="href">mailto:<xsl:value-of select="."/></xsl:attribute> <xsl:apply-templates/> </a> <xsl:text>></xsl:text> </xsl:with-param> </xsl:call-template> </xsl:template> HTML: Schreiben Sie an <tt><<a DocBook 15

monoseq"> <xsl:with-param name="content"> <xsl:text><</xsl:text> <a> <xsl:attribute name="href">mailto:<xsl:value-of

17 DSSSL-Beispiel DocBook: Schreiben Sie an (element ($code-seq$ (make sequence (literal "<") (make element gi: "A" attributes: (list (list "HREF" (string-append "mailto:" (data (current-node))))) (process-children)) (literal ">")))) HTML: Schreiben Sie an <tt><<a DocBook 16

(list (list "HREF" (string-append "mailto:" (data (current-node))))) (process-children))

18 XSLT-Prozessoren xsltproc Saxon Xalan... DocBook 17

19 XSL-FO-Prozessoren Frei: FOP PassiveTEX Nicht frei: Antenna House XSL Formatter RenderX XEP Unicorn Formatting Objects DocBook 18

20 DSSSL-Toolchain Umwandlung DSSSL: Jade, OpenJade Umwandlung TEX in PDF: JadeTEX DocBook 19

21 Schreibwerkzeuge Texteditor Editor mit SGML/XML-Modus XML-Editor DocBook 20

22 Beispiele: Inline-Markup <para>auf <trademark class="registered">unix</trademark>-systemen steuert die Datei <filename>/etc/crontab</filename> die von <command>cron</command> ausgeführten Befehle.</para> <para><symbol>uintmax</symbol> ist gleich 2<superscript>32</superscript>-1.</para> DocBook 21

23 Beispiele: Listen <itemizedlist> <listitem> <para>erster Punkt</para> </listitem> <listitem> <para>zweiter Punkt</para> </listitem> <listitem> <para>dritter Punkt</para> </listitem> </itemizedlist> DocBook 22

24 Beispiele: Formale Objekte Abbildungen, Beispiele, Gleichungen, Tabellen automatisch nummeriert automatisches Abbildungsverzeichnis usw. DocBook 23

25 Beispiele: Code <para>dies ist ein sehr einfaches Shell-Skript: <programlisting> #!/bin/sh exit 0 </programlisting> </para> DocBook 24

26 Beispiele: Querverweise <chapter id="maus"> <title>verwendung einer Maus</title>... Siehe <xref linkend="maus"/>. HTML-Ausgabe: Siehe <a href="#maus">kapitel 3, Verwendung einer Maus</a>. DocBook 25

27 Beispiele: Grafiken Unterstützte Formate hängen von der Toolchain ab. <mediaobject> <imageobject> <imagedata fileref="figures/eiffeltower.eps" format="eps"> </imageobject> <imageobject> <imagedata fileref="figures/eiffeltower.gif" format="gif"> </imageobject> <textobject> <phrase>the Eiffel Tower</phrase> </textobject> </mediaobject> DocBook 26

28 Customization DocBook DTD anpassbar: Elemente hinzufügen Elemente entfernen DocBook Stylesheets anpassbar: neue Formatierungsregeln HTML-Ausgabe anpassbar: CSS DocBook 27

29 Alternative Anwendungen Simplified DocBook DTD Module: EBNF, HTML Forms, MathML, SVG Website DTD Slides DTD angepasste Rechtschreibprüfung Gettext-Integration DocBook 28

30 Zusammenfassung DocBook... ist eine XML DTD für technische Dokumente unterstützt viele Ausgabeformate ist geeignet für wiederholte und verteilte Bearbeitung ist nicht immer ganz einfach Weitere Informationen: DocBook 29

Ähnliche Dokumente

DocBook für Anfänger

DocBook für Anfänger Michael Wiedmann http://www.miwie.org/db-beginners/ Linux Advanced Lectures Berlin, BUUG, Mittwoch, 7.11.2001, 18:30 s.t. Einführung Anwendungsfälle Beispiel