AsciiDoc

AsciiDoc ist eine vereinfachte Auszeichnungssprache, die dazu dient, Texte in verschiedenen Dokumentenformaten zu veröffentlichen. AsciiDoc-Dateien können entweder nach HTML oder ins DocBook-Format konvertiert werden – und von dort dann ggf. weiter in viele andere Formate, z. B. PDF oder Manpage. Das Konvertierprogramm asciidoc ist in Python geschrieben und steht unter der freien GNU General Public License (GPL).

Im Vergleich zu auf SGML oder XML basierenden Dokumentenformaten wie DocBook haben auf Plain text basierende „leichte“ Auszeichnungssprachen wie AsciiDoc den Vorteil, leicht erlernbar zu sein und auch unverarbeitet (als Quelltext) gut lesbar zu sein. Weitere „leichte“ Auszeichnungssprachen sind z. B. Markdown, reStructuredText, Textile, txt2tags, Almost Free Text (AFT), Almost Plain Text oder auch Wikitext. Der Nachteil von nicht auf XML basierenden Formaten ist natürlich, dass die vielen XML-verarbeitenden Programme und Standards (z. B. XSLT) nicht unmittelbar zu deren Weiterverarbeitung genutzt werden können. Dieser Nachteil lässt sich durch eine Konvertierung ins DocBook-Format ausgleichen und man kann anschließend XML-verarbeitende Programme zum Einsatz bringen.

Beispiel

Das folgende Beispiel zeigt einen in AsciiDoc geschriebenen Quelltext und eine HTML-Darstellung ähnlich der, wie sie ein AsciiDoc-Prozessor aus dem Quelltext erzeugt.

Die Encoding-Angabe in der ersten Zeile ist nur nötig, wenn das Dokument nicht in UTF-8 kodiert ist.

Eingabe
:encoding: iso-8859-1 = Meine Überschrift K. Mustermann http://wikipedia.org[Wikipedia] ist eine Online-Enzyklopädie, verfügbar auf Englisch, Deutsch und in vielen anderen Sprachen. == Software Sie können 'paket' mit dem `make`-Kommando installieren: make install paket == Hardware Häufig genutzte Metalle sind: * Eisen * Kupfer

Ergebnis
Vorlage:Überschriftensimulation 1 K. Mustermann Wikipedia ist eine Online-Enzyklopädie, verfügbar auf Englisch, Deutsch und in vielen anderen Sprachen. Vorlage:Überschriftensimulation 2 Sie können paket mit dem make-Kommando installieren: make install paket Häufig genutzte Metalle sind: Eisen Kupfer

Abgrenzung Wikitext

Zu beachten ist, dass obiges Beispiel den irrtümlichen Eindruck erweckt, dass AsciiDoc eine Variante von Wikitext sei. Der charakteristische Unterschied von AsciiDoc zu Wikitext ist, dass AsciiDoc mehrere verschiedene Varianten erlaubt, zum Beispiel in der Kennzeichnung von Listen und Überschriften – während Wikitext sich im Regelfall auf genau eine Schreibweise festlegt – damit große Projekte über viele Jahre effizient wartbar bleiben und Einsteiger sich nur eine Schreibweise merken müssen.

Weblinks

• Website des AsciiDoc-Projekts (englisch)
• AsciiDoc Cheatsheet (Kurzzusammenfassung) (englisch)
• AsciidocToGo Portable Version von AsciiDoc für MS Windows (englisch)