Hinweise
Die fünf Hinweistypen
Mit Hinweisen (im Englischen Admonitions genannt) betonen Sie bestimmte Informationen. In AsciiDoc gibt es fünf Arten von Hinweisen:
| Syntax | Bedeutung |
|---|---|
|
|
Allgemeiner Hinweis oder Information |
|
|
Hilfreicher Tipp oder Empfehlung |
|
|
Wichtige Information |
|
|
Vorsicht – etwas könnte schiefgehen |
|
|
Warnung – Gefahr oder kritische Information |
Die Syntax ist einfach – schreiben Sie den Typ gefolgt von einem Doppelpunkt und Ihrem Text:
NOTE: Dies ist ein allgemeiner Hinweis.
TIP: Hier ein hilfreicher Tipp für Sie.
WARNING: Achtung, diese Aktion kann nicht rückgängig gemacht werden!Hinweise als Icon darstellen
Standardmäßig werden Hinweise als Text ausgegeben (z.B. "Hinweis:" oder "Warnung:"). Sie können den Text durch ein Icon ersetzen, indem Sie im Dokumentkopf das Attribut :icons: font setzen.
| Dies ist ein Hinweis mit Icon. |
| Dies ist ein Tipp mit Icon. |
| Dies ist eine Warnung mit Icon. |
| Hier ist Vorsicht geboten. |
| Das ist wichtig zu wissen. |
Hinweistexte anpassen: Wenn Sie die Beschriftung ändern möchten, nutzen Sie die entsprechenden Caption-Attribute. Mit :warning-caption: Achtung wird beispielsweise "Warnung" durch "Achtung" ersetzt.
Block-Hinweise
Für längere Hinweise mit mehreren Absätzen oder Listen verwenden Sie die Block-Syntax:
====
Dieser Hinweis kann mehrere Absätze enthalten.
Er kann auch Listen beinhalten:
* Punkt 1
* Punkt 2
Oder sogar Code-Blöcke.
====|
Dieser Hinweis kann mehrere Absätze enthalten. Er kann auch Listen beinhalten:
|