Darwin Information Typing Architecture (DITA) Version 1.3 ...docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part3-all-inclusive.pdf · Darwin Information Typing Architecture (DITA)

Darwin Information Typing Architecture(DITA) Version 1.3 Part 3: All-InclusiveEdition ►Plus Errata 02◄OASIS Standard ►incorporating Approved Errata◄

19 June 2018Specification URIs

This version:

http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete.html (Authoritative)http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete.pdf

Previous version:

http://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/dita-v1.3-os-part3-all-inclusive.html (Authoritative)http://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/dita-v1.3-os-part3-all-inclusive.pdf

Latest version:

http://docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part3-all-inclusive.html (Authoritative)http://docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part3-all-inclusive.pdf

Technical Committee:

OASIS Darwin Information Typing Architecture (DITA) TC

Chair:

Kristen James Eberlein ([email protected]), Eberlein Consulting LLC

Editors:

Robert D. Anderson ([email protected]), IBMKristen James Eberlein ([email protected]), Eberlein Consulting LLC

Additional artifacts:

This prose specification is one component of a work product that also includes:

• Darwin Information Typing Architecture (DITA) Version 1.3 Errata 02. OASIS Approved Errata. http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/dita-v1.3-errata02-os.html

dita-v1.3-errata02-os-part3-all-inclusive-complete 19 June 2018Standards Track Work Product Copyright © OASIS Open 2018. All Rights Reserved. Page 1 of 1357

http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete.pdfhttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete.pdfhttp://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/dita-v1.3-os-part3-all-inclusive-complete.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/dita-v1.3-os-part3-all-inclusive.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/dita-v1.3-os-part3-all-inclusive-complete.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/dita-v1.3-os-part3-all-inclusive-complete.pdfhttp://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/dita-v1.3-os-part3-all-inclusive.pdfhttp://docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part3-all-inclusive.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part3-all-inclusive.pdfhttps://www.oasis-open.org/committees/dita/mailto:[email protected]://eberleinconsulting.com/mailto:[email protected]://www.ibm.commailto:[email protected]://eberleinconsulting.com/http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/dita-v1.3-errata02-os.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/dita-v1.3-errata02-os.html

• Darwin Information Typing Architecture (DITA) Version 1.3. Part 0: Overview Plus Errata 02. OASISStandard incorporating Approved Errata. http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part0-overview/dita-v1.3-errata02-os-part0-overview-complete.html.

• Darwin Information Typing Architecture (DITA) Version 1.3. Part 1: Base Edition Plus Errata 02. OASISStandard incorporating Approved Errata. http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part1-base/dita-v1.3-errata02-os-part1-base-complete.html. This edition contains topic andmap; it is designed for implementers and users who need only the most fundamental pieces of theDITA framework.

• Darwin Information Typing Architecture (DITA) Version 1.3. Part 2: Technical Content Edition PlusErrata 02. OASIS Standard incorporating Approved Errata. http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part2-tech-content/dita-v1.3-errata02-os-part2-tech-content-complete.html. Thisedition contains the base architecture plus the technical-content specializations; it is designed forauthors who use information typing and document complex applications and devices.

• Darwin Information Typing Architecture (DITA) Version 1.3. Part 3: All-Inclusive Edition Plus Errata 02(this document). OASIS Standard incorporating Approved Errata. http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete.html.This edition contains the base architecture, technical content, and the learning and trainingspecializations. It is designed for implementers who want all OASIS-approved specializations, as wellas users who develop learning and training materials.

• ZIP file that contains a CHM version of the written specification for this part. http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete-chm.zip

• ZIP file that contains an HTML version of the written specification for this part. http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete-html.zip

• ZIP file that contains the grammar files for this part. http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete-grammars.zip

• ZIP file that contains the DITA source for this part. http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete-dita.zip

For more information about the editions and what they contain, see Editions.

Related work:

This Errata supersedes Darwin Information Typing Architecture (DITA) Version 1.3, a multi-part OASISStandard that includes:

• Darwin Information Typing Architecture (DITA) Version 1.3 Part 0: Overview http://docs.oasis-open.org/dita/dita/v1.3/os/part0-overview/dita-v1.3-os-part0-overview.html

• Darwin Information Typing Architecture (DITA) Version 1.3 Part 1: Base Edition http://docs.oasis-open.org/dita/dita/v1.3/os/part1-base/dita-v1.3-os-part1-base.html

• Darwin Information Typing Architecture (DITA) Version 1.3 Part 2: Technical Content Edition http://docs.oasis-open.org/dita/dita/v1.3/os/part2-tech-content/dita-v1.3-os-part2-tech-content.html

• Darwin Information Typing Architecture (DITA) Version 1.3 Part 3: All-Inclusive Edition http://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/dita-v1.3-os-part3-all-inclusive.html


