%univ-atts;Universal attributes is a parameter entity declaration in the topic
DTD, which defines a set of common attributes available on most DITA elements.
The univ-atts entity includes:
[edit] Attributes
This section describes the attributes
from select-atts, followed by those from id-atts, followed by those from localization-atts.
| Name
| Description
| Data Type
| Default Value
| Required?
|
| props
| Root attribute from which new metadata attributes can be specialized.
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 inherit from the closest ancestor. The attribute takes a space delimited set of
values. However, when acting as a container for generalized attributes, the
content model will be more complex; that model is documented in the "attribute
generalization" section of the DITA architectural specification.
| CDATA
| #IMPLIED
| No
|
| base
| A generic attribute that has no specific purpose, but is intended
to act as a base for specialized attributes that have a simple value syntax
like the conditional processing attributes (one or more alphanumeric values
separated by whitespace). The attribute takes a space delimited set of
values. However, when acting as a container for generalized attributes, the
content model will be more complex; that model is documented in the "attribute
generalization" section of the DITA architectural specification.
| CDATA
| #IMPLIED
| No
|
| platform
| Indicates operating system and hardware. 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 inherit from the closest ancestor. The attribute takes a space delimited set
of values.
| CDATA
| #IMPLIED
| No
|
| product
| Contains the name of the product to which the topic applies. 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 inherit from the closest ancestor. The attribute takes a space delimited set
of values.
| CDATA
| #IMPLIED
| No
|
| audience
| Indicates the intended audience for the element.
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 inherit from the closest ancestor. The attribute takes a space delimited set
of values.
| CDATA
| #IMPLIED
| No
|
| otherprops
| This attribute can be used for any other properties that might be
needed to describe an audience, or to provide selection criteria for the
element. 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 inherit from the closest ancestor. The attribute takes a space delimited set
of values.
| CDATA
| #IMPLIED
| No
|
| importance
| A range of values that describe an importance or priority attributed
to an element. For example, in steps of a task, the attribute indicates whether
a step is optional or required.
| deprecated | optional | default | low | normal | high
| required | urgent | -dita-use-conref-target
| #IMPLIED
| No
|
| rev
| Indicates revision level of an element. It is useful for flagging
outputs based on revision. 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.
| CDATA
| #IMPLIED
| No
|
| status
| The status of the current element.
| changed | deleted | unchanged | -dita-use-conref-target
| #IMPLIED
| No
|
| Name
| Description
| Data Type
| Default Value
| Required?
|
| id
| An anchor point. This ID is the target for references by href and
conref attributes, and for external applications that refer to DITA content.
| NMTOKEN
| #IMPLIED
| No
|
| conref
| This attribute is used to reference an ID on content that can be
reused. See The conref attribute for examples and
details about the syntax.
| CDATA
| #IMPLIED
| No
|
| Name
| Description
| Data Type
| Default Value
| Required?
|
| translate
| Indicates whether the content of the element should be translated
or not. The DITA architectural specification contains a list of each OASIS DITA
element and its common processing default for the translate value.
| no | -dita-use-conref-target
| #IMPLIED
| No
|
| xml:lang
| Specifies the language of the element content. When no xml:lang value
is supplied, the default value of English is assumed. For example, if there
is a note element with the attribute xml:lang set to the value "es,"
then the label on the note, which normally appears as "Note" will now
appear in Spanish as "Nota." The allowed xml:lang values are
based on
RFC 4646 Tags for Identifying Languages (see [[W3C:
Language tags in HTML and XML]]).
| NMTOKEN
| #IMPLIED
| No
|
| dir
| Specifies the directionality of text: left-to-right (ltr, the processing
default) or right-to-left (rtl). See the DITA Architectural Specification
for best practices related to this attribute, and other aspects of DITA and translation.
| rtl | lro | rlo | -dita-use-conref-target)
| #IMPLIED
| No
| See examples for the select-atts and id-atts parameter entries.
TOC: Language Specification 1.1
Parent topic: Commonly referenced attributes
Previous topic: %localization-atts; Next topic: %topicref-atts; and %topicref-atts-no-toc;
|
|
