Navigation in Topics
(Auszug aus "DITA - Der neue Standard für Technische Dokumentation" von Johannes Hentrich)
DITA bietet drei Möglichkeiten an, um mit Links zwischen Topics navigieren
zu können:
- gewöhnliche Links
- verwandte Links (related links)
- Beziehungstabellen (relationship tables)
Gewöhnliche Links und verwandte Links werden in Topics definiert. Beziehungstabellen stehen in Maps und Bookmaps zur Verfügung. Informationen zu Beziehungstabellen erhalten Sie unter Beziehungstabellen.
Links
Mit dem <xref>-Element können Sie wie folgt Links setzen:
- zu anderen Topics,
- zu Elementen in anderen Topics,
- zu Elementen innerhalb des gleichen Topics,
- zu externen Quellen.
Geben Sie das Ziel des Links im href-Attribut an.
Einen Link zu einem anderen Topic definieren Sie mit
<xref href="zieltopic.xml">Link zu Topic</xref>Der Text im <xref>-Element wird dabei als Linktext verwendet. Mit dem type-Attribut können Sie zusätzlich noch angegeben, was für eine Eigenschaft das Ziel aufweist. Werte für das type-Attribut sind concept, task, reference, topic sowie fig, table, li, fn und section.
Wenn Sie zu einem Element in einem anderen Topic verlinken wollen, müssen Sie sowohl die ID des Topics als auch die ID des Elements kennen. Ein Link wird dann wie folgt gesetzt:
<xref href="zieltopic.xml#topicid/elementid">Link zu Element in einem Topic</xref>Hinter dem Pfad zur Zieldatei folgt ein Gartenzaun (#), gefolgt von der ID des Topics, die mit einem Schrägstrich (/) von der ID des Elements getrennt ist.
Soll auf ein Element im gleichen Topic verlinkt werden, so müssen Sie auch hier die ID des Topics und die ID des Elements kennen. Ein Link zu einem Element wird dann wie folgt gesetzt:
<xref href="#topicid/elementid">Link zu einem Element im selben Topic</xref>Bei einem Link zu einer externen Quelle muss die URL bekannt sein. Einen Link können Sie dann wie folgt setzen:
<xref href="http://www.xlcontent-verlag.de">XLcontent Verlag</xref>Verwandte Links
Am Ende eines Topics können Sie mit dem <related-links>-Element eine Liste mit Links zu anderen Topics oder zu externen Quellen einfügen, die im Zusammenhang mit dem aktuellen Topic stehen. Das <related-links>-Element wird nach dem <body>-Element oder dessen Entsprechungen bei den anderen Topictypen platziert.
<concept id="kapitel8_concept">
<title>...</title>
<conbody>
....
</conbody>
<related-links>
....
</related-links>
</concept>Ein Link wird im <link>-Element definiert. Der Mechanismus der Verlinkung über das href-Attribut funktioniert wie beim <xref>-Element.
<related-links>
<link href="uerblick.xml"/>
</related-links>Der Linktext wird erst bei der Verarbeitung der XML DITA-Dateien durch das DITA Open Toolkit erzeugt. Wenn möglich, wird der Titel des Zieltopics dafür verwendet. Mit dem <linktext>-Element können Sie jedoch auch einen anderen Linktext definieren. Inbesondere wenn der Link zu einer externen URL führt, sollten Sie das <linktext>-Element verwenden.
<a href="http://href="http://www.xlcontent-verlag.de"">
<linktext>Informationen zum XLcontent Verlag</linktext>
</a>Die Links können auf zwei Arten gruppiert werden: über das <linkpool>-Element und über das <linklist>-Element.
Thematisch ähnliche Links können Sie mit dem <linkpool>-Element gruppieren. Über das type-Attribut kann die Beziehung der Topics zueinander näher spezifiziert werden.
<related-links>
<linkpool type="task">
<link href="database_install.xml"/>
<link href="server_install.xml"/>
<link href="program_install.xml"/>
</linkpool>
</related-links>Beim <linkpool>-Element erfolgt die Sortierung der Links bei der Verarbeitung der XML DITA-Dateien durch das DITA Open Toolkit. Maßgeblich für die Sortierung sind die verwendeten Attribute in den Links, wie zum Beispiel das type-Attribut.
Mit dem <linklist>-Element können Sie ebenfalls die Links thematisch gruppieren, jedoch wird bei der Ausgabe die von Ihnen vorgegebene Sortierung verwendet. Mit dem collection-type-Attribut können Sie spezifizieren, in welcher Beziehung die Topics im <linklist>-Element stehen. Folgende Werte sind für das collection-type-Attribut möglich:
- unordered: Mit dem Wert unordered wird angezeigt, dass die Reihenfolge der Topics für das Verständnis nicht wichtig ist. Dies ist die Defaulteinstellung.
- sequence: Mit dem Wert sequence wird angezeigt, dass die Reihenfolge der in den Links angegeben Topics zum Verständnis wichtig ist.
- choice: Mit dem Wert choice wird angezeigt, dass einer der Topics ausgewählt werden soll.
- family: Mit dem Wert family wird angezeigt, dass die in den Links aufgelisteten Topics nicht nur mit dem aktuellen Topic zusammenhängen, sondern auch untereinander.
<related-links>
<linklist collection-type="familiy">
<link href="database_install.xml"/>
<link href="server_install.xml"/>
<link href="program_install.xml"/>
</linklist>
</related-links>Für das <linklist>-Element steht noch das <linkinfo>-Element zur Verfügung. Hier können Sie weitere Informationen zu einer Linkliste hinzufügen.
<related-links>
<linklist collection-type="familiy">
<link href="database_install.xml"/>
<link href="server_install.xml"/>
<link href="program_install.xml"/>
<linkinfo>Informationen zur Installation der Entwicklungsumgebung</linkinfo>
</linklist>
</related-links>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