Reference
Das DITA Reference-Topic beschreibt die normalen Funktionen eines Topic oder Produkts, so zum Beispiel die Befehle in einer Programmiersprache oder einer API (Application Programming Interface). DITA Reference-Topics liefern Informationen zu beliebigen Themen mit geregeltem Inhalt, zum Beispiel Rezepte, Kataloge, Bibliographien und ähnlich strukturierte beschreibende Informationen.
Eine Referenz enthält die folgenden primären Tags:
• reference – Enthält alle übrigen Tags
• title – Der Betreff des Topic
• shortdesc – Eine kurze Beschreibung oder Übersicht über das Topic
• prolog– Verschiedene Metadaten zum Topic, z.B. Autor, Copyright, Indexbegriffe usw.
• refbody – Enthält den eigentlichen Inhalt des Topic
Eine Referenz ist in der Regel in mindestens einen Abschnitt, eine Tabelle und eine Liste organisiert, die Sie in beliebiger Reihenfolge anordnen können. Die primären Tags im Referenztextkörper lauten wie folgt:
◦ section – Ein Container für den Inhalt, den Sie in einer Referenz gruppieren möchten
◦ refsyn – Syntax oder ähnliche Informationen
◦ properties – Eine Liste mit Eigenschaften, die dem Referenzthema zugeordnet sind und die in der Regel in Tabellenform dargestellt werden
◦ example – Beispiele, die die Referenzinformationen veranschaulichen oder unterstützen
Das refbody-Tag kann außerdem die DITA-Standardtabellen enthalten.
• related-links – Querverweis-Links zu verwandten Themen
Die meisten dieser Tags sind optional. Verwenden Sie daher nur diejenigen, die Sie zum Erstellen des Topic benötigen.