DocBook ist eine semantische Preiserhöhungssprache für die Entwicklerdokumentation. Es war ursprünglich beabsichtigt, um technische Dokumente zu schreiben, die mit der Computerhardware und Software verbunden sind, aber es kann für jede andere Sorte der Dokumentation verwendet werden.

Als eine semantische Sprache ermöglicht DocBook seinen Benutzern, Dokumenteninhalt in einer mit der Präsentation neutralen Form zu schaffen, die die logische Struktur des Inhalts gewinnt; dieser Inhalt kann dann in einer Vielfalt von Formaten, einschließlich HTML, XHTML, EPUB, PDF, Mann-Seiten, Webhilfe und HTML-Hilfe veröffentlicht werden, ohne zu verlangen, dass Benutzer irgendwelche Änderungen mit der Quelle vornehmen.

Übersicht

DocBook ist eine XML Sprache. In seiner jetzigen Version (5.0) wird die Sprache von DocBook durch ein ENTSPANNEN Diagramm von NG mit einheitlichen Regeln von Schematron formell definiert. (Es gibt auch W3C XML Schema+Schematron und Versionen der Dokumenttyp-Definition (DTD) des Diagramms verfügbar, aber diese werden umgangssprachlich betrachtet.)

Als eine semantische Sprache beschreiben Dokumente von DocBook nicht, wie was ihr Inhalt "," aber eher die Bedeutung jenes Inhalts aussieht. Zum Beispiel anstatt zu erklären, wie der Auszug für einen Artikel visuell formatiert werden könnte, sagt DocBook einfach, dass eine besondere Abteilung ein Auszug ist. Es ist bis zu einem in einer Prozession gehenden Außenwerkzeug oder Anwendung, um zu entscheiden, wohin auf einer Seite der Auszug gehen sollte, und wie was es aussehen sollte, oder ob es in die Endproduktion überhaupt eingeschlossen werden sollte.

DocBook stellt eine riesengroße Zahl von semantischen Element-Anhängseln zur Verfügung. Sie werden in drei breite Kategorien geteilt: strukturell, Block-Niveau, und Reihen-.

Strukturanhängsel geben breite Eigenschaften ihres Inhalts an. Das Element gibt zum Beispiel an, dass seine Kinderelemente die Teile eines Buches vertreten. Das schließt einen Titel, Kapitel, Wörterverzeichnisse, Anhänge und so weiter ein. Die Strukturanhängsel von DocBook schließen ein, aber werden nicht beschränkt auf:

• : eine betitelte Sammlung von einem oder mehr s. Sätze können mit anderen Sätzen verschachtelt werden.
• : eine betitelte Sammlung von s, s, und/oder s, mit fakultativen Wörterverzeichnissen, Anhängen, und so weiter.
• : eine betitelte Sammlung von einem oder mehr s. Teile können mit anderen Teilen verschachtelt werden. Kann speziellen einleitenden Text haben.
• : eine betitelte, unnumerierte Sammlung von Elementen des Block-Niveaus.
• : eine betitelte, numerierte Sammlung von Elementen des Block-Niveaus. DocBook verlangt nicht wirklich, dass Kapitel Zahlen ausführlich gegeben werden; es wird durch die Semantik verstanden, dass die Zahl eines Kapitels die Zahl von vorherigen Kapitel-Elementen im XML Dokument plus 1 ist.
• : der enthaltene Text vertritt einen Anhang.
• : der Text vertritt die Hingabe des enthaltenen Strukturelements.

Strukturelemente können andere Strukturelemente enthalten. Strukturelemente sind die einzigen erlaubten Elemente auf höchster Ebene in einem Dokument von DocBook.

Anhängsel des Block-Niveaus sind Elemente wie Paragraf, Listen und so weiter. Nicht alle diese Elemente können wirklichen Text direkt enthalten. Wie man erwartet, werden folgende Elemente des Block-Niveaus dasjenige "nach" einem anderen gemacht. Danach in diesem Fall kann sich abhängig von der Sprache unterscheiden. Auf den meisten Westsprachen, bedeutet "danach" unten: Textparagrafen werden unter die Seite gedruckt. Die Schreiben-Systeme anderer Sprachen können verschiedenen directionality haben; zum Beispiel, in Japanisch, wird Text häufig in Säulen mit Paragrafen gedruckt, die vom Recht bis linken so laufen, "nachdem" in diesem Fall nach links sein würde. Semantik von DocBook ist zu diesen Arten von sprachbasierten Konzepten völlig neutral.

