AsciiDoc
| AsciiDoc ( markup language ) | |
|---|---|
| File extension : |
.adoc, .asciidoc
|
| Developed by: | Stuart Rackham |
| Initial release: | 2002 |
| Type: | Simplified markup language |
| Extended by: | Text file |
| Expanded to: | Asciidoctor |
asciidoc (Software)
|
|
|---|---|
| Basic data
|
|
| Maintainer | Stuart Rackham |
| Publishing year | 2002 |
| Current version | 9.0.1 (2020-06-26) |
| operating system | platform-independent , supports various operating systems |
| programming language | python |
| category | Document converter |
| License | GPLv2 ( free software ) |
| asciidoc.org | |
asciidoctor (Software)
|
|
|---|---|
| Basic data
|
|
| Maintainer | Dan Allan |
| Publishing year | 2013 |
| Current version |
v2.0.10 (2019-06-01) |
| operating system | platform-independent , supports various operating systems |
| programming language | Ruby |
| category | Document converter |
| License | MIT License |
| asciidoctor.org | |
AsciiDoc is a simplified markup language that is used to publish texts in various document formats. AsciiDoc files can either be converted to HTML or to DocBook format - and from there then to many other formats, e.g. B. PDF or manpage .
Compared to SGML or XML- based document formats such as DocBook, “light” markup languages based on plain text such as AsciiDoc have the advantage of being easy to learn and also easy to read unprocessed (as source text). Other "light" markup languages are e.g. B. Markdown , reStructuredText , Textile , Almost Plain Text or Wikitext .
AsciiDoc became known to the general public through its use in GitHub .
History and software
The original conversion program , asciidoc , is written in Python and is available under the free GNU General Public License (GPL). A version adapted to current Python versions was published in June 2020.
A new implementation of AsciiDoc is 'Asciidoctor', version 0.1 was published in 2013. GitHub uses Asciidoctor to convert AsciiDoc documents to HTML. In addition to the Ruby variant, Asciidoctor is also available in variants for Java and JavaScript .
AsciiDoc Working Group
On February 6, 2020, the Eclipse Foundation announced that the AsciiDoc Working Group had been established to standardize AsciiDoc. The open source organization wants to create an "open and neutral space for discussions and developments on the markup language, both in terms of the language and the document model."
example
The following example shows a source text written in AsciiDoc and an HTML representation similar to that generated by an AsciiDoc processor from the source text.
The Encoding specification in the first line is only necessary if the document is not encoded in UTF-8 .
| input |
|---|
: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 |
|
K. Mustermann Wikipedia is an online encyclopedia, available in English, German, and many other languages. You can install the package with the make install paket Commonly used metals are:
|
Compared to Wikitext
AsciiDoc is in some ways similar to Wikitext , as are many simplified markup languages. The strengths of the two languages are noticeable in the respective application areas for which they were developed.
Wikitext was developed for displaying web pages, especially wiki pages. For example, Wikitext makes it easy for authors to display links to other Wiki pages. The spelling for a reference to the example page is for example [[Beispiel]]. Original AsciiDoc does not have its own notation for references to Wiki pages. Referrals must state the full url , for example https://de.wikipedia.org/wiki/Beispiel[Beispiel].
AsciiDoc, on the other hand, was developed for technical documentation, especially in the field of computer science. For example, it is very easy to mark up file names or program code in the running text. For example, `Beispiel`the result is Beispiel, while Wikitext requires Beispielthe spelling <code>Beispiel</code>for the result and Beispieleven the spelling for the result <code style="border:0; background:#FFFFFF;">Beispiel</code>.
Another difference is the output formats. MediaWiki simply offers conversion from Wikitext to HTML and is therefore limited to the display of web pages. In addition to HTML, the common AsciiDoc implementations offer various other output formats, in addition to the PDF, DocBook and Manpage already mentioned, EPUB and LaTeX . As a result, AsciiDoc is also suitable for formatting books and documents in general, which should also be able to be distributed and read outside the web.
literature
- Alexander Schwartz: Documentation as Code with Asciidoctor. In: Heise Developer. January 21, 2020, accessed on February 16, 2020 (six chapters).
Web links
- Website AsciiDoc Project (English)
- AsciiDoc Cheatsheet (short summary )
- AsciidocToGo Portable Version of AsciiDoc for MS Windows (English)
Individual evidence
- ↑ AsciiDoc, powered by Asciidoctor, returns to GitHub
- ↑ Documentation of the markup software library . When displaying a file on GitHub (for example README), the library decides which markup library is used to convert the content to HTML.
- ^ Dan Allen: [asciidoc-wg] More about the AsciiDoc Working Group. In: eclipse.org. February 6, 2020, accessed February 16, 2020 .
- ↑ Alexander Neumann: Working group on the AsciiDoc markup language started. In: heise online. February 14, 2020, accessed February 16, 2020 .
- ↑ a b The page Lightweight markup language of the English Wikipedia compares many aspects of various markup languages in tabular form.