This attribute group collects several attributes that are used on a variety of map
elements. For a few elements, the group is modified slightly to remove an attribute such as
@toc or @format; in those cases the element definition will
clarify that the element does not use this full set. That is generally done in order to specify a
default for one attribute, such as defaulting @format to "ditamap" on the
<mapref> element.
@cascade- Controls how metadata attributes cascade within a map. There are two defined values that
should be supported: "merge" and "nomerge". If no value is set, and no value cascades from an
ancestor element, processors SHOULD assume a default of
"merge". See Cascading of metadata attributes in a DITA map for more
information about how this attribute interacts with metadata attributes.
@collection-type- Collection
types describe how links relate to each other. The processing default is "unordered", although
no default is specified in the DTD or Schema. Allowable values are:
- unordered
- Indicates that the order of the child topics is not significant.
- sequence
- Indicates that the order of the child topics is significant; output processors will
typically link between them in order.
- choice
- Indicates that one of the children should be selected.
- 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.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
Usage of the @collection-type attribute on
<reltable> and <relcolspec> is currently
undefined and reserved for future use.
@processing-role- Describes
the processing role of the referenced topic. The processing default is "normal". 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 cascade from the closest ancestor. Allowable values are:
- normal
- Normal topic that is a readable part of the information.
- resource-only
- The topic is used as a resource for processing purposes. This topic should not be
included in a rendered table of contents, and the topic should not be rendered on its own.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
@locktitle- If the
@locktitle attribute is set to "yes", the content of the
<navtitle> element or @navtitle attribute is used for
a navigation title, if it is present. If the @locktitle attribute is not
present or set to "no", the content of the <navtitle> element or
@navtitle attribute is ignored, and the title of the referenced topic is used
as a navigation title. Note: The @navtitle
attribute is deprecated in favor of the
<navtitle> element. When both a
<navtitle> element and a
@navtitle attribute are specified, the
<navtitle> element should be used.
Allowable
values for
@locktitle are:
- yes
- The content of the
<navtitle> element or
@navtitle attribute is used for a navigation title.
- no
- The content of the
<navtitle> element or
@navtitle attribute is ignored. This is the processing default.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
@linking- Defines
some specific linking characteristics of a topic's current location in the map. If
the value is not specified locally, the value might cascade from
another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). Allowable
values are:
- 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.
@toc- Specifies
whether a topic appears in the table of contents (TOC). If
the value is not specified locally, the value might cascade from
another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). Allowable
values are:
- yes
- The topic appears in a generated TOC.
- no
- The topic does not appear in a generated TOC.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
@print- Specifies
whether the topic should be included in a print-specific rendition, such as PDF. The
processing default is "yes". If
the value is not specified locally, the value might cascade from
another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map).
Note: Beginning with DITA 1.3, the
@print attribute is
deprecated. It is replaced with a conditional processing attribute:
@deliveryTarget. See
@deliveryTarget for more
details.
Allowable values are:
- yes
- Include the topic in the print-oriented file.
- no
- Do not include the topic in a print-oriented
file.
- printonly
- Only include the topic when rendering the DITA
content in a print-oriented context; the topic is not appropriate for other
contexts, such as when rendering as
HTML.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
@search- Describes
whether the target is available for searching. If
the value is not specified locally, the value might cascade from
another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). Allowable
values are:
- yes
-
- no
-
- -dita-use-conref-target
-
@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 Chunking.
@keyscope- Specifies that the element marks the boundaries of a key scope. See The keyscope attribute for details on how to use the
@keyscope
attribute.