Reihenniveau-Anhängsel sind Elemente wie Betonung, Hypertext-Links und so weiter. Sie wickeln Text innerhalb eines Elements des Block-Niveaus. Diese Elemente veranlassen den Text nicht, wenn gemacht, in einem Paragraf-Format zu brechen, aber normalerweise veranlassen sie den Dokumentenverarbeiter, eine Art verschiedene typografische Behandlung auf den beiliegenden Text anzuwenden, indem sie die Schriftart, Größe oder ähnlichen Attribute ändern. (Die Spezifizierung von DocBook sagt wirklich, dass sie verschiedene typografische Behandlung erwartet, aber sie bietet spezifische Voraussetzungen betreffs nicht an, wie diese Behandlung sein kann.) D. h. ist es nicht erforderlich, dass ein Verarbeiter von DocBook ein Anhängsel in "die Kursive" umgestaltet. Ein Leser-basierter Verarbeiter von DocBook konnte das Volumen der Wörter vergrößern. Oder ein textbasierter Verarbeiter konnte kühn statt der Kursive verwenden.

Beispieldokument

</Kapitel>

</Kapitel>

</Buch>

</Quelle>

Semantisch ist dieses Dokument ein "Buch" mit einem "Titel", der zwei "Kapitel" jeder mit ihren eigenen "Titeln" enthält. Jene "Kapitel" enthalten "Paragrafen", die Text in ihnen haben. Die Preiserhöhung ist in Englisch ziemlich lesbar.

Ausführlicher ist das Wurzelelement des Dokumentes. Alle Elemente von DocBook sind in einem XML Namespace, so hat das Wurzelelement ein Xmlns-Attribut, um den Strom namespace zu setzen. Außerdem muss das Wurzelelement eines Dokumentes von DocBook eine Version haben, die die Version des Formats angibt, dass auf das Dokument gebaut wird.

(XML Dokumente können Elemente von vielfachem namespaces sofort einschließen. Für die Einfachheit illustriert das Beispiel das nicht.)

Ein Element muss a oder ein Element enthalten, das a enthält. Das muss vor jedem Kind Strukturelemente sein. Im Anschluss an den Titel sind die Strukturkinder, in diesem Fall, zwei Elemente. Jeder von diesen muss a haben. Sie enthalten Block-Elemente, die freien Text und andere Reihenelemente wie im zweiten Paragrafen des ersten Kapitels enthalten können.

Diagramme und Gültigkeitserklärung

Regeln wie diejenigen haben auf im vorhergehenden Paragrafen angespielt ("ein Element muss a oder ein Element enthalten, das a enthält," usw.) werden im Diagramm von DocBook formell definiert. Passende Programmierwerkzeuge können verwendet werden, um ein XML Dokument (DocBook oder sonst) gegen sein entsprechendes Diagramm gültig zu machen, um zu bestimmen, ob (und wenn so, wo) das Dokument scheitert, sich diesem Diagramm anzupassen. XML das Redigieren von Werkzeugen kann auch Diagramm-Information verwenden, um zu vermeiden, nonkonformistische Dokumente an erster Stelle zu schaffen.

DocBook authoring

Weil DocBook XML ist, können Dokumente geschaffen und mit jedem Textaufbereiter editiert werden. Ein hingebungsvoller XML Redakteur ist ebenfalls ein funktioneller Redakteur von DocBook. DocBook stellt Diagramm-Dateien für populäre XML Diagramm-Sprachen zur Verfügung, so kann jeder XML Redakteur, der zufriedene auf einem Diagramm gestützte Vollziehung zur Verfügung stellen kann, so für DocBook tun. Viele grafisch oder WYSIWYG XML Redakteure kommen mit der Fähigkeit, DocBook wie ein Textverarbeitungsprogramm zu editieren.

Verarbeitung von DocBook

Weil DocBook ein XML-Format ist, sich einem bestimmten Diagramm anpassend, können Dokumente gültig gemacht werden und haben das Verwenden jedes Werkzeugs oder Programmiersprache bearbeitet, die XML-Unterstützung einschließt.

