Reused text from attribute
descriptionsCommon dlentry for
-dita-use-conref-target:
- -dita-use-conref-target
- See for more information.
Common phrase for filter/flatting attributes: This is a property attribute which
supports conditional processing for filtering or
flagging.
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.
The attribute takes a
space-delimited set of values, with optional groups of space
delimited properties.
If
the value is not specified locally, the value might cascade from
another element in the map (for cascade rules, see ).
This attribute is defined
with the XML Data Type ID.
This attribute is defined with the XML Data Type
CDATA.
This attribute is
defined with the XML Data Type NMTOKEN.
This attribute is defined with the XML
Data Type NMTOKENS.
Note that this differs from the type
attribute on many other DITA elements.
References to content other than DITA
topics should use the format attribute to
identify the kind of resource being
referenced.
Required attribute token: (REQUIRED)
Deprecated
attribute token: (DEPRECATED)
The
value of this attribute is a real number (expressed in
decimal notation) optionally followed by a unit of measure
from the set of pc, pt, px, in, cm, mm, em (picas, points,
pixels, inches, centimeters, millimeters, and ems
respectively). The default unit is px (pixels). Possible
values include: "5", "5in", and "10.5cm".
If both a height value and width
value are specified, implementations MAY ignore one of the
two values when they are unable to scale to each direction
using different factors.
Although
locktitle is available as part of
, it has no defined purpose for this element.
The following attributes
are available on this element: ,
, ,
keyref, and .
The following
attributes are available on this element: ,
, ,
and .
The following attributes are available
on this element: .
The following attributes are
available on this element: and
.
The following attributes
are available on this element: ,
, and .
The following attributes
are available on this element: ,
, and keyref.
The following attributes are
available on this element: ,
, and .
The following
attributes are available on this element: ,
, and .
The following
attributes are available on this element: ,
, , and .
The following attributes are available on this element: (with a narrowed definition of id, given
below), , and .
- id
- An anchor point. This ID is usually required as
part of the href or
conref syntax when cross
referencing or reusing content within the topic;
it also enables topicref
elements in DITA maps to optionally reference a
specific topic within a DITA document.
The following attributes are available on
this element:
(without the Metadata attribute group), base from
the ,
and .
The following attributes are available on this element: , , , and the attributes defined below.
- type
- Defines the type of a note. For example, if the
note is a tip, the word Tip
might be used to
draw the reader's attention to it. See
for detailed information on supported values
and processing implications. Available values are
note, tip, fastpath, restriction, important,
remember, attention, caution, notice, danger,
warning, trouble, other, and -dita-use-conref-target.
- othertype
- Indicates an alternate note type, when the type
is not available in the type
attribute value list. This value is used as the
user-provided note title when the
type attribute value is set to
"other".
The following attributes are available
on this element: ,
,
, and .
The following attributes are available
on this element: ,
,
, , and .
The following attributes are
available on this element: ,
, , and keyref.
The following attributes are available on this element: , , and the attribute defined below.
- callout
- Specifies what character is used for the
footnote link, for example a number or an alpha
character. The attribute can also specify a short string of
characters. When no callout value
is specified, footnotes are typically
numbered.
- datatype
- Available for describing the type of data
contained in the value attribute for this metadata
element. The default value is the empty string
"".
The following attributes are available on this element: , (with a narrowed definition for type,
given below), and keyref.
- type
- Describes the target of a reference. See for detailed information on supported values
and processing implications.
Beginning with DITA 1.2, values in this attribute
are not limited to a small number of choices; the
following values were used in DITA 1.0 and DITA
1.1, and are also recognized for the
author element (and its
specializations):
- creator
- The primary or original author of the content.
- contributor
- An additional author who is not primary.
-
-
The following attributes are available on this element: , (with a narrowed definition of href,
given below), , , , keys, and keyref.
- href
- A pointer to the resource represented by the
topicref. See for detailed information on supported values
and processing implications. References to DITA
content cannot be below the topic level: that is,
you cannot reference individual elements inside a
topic. References to content other than DITA
topics should use the format
attribute to identify the kind of resource being
referenced.
The following attributes are available on this element: , (with a narrowed definition of href,
given below), , navtitle and copy-to
from , , and keyref.
- href
- References a manual listing for the current
element. See for detailed information on supported values
and processing implications. If no
href is specified, processors can choose to generate
an appropriate listing for this element. All of
the book listings operate in a similar manner; for
example, <toc
href="toc.dita"/> references a topic
which contains a manual table of contents, while
<toc/> indicates that a
processor should generate the table of contents.
The following attributes are available on this element: , (with a narrowed definition of href,
given below), , navtitle and copy-to
from , , and keyref.
The following attributes are available on this element: , , , keyref, and
query from . This element also uses scope,
format, and type
from .
Define the href value common to map references.
- format
- On this element the format
attribute sets a default value of "ditamap",
because the purpose of the element is to reference
a ditamap document. Otherwise, the attribute is
the same as described in .
Provide a reusable definition of toc when there
is a default of "no".
- toc
- Specifies whether a topic appears in the table
of contents (TOC). If the value is not specified
locally, but is specified on an ancestor, the
value will cascade from the closest ancestor. On
this element the default value for
toc is "no". See for a complete definition of
toc.
Provide a reusable definition of print attribute
values, and a reusable definition when there is a default of
"no".
- 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.
- print
- Specifies whether the topic should be included
in a print-specific rendition, such as PDF. On
this element the value defaults to "no". Allowable
values are:
Provide a reusable definition of processing-role
with a default of "resource-only"
- processing-role
- For this element, the default value for
processing-role is
"resource-only". Otherwise, the definition matches
the one found in .
The following attributes are available on this element: , (with a narrowed definition of href,
given below), processing-role from , navtitle from , , keys, and keyref.
The following attributes are available on this element: , (with a narrowed definition of href,
given below), , , , keys, and keyref.
The following attributes are available on this element: , (with narrowed definitions of href and
format, given below), (without the collection-type attribute),
, , keys, and keyref.
- format
- On this element, the format
attribute has a default value of "dita", because
it usually links to DITA learning topics. If
linking to something other than DITA, set the
format attribute as described in
.
The following attributes are available on this element: , (with narrowed definitions of href and
format, given below), (without the collection-type attribute,
and with a narrowed definition of chunk,
given below), , , keys, and keyref.
- format
- On this element, the format
attribute has a default value of "dita", because
it usually links to DITA learning topics. If
linking to something other than DITA, set the
format attribute as described in
.
- chunk
- On this element, the chunk
attribute has a default value of "to-content",
which causes the current branch of content to be
published as a single unit. See for more
information and for details on other supported
values.
The following attributes are available on this element: , (with narrowed definitions of href and
format, given below), , , , keys, and keyref.
The following attributes are available on this element: and the attribute defined below.
- lockmeta
-
By default, metadata in the map supplements or
overrides metadata that is specified at the topic
level, unless the lockmeta
attribute of the
topicmeta element is set
to "no". Allowable values are "yes", "no", and
.
The following attributes are available on this element: (with a narrowed definition of
translate, given below), , and keyref.
- translate
- Indicates whether the content of the element
should be translated or not. For this element the
default value is "no". Setting to "yes" will
override the default. The DITA architectural
specification contains a list of each OASIS DITA
element and its common processing default for the
translate value; because this element uses an
actual default, it will always be treated as
translate="no" unless overridden
as described. Available values are:
- no
- The content of this element is not
translateable.
- yes
- The content of this element is
translateable.
The following attributes are available on this element: (with a narrowed definition of id, given
below) and .
- id
- Defines an ID by which the element can be referenced.
- duplicates
- Specifies whether or not duplicate links will be
filtered out of a group of links. Allowable values
are:
- yes
- Allow duplicate links
- no
- Filter out duplicate links
Conceptually, two links are duplicates if
they address the same resource using the same
properties, such as link text and link role. The
details of determining duplicate links is
processor specific.
The suggested processing
default is "yes" within
linklist elements and
"no" for other links.
- collection-type
- See for a full definition and list of supported
values.
In the initial DTD implementation of
DITA, this attribute was defined with an
additional value of "tree"; that value was only
defined for collection-type on
the linkpool and
linklist elements. The
"tree" value is not allowed on
collection-type when used in
maps, and is not defined in the XSD or RELAX NG
versions of linkpool or
linklist. The extra value
in the DTD implementation is retained for
backwards compatibility, but is
deprecated.