The %topicref-atts-no-toc; parameter entity represents the set of attributes used in the reltable map element. The set is similar to those documented in topicref-atts but for <reltable> the toc attribute defaults to "no". For the other elements that use the %topicref-atts; group declaration, the toc attribute doesn't have a default; they can inherit their toc value from the nearest container, otherwise it functions upon output as if set to "yes".
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:
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 |
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 | no) | #IMPLIED | No |
format | The format attribute identifies the format of the resource being
cross referenced. The default format is "dita". Possible values include:
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 | sourceonly | normal | none) | #IMPLIED | No |
Specifies whether the topic should be included in a portable document
format (PDF) file.
|
(yes | no) | #IMPLIED | No | |
search | Currently not used.
|
(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 |
OASIS DITA Language Specification v1.0 -- 09 May 2005
Copyright (c) OASIS Open 2005. All Rights Reserved.