XML-Technologien / DITA / Topics erstellen und organisieren / Referenz

Referenz

(Auszug aus "DITA - Der neue Standard für Technische Dokumentation" von Johannes Hentrich)

In dem Topictyp „Referenz“ werden Fragen beantwortet wie „Welche Werte hat ..?“ oder „Welche Eigenschaften hat ..?“. Ein Topic vom Typ „Referenz“ enthält daher oft Tabellen, in denen die Eigenschaften, die Werte und die dazugehörende Beschreibung aufgeführt sind. Das folgende Beispiel zeigt den Topictyp “Referenz“ mit seiner einfachsten Struktur:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//ELEMENTS DITAReference//EN" "../dtd/reference.dtd">
<reference id="kapitel8_ref">
    <title></title>
    <refbody></refbody>
</reference>

Wie jedes DITA-Topic beginnt auch das Topic vom Typ „Referenz“ mit einer XML- und der DOCTYPE-Deklaration. In der DOCTYPE-Deklaration wird auf die reference.dtd verwiesen.

Das Wurzel-Element des Topictyps „Referenz“ ist das <reference>-Element. Im Wurzel-Element <reference> muss eine eindeutige Kennung, das heißt eine ID zugewiesen werden.

Das <title>-Element enthält einen aussagekräftigen Titel für das Topic vom Typ „Referenz“.

Das <refbody>-Element legt die Struktur des Topictyps „Referenz“ fest. Neben den üblichen Block-Elementen zur Erfassung von Referenzinformationen stellt DITA zudem noch folgende Elemente für Topics vom Typ „Referenz“ bereit:

<properties>: Zur Erfassung von Referenzinformationen steht eine Tabelle zur Verfügung, die durch das <properties>-Element definiert ist. Jede Referenzinformation wird über den Typ, dessen Wert und eine Beschreibung erfasst. Den Tabellenkopf definieren Sie mit dem <prophead>-Element. Dort wird der Typ mit dem <proptypehd>-Element, der Wert mit dem <propvaluehd>-Element und die Beschreibung mit dem <propdeschd>-Element definiert. Für die Definition der Zellenelemente stehen innerhalb des <poperty>-Elements für den Typ das <proptype>-Element, für den Wert das <propvalue>-Element und für die Beschreibung das <propdesc>-Element zur Verfügung.

<properties>
    <prophead>
        <proptypehd>save()</proptypehd>
        <propvaluehd>0</propvaluehd>
        <propdeschd>Speichern der Datei</propdeschd>
    </prophead>
    <property>
        <proptype>close()</proptype>
        <propvalue>0</propvalue>
        <propdesc>Fenster schließen.</propdesc>
    </property>
    <property>
        <proptype>abort()</proptype>
        <propvalue>0</propvalue>
        <propdesc>Abbruch-</propdesc>
    </property>
</properties>

<refsyn>: Dieses Element können Sie dazu verwenden, um Hinweise zu liefern, welche Programmiersprache oder Syntax in diesem Topic beschrieben werden.

<< zurück

vor >>

Tipp der data2type-Redaktion:
Zum Thema DITA bieten wir auch folgende Schulungen zur Vertiefung und professionellen Fortbildung an:

DITA
TEI

DocBook
XSLT

Copyright © 2008 XLcontent Verlag
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "DITA - Der neue Standard für Technische Dokumentation" denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.

XLcontent Verlag, Pflegerstraße 40, 81247 München