Was sind DITA und DocBook?




Was sind strukturierte Inhalte?

Strukturierter Inhalt ist ein Inhalt, der einem bestimmten Standard oder einer bestimmten Spezifikation entspricht. Das heisst dass er eine vordefinierte Struktur hat und nach vordefinierten Regeln organisiert ist. Strukturierter Inhalt wird am häufigsten mit XML ausgedrückt. Das erlaubt Inhalte leicht in andere Inhalte zu verarbeiten.


Was ist DITA?

DITA oder Darwin Information Typing Architecture ist ein offener Standard für technische Dokumentation, der von IBM erstellt ist. Inhalte, die dem DITA-Standard entsprechen, sind strukturierte Inhalte. DITA-Inhalt ist als topics organisiert, daher wird das Authoring in DITA auch als topic-basierte Authoring bezeichnet. Haupt-topics (oder Typen) von DITA sind zum Beispiel Task, Concept, Reference, Glossary Entry, Troubleshooting. DITA definiert auch eine bookmap, die ein Container für DITA-topics ist. Zum Beispiel für ein physisches Buch kann das Buch selbst in DITA als bookmap dargestellt werden und die einzelne Kapitel als topics. In diesem Fall können zwei verschiedene bookmap dasselbe topic enthalten, was die Modularisierung von Inhalten ist. für die Veröffentlichung von DITA-Inhalten. jAuthor ist ein DITA-Authoring-Tool, das sowohl kostenlose als auch kommerzielle Toolkits für die Veröffentlichung verwendet.

Hier ein Beispiel für ein DITA-Dokument: 

								  
<topic id="chapter_1" xml:lang="en-us">
    <title>Front View</title>
    <shortdesc>Car front view</shortdesc>
    <body>
        <section/>
        <p>
            <image placement="inline" src="images/front_view.png" width="300"/>
            <ol>
                <li >Fuel filter flap</li>
                <li >Roof antenna</li>
                <li >...</li>
            </ol>
        </p>
    </body>
</topic>

Jetzt kann dieses topic in eine separate Datei front_view.dita aufgenommen und in eine DITA-Bookmap wie folgt eingefügt werden: 

								
<bookmap id="car_manual">
  <booktitle>
    <booklibrary>Manuals</booklibrary>
    <mainbooktitle>Vehicle Owner's Manual</mainbooktitle>
    <booktitlealt>Owner's Manual for vehicle</booktitlealt>
  </booktitle>
  <chapter href="front_view.dita"/>
</bookmap>

In ähnlicher Weise können zusätzliche Kapitel hinzugefügt werden, indem auf ihre Dateien wie folgt verwiesen wird: 

								
<bookmap id="car_manual">
  <booktitle>
    <booklibrary>Manuals</booklibrary>
    <mainbooktitle>Vehicle Owner's Manual</mainbooktitle>
    <booktitlealt>Owner's Manual for vehicle</booktitlealt>
  </booktitle>
  <chapter href="front_view.dita"/>
  <chapter href="side_view.dita"/>
  <chapter href="rear_view.dita"/>
</bookmap>

Was ist DocBook?

DocBook ist eine Schema- oder Markup-Sprache, die ursprünglich zum Schreiben und Veröffentlichen von Computerdokumentationen entwickelt wurde. Nach dem DocBook-Standard erstellte Inhalte sind ebenfalls strukturierte Inhalte. Einige der strukturellen Tags von DocBook umfassen: set, book, article, chapter, appendix und andere. Ähnlich wie bei DITA können auch DocBook-Inhalte einfach in vielen anderen Formaten z.B. wie HTML, XHTML, EPUB, PDF, HTML Help, veröffentlicht, also in solche anderen Formate konvertiert werden.

Hier ein Beispiel für ein DocBook-Dokument: 


