Element quick reference

Darwin Information Typing Architecture (DITA) Version 1.2

Introduction
Terminology
Normative references
Non-normative references
Formatting conventions in the XHTML version of the specification
Architectural specification
Base architecture
Introduction to DITA
About the specification source
DITA terminology and notation
Basic concepts
File naming conventions
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
Transitional text solutions
Information typing
Generic topics
Topic structure
Topic content
Topic domains: Basic DITA
DITA maps
Definition of DITA maps
Purpose of DITA maps
DITA map elements
DITA map attributes
Subject scheme maps
DITA metadata
Metadata elements
Metadata attributes
Conditional processing attributes
Translation and localization attributes
Architectural attributes
Metadata in maps and topics
Cascading of attributes and metadata in a DITA map
Map-to-map cascading behaviors
Reconciling topic and map metadata
DITA processing
Module compatibility and the @domains attribute
Navigation behaviors
DITA linking
Links within maps
Links within topics
DITA addressing
ID attribute
URI-based (direct) addressing
Key-based addressing
Overview of keys
Using keys to address DITA elements
Processing key references
Examples of keys
Summary of addressing elements
Content inclusion (conref)
Conditional processing (profiling)
Chunking
Printing
Translation and localization
The @xml:lang attribute
The dir attribute
Configuration, specialization, and constraints
Overview of DITA extension facilities
Recognized XML document constraint mechanisms
Configuration (Document type shells)
DTD document-type shell: Coding requirements
XSD document-type shell: Coding requirements
Specialization
Vocabulary modules
Requirements for specialized element types and attributes
Element type specialization hierarchy declaration (the @class attribute)
Domain usage declaration (the @domains attribute)
Generalization
Attribute generalization
Specializing foreign or unknown content
Specialization module coding requirements
DTD syntax specialization module coding requirements
General element type declaration coding requirements
Structural module coding requirements
Topic type module coding requirements
Element domain module coding requirements
Attribute domain module coding requirements
XSD schema specialization module coding requirements
General element type declaration coding requirements
Structural specialization coding requirements
Attribute domain coding requirements
Constraints
Constraint module DTD coding requirements
Constraint module XSD coding requirements
Conref and generalization for constraint modules
Examples of constraint declaration modules
Technical content architecture
Overview of the DITA 1.2 Specification: Technical Content
Technical content: Document and information types
Concept topic
Reference topic
General task topic
Task topic (strict task)
Machinery task topic
Glossary entry topic
Glossary group topic
Bookmap
Topic domains: Technical content
The xNAL domain
Learning and training architecture
Overview
Objectives of the DITA Learning and Training Specialization
A learning objects approach to learning and training content
Use cases
Summary of learning topic, map, and domain designs
Language reference
Base elements
Topic elements
Basic topic elements
topic
title
titlealts
searchtitle
navtitle
shortdesc
abstract
body
bodydiv
related-links
dita
Body elements
alt
cite
dd
desc
ddhd
dl
dlentry
dlhead
dt
draft-comment
dthd
example
fig
figgroup
fn
image
keyword
li
lines
longdescref
longquoteref
lq
object
note
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
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
Typographic elements
b
i
sup
sub
tt
u
Utilities elements
area
coords
imagemap
shape
Classification elements
Subject scheme maps
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
stepresult
tutorialinfo
result
postreq
Reference elements
reference
refbody
refbodydiv
refsyn
properties
prophead
proptypehd
propvaluehd
propdeschd
property
proptype
propvalue
propdesc
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
Domain elements
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
Programming elements
apiname
codeblock
coderef
codeph
option
parmname
parml
plentry
pt
pd
synph
syntaxdiagram
groupseq
groupchoice
groupcomp
fragment
fragref
synblk
synnote
synnoteref
kwd
var
oper
delim
sep
repsep
Software elements
msgph
msgblock
msgnum
cmdname
varname
filepath
userinput
systemoutput
User interface elements
uicontrol
wintitle
menucascade
shortcut
screen
xNAL domain elements
xNAL usage guidelines
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 domain elements
learningGroup
learningObject
learningPlanRef
learningPreAssessmentRef
learningOverviewRef
learningContentRef
learningContentComponentRef
learningSummaryRef
learningPostAssessmentRef
Learning and training interactions domain elements
lcInstructornote
DITA learning interaction base domain elements
lcInteractionBase
lcQuestionBase
lcOpenQuestion
lcTrueFalse
lcSingleSelect
lcMultipleSelect
lcSequencing
lcMatching
lcHotspot
Learning and training metadata elements
lcLom
lomAggregationLevel
lomContext
lomCoverage
lomDifficulty
lomInstallationRemarks
lomIntendedUserRole
lomInteractivityLevel
lomInteractivityType
lomLearningResourceType
lomOtherPlatformRequirements
lomSemanticDensity
lomStructure
lomTechRequirement
lomTypicalAgeRange
lomTypicalLearningTime
Other learning and training elements
Common learning interactions elements
lcAnswerContent
lcAnswerOption
lcAnswerOptionGroup
lcArea
lcAreaCoords
lcAreaShape
lcAsset
lcCorrectResponse
lcFeedback
lcFeedbackCorrect
lcFeedbackIncorrect
lcHotspotMap
lcItem
lcMatchingHeader
lcMatchingItem
lcMatchingItemFeedback
lcMatchingPair
lcMatchTable
lcOpenAnswer
lcQuestion
lcSequence
lcSequenceOption
lcSequenceOptionGroup
Common learning 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
Commonly referenced attribute groups
display-atts attribute group
global-atts attribute group
univ-atts attribute group
id-atts attribute group
select-atts attribute group
localization-atts attribute group
relational-atts attribute group
rel-atts attribute group
topicref-atts, topicref-atts-no-toc, and topicref-atts-without-format attribute groups
Other common DITA attributes
Complex attribute definitions
The href attribute
The keys attribute
The keyref 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 attribute
Element quick reference
Base DITA elements, A to Z
Technical content elements, A to Z
Learning and training elements, A to Z
All DITA 1.2 elements, A to Z
Conformance
Acknowledgments
Non-normative information
Changes from previous versions
Changes from DITA 1.1 to DITA 1.2
Changes from DITA 1.0 to DITA 1.1
Migrating from DITA 1.1 to 1.2
DITA MIME type
Considerations for generalizing <foreign> elements
Element-by-element recommendations for translators
DITA module and shell implementation reference
DTD organization
XML schema organization
Processing component modularization and naming conventions
Processing interoperability considerations
Specialization design, customization, and the limits of specialization

Back to home page