AsciiDoc
| AsciiDoc (Auszeichnungssprache) | |
|---|---|
| Dateiendung: | .adoc, .asciidoc
|
| Entwickelt von: | Stuart Rackham |
| Erstveröffentlichung: | 2002 |
| Art: | Vereinfachte Auszeichnungssprache |
| Erweitert von: | Textdatei |
| Erweitert zu: | Asciidoctor |
| asciidoc.org | |
| asciidoc (Software) | |
|---|---|
| Basisdaten
| |
| Hauptentwickler | Stuart Rackham |
| Erscheinungsjahr | 2002 |
| Aktuelle Version | 10.0.2 (2021-11-13) |
| Betriebssystem | plattformunabhängig, unterstützt diverse Betriebssysteme |
| Programmiersprache | Python |
| Kategorie | Dokumentwandler |
| Lizenz | GPLv2 (freie Software) |
| asciidoc.org | |
| asciidoctor (Software) | |
|---|---|
| Basisdaten
| |
| Hauptentwickler | Dan Allan |
| Erscheinungsjahr | 2013 |
| Aktuelle Version | v2.0.17 (2022-01-06) |
| Betriebssystem | plattformunabhängig, unterstützt diverse Betriebssysteme |
| Programmiersprache | Ruby |
| Kategorie | Dokumentwandler |
| Lizenz | MIT License |
| asciidoctor.org | |
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.
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, Almost Plain Text oder auch Wikitext.
Einer breiten Öffentlichkeit wurde AsciiDoc bekannt durch den Einsatz in GitHub.
Geschichte und Software
[Bearbeiten | Quelltext bearbeiten]Das ursprüngliche Konvertierprogramm, asciidoc, ist in Python geschrieben und steht unter der freien GNU General Public License (GPL). Im Juni 2020 wurde eine an aktuelle Python-Versionen angepasste Version veröffentlicht.
Eine Neuimplementierung von AsciiDoc ist ‘Asciidoctor’, Version 0.1 wurde 2013 veröffentlicht. GitHub verwendet Asciidoctor, um AsciiDoc-Dokumente nach HTML zu wandeln.[1][2] Neben der Ruby-Variante ist Asciidoctor auch in Varianten für Java und JavaScript verfügbar.
AsciiDoc Working Group
[Bearbeiten | Quelltext bearbeiten]Am 6. Februar 2020 gab die Eclipse Foundation bekannt, dass die AsciiDoc Working Group gegründet wurde zur Standardisierung von AsciiDoc.[3] Die Open-Source-Organisation will einen „offenen und neutralen Raum für die Diskussionen und Entwicklungen zur Auszeichnungssprache schaffen, sowohl was die Sprache als auch das Dokumentmodell betrifft.“[4]
Beispiel
[Bearbeiten | Quelltext bearbeiten]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 https://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 |
|---|
|
K. Mustermann Wikipedia ist eine Online-Enzyklopädie, verfügbar auf Englisch, Deutsch und in vielen anderen Sprachen. Sie können paket mit dem make install paket Häufig genutzte Metalle sind:
|
Vergleich zu Wikitext
[Bearbeiten | Quelltext bearbeiten]AsciiDoc ähnelt in mancher Hinsicht Wikitext, wie viele vereinfachte Auszeichnungssprachen.[5] Die Stärken der beiden Sprachen machen sich in den jeweiligen Einsatzgebieten bemerkbar, für die sie entwickelt wurden.
Wikitext wurde für die Darstellung von Webseiten entwickelt, speziell Wiki-Seiten. Beispielsweise macht Wikitext es den Autoren einfach, Verweise auf andere Wiki-Seiten darzustellen. Die Schreibweise für einen Verweis auf die Seite Beispiel ist zum Beispiel [[Beispiel]]. Original AsciiDoc besitzt für Verweise auf Wiki-Seiten keine eigene Schreibweise. Verweise müssen die volle URL angeben, zum Beispiel https://de.wikipedia.org/wiki/Beispiel[Beispiel].
AsciiDoc hingegen wurde für technische Dokumentation entwickelt, insbesondere im Bereich der Informatik. Beispielsweise ist es sehr einfach, im Fließtext Dateinamen oder Programmcode auszuzeichnen. Zum Beispiel ergibt `Beispiel` das Ergebnis Beispiel, während Wikitext für das Ergebnis Beispiel die Schreibweise <code>Beispiel</code> erfordert und für das Ergebnis Beispiel gar die Schreibweise <code style="border:0; background:#FFFFFF;">Beispiel</code>.
Ein weiterer Unterschied sind die Ausgabeformate. MediaWiki bietet ohne Weiteres nur Wandlung von Wikitext nach HTML und beschränkt sich insofern auf die Darstellung von Web-Seiten. Die gängigen AsciiDoc-Implementierungen bieten neben HTML verschiedene weitere Ausgabeformate, neben den schon erwähnten PDF, DocBook und Manpage auch EPUB und LaTeX.[5] Dadurch bietet sich AsciiDoc auch für die Formatierung von Büchern und allgemein Dokumenten an, die auch außerhalb des Webs verbreitet und gelesen werden können sollen.
Literatur
[Bearbeiten | Quelltext bearbeiten]- Alexander Schwartz: Documentation as Code mit Asciidoctor. In: Heise Developer. 21. Januar 2020, abgerufen am 16. Februar 2020 (Umfang sechs Kapitel).
Weblinks
[Bearbeiten | Quelltext bearbeiten]- Website des AsciiDoc-Projekts (englisch)
- AsciiDoc Cheatsheet (Kurzzusammenfassung) (englisch)
- AsciidocToGo Portable Version von AsciiDoc für MS Windows (englisch)
Einzelnachweise
[Bearbeiten | Quelltext bearbeiten]- ↑ AsciiDoc, powered by Asciidoctor, returns to GitHub
- ↑ Dokumentation der Software-Bibliothek markup. Die Bibliothek entscheidet beim Anzeigen einer auf GitHub liegenden Datei (zum Beispiel README), welche Markup-Bibliothek verwendet wird, um den Inhalt nach HTML zu wandeln.
- ↑ Dan Allen: [asciidoc-wg] More about the AsciiDoc Working Group. In: eclipse.org. 6. Februar 2020, abgerufen am 16. Februar 2020.
- ↑ Alexander Neumann: Arbeitsgruppe zur Auszeichnungssprache AsciiDoc gestartet. In: heise online. 14. Februar 2020, abgerufen am 16. Februar 2020.
- ↑ a b Die Seite Lightweight markup language der englischen Wikipedia vergleicht viele Aspekte diverser Auszeichnungssprachen in Tabellenform.