http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part0-overview/dita-v1.3-errata02-os-part0-overview-complete.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part0-overview/dita-v1.3-errata02-os-part0-overview-complete.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part1-base/dita-v1.3-errata02-os-part1-base-complete.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part1-base/dita-v1.3-errata02-os-part1-base-complete.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part2-tech-content/dita-v1.3-errata02-os-part2-tech-content-complete.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part2-tech-content/dita-v1.3-errata02-os-part2-tech-content-complete.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete-chm.ziphttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete-chm.ziphttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete-chm.ziphttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete-html.ziphttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete-html.ziphttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete-html.ziphttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete-grammars.ziphttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete-grammars.ziphttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete-grammars.ziphttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete-dita.ziphttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete-dita.ziphttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part0-overview/introduction/about-the-dita-specification.html#about-the-dita-specification__editionshttp://docs.oasis-open.org/dita/dita/v1.3/os/part0-overview/dita-v1.3-os-part0-overview.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/os/part0-overview/dita-v1.3-os-part0-overview.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/os/part1-base/dita-v1.3-os-part1-base.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/os/part1-base/dita-v1.3-os-part1-base.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/os/part2-tech-content/dita-v1.3-os-part2-tech-content.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/os/part2-tech-content/dita-v1.3-os-part2-tech-content.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/dita-v1.3-os-part3-all-inclusive.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/dita-v1.3-os-part3-all-inclusive.html

Abstract:

This document incorporates Errata for Darwin Information Typing Architecture (DITA) Version 1.3: Part 3All-Inclusive Edition.

Status:

This document was last revised or approved by the OASIS Darwin Information Typing Architecture(DITA) TC on the above date. The level of approval is also listed above. Check the “Latest version”location noted above for possible later revisions of this document. Any other numbered Versions andother technical work produced by the Technical Committee (TC) are listed at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita#technical.

TC members should send comments on this specification to the TC’s email list. Others should sendcomments to the TC’s public comment list, after subscribing to it by following the instructions at the“Send A Comment” button on the TC’s web page at https://www.oasis-open.org/committees/comments/index.php?wg_abbrev=dita.

