Darwin Information Typing Architecture (DITA) Version 1.3 Part 3: All-Inclusive Edition
►Plus Errata
02
◄
Specification URIs
Notices
Introduction to DITA 1.3
About the DITA specification: All-inclusive edition
Terminology
Normative references
Non-normative references
Formatting conventions in the XHTML version of the specification
Formatting conventions in the Errata 02 version of the specification
Architectural specification: All-inclusive edition
Introduction to DITA
DITA terminology and notation
Basic concepts
File extensions
Producing different deliverables from a single source
DITA markup
DITA topics
The topic as the basic unit of information
The benefits of a topic-based architecture
Disciplined, topic-oriented writing
Information typing
Generic topics
Topic structure
Topic content
DITA maps
Definition of DITA maps
Purpose of DITA maps
DITA map elements
DITA map attributes
Examples of DITA maps
Example: DITA map that references a subordinate map
Example: DITA map with a simple relationship table
Example: How the collection-type and linking attributes determine links
Example: How the cascade attribute functions
Subject scheme maps and their usage
Subject scheme maps
Defining controlled values for attributes
Binding controlled values to an attribute
Processing controlled attribute values
Extending subject schemes
Scaling a list of controlled values to define a taxonomy
Classification maps
Examples of subject scheme maps
Example: How hierarchies defined in a subject scheme map affect filtering
Example: Extending a subject scheme
Example: Extending a subject scheme upwards
Example: Defining values for deliveryTarget
DITA metadata
Metadata elements
Metadata attributes
Conditional processing attributes
Translation and localization attributes
Architectural attributes
Metadata in maps and topics
Cascading of metadata attributes in a DITA map
Reconciling topic and map metadata elements
Map-to-map cascading behaviors
Cascading of attributes from map to map
Cascading of metadata elements from map to map
Cascading of roles from map to map
Context hooks and window metadata for user assistance
DITA addressing
ID attribute
DITA linking
URI-based (direct) addressing
Indirect key-based addressing
Core concepts for working with keys
Key scopes
Using keys for addressing
Addressing keys across scopes
Cross-deliverable addressing and linking
Processing key references
Processing key references for navigation links and images
Processing key references on topicref elements
Processing key references to generate text or link text
Examples of keys
Examples: Key definition
Examples: Key definitions for variable text
Example: Scoped key definitions for variable text
Example: Duplicate key definitions within a single map
Example: Duplicate key definitions across multiple maps
Example: Key definition with key reference
Example: References to scoped keys
Example: Key definitions in nested key scopes
Example: Link redirection
Example: Link modification or removal
Example: Links from term or keyword elements
Example: conref redirection
Example: Key scopes and omnibus publications
Example: How key scopes affect key precedence
Example: Keys and collaboration
DITA processing
Navigation
Table of contents
Indexes
Content reference (conref)
Conref overview
Processing conrefs
Processing attributes when resolving conrefs
Processing xrefs and conrefs within a conref
Conditional processing (profiling)
Conditional processing values and groups
Filtering
Flagging
Conditional processing to generate multiple deliverable types
Examples of conditional processing
Example: Setting conditional processing values and groups
Example: Filtering and flagging topic content
Branch filtering
Overview of branch filtering
Branch filtering: Single condition set for a branch
Branch filtering: Multiple condition sets for a branch
Branch filtering: Impact on resource and key names
Branch filtering: Implications of processing order
Examples of branch filtering
Example: Single ditavalref on a branch
Example: Multiple ditavalref elements on a branch
Example: Single ditavalref as a child of map
Example: Single ditavalref in a reference to a map
Example: Multiple ditavalref elements as children of map in a root map
Example: Multiple ditavalref elements in a reference to a map
Example: ditavalref within a branch that already uses ditavalref
Example: ditavalref error conditions
Chunking
Using the chunk attribute
Chunking examples
Translation and localization
The xml:lang attribute
The dir attribute
Processing documents with different values of the domains attribute
Sorting
Configuration, specialization, generalization, and constraints
Overview of DITA extension facilities
Configuration
Overview of document-type shells
Rules for document-type shells
Equivalence of document-type shells
Conformance of document-type shells
Specialization
Overview of specialization
Modularization
Vocabulary modules
Specialization rules for element types
Specialization rules for attributes
class attribute rules and syntax
domains attribute rules and syntax
Specializing to include non-DITA content
Sharing elements across specializations
Generalization
Overview of generalization
Element generalization
Processor expectations when generalizing elements
Attribute generalization
Generalization with cross-specialization dependencies
Constraints
Overview of constraints
Constraint rules
Constraints, processing, and interoperability
Weak and strong constraints
Conref compatibility with constraints
Examples: Constraints
Example: Redefine the content model for the topic element
Example: Constrain attributes for the section element
Example: Constrain a domain module
Example: Replace a base element with the domain extensions
Example: Apply multiple constraints to a single document-type shell
Example: Correct the constraint for the machinery task
Coding practices for DITA grammar files
Recognized XML-document grammar mechanisms
Normative versions of DITA grammar files
DTD coding requirements
DTD: Overview of coding requirements
DTD: Coding requirements for document-type shells
DTD: Coding requirements for element type declarations
DTD: Coding requirements for structural modules
DTD: Coding requirements for element domain modules
DTD: Coding requirements for attribute domain modules
DTD: Coding requirements for constraint modules
RELAX NG coding requirements
RELAX NG: Overview of coding requirements
RELAX NG: Coding requirements for document-type shells
RELAX NG: Coding requirements for element type declarations
RELAX NG: Coding requirements for structural modules
RELAX NG: Coding requirements for element domain modules
RELAX NG: Coding requirements for attribute domain modules
RELAX NG: Coding requirements for constraint modules
XML Schema coding requirements
XML Schema: Overview and limitations of coding requirements
XML Schema: Coding requirements for document-type shells
XML Schema: Coding requirements for element type declarations
XML Schema: Coding requirements for structural modules
XML Schema: Coding requirements for attribute domain modules
XML Schema: Coding requirements for constraint modules
Technical content specializations
Technical content: Document types
Concept topic
Reference topic
General task topic
Task topic (strict task)
Machinery Task topic
Troubleshooting topic
Glossary entry topic
Glossary group topic
Bookmap
Technical content domains
The xNAL domain
xNAL usage guidelines
MathML and equation domains
Release management domain
Troubleshooting information
Learning and training specializations
Overview
Objectives of the DITA learning and training specializations
A learning objects approach to learning and training content
Use cases
Summary of learning topic, map, and domain designs
Support for learningDomain1 and learningDomain2
Learning and training specialization usage
Language reference: All-inclusive edition
Element quick reference
Base DITA elements, A to Z
Technical content elements, A to Z
Learning and training elements, A to Z
All DITA elements, A to Z
Topic elements
Basic topic elements
topic
title
titlealts
searchtitle
navtitle
shortdesc
abstract
body
bodydiv
related-links
dita
Body elements
alt
cite
dd
desc
ddhd
div
dl
dlentry
dlhead
dt
draft-comment
dthd
example
fig
figgroup
fn
image
keyword
li
lines
longdescref
longquoteref
lq
note
object
ol
p
param
ph
pre
q
section
sectiondiv
sl
sli
term
text
tm
ul
xref
Table elements
table
tgroup
colspec
thead
tbody
row
entry
simpletable
sthead
strow
stentry
Related links elements
link
linklist
linkpool
linktext
linkinfo
Map elements
Basic map elements
map
topicref
topicmeta
anchor
navref
reltable
relrow
relcell
relheader
relcolspec
ux-window
Map group elements
anchorref
keydef
mapref
topicgroup
topichead
topicset
topicsetref
Metadata elements
Prolog (metadata) elements
prolog
audience
author
brand
category
component
copyright
copyrholder
copyryear
created
critdates
featnum
keywords
metadata
othermeta
permissions
platform
prodinfo
prodname
prognum
publisher
resourceid
revised
series
source
vrmlist
vrm
Indexing group elements
indexterm
indextermref
index-see
index-see-also
index-sort-as
Delayed conref resolution elements
exportanchors
anchorid
anchorkey
Domain elements
Hazard statement elements
hazardstatement
consequence
hazardsymbol
howtoavoid
messagepanel
typeofhazard
Highlighting elements
b
i
sup
sub
tt
u
line-through
overline
Utilities elements
area
coords
imagemap
shape
sort-as
DITAVAL reference domain
ditavalref
ditavalmeta
dvrResourcePrefix
dvrResourceSuffix
dvrKeyscopePrefix
dvrKeyscopeSuffix
Classification elements
Subject scheme elements
subjectScheme
schemeref
hasInstance
hasKind
hasNarrower
hasPart
hasRelated
enumerationdef
elementdef
attributedef
defaultSubject
subjectHead
subjectHeadMeta
subjectdef
relatedSubjects
subjectRelTable
subjectRelHeader
subjectRel
subjectRole
Classification domain elements
subjectref
topicapply
topicsubject
topicSubjectTable
topicSubjectHeader
topicSubjectRow
topicCell
subjectCell
Specialization elements
boolean
data
data-about
foreign
index-base
itemgroup
no-topic-nesting
state
unknown
Legacy conversion elements
required-cleanup
DITAVAL elements
val
style-conflict
prop
revprop
startflag
endflag
alt-text
Technical content elements
Concept elements
concept
conbody
conbodydiv
Task elements
task
taskbody
prereq
context
steps
steps-informal
steps-unordered
step
stepsection
cmd
info
substeps
substep
stepxmp
choicetable
chhead
choptionhd
chdeschd
chrow
choption
chdesc
choices
choice
steptroubleshooting
stepresult
tutorialinfo
tasktroubleshooting
result
postreq
Reference elements
reference
refbody
refbodydiv
refsyn
properties
prophead
proptypehd
propvaluehd
propdeschd
property
proptype
propvalue
propdesc
Troubleshooting elements
troubleshooting
troublebody
condition
troubleSolution
cause
remedy
responsibleParty
Glossary elements
Glossentry elements
glossentry
glossterm
glossdef
glossAbbreviation
glossAcronym
glossAlt
glossAlternateFor
glossBody
glossPartOfSpeech
glossProperty
glossScopeNote
glossShortForm
glossStatus
glossSurfaceForm
glossSymbol
glossSynonym
glossUsage
Glossary related elements
abbreviated-form
glossref
glossgroup
Bookmap elements
Bookmap content elements
bookmap
abbrevlist
amendments
appendices
appendix
backmatter
bibliolist
bookabstract
booklibrary
booklist
booklists
booktitle
booktitlealt
chapter
colophon
dedication
draftintro
figurelist
frontmatter
glossarylist
indexlist
mainbooktitle
notices
part
preface
tablelist
toc
trademarklist
Bookmap metadata elements
bookmeta
approved
bookchangehistory
bookevent
bookeventtype
bookid
booknumber
bookowner
bookpartno
bookrestriction
bookrights
completed
copyrfirst
copyrlast
day
edited
edition
isbn
maintainer
month
organization
person
printlocation
published
publisherinformation
publishtype
reviewed
revisionid
started
summary
tested
volume
year
Technical-content domains elements
Equation domain elements
equation-block
equation-figure
equation-inline
equation-number
Markup domain
markupname
MathML domain elements
mathml
mathmlref
Programming elements
apiname
codeblock
codeph
coderef
option
parmname
parml
plentry
pt
pd
synph
syntaxdiagram
groupseq
groupchoice
groupcomp
fragment
fragref
synblk
synnote
synnoteref
kwd
var
oper
delim
sep
repsep
Release-management domain elements
change-completed
change-historylist
change-item
change-organization
change-person
change-request-id
change-request-reference
change-request-system
change-revisionid
change-started
change-summary
Software elements
msgph
msgblock
msgnum
cmdname
varname
filepath
userinput
systemoutput
SVG elements
svg-container
svgref
Task requirements domain
prelreqs
closereqs
reqconds
reqcond
noconds
reqcontp
reqpers
personnel
perscat
perskill
esttime
supeqli
supequi
supequip
nosupeq
supplies
supply
supplyli
nosupply
spare
spares
sparesli
nospares
nosafety
safecond
safety
User interface elements
uicontrol
wintitle
menucascade
shortcut
screen
XML mention domain
numcharref
parameterentity
textentity
xmlatt
xmlelement
xmlnsname
xmlpi
xNAL domain elements
authorinformation
addressdetails
administrativearea
contactnumber
contactnumbers
country
emailaddress
emailaddresses
firstname
generationidentifier
honorific
lastname
locality
localityname
middlename
namedetails
organizationinfo
organizationname
organizationnamedetails
otherinfo
personinfo
personname
postalcode
thoroughfare
url
urls
Learning and training elements
Learning and training: topic elements
learningOverview
learningOverviewbody
learningContent
learningContentbody
learningSummary
learningSummarybody
learningAssessment
learningAssessmentbody
learningPlan
learningPlanbody
learningBase
learningBasebody
Learning and training: map types
learningGroupMap
learningObjectMap
Learning and training: map domain elements
learningGroup
learningObject
learningObjectMapRef
learningGroupMapRef
learningPlanRef
learningPreAssessmentRef
learningOverviewRef
learningContentRef
learningContentComponentRef
learningSummaryRef
learningPostAssessmentRef
Learning and training: interactions domain elements
Top level interactions elements
lcInstructornote2
lcOpenQuestion2
lcTrueFalse2
lcSingleSelect2
lcMultipleSelect2
lcSequencing2
lcMatching2
lcHotspot2
lcInteractionBase2
lcQuestionBase2
Interactions domain content elements
lcAnswerContent2
lcAnswerOption2
lcAnswerOptionGroup2
lcArea2
lcAreaCoords2
lcAreaShape2
lcAsset2
lcCorrectResponse2
lcFeedback2
lcFeedbackCorrect2
lcFeedbackIncorrect2
lcHotspotMap2
lcInteractionLabel2
lcItem2
lcMatchingHeader2
lcMatchingItem2
lcMatchingItemFeedback2
lcMatchingPair2
lcMatchTable2
lcOpenAnswer2
lcQuestion2
lcSequence2
lcSequenceOption2
lcSequenceOptionGroup2
Learning and training: interactions domain elements (DEPRECATED)
Top level interactions elements (DEPRECATED)
lcInstructornote
lcOpenQuestion
lcTrueFalse
lcSingleSelect
lcMultipleSelect
lcSequencing
lcMatching
lcHotspot
lcInteractionBase
lcQuestionBase
Interactions domain content elements (DEPRECATED)
lcAnswerContent
lcAnswerOption
lcAnswerOptionGroup
lcArea
lcAreaCoords
lcAreaShape
lcAsset
lcCorrectResponse
lcFeedback
lcFeedbackCorrect
lcFeedbackIncorrect
lcHotspotMap
lcItem
lcMatchingHeader
lcMatchingItem
lcMatchingItemFeedback
lcMatchingPair
lcMatchTable
lcOpenAnswer
lcQuestion
lcSequence
lcSequenceOption
lcSequenceOptionGroup
Learning and training: metadata elements
lcLom
lomAggregationLevel
lomContext
lomCoverage
lomDifficulty
lomInstallationRemarks
lomIntendedUserRole
lomInteractivityLevel
lomInteractivityType
lomLearningResourceType
lomOtherPlatformRequirements
lomSemanticDensity
lomStructure
lomTechRequirement
lomTypicalAgeRange
lomTypicalLearningTime
Learning and training: common content elements
lcAge
lcAssessment
lcAttitude
lcAudience
lcBackground
lcChallenge
lcCIN
lcClassroom
lcClient
lcConstraints
lcDelivDate
lcDelivery
lcDownloadTime
lcDuration
lcEdLevel
lcFileSizeLimitations
lcGapAnalysis
lcGapItem
lcGapItemDelta
lcGeneralDescription
lcGoals
lcGraphics
lcHandouts
lcInstruction
lcInteraction
lcIntervention
lcInterventionItem
lcIntro
lcJtaItem
lcKnowledge
lcLearnStrat
lcLMS
lcModDate
lcMotivation
lcNeeds
lcNeedsAnalysis
lcNextSteps
lcNoLMS
lcObjective
lcObjectives
lcObjectivesGroup
lcObjectivesStem
lcOJT
lcOrganizational
lcOrgConstraints
lcPlanAudience
lcPlanDescrip
lcPlanObjective
lcPlanPrereqs
lcPlanResources
lcPlanSubject
lcPlanTitle
lcPlayers
lcPrereqs
lcProcesses
lcProject
lcResolution
lcResources
lcReview
lcSecurity
lcSkills
lcSpecChars
lcSummary
lcTask
lcTaskItem
lcTechnical
lcTime
lcValues
lcViewers
lcW3C
lcWorkEnv
lcWorkEnvDescription
Attributes
Universal attribute group
ID attribute group
Metadata attribute group
Localization attribute group
Debug attribute group
Architectural attribute group
Attributes common to many map elements
Complex-table attribute group
Data element attributes group
Date attributes group
Display attribute group
Link relationship attribute group
Other common attributes
Simpletable attribute group
Specialization attributes group
Topicref element attributes group
Complex attribute definitions
The href attribute
The keys attribute
The keyref attribute
The keyscope attribute
The conref attribute
Using the -dita-use-conref-target value
The conaction attribute
The conrefend attribute
The conkeyref attribute
The type attribute
The format attribute
The scope attribute
The role and otherrole attributes
Conformance
Acknowledgments
Non-normative information
About the specification source
Changes from previous versions
Changes from DITA 1.2 to DITA 1.3
Changes from DITA 1.1 to DITA 1.2
Changes from DITA 1.0 to DITA 1.1
File naming conventions
Migrating to new versions of DITA
Migrating from DITA 1.2 to 1.3
Migrating from DITA 1.1 to 1.2
Considerations for generalizing foreign elements
Element-by-element recommendations for translators: All-inclusive edition
DTD public identifiers
XML Schema catalog identifiers
Domains and constraints in the OASIS specification
Domains and constraints in the OASIS specification
Base domains: Where they are used
Technical content domains and constraints: Where they are used
Learning domains and constraints: Where they are used
Base document types: Included domains
Technical content document types: Included domains and constraints
Learning and training document types: Included domains and constraints
Processing interoperability considerations
Specialization design, customization, and the limits of specialization
Content models for learning and training package
A elements
B elements
C elements
D elements
E elements
F elements
G elements
H elements
I elements
K elements
L elements
M elements
N elements
O elements
P elements
Q elements
R elements
S elements
T elements
U elements
V elements
W elements
X elements
Y elements