Anleitung AsciiDoc-Syntax

Sätze und Absätze

Regeln

  • Ein Satz pro Zeile.

  • Einen Absatz durch eine Leerzeile von dem vorherigen Absatz trennen.

AsciiDoc-Syntax

Das ist der erste Satz in dem ersten Absatz.
Das ist der zweite Satz in dem ersten Absatz.
Das ist der dritte Satz in dem ersten Absatz.

Das ist der erste Satz in dem zweiten Absatz.
Das ist der zweite Satz in dem zweiten Absatz.
Das ist der dritte Satz in dem zweiten Absatz.

Anzeige im Dokument

Das ist der erste Satz in dem ersten Absatz. Das ist der zweite Satz in dem ersten Absatz. Das ist der dritte Satz in dem ersten Absatz.

Das ist der erste Satz in dem zweiten Absatz. Das ist der zweite Satz in dem zweiten Absatz. Das ist der dritte Satz in dem zweiten Absatz.

Überschriften

Regeln

  • Nicht mehr als vier Ebenen für Überschriften verwenden, da das Dokument sonst zu stark verschachtelt ist.

AsciiDoc-Syntax

= Überschrift auf der ersten Ebene
== Überschrift auf der zweiten Ebene
=== Überschrift auf der dritten Ebene
==== Überschrift auf der vierten Ebene

Anzeige im Dokument

Überschrift auf der ersten Ebene

Überschrift auf der zweiten Ebene

Überschrift auf der dritten Ebene

Überschrift auf der vierten Ebene

Textstellen hervorheben

AsciiDoc-Syntax

*fett*
_kursiv_
`nichtproportionale Schrift`

Anzeige im Dokument

fett
kursiv
nichtproportionale Schrift

Listen

Unsortierte Listen

Regeln

  • Unsortierte Listen für Aufzählungen verwenden, die keiner logischen Reihenfolge folgen.

AsciiDoc-Syntax

* Erster Listeneintrag
* Zweiter Listeneintrag
* Dritter Listeneintrag

Anzeige im Dokument

  • Erster Listeneintrag

  • Zweiter Listeneintrag

  • Dritter Listeneintrag

Sortierte Listen

Regeln

  • Sortierte Listen für Schritt-für-Schritt-Anleitungen verwenden.

AsciiDoc-Syntax

. Erster Schritt
. Zweiter Schritt
. Dritter Schritt

Anzeige im Dokument

  1. Erster Schritt

  2. Zweiter Schritt

  3. Dritter Schritt

Tabellen & Bilder

Alle Tabellen und Bilder, die du in deinem Dokument verwendest, müssen nummeriert und mit kurzen Beschriftungen versehen werden. Die Beschriftung sollte so prägnant sein, dass deutlich wird, was die Tabelle bzw. Das Bild inhaltlich darstellt. Stammt deine Tabelle/Bild aus einer fremden Quelle, musst du dies zusätzlich kennzeichnen. Die Quellenangabe besteht aus den Informationen Autor, Jahr und Seitenzahl.

Somit lassen sich im Fliestext Bilder auf diese Art nennen: Siehe Ein Bild. Ebenso verhällt es sich bei Tabellen, siehe Eine Tabelle

Ausserdem ist es somit möglich ein Bild bzw. Tabellenverzeichnis zu erstellen.

Die Bilder, die in asciiDoc im 'image' Verzeichnis abgelegt werden, sollten ebenso einen Namen haben, der den Inhalt darstellt. Idealerweise ähneln sich Bildbeschriftung und Bild Datei-Name, das erleichtert das auffinden des Bildes im 'image' Verzeichnis.

Tabellen

AsciiDoc-Syntax

[#tab-uuid]
.Beschreibung des Tabelleninhalts
[%header]
|===
|Tabellenkopf erste Spalte  |Tabellenkopf zweite Spalte  |Tabellenkopf dritte Spalte
|Erste Spalte, erste Zeile  |Zweite Spalte, erste Zeile  |Dritte Spalte, erste Zeile
|Erste Spalte, zweite Zeile |Zweite Spalte, zweite Zeile |Dritte Spalte, zweite Zeile
|Erste Spalte, dritte Zeile |Zweite Spalte, dritte Zeile |Dritte Spalte, dritte Zeile
|===

Anzeige im Dokument

Beschreibung des Tabelleninhalts
Tabellenkopf erste Spalte Tabellenkopf zweite Spalte Tabellenkopf dritte Spalte

Erste Spalte, erste Zeile

Zweite Spalte, erste Zeile

Dritte Spalte, erste Zeile

Erste Spalte, zweite Zeile

Zweite Spalte, zweite Zeile

Dritte Spalte, zweite Zeile

Erste Spalte, dritte Zeile

Zweite Spalte, dritte Zeile

Dritte Spalte, dritte Zeile

Bilder

AsciiDoc-Syntax

[#fig-uuid]
.Beschreibung des Bildinhalts
image::providing_content/fig_example.png[Example]

Anzeige im Dokument

Example
Figure 1. Beschreibung des Bildinhalts