Topicref, or topic reference, is a reference from within a map to an external topic, DITA document or non-DITA document.
Topicrefs are characterized by the following:
-
Target location
Topicrefs can link to:-
External topics
-
DITA documents
-
Non-DITA documents
-
-
Attributes
The href attribute provides the location of the target.
The format attribute identifies the format of the target: dita, html, pdf or ditamap.
The scope attribute identifies the closeness of the relationship between the current document and the target: local, peer or external.
The type attribute identifies the type of the target, e.g. concept, task, topic.
The collection-type attribute describes how topicrefs relate to each other: choice, family, sequence, unordered.
-
Views of topicref
Topicrefs can be displayed two ways: either unresolved (as links) or as resolved content of referenced documents. For more information, see DITA Maps XSLT Parameter Sets.
Figure 1. Unresolved and resolved views of topicrefs in Serna.
-
Operations with topicref
You can do the following operations with topicrefs: