Zum Inhalt springen

„AsciiDoc“ – Versionsunterschied

aus Wikipedia, der freien Enzyklopädie
Versionsgeschichte interaktiv durchsuchen
[gesichtete Version][gesichtete Version]
← Zum vorherigen Versionsunterschied
Inhalt gelöscht Inhalt hinzugefügt
VisuellWikitext
https://asciidoc.org/CHANGELOG.html
Keine Bearbeitungszusammenfassung
Markierungen: Mobile Bearbeitung Mobile Web-Bearbeitung Erweiterte mobile Bearbeitung
 
(11 dazwischenliegende Versionen von 7 Benutzern werden nicht angezeigt)
Zeile 24: Zeile 24:
}}
}}
{{Infobox Software
{{Infobox Software
|Name = <code style="border:0; background:transparent;">asciidoc</code> (Software)
|Name = asciidoc (Software)
|Logo =
|Logo =
|Screenshot =
|Screenshot =
|Beschreibung = Implementierung von AsciiDoc, wandelt AsciiDoc in andere Formate
|Beschreibung = Implementierung von AsciiDoc, wandelt AsciiDoc in andere Formate
Zeile 31: Zeile 31:
|Hersteller =
|Hersteller =
|Erscheinungsjahr = 2002<!-- 2002-11-25 -->
|Erscheinungsjahr = 2002<!-- 2002-11-25 -->
|AktuelleVersion = 9.0.1
|AktuelleVersion = 10.0.2
|AktuelleVersionFreigabeDatum = 2020-06-26
|AktuelleVersionFreigabeDatum = 2021-11-13
|AktuelleVorabVersion =
|AktuelleVorabVersion =
|AktuelleVorabVersionFreigabeDatum =
|AktuelleVorabVersionFreigabeDatum =
Zeile 44: Zeile 44:
}}
}}
{{Infobox Software
{{Infobox Software
|Name = <code style="border:0; background:transparent;">asciidoctor</code> (Software)
|Name = asciidoctor (Software)
|Logo =
|Logo =
|Screenshot =
|Screenshot =
|Beschreibung = Implementierung von Asciidoctor, wandelt Asciidoctor-Dokumente in andere Formate
|Beschreibung = Implementierung von Asciidoctor, wandelt Asciidoctor-Dokumente in andere Formate
|Maintainer = Dan Allan
|Maintainer = Dan Allan
|Hersteller =
|Hersteller =
|Erscheinungsjahr = 2013 <!-- 0.1.0 von 2013-02-04 entspricht v1.0 -->
|Erscheinungsjahr = 2013 <!-- 0.1.0 von 2013-02-04 entspricht v1.0 -->
|AktuelleVersion = [https://github.com/asciidoctor/asciidoctor/releases v2.0.10]
|AktuelleVersion = [https://github.com/asciidoctor/asciidoctor/releases v2.0.17]
|AktuelleVersionFreigabeDatum = 2019-06-01
|AktuelleVersionFreigabeDatum = 2022-01-06
|AktuelleVorabVersion =
|AktuelleVorabVersion =
|AktuelleVorabVersionFreigabeDatum =
|AktuelleVorabVersionFreigabeDatum =
|Programmiersprache = [[Ruby (Programmiersprache)|Ruby]]
|Programmiersprache = [[Ruby (Programmiersprache)|Ruby]]
|Betriebssystem = [[Plattformunabhängigkeit|plattformunabhängig]], unterstützt diverse Betriebssysteme
|Betriebssystem = [[Plattformunabhängigkeit|plattformunabhängig]], unterstützt diverse Betriebssysteme
|Kategorie = [[Konvertierung (Informatik)|Dokumentwandler]]
|Kategorie = [[Konvertierung (Informatik)|Dokumentwandler]]
|Lizenz = [[MIT License]]
|Lizenz = [[MIT License]]
|Deutsch =
|Deutsch =
|Website = [http://asciidoctor.org/ asciidoctor.org]
|Website = [http://asciidoctor.org/ asciidoctor.org]
|Dateien =
|Dateien =
}}
}}


'''AsciiDoc''' ist eine [[vereinfachte Auszeichnungssprache]], die dazu dient, Texte in verschiedenen [[Dokumentenformat]]en zu veröffentlichen. AsciiDoc-Dateien können entweder nach [[Hypertext Markup Language|HTML]] oder ins [[DocBook]]-Format konvertiert werden – und von dort dann ggf. weiter in viele andere Formate, z.&nbsp;B. [[PDF]] oder [[Manpage]].
'''AsciiDoc''' ist eine [[vereinfachte Auszeichnungssprache]], die dazu dient, Texte in verschiedenen [[Dokumentenformat]]en zu veröffentlichen. AsciiDoc-Dateien können entweder nach [[Hypertext Markup Language|HTML]] oder ins [[DocBook]]-Format konvertiert werden – und von dort dann ggf. weiter in viele andere Formate, z.&nbsp;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.&nbsp;B. [[Markdown]], [[reStructuredText]], [[Textile]], [[Almost Plain Text]] oder auch [[Wikitext]].
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.&nbsp;B. [[Markdown]], [[reStructuredText]], [[Textile]], [[Almost Plain Text]] oder auch [[Wikitext]].


Einer breiten Öffentlichkeit wurde AsciiDoc bekannt durch den Einsatz in [[GitHub]].
Einer breiten Öffentlichkeit wurde AsciiDoc bekannt durch den Einsatz in [[GitHub]].
Zeile 83: Zeile 83:


Die [[Zeichenkodierung|Encoding]]-Angabe in der ersten Zeile ist nur nötig, wenn das Dokument nicht in [[UTF-8]] kodiert ist.
Die [[Zeichenkodierung|Encoding]]-Angabe in der ersten Zeile ist nur nötig, wenn das Dokument nicht in [[UTF-8]] kodiert ist.
<!--


<!-- Die Auf der rechten Seite gezeigte Darstellung ist angenähert.
Die Auf der rechten Seite gezeigte Darstellung ist angenähert.
Sie zeigt, was ein Asciidoc-Benutzer ungefähr erwarten darf.
Sie zeigt, was ein Asciidoc-Benutzer ungefähr erwarten darf.


ACHTUNG! Bitte das Beispiel nur ändern, wenn auch mit einem Asciidoc-Prozessor
ACHTUNG! Bitte das Beispiel nur ändern, wenn auch mit einem Asciidoc-Prozessor
überprüft wurde, ob das Ergebnis das erwartete ist und der rechten Seite entspricht!
überprüft wurde, ob das Ergebnis das erwartete ist und der rechten Seite entspricht!
Das gilt insbesondere für die Ebenen der Überschriften. -->
Das gilt insbesondere für die Ebenen der Überschriften.


-->
{| style="float:left; margin-right:1em;"
{|
|-
|-
! Eingabe
! Eingabe
Zeile 119: Zeile 121:
</pre>
</pre>
|}
|}

{| style="padding: .5em; border: 1pt solid #BBBBBB; margin-top: 1em;"
{|
|+ style="margin-bottom: 1em;"| '''Ergebnis'''
|-
! Ergebnis
|-
|-
|<div style="border-bottom: 1px solid #AAAAAA; font-size: 1.8em; margin-top: 1em; margin-bottom: .25em; overflow: hidden;">Meine Überschrift</div>
| style="padding: .5em; border: 1pt solid #BBBBBB;" |
<div style="border-bottom: 1px solid #AAAAAA; font-size: 1.8em; margin-top: 1em; margin-bottom: .25em; overflow: hidden;">Meine Überschrift</div>
'''K. Mustermann'''
'''K. Mustermann'''


Zeile 166: Zeile 171:
<ref name="eclipse-2020-02-06">
<ref name="eclipse-2020-02-06">
{{Internetquelle |autor=Dan Allen |url=https://www.eclipse.org/lists/asciidoc-wg/msg00002.html |titel=&#91;asciidoc-wg&#93; More about the AsciiDoc Working Group |werk=eclipse.org |datum=2020-02-06 |abruf=2020-02-16}}
{{Internetquelle |autor=Dan Allen |url=https://www.eclipse.org/lists/asciidoc-wg/msg00002.html |titel=&#91;asciidoc-wg&#93; More about the AsciiDoc Working Group |werk=eclipse.org |datum=2020-02-06 |abruf=2020-02-16}}
</ref>
</ref>
<ref name="heise-2020-02-14">
<ref name="heise-2020-02-14">
{{Internetquelle |autor=Alexander Neumann |url=https://www.heise.de/developer/meldung/Arbeitsgruppe-zur-Auszeichnungssprache-AsciiDoc-gestartet-4660580.html |titel=Arbeitsgruppe zur Auszeichnungssprache AsciiDoc gestartet |werk=heise online |datum=2020-02-14 |abruf=2020-02-16}}
{{Internetquelle |autor=Alexander Neumann |url=https://www.heise.de/developer/meldung/Arbeitsgruppe-zur-Auszeichnungssprache-AsciiDoc-gestartet-4660580.html |titel=Arbeitsgruppe zur Auszeichnungssprache AsciiDoc gestartet |werk=heise online |datum=2020-02-14 |abruf=2020-02-16}}

Aktuelle Version vom 10. Oktober 2024, 15:00 Uhr

AsciiDoc (Auszeichnungssprache)
Dateiendung: .adoc, .asciidoc
Entwickelt von: Stuart Rackham
Erstveröffentlichung: 2002
Art: Vereinfachte Auszeichnungssprache
Erweitert von: Textdatei
Erweitert zu: Asciidoctor
asciidoc.org


Auszeichnungssprache für Text

asciidoc (Software)
Basisdaten

Hauptentwickler Stuart Rackham
Erscheinungsjahr 2002
Aktuelle Version 10.0.2
(13. November 2021)
Betriebssystem plattformunabhängig, unterstützt diverse Betriebssysteme
Programmier­sprache Python
Kategorie Dokumentwandler
Lizenz GPLv2 (freie Software)
asciidoc.org
asciidoctor (Software)
Basisdaten

Hauptentwickler Dan Allan
Erscheinungsjahr 2013
Aktuelle Version v2.0.17
(6. Januar 2022)
Betriebssystem plattformunabhängig, unterstützt diverse Betriebssysteme
Programmier­sprache 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
Meine Überschrift

K. Mustermann

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

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]
[Bearbeiten | Quelltext bearbeiten]

Einzelnachweise

[Bearbeiten | Quelltext bearbeiten]
  1. ↑ AsciiDoc, powered by Asciidoctor, returns to GitHub
  2. ↑ 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.
  3. ↑ Dan Allen: [asciidoc-wg] More about the AsciiDoc Working Group. In: eclipse.org. 6. Februar 2020, abgerufen am 16. Februar 2020.
  4. ↑ Alexander Neumann: Arbeitsgruppe zur Auszeichnungssprache AsciiDoc gestartet. In: heise online. 14. Februar 2020, abgerufen am 16. Februar 2020.
  5. ↑ a b Die Seite Lightweight markup language der englischen Wikipedia vergleicht viele Aspekte diverser Auszeichnungssprachen in Tabellenform.
Abgerufen von „https://de.wikipedia.org/w/index.php?title=AsciiDoc&oldid=249305967“