Dateien von DocBook werden verwendet, um Produktionsdateien in einem großen Angebot an Formaten vorzubereiten. Fast immer wird das mit DocBook XSL stylesheets vollbracht. Das ist XSLT stylesheets, die Dokumente von DocBook in mehrere Formate (HTML, XSL-FO für die spätere Konvertierung in PDF, usw.) umgestalten. Diese stylesheets können hoch entwickelt genug sein, um Inhaltsübersichten, Wörterverzeichnisse und Indizes zu erzeugen. Sie können die Auswahl an besonderen benannten Teilen eines Master-Dokumentes beaufsichtigen, um verschiedene Versionen desselben Dokumentes zu erzeugen (wie ein "Tutorenkurs" oder ein "Führer der schnellen Verweisung," wo beide von diesen aus einer Teilmenge des Materials bestehen).

Weil normale DocBook XSL stylesheets XSL stylesheets gut gebildet werden, und DocBook XML gut gebildet wird, können Benutzer schreiben, dass ihr eigenes stylesheets oder sogar ein flügges Programm kundengerecht angefertigt hat, um DocBook in ein passendes Produktionsformat zu bearbeiten, weil ihre Bedürfnisse diktieren.

Webhilfe

Webhilfe ist ein chunked HTML-Produktionsformat in DocBook XSL stylesheets, der in der Version 1.76.1 eingeführt wurde. Die Dokumentation für die Webhilfe stellt auch ein Beispiel der Webhilfe zur Verfügung und ist ein Teil von DocBook xsl Vertrieb. Es sind Haupteigenschaften schließen CSS-basiertes Seitenlay-Out ohne frameset, mehrsprachige volle zufriedene Suche, Fensterscheibe der Inhaltsübersicht (TOC) mit dem zusammenklappbaren TOC Baum, der Autosynchronisation der zufriedenen Fensterscheibe und TOC ein. Dieses Webhilfsformat wurde von Kasun Gajasinghe und David Cramer als ein Teil des Google Sommers des Programms des Codes 2010 ursprünglich durchgeführt.

Geschichte

DocBook hat 1991 in Diskussionsgruppen auf Usenet begonnen, und evenually ist ein gemeinsames Projekt von HAL Computer Systems and O'Reilly & Associates geworden und hat schließlich seine eigene Wartungsorganisation (Davenport Group) vor dem Bewegen 1998 zum SGML Offenes Konsortium erzeugt, das nachher OASE geworden ist. DocBook wird zurzeit von DocBook Technisches Komitee an der OASE unterstützt.

DocBook ist sowohl in SGML als auch in XML-Formen als ein DTD verfügbar. ENTSPANNEN SIE NG und W3C XML Diagramm-Formen der XML Version sind verfügbar. Mit DocBook 5 anfangend, ist die ENTSPANNEN Version von NG die "normative" Form, von der die anderen Formate erzeugt werden.

DocBook ist ursprünglich als eine SGML Anwendung aufgebrochen, aber eine gleichwertige XML Anwendung wurde entwickelt und hat jetzt den SGML ein für den grössten Teil des Gebrauches ersetzt. (Mit der Version 4 des SGML DTD anfangend, hat der XML DTD mit diesem Versionszählen-Schema weitergegangen.) Am Anfang hat eine Schlüsselgruppe von Softwaregesellschaften DocBook verwendet, seitdem ihre Vertreter an seinem anfänglichen Design beteiligt wurden. Schließlich, jedoch, wurde DocBook von der offenen Quellgemeinschaft angenommen, wo es ein Standard geworden ist, um Dokumentation für viele Projekte, einschließlich FreeBSD, KDE, ZWERG-Tischdokumentation, der GTK + API-Verweisungen, die Kerndokumentation von Linux und die Arbeit des Linux Dokumentationsprojektes zu schaffen.

Norman Walsh und die Projektentwicklungsmannschaft von DocBook erhalten die Schlüsselanwendung dafür aufrecht, Produktion aus Quelldokumenten von DocBook zu erzeugen: Eine Reihe von XSL stylesheets (sowie ein Vermächtnis-Satz von DSSSL stylesheets), der Qualitäts-HTML und Druck (FO/PDF) Produktion, sowie Produktion in anderen Formaten, einschließlich des Volltextformats, der Mann-Seiten und der HTML-Hilfe erzeugen kann.

