Attribute

Attribute definieren und verwenden

Stellen Sie sich vor, Sie haben eine neue Version Ihrer Software herausgebracht und müssen nun das Handbuch anpassen. Ohne Attribute müssten Sie jede Stelle einzeln von "Version X" auf "Version Y" ändern.

Mit Attributen definieren Sie einen Wert einmal und verwenden ihn überall im Dokument:

:version: 2.0
:produktname: adoc Studio

Die aktuelle Version von {produktname} ist {version}.

Ergebnis: Die aktuelle Version von adoc Studio ist 2.0.

Die Syntax ist einfach:

  • Definition: :attributname: wert

  • Verwendung: {attributname}

Bei Änderungen passen Sie nur die Definition an – alle Stellen im Text werden automatisch aktualisiert.

attributes example

Wichtige Standardattribute

Neben eigenen Attributen bietet AsciiDoc viele vordefinierte Attribute:

Attribut Wirkung

:toc:

Fügt ein Inhaltsverzeichnis ein

:icons: font

Zeigt Hinweise als Icons statt Text

:sectnums:

Nummeriert Überschriften automatisch

:stem:

Aktiviert mathematische Formeln

:imagesdir: images

Setzt das Standardverzeichnis für Bilder

Für die PDF-Ausgabe sind zusätzlich relevant:

Attribut Wirkung

:title-page:

Erstellt eine separate Titelseite

:pagenums:

Zeigt Seitenzahlen an

:toc-title: Inhalt

Ändert die Überschrift des Inhaltsverzeichnisses

Attribute im Dokumentkopf

Viele Attribute müssen im Dokumentkopf stehen – also oberhalb des Titels oder direkt danach. So ist sichergestellt, dass sie im gesamten Dokument wirken:

= Mein Dokument
:toc:
:icons: font
:version: 1.0

Hier beginnt der Text...
Der adoc Coach hilft Ihnen bei der Auswahl. Drücken Sie ESC im Dokumentkopf, um alle verfügbaren Attribute mit Erklärungen zu sehen.
Attribute können auch in den Produkt-Einstellungen definiert werden. Das ist besonders nützlich, wenn verschiedene Ausgaben unterschiedliche Werte benötigen – mehr dazu im Kapitel Produkte.