%topicref-atts; and %topicref-atts-no-toc;

The %topicref-atts; parameter entity represents a group of attributes used in numerous map elements, such as map, topicref, relcolspec, relcell, topichead, and topicgroup. The set is identical to those in the topicref-atts-no-toc attribute set, except that %topicref-atts; does not provide a default for the toc attribute.

Attributes

The table below represents the topicref-atts attribute set. For elements that use topicref-atts-no-toc, such as <reltable>, the toc attribute has a default of "no".

Name Description Data Type Default Value Required?
collection-type Collection types describe how links relate to each other. A family collection represents a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other. Sequence indicates that the order of the child topics is significant; output processors will typically link between them in order. Unordered indicates that the order is not significant. Choice indicates that one of the children should be selected. If no value is specified, processors should treat the default as "unordered", although no default is specified in the DTD. See this topic for more information on the conref value.

Usage of the collection-type attribute on <reltable> and <relcolspec> is currently undefined, and reserved for future use.

(unordered | sequence | choice | family | -dita-use-conref-target) #IMPLIED No
type Describes the target of a cross-reference. See The type attribute for detailed information on supported values and processing implications. CDATA #IMPLIED (Processed as if the target were of type "topic", or inherited from an ancestor) 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.
  • 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.
  • See Using the -dita-use-conref-target value for more information on -dita-use-conref-target.
The processing default is local. If no value is specified, but the attribute is specified on an ancestor within a map or within the related-links section, the value will inherit from the closest ancestor.
(local | peer | external | -dita-use-conref-target) #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.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
(yes | no | -dita-use-conref-target) #IMPLIED No
format The format attribute identifies the format of the resource being cross referenced. See The format attribute for details on supported values. CDATA #IMPLIED No
linking Defines some specific linking characteristics of a topic's current location in the map. If the value is not specified locally, but it specified on an ancestor, it will inherit the value of on the ancestor.
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.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
(targetonly | sourceonly | normal | none | -dita-use-conref-target) #IMPLIED No
toc Specifies whether a topic appears in the table of contents (toc). If the value is not specified locally, but it specified on an ancestor, it will inherit the value of on the ancestor. (yes | no | -dita-use-conref-target) #IMPLIED No
print Specifies whether the topic should be included in a portable document format (PDF) file. If the value is not specified locally, but it specified on an ancestor, it will inherit the value of on the ancestor.
yes
Include the topic in a PDF file.
no
Do not include the topic in a PDF file.
printonly
Directs processing to skip the parent topic for non-print outputs of map.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
(yes | no | printonly | -dita-use-conref-target) #IMPLIED No
search Describes whether the target is available for searching. If the value is not specified locally, but it specified on an ancestor, it will inherit the value of on the ancestor.
yes
no
-dita-use-conref-target
(yes | no | -dita-use-conref-target) #IMPLIED No
chunk When a set of topics is transformed using a map, the chunk attribute allows multi-topic documents to be broken into smaller files, and multiple individual topics to be combined into larger combined documents.

For a detailed description of the chunk attribute and its usage see the section on Chunking in Chapter 4 of the DITA 1.1 Architectural Specification.

CDATA #IMPLIED No