%topicref-atts;

The %topicref-atts; parameter entity represents a group of attributes used in numerous map elements: map, topicref, relcolspec, relcell, topichead, and topicgroup. The set is similar to those documented in topicref-atts-no-toc but includes the toc attribute.

Attributes

Name Description Data Type Default Value Required?
collection-type Collection types describe how links relate to each other. A family represents a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other. (unordered | sequence | choice | family) "unordered" No
type Describes the target of a cross-reference and may generate cross-reference text based on that description. Only the <xref> element can link to content below the topic level: other types of linking can target whole topics, but not parts of topics. Typically <xref> should also be limited to topic-level targets, unless the output is primarily print-oriented. Web-based referencing works best at the level of whole topics, rather than anchor locations within topics.

When targetting DITA content, the type should match one of the values in the target's class attribute. For example, if type="topic", the link could be to a generic topic, or any specialization of topic, including concept, task, and reference.

Some possible values include:

fig
Indicates a link to a figure.
table
Indicates a link to a table.
li
Indicates a link to an ordered list item.
fn
Indicates a link to a footnote.
section
"section" indicates a link to a section.
concept, task, reference, topic
Cross-reference to a topic type.
(no value)
Defaults to generic topic, or the processor may retrieve the actual type from the target if available.

Other values can be used to indicate other types of topics or elements as targets. Processing is only required to support the above list, or specializations of types in that list. Supporting additional types as targets may require the creation of processing overrides.

CDATA #IMPLIED (Processed as if the target were of type "topic.") No
scope The scope attribute identifies the closeness of the relationship between the current document and the target resource.
  • Set scope to local when the resource is part of the current set of content, and should be accessed and copied to the output directory.
  • Set scope to peer when the resource is part of the current set of content but is not accessible at build time.
  • Set scope to external when the resource is not part of the current information set and should open in a new browser window.
The default is local.
(local | peer | external) #IMPLIED No
locktitle This attribute makes sure the navtitle attribute is used if it is present; if locktitle isn't set to "yes", the navtitle attribute is ignored and text is retrieved from the target
yes
The navtitle in the map is used.
no
Default. The navtitle or title of the topic is used.
(yes | no) #IMPLIED No
format The format attribute identifies the format of the resource being cross referenced. The default format is "dita".

Possible values include:

dita
The destination uses DITA topic markup, or markup specialized from a DITA topic. Unless otherwise specified, the corresponding default type will be treated as "topic."
html
The format of the linked-to resource is HTML or XHTML.
pdf
The format of the linked-to resource is PDF (opens a new window).
ditamap
The linked-to resource is a DITA map. It represents a referenced hierarchy at a position within referencing hierarchy, and a referenced relationship table included outside the referencing hierarchy
(no value)
Defaults to "dita"

For other formats, you can use the file extension without the "." (for example, in a link to file "readme.txt", use "txt" as the value)

CDATA #IMPLIED No
linking Defines some specific linking characteristics of a topic's current location in the map.
targetonly
A topic can only be linked to and cannot link to other topics.
sourceonly
A topic cannot be linked to but can link to other topics.
normal
A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none
A topic cannot be linked to or link to other topics.
(targetonly | sourceonly | normal | none) #IMPLIED No
toc Specifies whether a topic appears in the table of contents (toc). This value is set to no. No
print Specifies whether the topic should be included in a portable document format (PDF) file.
yes
Include the topic in a PDF file.
no
Do not include the topic in a PDF file.
(yes | no) #IMPLIED No
search Currently not used.
yes
no
(yes | no) #IMPLIED No
chunk Intended to allow re-chunking of content on output: for example, combining topics from separate files into one output file, or splitting multiple topics in one file into separate files. Currently the file names and chunking of input files determines the file names and chunking of output files, during output to HTML. The chunking attribute is not currently supported. CDATA #IMPLIED No