@domainsattribute rules and syntax
@domains attribute enables processors to
determine whether two elements or two documents use compatible domains. The attribute is
declared on the root element for each topic or map type. Each structural, domain, and constraint
module defines its ancestry as a parenthesized sequence of space-separated module names; the
effective value of the
@domains attribute is composed of these parenthesized
Document type shells collect the values that are provided by each module to construct the
effective value of the
@domains attribute. Processors can examine the
collected values when content from one document is used in another, in order to determine
whether the content is compatible.
For example, when an author pastes content from one topic into another
topic within an XML editor, the application can use the
@domains attribute to
determine if the two topics use compatible domains. If not, copied content from the first
topic might need to be generalized before it can be placed in the other topic.
@domains attribute serves the same function when an
element uses the
@conref attribute to reference a more specialized version of
the element. For example, a
<note> element in a concept topic conrefs a
<hazardstatement> element in a reference document. If the hazard
statement domain is not available in the concept topic, the
<hazardstatement> element is generalized to a
<note> element when the content reference is resolved.
Each domain and constraint module MUST provide a value for use by the
@domains attribute. Each
structural vocabulary module SHOULD
provide a value for use by the
@domains attribute, and it MUST do so when it has a dependency on
elements from any module that is not part of its specialization ancestry.
Values provided for the
@domains attribute values are
specified from root module (map or topic) to the provided module.
@domainsattribute includes each module in the specialization ancestry:
'(', topic-or-map, (' ', module)+, ')'
For example, consider the
specialization, in which the topic type is specialized to the concept type, and the
concept type is specialized to glossentry. The structural module contribution to the
value of the
@domains attribute for the glossentry structural module
is (topic concept glossentry).
@domainsattribute MUST include the names of each dependent, non-ancestor module.
@domainsattribute following the name of the structural module with the dependency on the non-ancestor module. Domain or attribute modules are appended to the name of the structural module with the dependency on the non-ancestor module, or to previous dependencies, separated by "+". Dependencies on structural specialization modules are appended to the name of the structural module with the dependency on the non-ancestor module, or to previous dependencies, separated by "++". The syntax is the same as for other structural modules, except that added modules can include these dependencies:
'(', topic-or-map, (' ', module-plus-optional-dependency-list)+, ')'
When the structural module is included in a document-type shell, all dependency
modules also are included along with their own
(topic reference cppApiRef+cpp-d+compilerTypeAtt-d)
(topic reference codeChecklist+pr-d++task) (topic pr-d) (topic task)
'(', topic-or-map, (' ', domain-module)+, ')'
'(', inheritance-hierarchy qualifierTagname-c, ')'
For example, the strictTaskbody constraint applies to the task module, which is specialized from topic, resulting in the following value: (topic task strictTaskbody-c).
Optionally, a domains contribution can indicate a strong constraint by preceding the domains contribution with the letter "s". For example, s(topic task strictTaskbody-c) indicates a strong constraint.
'(', inheritance-hierachy qualifierdomainDomain-c ')'
For example, a domain constraint module that restricts the highlighting domain includes a value like the following: (topic hi-d basic-HighlightingDomain-c)
'a(', props-or-base, (' ', attname)+, ')'
For example, the
@props results in the following value: a(props
In this example, a document-type shell integrates the task structural module and the following domain modules:
|Domain||Domain short name|
The value of the
@domains attribute includes one value from each module;
the effective value is the following:
domains="(topic task) (topic ui-d) (topic sw-d) (topic pr-d)"
If the document-type shell also used a specialization of the programming domain that
describes C++ programming (with a short name of "cpp-d"), the new C++ programming domain
would add an additional value to the
domains="(topic task) (topic ui-d) (topic sw-d) (topic pr-d) (topic pr-d cpp-d)"
Note that the value for the
@domains attribute is not authored; Instead,
the value is defaulted based on the modules that are included in the document type
Return to main page.
Standards Track Work Product
|Copyright © OASIS Open 2016. All Rights Reserved.||30 August 2016|