Walsh ist auch der Hauptautor des Buches DocBook: Das Endgültige Handbuch, die offizielle Dokumentation von DocBook. Dieses Buch ist online unter dem GFDL, und auch als eine Druckveröffentlichung verfügbar.

Pre DocBook v5.0

Die jetzige Version von DocBook, 5.0, ist ziemlich neu. Vorherige Versionen sind gewesen und sind noch im weit verbreiteten Gebrauch, so stellt diese Abteilung eine Übersicht der Änderungen zum älteren 4.x Formate zur Verfügung.

Bis zu DocBook 5 wurde DocBook normativ durch eine Dokumenttyp-Definition (DTD) definiert. Seitdem DocBook ursprünglich als eine Anwendung von SGML gebaut wurde, war der DTD die einzige verfügbare Diagramm-Sprache. DocBook 4.x können Formate SGML oder XML sein, aber die XML Version hat seinen eigenen namespace nicht.

Als ein Auswuchs, durch einen DTD DocBook 4.x definiert zu werden, waren Formate erforderlich, innerhalb der Beschränkungen zu leben, durch einen DTD definiert zu werden. Das bedeutendste für die Sprache, die ist, dass ein Elementname einzigartig seinen möglichen Inhalt definiert. D. h. ein genanntes Element muss dieselbe Information enthalten, egal wo es in der Datei von DocBook ist. Als solcher gibt es viele Arten von Info-Elementen in DocBook 4.x: usw. Jeder von ihnen hat ein ein bisschen verschiedenes zufriedenes Modell, aber sie teilen wirklich etwas von ihrem zufriedenen Modell. Zusätzlich wiederholen sie Zusammenhang-Information. Das Element des Buches ist das, weil es ein direktes Kind des Buches ist; es braucht besonders für einen menschlichen Leser nicht genannt zu werden. Jedoch, weil das Format durch einen DTD definiert wurde, musste es wirklich als solcher genannt werden.

Das Wurzelelement hat nicht oder braucht eine Version, weil die Version in die DTD Behauptung an der Oberseite von einem pre-DocBook 5 Dokument eingebaut wird.

DocBook 4.x sind Dokumente mit DocBook 5 nicht vereinbar, aber sie können in DocBook 5 Dokumente durch den Gebrauch eines XSLT stylesheet umgewandelt werden. Einer wird als ein Teil des Vertriebs von DocBook 5 Diagramm und Spezifizierungspaket zur Verfügung gestellt.

Vereinfachter DocBook

DocBook bietet eine Vielzahl von Eigenschaften an, die einem neuen Benutzer überwältigend sein können. Für diejenigen, die die Bequemlichkeit von DocBook ohne eine große Lernkurve wollen, wurde Vereinfachter DocBook entworfen. Es ist eine kleine Teilmenge von DocBook, der für einzelne Dokumente wie Artikel oder technische Dokumentation entworfen ist (d. h. "Bücher" werden nicht unterstützt). Vereinfachter DocBook DTD ist zurzeit an der Version 1.1.

Siehe auch

• Liste von Dokumentenpreiserhöhungssprachen
• Vergleich von Dokumentenpreiserhöhungssprachen
• DocBook XSL Eine Gruppe von XSLT stylesheets, für DocBook in verschiedene Viewable-Formate umzugestalten.
• Darwin Information Typing Architecture (DITA), ein Konkurrieren xml Vokabular für technische Dokumente
• LinuxDoc
• LATEX

Weiterführende Literatur

Links

• DocBook.org - Sammlung der Information von DocBook, einschließlich 4.x und 5.0 Version von DocBook: Der Endgültige Führer und alle Versionen von DocBook schemas/DTDs.
• Behältnis von DocBook an der OASE - Normatives Haus von DocBook schema/DTD.
• DocBook XSL Projektseite an SourceForge.net
• DocBook Demystification HOWTO
• DocBook: Das Endgültige Handbuch, die 1. Ausgabe, v. 2.0.6 - haben Völlig PDF des Führers für DocBook 3.x und 4.x mit einem Lesezeichen versehen.