<article>
 <info>
   <title>Learning DITA and DocBook</title>
     <author>
       <personname>
         <firstname>John</firstname>
         <surname>Doe</surname>
       </personname>
     </author>
     <publisher>
       <publishername>jauthor.com</publishername>
     </publisher>
   <pubdate>2022</pubdate>
 </info>
   <section id="dita">
     <title>Learning DITA</title>
     <para>Introduction to DITA authoring...</para>
   </section>
   <section id="docbook">
     <title>Learning DocBook</title>
     <para>Introduction to DocBook authoring...</para>
   </section>
</article>

Das Erstellen eines Buches mit diesem Artikel sieht so aus: 


<book>
  <article>
   <info>
     <title>Learning DITA and DocBook</title>
	   <author>
	     <personname>
		   <firstname>John</firstname>
		   <surname>Doe</surname>
	     </personname>
	   </author>
	   <publisher>
	     <publishername>jauthor.com</publishername>
	   </publisher>
     <pubdate>2022</pubdate>
   </info>
     <section id="dita">
	   <title>Learning DITA</title>
	   <para>Introduction to DITA authoring...</para>
     </section>
     <section id="docbook">
	   <title>Learning DocBook</title>
	   <para>Introduction to DocBook authoring...</para>
     </section>
  </article>
</book>

Oder wie folgt, wenn der Artikel in einer separaten Datei article.xml gespeichert wird: 


<book lang="en">
    <title>Technical Documentation Authoring</title>
    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="article.xml"/>
</book>

Erstellen von DITA- und DocBook-Dokumentationen mit jAuthor

Der schnellste und einfachste Weg zum Erstellen von DITA- und DocBook-Dokumentationen ist die Verwendung von jAuthor Lite. jAuthor Lite ist eine kostenlose, leichte verwendbare Version von jAuthor zum Erstellen von Online-Dokumentationen. Um das Tool zu verwenden, gehen Sie zu jAuthor Lite und klicken Sie auf "Sign Up", um sich kostenlos zu registrieren.

Um nach der Registrierung auf der Website schnell auf dem Laufenden zu sein, lesen Sie bitte die hier verfügbare Kurzanleitung:

jAuthor Lite Quick Start Guide



Andere Spezifikationen

S1000D

S1000D ist eine technische Veröffentlichungsspezifikation, die ursprünglich zur Erstellung von Dokumentationen für Militärflugzeuge von der AeroSpace and Defense Industries Association of Europe (ASD) entwickelt wurde. Sie ist inzwischen weltweit anerkannt und wird auch für zivile Produkte verwendet. Sie kann auch für nicht-technische Veröffentlichungen verwendet werden. S1000D ist eine XML-Spezifikation und wird daher im XML-Format bereitgestellt. S1000D wird vom S1000D-Lenkungsausschuss gewartet:

  • ASD - AeroSpace and Defence Industries Association of Europe
  • AIA - Aerospace Industries Association
  • ATA - Air Transport Association of America

Die Spezifikation basiert auf internationalen ISO-, W3C-, ATA-Standards und kann kostenlos heruntergeladen und benutzt werden.

Das Hauptkonzept in S1000D ist das DataModule, eine einzelne Informationseinheit für a ein bestimmtes Teil oder Produkt. Jedes Modul hat einen spezifischen Code (SNS oder Standard Numbering System) der verwendet wird, um es in einer Datenbank (CSDB oder Common Source DataBase) im XML-Format zu speichern. Der spezifische Code wird dann verwendet, um das Modul abzurufen. Verschiedene Bild- und Videoformate werden von der Spezifikation unterstützt, die ihrerseits in der CSDB gespeichert und über ICN (Information Control Number) abgerufen werden.

Das Publikationsmodul hingegen definiert den Inhalt und die Struktur einer Veröffentlichung durch Referenzieren von Datenmodulen oder anderen Veröffentlichungsmodulen. Veröffentlichungsmodule werden durch den Veröffentlichungsmodulcode oder PMC identifiziert.

S1000D wird in zukünftigen Versionen von jAuthor unterstützt.


(Diese Seite wird ständig aktualisiert)