For information on whether any patents have been disclosed that may be essential to implementing thisspecification, and any offers of patent licensing terms, please refer to the Intellectual Property Rightssection of the TC’s web page (https://www.oasis-open.org/committees/dita/ipr.php).

Citation format:

When referencing this specification the following citation format should be used:

[DITA-v1.3-part3-errata02]Darwin Information Typing Architecture (DITA) Version 1.3 Part 3: All-Inclusive Edition Plus Errata 02.Edited by Robert D. Anderson and Kristen James Eberlein. 19 June 2018. OASIS StandardIncorporating OASIS Approved Errata of Errata 02. http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete.html. Latestversion: http://docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part3-all-inclusive.html.

NoticesCopyright © OASIS Open 2018. All Rights Reserved.

All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual PropertyRights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.

This document and translations of it may be copied and furnished to others, and derivative works that commenton or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, inwhole or in part, without restriction of any kind, provided that the above copyright notice and this section areincluded on all such copies and derivative works. However, this document itself may not be modified in any way,including by removing the copyright notice or references to OASIS, except as needed for the purpose ofdeveloping any document or deliverable produced by an OASIS Technical Committee (in which case the rulesapplicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it intolanguages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors orassigns.

This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMSALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THATTHE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANYIMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.


https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita#technicalhttps://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita#technicalhttps://www.oasis-open.org/committees/comments/index.php?wg_abbrev=ditahttps://www.oasis-open.org/committees/comments/index.php?wg_abbrev=ditahttps://www.oasis-open.org/committees/dita/ipr.phphttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/dita-v1.3-errata02-os-part3-all-inclusive-complete.htmlhttp://docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part3-all-inclusive.htmlhttps://www.oasis-open.org/policies-guidelines/ipr

OASIS requests that any OASIS Party or any other party that believes it has patent claims that wouldnecessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notifyOASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patentclaims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced thisspecification.

OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of anypatent claims that would necessarily be infringed by implementations of this specification by a patent holder thatis not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASISTechnical Committee that produced this specification. OASIS may include such claims on its website, butdisclaims any obligation to do so.

OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might beclaimed to pertain to the implementation or use of the technology described in this document or the extent towhich any license under such rights might or might not be available; neither does it represent that it has madeany effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document ordeliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claimsof rights made available for publication and any assurances of licenses to be made available, or the result of anattempt made to obtain a general license or permission for the use of such proprietary rights by implementers orusers of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TCAdministrator. OASIS makes no representation that any information or list of intellectual property rights will atany time be complete, or that any claims in such list are, in fact, Essential Claims.

The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be usedonly to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation anduse of, specifications, while reserving the right to enforce its marks against misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark for above guidance.

https://www.oasis-open.org/https://www.oasis-open.org/policies-guidelines/trademarkhttps://www.oasis-open.org/policies-guidelines/trademark

Table of contents1 Introduction to DITA 1.3...................................................................................................................................... 25

1.1 About the DITA specification: All-inclusive edition......................................................................................251.2 Terminology................................................................................................................................................ 261.3 Normative references................................................................................................................................. 271.4 Non-normative references.......................................................................................................................... 271.5 Formatting conventions in the XHTML version of the specification............................................................291.6 Formatting conventions in the Errata ►02◄ version of the specification.................................................. 31

2 Architectural specification: All-inclusive edition ..................................................................................................322.1 Introduction to DITA....................................................................................................................................32

2.1.1 DITA terminology and notation...........................................................................................................322.1.2 Basic concepts................................................................................................................................... 362.1.3 File extensions................................................................................................................................... 372.1.4 Producing different deliverables from a single source........................................................................37

2.2 DITA markup ..............................................................................................................................................382.2.1 DITA topics.........................................................................................................................................38

2.2.1.1 The topic as the basic unit of information.................................................................................. 382.2.1.2 The benefits of a topic-based architecture.................................................................................392.2.1.3 Disciplined, topic-oriented writing.............................................................................................. 402.2.1.4 Information typing...................................................................................................................... 402.2.1.5 Generic topics............................................................................................................................412.2.1.6 Topic structure........................................................................................................................... 412.2.1.7 Topic content..............................................................................................................................42

2.2.2 DITA maps..........................................................................................................................................432.2.2.1 Definition of DITA maps............................................................................................................. 432.2.2.2 Purpose of DITA maps ..............................................................................................................442.2.2.3 DITA map elements................................................................................................................... 442.2.2.4 DITA map attributes .................................................................................................................. 462.2.2.5 Examples of DITA maps............................................................................................................ 49

2.2.2.5.1 Example: DITA map that references a subordinate map...................................................492.2.2.5.2 Example: DITA map with a simple relationship table.........................................................502.2.2.5.3 Example: How the @collection-type and @linking attributes determine links...................512.2.2.5.4 Example: How the @cascade attribute functions..............................................................52

2.2.3 Subject scheme maps and their usage.............................................................................................. 522.2.3.1 Subject scheme maps............................................................................................................... 532.2.3.2 Defining controlled values for attributes.....................................................................................532.2.3.3 Binding controlled values to an attribute....................................................................................542.2.3.4 Processing controlled attribute values....................................................................................... 552.2.3.5 Extending subject schemes....................................................................................................... 562.2.3.6 Scaling a list of controlled values to define a taxonomy............................................................ 562.2.3.7 Classification maps....................................................................................................................572.2.3.8 Examples of subject scheme maps........................................................................................... 57

2.2.3.8.1 Example: How hierarchies defined in a subject scheme map affect filtering.....................572.2.3.8.2 Example: Extending a subject scheme............................................................................. 592.2.3.8.3 Example: Extending a subject scheme upwards...............................................................602.2.3.8.4 Example: Defining values for @deliveryTarget .................................................................61

2.2.4 DITA metadata................................................................................................................................... 632.2.4.1 Metadata elements.................................................................................................................... 632.2.4.2 Metadata attributes.................................................................................................................... 63


2.2.4.2.1 Conditional processing attributes...................................................................................... 632.2.4.2.2 Translation and localization attributes............................................................................... 652.2.4.2.3 Architectural attributes.......................................................................................................65

2.2.4.3 Metadata in maps and topics.....................................................................................................662.2.4.4 Cascading of metadata attributes in a DITA map ..................................................................... 672.2.4.5 Reconciling topic and map metadata elements ........................................................................ 692.2.4.6 Map-to-map cascading behaviors..............................................................................................72

2.2.4.6.1 Cascading of attributes from map to map......................................................................... 722.2.4.6.2 Cascading of metadata elements from map to map..........................................................732.2.4.6.3 Cascading of roles from map to map................................................................................ 74

2.2.4.7 Context hooks and window metadata for user assistance.........................................................752.3 DITA addressing......................................................................................................................................... 76

2.3.1 ID attribute..........................................................................................................................................762.3.2 DITA linking........................................................................................................................................ 772.3.3 URI-based (direct) addressing........................................................................................................... 782.3.4 Indirect key-based addressing........................................................................................................... 80

2.3.4.1 Core concepts for working with keys......................................................................................... 802.3.4.2 Key scopes................................................................................................................................ 822.3.4.3 Using keys for addressing ........................................................................................................ 832.3.4.4 Addressing keys across scopes................................................................................................ 842.3.4.5 Cross-deliverable addressing and linking ................................................................................. 862.3.4.6 Processing key references........................................................................................................ 872.3.4.7 Processing key references for navigation links and images ..................................................... 882.3.4.8 Processing key references on elements...................................................................882.3.4.9 Processing key references to generate text or link text............................................................. 892.3.4.10 Examples of keys.....................................................................................................................91

2.3.4.10.1 Examples: Key definition................................................................................................. 912.3.4.10.2 Examples: Key definitions for variable text......................................................................912.3.4.10.3 Example: Scoped key definitions for variable text...........................................................922.3.4.10.4 Example: Duplicate key definitions within a single map.................................................. 932.3.4.10.5 Example: Duplicate key definitions across multiple maps...............................................942.3.4.10.6 Example: Key definition with key reference.....................................................................952.3.4.10.7 Example: References to scoped keys ............................................................................ 952.3.4.10.8 Example: Key definitions in nested key scopes.............................................................. 962.3.4.10.9 Example: Link redirection................................................................................................ 982.3.4.10.10 Example: Link modification or removal..........................................................................992.3.4.10.11 Example: Links from or elements................................................. 1002.3.4.10.12 Example: conref redirection.........................................................................................1002.3.4.10.13 Example: Key scopes and omnibus publications........................................................ 1012.3.4.10.14 Example: How key scopes affect key precedence...................................................... 1022.3.4.10.15 Example: Keys and collaboration................................................................................ 104

2.4 DITA processing....................................................................................................................................... 1042.4.1 Navigation........................................................................................................................................ 105

2.4.1.1 Table of contents......................................................................................................................1052.4.1.2 Indexes.................................................................................................................................... 105

2.4.2 Content reference (conref)............................................................................................................... 1052.4.2.1 Conref overview ......................................................................................................................1062.4.2.2 Processing conrefs ................................................................................................................. 1072.4.2.3 Processing attributes when resolving conrefs ........................................................................ 1072.4.2.4 Processing xrefs and conrefs within a conref.......................................................................... 108


2.4.3 Conditional processing (profiling)..................................................................................................... 1102.4.3.1 Conditional processing values and groups...............................................................................1112.4.3.2 Filtering.................................................................................................................................... 1122.4.3.3 Flagging................................................................................................................................... 1142.4.3.4 Conditional processing to generate multiple deliverable types................................................ 1142.4.3.5 Examples of conditional processing.........................................................................................116

2.4.3.5.1 Example: Setting conditional processing values and groups...........................................1162.4.3.5.2 Example: Filtering and flagging topic content..................................................................116

2.4.4 Branch filtering..................................................................................................................................1172.4.4.1 Overview of branch filtering......................................................................................................1172.4.4.2 Branch filtering: Single condition set for a branch....................................................................1182.4.4.3 Branch filtering: Multiple condition sets for a branch................................................................1182.4.4.4 Branch filtering: Impact on resource and key names...............................................................1192.4.4.5 Branch filtering: Implications of processing order.................................................................... 1212.4.4.6 Examples of branch filtering.................................................................................................... 122

2.4.4.6.1 Example: Single on a branch.......................................................................1222.4.4.6.2 Example: Multiple elements on a branch.....................................................1232.4.4.6.3 Example: Single as a child of ......................................................... 1252.4.4.6.4 Example: Single in a reference to a map.....................................................1252.4.4.6.5 Example: Multiple elements as children of in a root map................ 1262.4.4.6.6 Example: Multiple elements in a reference to a map...................................1272.4.4.6.7 Example: within a branch that already uses ........................... 1282.4.4.6.8 Example: error conditions............................................................................129

2.4.5 Chunking.......................................................................................................................................... 1302.4.5.1 Using the @chunk attribute..................................................................................................... 1312.4.5.2 Chunking examples................................................................................................................. 133

2.4.6 Translation and localization..............................................................................................................1352.4.6.1 The @xml:lang attribute...........................................................................................................1362.4.6.2 The @dir attribute.................................................................................................................... 137

2.4.7 Processing documents with different values of the @domains attribute .........................................1392.4.8 Sorting..............................................................................................................................................140

2.5 Configuration, specialization, generalization, and constraints .................................................................1412.5.1 Overview of DITA extension facilities............................................................................................... 1412.5.2 Configuration....................................................................................................................................141

2.5.2.1 Overview of document-type shells...........................................................................................1412.5.2.2 Rules for document-type shells............................................................................................... 1422.5.2.3 Equivalence of document-type shells...................................................................................... 1432.5.2.4 Conformance of document-type shells.................................................................................... 143

2.5.3 Specialization................................................................................................................................... 1432.5.3.1 Overview of specialization....................................................................................................... 1442.5.3.2 Modularization......................................................................................................................... 1452.5.3.3 Vocabulary modules................................................................................................................ 1452.5.3.4 Specialization rules for element types..................................................................................... 1462.5.3.5 Specialization rules for attributes.............................................................................................1462.5.3.6 @class attribute rules and syntax............................................................................................1462.5.3.7 @domains attribute rules and syntax...................................................................................... 1482.5.3.8 Specializing to include non-DITA content................................................................................ 1512.5.3.9 Sharing elements across specializations.................................................................................152

2.5.4 Generalization.................................................................................................................................. 1532.5.4.1 Overview of generalization...................................................................................................... 153


2.5.4.2 Element generalization............................................................................................................ 1532.5.4.3 Processor expectations when generalizing elements..............................................................1542.5.4.4 Attribute generalization............................................................................................................ 1562.5.4.5 Generalization with cross-specialization dependencies.......................................................... 156

2.5.5 Constraints....................................................................................................................................... 1572.5.5.1 Overview of constraints........................................................................................................... 1572.5.5.2 Constraint rules........................................................................................................................1572.5.5.3 Constraints, processing, and interoperability...........................................................................1582.5.5.4 Weak and strong constraints................................................................................................... 1592.5.5.5 Conref compatibility with constraints....................................................................................... 1592.5.5.6 Examples: Constraints.............................................................................................................162

2.5.5.6.1 Example: Redefine the content model for the element.......................................1622.5.5.6.2 Example: Constrain attributes for the element................................................1632.5.5.6.3 Example: Constrain a domain module............................................................................ 1642.5.5.6.4 Example: Replace a base element with the domain extensions..................................... 1652.5.5.6.5 Example: Apply multiple constraints to a single document-type shell............................. 1662.5.5.6.6 Example: Correct the constraint for the machinery task..................................................167

2.6 Coding practices for DITA grammar files..................................................................................................1672.6.1 Recognized XML-document grammar mechanisms........................................................................ 1672.6.2 Normative versions of DITA grammar files.......................................................................................1682.6.3 DTD coding requirements................................................................................................................ 168

2.6.3.1 DTD: Overview of coding requirements...................................................................................1682.6.3.2 DTD: Coding requirements for document-type shells..............................................................1692.6.3.3 DTD: Coding requirements for element type declarations.......................................................1732.6.3.4 DTD: Coding requirements for structural modules.................................................................. 1752.6.3.5 DTD: Coding requirements for element domain modules........................................................1762.6.3.6 DTD: Coding requirements for attribute domain modules....................................................... 1772.6.3.7 DTD: Coding requirements for constraint modules..................................................................177

2.6.4 RELAX NG coding requirements..................................................................................................... 1792.6.4.1 RELAX NG: Overview of coding requirements........................................................................ 1792.6.4.2 RELAX NG: Coding requirements for document-type shells................................................... 1802.6.4.3 RELAX NG: Coding requirements for element type declarations............................................ 1822.6.4.4 RELAX NG: Coding requirements for structural modules........................................................1852.6.4.5 RELAX NG: Coding requirements for element domain modules.............................................1862.6.4.6 RELAX NG: Coding requirements for attribute domain modules ............................................1872.6.4.7 RELAX NG: Coding requirements for constraint modules.......................................................188

2.6.5 XML Schema coding requirements.................................................................................................. 1902.6.5.1 XML Schema: Overview and limitations of coding requirements.............................................1902.6.5.2 XML Schema: Coding requirements for document-type shells................................................1902.6.5.3 XML Schema: Coding requirements for element type declarations.........................................1932.6.5.4 XML Schema: Coding requirements for structural modules.................................................... 1942.6.5.5 XML Schema: Coding requirements for attribute domain modules......................................... 1952.6.5.6 XML Schema: Coding requirements for constraint modules................................................... 196

2.7 Technical content specializations............................................................................................................. 1972.7.1 Technical content: Document types................................................................................................. 197

2.7.1.1 Concept topic...........................................................................................................................1972.7.1.2 Reference topic........................................................................................................................1982.7.1.3 General task topic....................................................................................................................2002.7.1.4 Task topic (strict task).............................................................................................................. 201Machinery Task topic........................................................................................................................... 203


2.7.1.6 Troubleshooting topic...............................................................................................................2042.7.1.7 Glossary entry topic................................................................................................................. 2062.7.1.8 Glossary group topic................................................................................................................2082.7.1.9 Bookmap..................................................................................................................................208

2.7.2 Technical content domains...............................................................................................................2092.7.2.1 The xNAL domain.................................................................................................................... 2092.7.2.2 xNAL usage guidelines............................................................................................................ 2092.7.2.3 MathML and equation domains............................................................................................... 2122.7.2.4 Release management domain.................................................................................................213

2.7.3 Troubleshooting information.............................................................................................................2142.8 Learning and training specializations....................................................................................................... 216

2.8.1 Overview.......................................................................................................................................... 2162.8.2 Objectives of the DITA learning and training specializations............................................................2172.8.3 A learning objects approach to learning and training content.......................................................... 2172.8.4 Use cases........................................................................................................................................ 2192.8.5 Summary of learning topic, map, and domain designs.................................................................... 2202.8.6 Support for learningDomain1 and learningDomain2........................................................................ 2232.8.7 Learning and training specialization usage ..................................................................................... 224

3 Language reference: All-inclusive edition......................................................................................................... 2253.1 Element quick reference...........................................................................................................................225

3.1.1 Base DITA elements, A to Z.............................................................................................................2253.1.2 Technical content elements, A to Z.................................................................................................. 2293.1.3 Learning and training elements, A to Z............................................................................................ 2353.1.4 All DITA elements, A to Z................................................................................................................. 239

3.2 Topic elements..........................................................................................................................................2523.2.1 Basic topic elements........................................................................................................................ 252

3.2.1.1 .................................................................................................................................... 2533.2.1.2 ...................................................................................................................................... 2533.2.1.3 ................................................................................................................................ 2543.2.1.4 ........................................................................................................................... 2543.2.1.5 ................................................................................................................................ 2553.2.1.6 ............................................................................................................................ 2563.2.1.7 ...............................................................................................................................2593.2.1.8 ....................................................................................................................................2613.2.1.9 ............................................................................................................................... 2613.2.1.10 ...................................................................................................................... 2623.2.1.11 .................................................................................................................................... 263

3.2.2 Body elements................................................................................................................................. 2643.2.2.1 ........................................................................................................................................2643.2.2.2 ...................................................................................................................................... 2643.2.2.3 ........................................................................................................................................2653.2.2.4 .................................................................................................................................... 2653.2.2.5 ....................................................................................................................................2663.2.2.6 ....................................................................................................................................... 2673.2.2.7 .........................................................................................................................................2683.2.2.8 .................................................................................................................................2693.2.2.9 .................................................................................................................................2703.2.2.10 .......................................................................................................................................2713.2.2.11 ...................................................................................................................2713.2.2.12 ...................................................................................................................................272


3.2.2.13 ............................................................................................................................ 2733.2.2.14 ......................................................................................................................................2733.2.2.15 .............................................................................................................................2743.2.2.16 .......................................................................................................................................2753.2.2.17 ................................................................................................................................2763.2.2.18 ............................................................................................................................ 2783.2.2.19 ........................................................................................................................................ 2793.2.2.20 .................................................................................................................................. 2803.2.2.21 ....................................................................................................................... 2803.2.2.22 ......................................................................................................................2813.2.2.23 .......................................................................................................................................2813.2.2.24 ...................................................................................................................................2823.2.2.25 ................................................................................................................................ 2833.2.2.26 .......................................................................................................................................2873.2.2.27

........................................................................................................................................2873.2.2.28 ............................................................................................................................... 2883.2.2.29 ......................................................................................................................................2893.2.2.30 .................................................................................................................................... 2903.2.2.31 ........................................................................................................................................2903.2.2.32 .............................................................................................................................. 2913.2.2.33 ..........................................................................................................................2923.2.2.34 ....................................................................................................................................... 2923.2.2.35 ...................................................................................................................................... 2933.2.2.36 .................................................................................................................................. 2933.2.2.37 ....................................................................................................................................2943.2.2.38 ......................................................................................................................................2943.2.2.39 .......................................................................................................................................2953.2.2.40 ....................................................................................................................................296

3.2.3 Table elements................................................................................................................................. 2983.2.3.1 ....................................................................................................................................2983.2.3.2 ................................................................................................................................. 3033.2.3.3 ............................................................................................................................... 3033.2.3.4 ...................................................................................................................................3043.2.3.5 ...................................................................................................................................3043.2.3.6 ......................................................................................................................................3043.2.3.7 ....................................................................................................................................3053.2.3.8 ......................................................................................................................... 3063.2.3.9 .................................................................................................................................3083.2.3.10 ................................................................................................................................. 3083.2.3.11 ............................................................................................................................... 308

3.2.4 Related links elements..................................................................................................................... 3093.2.4.1 ...................................................................................................................................... 3093.2.4.2 ..................................................................................................................................3103.2.4.3 ................................................................................................................................3113.2.4.4 ................................................................................................................................ 3133.2.4.5 ................................................................................................................................ 313

3.3 Map elements........................................................................................................................................... 3143.3.1 Basic map elements.........................................................................................................................314

3.3.1.1 .....................................................................................................................................3143.3.1.2 ................................................................................................................................315


3.3.1.3 ............................................................................................................................ 3163.3.1.4 .................................................................................................................................3173.3.1.5 ..................................................................................................................................3183.3.1.6 ................................................................................................................................3193.3.1.7 ..................................................................................................................................3213.3.1.8 .................................................................................................................................. 3213.3.1.9 ............................................................................................................................ 3223.3.1.10 ......................................................................................................................... 3223.3.1.11 .........................................................................................................................324

3.3.2 Map group elements........................................................................................................................ 3263.3.2.1 ............................................................................................................................ 3263.3.2.2 ................................................................................................................................. 3283.3.2.3 ................................................................................................................................ 3293.3.2.4 ...........................................................................................................................3303.3.2.5 ............................................................................................................................ 3313.3.2.6 ............................................................................................................................... 3323.3.2.7 ........................................................................................................................... 333

3.4 Metadata elements................................................................................................................................... 3343.4.1 Prolog (metadata) elements.............................................................................................................334

3.4.1.1 ..................................................................................................................................3343.4.1.2 ............................................................................................................................. 3353.4.1.3 ................................................................................................................................. 3363.4.1.4 .................................................................................................................................. 3373.4.1.5 ..............................................................................................................................3373.4.1.6 ..........................................................................................................................3383.4.1.7 ............................................................................................................................. 3393.4.1.8 .........................................................................................................................3393.4.1.9 ............................................................................................................................3403.4.1.10 ..............................................................................................................................3403.4.1.11 ............................................................................................................................ 3413.4.1.12 .............................................................................................................................3413.4.1.13 .......................................................................................................................... 3423.4.1.14 ...........................................................................................................................3433.4.1.15 ......................................................................................................................... 3433.4.1.16 ...................................................................................................................... 3443.4.1.17 .............................................................................................................................3453.4.1.18 .............................................................................................................................3453.4.1.19 ......................................................................................................................... 3463.4.1.20 ........................................................................................................................... 3463.4.1.21 ........................................................................................................................... 3473.4.1.22 .........................................................................................................................3473.4.1.23 .............................................................................................................................. 3493.4.1.24 ................................................................................................................................ 3503.4.1.25 ...............................................................................................................................3503.4.1.26 ............................................................................................................................... 3513.4.1.27 ....................................................................................................................................351

3.4.2 Indexing group elements..................................................................................................................3523.4.2.1 ............................................................................................................................3523.4.2.2 ........................................................................................................................3573.4.2.3 ............................................................................................................................ 357


3.4.2.4 .................................................................................................................... 3583.4.2.5 .......................................................................................................................359

3.4.3 Delayed conref resolution elements.................................................................................................3613.4.3.1 .....................................................................................................................3613.4.3.2 ..............................................................................................................................3643.4.3.3 ........................................................................................................................... 368

3.5 Domain elements......................................................................................................................................3703.5.1 Hazard statement elements............................................................................................................. 370

3.5.1.1 .................................................................................................................3703.5.1.2 ...................................................................................................................... 3713.5.1.3 ..................................................................................................................... 3723.5.1.4 ......................................................................................................................... 3743.5.1.5 .................................................................................................................... 3743.5.1.6 .......................................................................................................................375

3.5.2 Highlighting elements.......................................................................................................................3753.5.2.1 ..........................................................................................................................................3753.5.2.2 ...........................................................................................................................................3763.5.2.3 ......................................................................................................................................3763.5.2.4 ......................................................................................................................................3773.5.2.5 ..........................................................................................................................................3773.5.2.6 ..........................................................................................................................................3783.5.2.7 .........................................................................................................................3783.5.2.8 ............................................................................................................................... 379

3.5.3 Utilities elements.............................................................................................................................. 3793.5.3.1 .................................................................................................................................... 3793.5.3.2 .................................................................................................................................3803.5.3.3 ...........................................................................................................................3813.5.3.4 ..................................................................................................................................3823.5.3.5 .................................................................................................................................383

3.5.4 DITAVAL reference domain.............................................................................................................. 3853.5.4.1 ............................................................................................................................. 3853.5.4.2 ......................................................................................................................... 3873.5.4.3 .............................................................................................................. 3883.5.4.4 .............................................................................................................. 3893.5.4.5 ..............................................................................................................3903.5.4.6 ..............................................................................................................390

3.6 Classification elements.............................................................................................................................3913.6.1 Subject scheme elements ............................................................................................................... 391

3.6.1.1 ................................................................................................................... 3913.6.1.2 ...........................................................................................................................3933.6.1.3 ........................................................................................................................ 3933.6.1.4 ...............................................................................................................................3943.6.1.5 ....................................................................................................................... 3953.6.1.6 ............................................................................................................................... 3963.6.1.7 ......................................................................................................................... 3963.6.1.8 ...................................................................................................................3973.6.1.9 ..........................................................................................................................3983.6.1.10 ........................................................................................................................3993.6.1.11 ................................................................................................................... 4013.6.1.12 ......................................................................................................................401


3.6.1.13 ..............................................................................................................4033.6.1.14 ......................................................................................................................... 4033.6.1.15 .................................................................................................................4043.6.1.16 ................................................................................................................ 4053.6.1.17 ............................................................................................................. 4073.6.1.18 .........................................................................................................................4073.6.1.19 .......................................................................................................................408

3.6.2 Classification domain elements........................................................................................................4093.6.2.1 ............................................................................................................................ 4093.6.2.2 ........................................................................................................................... 4103.6.2.3 .........................................................................................................................4113.6.2.4 ............................................................................................................... 4123.6.2.5 ............................................................................................................ 4143.6.2.6 .................................................................................................................4153.6.2.7 ..............................................................................................................................4153.6.2.8 .......................................................................................................................... 415

3.7 Specialization elements............................................................................................................................4163.7.1 ....................................................................................................................................... 4163.7.2 ............................................................................................................................................. 4163.7.3 ...................................................................................................................................4193.7.4 ......................................................................................................................................... 4203.7.5 .................................................................................................................................. 4213.7.6 .................................................................................................................................... 4223.7.7 .......................................................................................................................... 4223.7.8 ............................................................................................................................................ 4233.7.9 ......................................................................................................................................423

3.8 Legacy conversion elements.................................................................................................................... 4243.8.1 ......................................................................................................................... 424

3.9 DITAVAL elements....................................................................................................................................4253.9.1 ............................................................................................................................................... 4253.9.2 ................................................................................................................................ 4283.9.3 .............................................................................................................................................4293.9.4 ........................................................................................................................................4303.9.5 ....................................................................................................................................... 4323.9.6 ........................................................................................................................................ 4323.9.7 ......................................................................................................................................... 433

3.10 Technical content elements.................................................................................................................... 4333.10.1 Concept elements.......................................................................................................................... 434

3.10.1.1 ............................................................................................................................. 4343.10.1.2 ............................................................................................................................ 4343.10.1.3 ....................................................................................................................... 435

3.10.2 Task elements................................................................................................................................ 4363.10.2.1 ................................................................................................................................... 4363.10.2.2 ........................................................................................................................... 4373.10.2.3 ............................................................................................................................... 4373.10.2.4 .............................................................................................................................. 4383.10.2.5 ................................................................................................................................. 4383.10.2.6 ................................................................................................................... 4393.10.2.7 ............................................................................................................... 4403.10.2.8 ...................................................................................................................................440


3.10.2.9 ....................................................................................................................... 4413.10.2.10 .................................................................................................................................4423.10.2.11 .................................................................................................................................. 4423.10.2.12 ......................................................................................................................... 4433.10.2.13 ........................................................................................................................... 4433.10.2.14 .......................................................................................................................... 4443.10.2.15 ..................................................................................................................... 4443.10.2.16 ............................................................................................................................4453.10.2.17 ...................................................................................................................... 4453.10.2.18 ........................................................................................................................ 4463.10.2.19 .............................................................................................................................. 4473.10.2.20 .......................................................................................................................... 4473.10.2.21 ............................................................................................................................ 4483.10.2.22 ........................................................................................................................... 4483.10.2.23 ............................................................................................................................. 4493.10.2.24 ........................................................................................................ 4493.10.2.25 ........................................................................................................................ 4503.10.2.26 ....................................................................................................................... 4513.10.2.27 ........................................................................................................ 4523.10.2.28 ...............................................................................................................................4523.10.2.29 ............................................................................................................................453

3.10.3 Reference elements....................................................................................................................... 4533.10.3.1 .......................................................................................................................... 4533.10.3.2 ..............................................................................................................................4553.10.3.3 ......................................................................................................................... 4553.10.3.4 ................................................................................................................................4563.10.3.5 ..........................................................................................................................4573.10.3.6 .......................................................................................................................... 4573.10.3.7 ........................................................................................................................4583.10.3.8 ......................................................................................................................4583.10.3.9 .......................................................................................................................4593.10.3.10 .......................................................................................................................... 4593.10.3.11 ..........................................................................................................................4593.10.3.12 ........................................................................................................................4603.10.3.13 .........................................................................................................................460

3.10.4 Troubleshooting elements..............................................................................................................4613.10.4.1 ................................................................................................................. 4613.10.4.2 .......................................................................................................................4623.10.4.3 ........................................................................................................................... 4623.10.4.4 ..................................................................................................................4633.10.4.5 ................................................................................................................................ 4633.10.4.6 ..............................................................................................................................4643.10.4.7 ...............................................................................................................464

3.10.5 Glossary elements......................................................................................................................... 4653.10.5.1 Glossentry elements.............................................................................................................. 465

3.10.5.1.1 .................................................................................................................4653.10.5.1.2 ..................................................................................................................4663.10.5.1.3 ....................................................................................................................4663.10.5.1.4 .....................................................................................................4673.10.5.1.5 ...........................................................................................................467


3.10.5.1.6 .....................................................................................................................4683.10.5.1.7 ..................................................................................................... 4683.10.5.1.8 .................................................................................................................4693.10.5.1.9 .................................................................................................. 4693.10.5.1.10 ......................................................................................................... 4703.10.5.1.11 ..................................................................................................... 4703.10.5.1.12 ......................................................................................................4713.10.5.1.13 .............................................................................................................4723.10.5.1.14 .................................................................................................. 4723.10.5.1.15 ...........................................................................................................4733.10.5.1.16 ........................................................................................................4743.10.5.1.17 ............................................................................................................ 475

3.10.5.2 Glossary related elements..................................................................................................... 4763.10.5.2.1 ...........................................................

Documents

Darwin Information Typing Architecture (DITA) Version 1.3 ...docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part3-all-inclusive.pdf · Darwin Information Typing Architecture (DITA)