DITA Annotations

3 min read

The purpose of a rule is to apply annotations to your content which will guide the conversion. There are many annotations to choose from.

These are the DITA-specific annotations.

Topic Identification	File Chunking	Prolog Metadata
p.title.concept p.title.reference p.title.task p.title.task-general p.title.topic p.title.unknown-topic p.title.custom-topic p.no-title.custom-topic	map-filename map-filename-lower-case map-filename-words target-filename target-filename-camel-case target-filename-dromedary-case target-filename-lower-case target-filename-words	p.author p.copyright-text p.data p.metadata p.prolog p.publisher prolog.data prolog.resourceid prolog.indexterms prolog.keywords prolog.meta.audience prolog.meta.category prolog.meta.othermeta prolog.meta.platform prolog.meta.prodname prolog.meta.version

Reference	Task	Tables
p.reference.syntax p.property p.property.description p.property.head p.property.head.description p.property.head.type s.property.description s.property.head.description s.property.head.type s.property.head.value s.property.type s.property.value	p.task.context p.task.postreq p.task.prereq p.task.result p.choice.entry p.choice.head s.choice.description s.choice.head.description s.choice.head.option s.choice.option p.step.choice p.step.example p.step.example.code p.step.info p.step.informal.command p.step.ordered.command p.step.result p.step.section p.step.unordered.command	p.table.head t.entry.description t.entry.option t.entry.term t.relative-column-widths t.table.choice t.table.definitions t.table.parameters t.table.properties t.table.simple p.simpletable.entry p.simpletable.head.entry p.simpletable.head p.simpletable.row s.simpletable.entry s.simpletable.head.entry

Lists	Other Block Level	Glossary
p.li.bulleted p.li.ordered p.li.simple p.title.search s.li.simple p.dl.definition p.dl.entry p.dl.head p.dl.term s.dl.definition s.dl.head.definition s.dl.head.term s.dl.term	p.note s.note t.note p.figure p.figure.desc p.title.figure p.title.for-following-content p.title.for-preceding-content p.lines p.pre p.quote p.section draft-comment p.example p.footnote related-link reltable-entry p.hazard.typeof p.hazard.consequences p.hazard.avoid	p.glossary.def p.glossary.entry p.glossary.term s.glossary.def s.glossary.term

Content Reuse	Non-Topic Titles	Equation Domain
conkeyref conref keyref	p.following-table-title p.table-title p.title.alternative p.title.glossary-group p.title.navigation p.title.related-link-list p.title.section p.title.unknown	equation

Index	Inline Level	User Interface Domain
indexterms s.index-see s.index-see-also s.indexterm	s.citation s.footnote-marker s.phrase s.quote s.term s.trademark s.xref	p.ui.screen s.ui.control s.ui.menu-cascade.control s.ui.screen s.ui.shortcut s.ui.window-title

Typographical Domain	Programming Domain	Software Domain
s.bold s.italic s.monospaced s.subscript s.superscript s.underline	p.code s.code p.parameter.definition p.parameter.entry p.parameter.term s.parameter.definition s.parameter-name s.parameter.term p.syntax-diagram s.syntax s.syntax.block s.syntax.delimiter s.syntax.fragment s.syntax.fragment-reference s.syntax.group-choice s.syntax.group-composite s.syntax.group-sequence s.syntax.keyword s.syntax.note s.syntax.note-reference s.syntax.operator s.syntax.separator s.syntax.separator.repeatable s.syntax.variable s.apiname s.keyword s.option t.table.parameters	p.command-name s.command-name p.file-path s.file-path p.message-block p.message-number p.message s.message s.message-number p.system-output s.system-output p.user-input s.user-input p.variable-name s.variable-name

map metadata	map structure	bookmap structure
p.map.date.created p.map.othermeta p.map.product-name p.map.product-version	p.map.navtitle p.reltable-entry p.title.map s.reltable-entry	p.title.backmatter.notice p.title.frontmatter.notice p.title.toc-appendix p.title.toc-chapter p.title.toc-part p.title.toc-preface

bookmap metadata
p.book.approved.completed p.book.author p.book.book-number p.book.category p.book.copyright.first-year p.book.copyright.last-year p.book.edition p.book.organization.addressdetails p.book.organization.administrativearea p.book.organization.country p.book.organization.email p.book.organization.first name p.book.organization.generation p.book.organization.honorific p.book.organization.lastname p.book.organization.locality p.book.organization.middlename	p.book.organization.number p.book.organization.orgname p.book.organization.thoroughfare p.book.organization.url p.book.othermeta p.book.owner.person p.book.owner.organization p.book.part-number p.book.person.addressdetails p.book.person.administrative area p.book.person.country p.book.person.email p.book.person.firstname p.book.person.generation p.book.person.honorific p.book.person.lastname	p.book.person.locality p.book.person.middlename p.book.person.number p.book.person.orgname p.book.person.thoroughfare p.book.product-name p.book.product-series p.book.product-version p.book.publisher.completed p.book.publisher.organization p.book.reviewed.person p.book.title p.book.title.alternative p.book.title.main p.book.title.library p.book.volume

Still stuck? How can we help?

Updated on December 18, 2023