Ein neues Handbuch in AsciiDoc

Teil 5

Mittlerweile ist das neue Jahr schon ein paar Tage alt und auch die letzten Urlauber sind nun auch wieder fleissig am Arbeiten.

Natürlich habe ich auch über die Feiertage einen Gang runter geschaltet und hauptsächlich an administrativen Dingen für das neue Jahr gearbeitet. Ebenso habe ich einiges an der Webseite für die bald erscheinende Merlin Project-Version 8.1 vorbereitet.

Daraus kann der aufmerksame Leser sofort entnehmen, dass ich am neuen Handbuch nicht ganz viel geschrieben habe … eigentlich gar nichts 🤷‍♂️.

Reaktionen auf vorherige Beiträge

Trotzdem möchte ich auf einige Mails eingehen, die mich nach dem vierten Teil erreicht haben. Viele Leute interessieren sich sehr für die Variablen und Textersetzungen. Daher möchte ich dieses Mal einen wichtigen Tip geben.

Asciidoc kennt das Konzept der Admonitions, was im deutschen am Besten mit Warnungen übersetzt werden kann. Die üblichen Werte sind hier NOTE, IMPORTANT, TIP, CAUTION und WARNING. Diese Warnungen werden als Wort ausgegeben, was dann in etwa so aussehen kann:

IMPORTANT | Lesen der Dokumentation kann Pannen verhindern!

Ist aber zu Beginn des Dokuments die Zeile:

:icons: font

enthalten, werden die Begriffe durch Symbole ersetzt. Je nach verwendetem Bild kann das dann so aussehen:

Lesen der Dokumentation kann Pannen verhindern!

Diese Technik mache ich mir zu Nutze, wann immer ich zwischen den Programmen, wie Merlin Project und Merlin Project Express unterscheiden muss, setze ich einen Text wie diesen ein:

[{MPE}]
NOTE: Merlin Project Express kennt nur den Anhangstyp Dateien.

Daraus wird dann das:

Das setzt voraus, dass in den attributes.adoc das icon definiert ist.

:mpe: icon=mpExpress-32.png

In diesem Sinne – bis zum nächsten Mal …