B.6 Element-by-element recommendations for translators: Technical content edition
This topic contains a list of all OASIS DITA elements that are available in the edition. It includes recommendations on how to present the element type to translators, whether the element contents are likely to be suitable for translation, and whether the element has attributes whose values are likely to be suitable for translation. Examples of content that is not suitable for translation include code fragments and mailing addresses.
Notes on the tables below
- For specializations, the second column gives the ancestor element, and the third column gives a quick yes/no guide to indicate whether all behavior is inherited. If something is not inherited, the change will appear in bold.
- For any specialization not listed below, the suggested default is to fall back to the closest listed ancestor.
- The block/inline presentation column indicates whether the element is formatted as a single block.
- The block/inline translation column indicates whether the element represents a complete
translatable segment. For example, the element
<cmd>
is presented inline with other elements, but represents a complete translation segment. - Items marked as block*** are blocks on their own, but might appear in the middle of a segment. They should not break the flow of the current segment. These are considered "subflow" elements for translation. We recommend that, when possible, these elements should only be placed at sentence boundaries to aid in translation.
- For all elements, the
@translate
attribute will override the suggested default translation setting. So, a translation setting of "yes" or "no" in the table below does not guarantee that an element will always, or never, be translated. - If an element has translatable attributes, they are listed in the last column. Note that
the
@spectitle
and@specentry
attributes are described with a footnote. - The
<keyword>
element (as well as specializations of<keyword>
) is an inline, phrase-like element when it appears in the body of a document. It can also appear in the<keywords>
element in<topicmeta>
(for maps) or in the<prolog>
(for topic). When it appears in the<keywords>
element, each<keyword>
represents an individual segment, and is not part of a larger segment; in that location,<keyword>
can be considered a "subflow" element.
topic elements
Element name | Specialized from | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|
<abstract>
|
N/A | block | block | yes | |
<alt>
5
|
N/A | block***1 | block | yes | |
<audience>
|
N/A | block (metadata) | block | yes | |
<author>
|
N/A | block (metadata) | block | yes | |
<body>
|
N/A | block | block | yes | |
<bodydiv>
(new in DITA 1.2)
|
N/A | block | block | yes | |
<boolean>
|
N/A | inline | inline | n/a | |
<brand>
|
N/A | block (metadata) | block | yes | |
<category>
|
N/A | block (metadata) | block | yes | |
<cite>
|
N/A | inline | inline | yes | |
<colspec>
|
N/A | n/a | n/a | n/a | |
<component>
|
N/A | block (metadata) | block | yes | |
<copyrholder>
|
N/A | block (metadata) | block | yes | |
<copyright>
|
N/A | block (metadata) | block | yes | |
<copyryear>
|
N/A | block (metadata) | block | yes | |
<created>
|
N/A | block (metadata) | block | yes | |
<critdates>
|
N/A | block (metadata) | block | yes | |
<data>
|
N/A | N/A (metadata) | block | no (likely to change for some specializations) | |
<data-about>
|
N/A | N/A (metadata) | block | no | |
<dd>
|
N/A | block | block | yes | |
<ddhd>
|
N/A | block | block | yes | |
<desc>
|
N/A | block | block | yes | |
<div>
(new in DITA 1.3)
|
N/A | block | block | yes | |
<dl>
|
N/A | block | block | yes |
@spectitle
2
|
<dlentry>
|
N/A | block | block | yes | |
<dlhead>
|
N/A | block | block | yes | |
<draft-comment>
|
N/A | block***1 | block | no | |
<dt>
|
N/A | block | block | yes | |
<dthd>
|
N/A | block | block | yes | |
<entry>
|
N/A | block | block | yes | |
<example>
|
N/A | block | block | yes |
@spectitle
2
|
<featnum>
|
N/A | block (metadata) | block | yes | |
<fig>
|
N/A | block | block | yes |
@spectitle
2
|
<figgroup>
|
N/A | block | block | yes | |
<fn>
|
N/A | block***1 | block | yes | |
<foreign>
7
|
N/A | block3 | block3 | no4 | |
<image>
|
N/A | block when @placement = break, otherwise inline |
block when @placement = break, otherwise inline |
yes |
@alt
5
|
<index-base>
|
N/A | block***1 | block | yes | |
<index-sort-as>
(new in DITA 1.2)
|
N/A | block***1 | block | yes | |
<indexterm>
|
N/A | block***1 | block | yes | |
<indextermref>
|
N/A | inline | n/a | n/a | |
<itemgroup>
|
N/A | inline | inline | yes | |
<keyword>
|
N/A | inline | inline (except when within <keywords> – see note above the table) |
yes | |
<keywords>
|
N/A | block | block | yes | |
<li>
|
N/A | block | block | yes | |
<lines>
|
N/A | block | block | yes |
@spectitle
2
|
<link>
|
N/A | block | block | yes | |
<linkinfo>
|
N/A | block | block | yes | |
<linklist>
|
N/A | block | block | yes |
@spectitle
2
|
<linkpool>
|
N/A | block | block | yes | |
<linktext>
|
N/A | block | block | yes | |
<lq>
|
N/A | block | block | yes |
@reftitle
|
<metadata>
|
N/A | block (metadata) | block | yes | |
<navtitle>
|
N/A | block | block | yes | |
<no-topic-nesting>
|
N/A | n/a | n/a | n/a | |
<note>
|
N/A | block | block | yes |
@othertype , @spectitle
2
|
<object>
|
N/A | block | block | yes |
@standby
|
<ol>
|
N/A | block | block | yes |
@spectitle
2
|
<othermeta>
|
N/A | block (metadata) | block | yes |
@content
|
<p>
|
N/A | block | block | yes | |
<param>
|
N/A | block | block | n/a | |
<permissions>
|
N/A | block (metadata) | block | yes | |
<ph>
|
N/A | inline | inline | yes | |
<platform>
|
N/A | block (metadata) | block | yes | |
<pre>
|
N/A | block | block | yes |
@spectitle
2
|
<prodinfo>
|
N/A | block (metadata) | block | yes | |
<prodname>
|
N/A | block (metadata) | block | yes | |
<prognum>
|
N/A | block (metadata) | block | yes | |
<prolog>
|
N/A | block (metadata) | block | yes | |
<publisher>
|
N/A | block (metadata) | block | yes | |
<q>
|
N/A | inline | inline | yes | |
<related-links>
|
N/A | block | block | yes | |
<required-cleanup>
|
N/A | block***1 | block | no | |
<resourceid>
|
N/A | block (metadata) | block | yes | |
<revised>
|
N/A | block (metadata) | block | yes | |
<row>
|
N/A | block | block | yes | |
<searchtitle>
|
N/A | block | block | yes | |
<section>
|
N/A | block | block | yes |
@spectitle
2
|
<sectiondiv>
(new in DITA 1.2)
|
N/A | block | block | yes | |
<series>
|
N/A | block (metadata) | block | yes | |
<shortdesc>
|
N/A | block | block | yes | |
<simpletable>
|
N/A | block | block | yes |
@spectitle
2
|
<sl>
|
N/A | block | block | yes |
@spectitle
2
|
<sli>
|
N/A | block | block | yes | |
<source>
|
N/A | block (metadata) | block | yes | |
<state>
|
N/A | inline | inline | yes |
@value
|
<stentry>
|
N/A | block | block | yes |
@specentry
2
|
<sthead>
|
N/A | block | block | yes | |
<strow>
|
N/A | block | block | yes | |
<table>
|
N/A | block | block | yes | |
<tbody>
|
N/A | block | block | yes | |
<term>
|
N/A | inline | inline | yes | |
<text>
(new in DITA 1.2)
|
N/A | inline | inline | yes | |
<tgroup>
|
N/A | block | block | yes | |
<thead>
|
N/A | block | block | yes | |
<title>
|
N/A | block | block | yes | |
<titlealts>
|
N/A | block | block | yes | |
<tm>
|
N/A | inline | inline | yes | |
<topic>
|
N/A | block | block | yes | |
<ul>
|
N/A | block | block | yes |
@spectitle
2
|
<unknown>
(new in DITA 1.1)
|
N/A | block | block | no | |
<vrm>
|
N/A | block (metadata) | block | yes | |
<vrmlist>
|
N/A | block (metadata) | block | yes | |
<xref>
|
N/A | inline | inline | yes |
map elements
As of DITA 1.2, the @navtitle
attribute is deprecated, for translation purposes, in favor
of the new <navtitle>
element. The <navtitle>
element is also available in topics,
and is included in the topic table above.
Element name | Specialized from | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|
<anchor>
|
N/A | n/a | n/a | n/a | |
<linktext>
|
N/A | block | block | yes | |
<map>
|
N/A | block | block | yes |
@title
8
|
<navref>
|
N/A | n/a | n/a | n/a | |
<relcell>
|
N/A | block | block | yes | |
<relcolspec>
|
N/A | block | block | yes | |
<relheader>
|
N/A | block | block | yes | |
<relrow>
|
N/A | block | block | yes | |
<reltable>
|
N/A | block | block | yes | |
<searchtitle>
|
N/A | block | block | yes | |
<shortdesc>
|
N/A | block | block | yes | |
<topicmeta>
|
N/A | block | block | yes | |
<topicref>
|
N/A | block | block | yes |
@navtitle
|
<ux-window>
|
N/A | N/A (empty) | N/A (empty) | no |
bookmap elements (new in DITA 1.1)
The bookmap specialization contains many phrase-based elements inside the bookmeta. These are metadata, and should not be translated.
As of DITA 1.2, the @navtitle
attribute is deprecated, for translation purposes, in favor
of the new <navtitle>
element.
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<abbrevlist>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<amendments>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<appendix>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<approved>
|
<data>
|
yes | block | block | no | |
<backmatter>
|
<topicref>
|
yes | block | block | yes | |
<bibliolist>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<bookabstract>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<bookchangehistory>
|
<data>
|
yes | block | block | no | |
<bookevent>
|
<data>
|
yes | block | block | no | |
<bookeventtype>
|
<data>
|
yes | block | block | no | |
<bookid>
|
<data>
|
yes | block | block | no | |
<booklibrary>
|
<ph>
|
yes | inline | inline | yes | |
<booklist>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<booklists>
|
<topicref>
|
yes | block | block | yes | |
<bookmap>
|
<map>
|
no | block | block | yes | removed title attribute |
<bookmeta>
|
<topicmeta>
|
yes | block | block | yes | |
<booknumber>
|
<data>
|
yes | block | block | no | |
<bookowner>
|
<data>
|
yes | block | block | no | |
<bookpartno>
|
<data>
|
yes | block | block | no | |
<bookrestriction>
|
<data>
|
yes | block | block | no | |
<bookrights>
|
<data>
|
yes | block | block | no | |
<booktitle>
|
<title>
|
yes | block | block | yes | |
<booktitlealt>
|
<ph>
|
yes | inline | inline | yes | |
<chapter>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<colophon>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<completed>
|
<ph>
|
no | inline | inline | no | |
<copyrfirst>
|
<data>
|
yes | block | block | no | |
<copyrlast>
|
<data>
|
yes | block | block | no | |
<day>
|
<ph>
|
no | inline | inline | no | |
<dedication>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<draftintro>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<edited>
|
<data>
|
yes | block | block | no | |
<edition>
|
<data>
|
yes | block | block | no | |
<figurelist>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<frontmatter>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<glossarylist>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<indexlist>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<isbn>
|
<data>
|
yes | block | block | no | |
<mainbooktitle>
|
<ph>
|
yes | inline | inline | yes | |
<maintainer>
|
<data>
|
yes | block | block | no | |
<month>
|
<ph>
|
no | inline | inline | no | |
<notices>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<organization>
|
<data>
|
yes | block | block | no | |
<part>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<person>
|
<data>
|
yes | block | block | no | |
<preface>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<printlocation>
|
<data>
|
yes | block | block | no | |
<published>
|
<data>
|
yes | block | block | no | |
<publisherinformation>
|
<publisher>
|
yes | block | block | yes | |
<publishtype>
|
<data>
|
yes | block | block | no | |
<reviewed>
|
<data>
|
yes | block | block | no | |
<revisionid>
|
<ph>
|
no | inline | inline | no | |
<started>
|
<ph>
|
no | inline | inline | no | |
<summary>
|
<ph>
|
yes | inline | inline | yes | |
<tablelist>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<tested>
|
<data>
|
yes | block | block | no | |
<toc>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<trademarklist>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<volume>
|
<data>
|
yes | block | block | no | |
<year>
|
<ph>
|
no | inline | inline | no |
concept elements
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<conbody>
|
<body>
|
yes | block | block | yes | |
<conbodydiv>
(new in DITA 1.2)
|
<bodydiv>
|
yes | block | block | yes | |
<concept>
|
<topic>
|
yes | block | block | yes |
glossentry elements (new in DITA 1.1)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<glossAbbreviation>
(new in DITA 1.2)
|
<title>
|
yes | block | block | yes | |
<glossAcronym>
(new in DITA 1.2)
|
<title>
|
yes | block | block | yes | |
<glossAlt>
(new in DITA 1.2)
|
<section>
|
yes | block | block | yes |
removes @spectitle
|
<glossAlternateFor>
(new in DITA 1.2)
|
<xref>
|
yes | inline | n/a (empty element) | n/a | |
<glossbody>
(new in DITA 1.2)
|
<body> , <conbody>
|
yes | block | block | yes | |
<glossdef>
|
<abstract>
|
yes | block | block | yes | |
<glossentry>
|
<topic> , <concept>
|
yes | block | block | yes | |
<glossPartOfSpeech>
(new in DITA 1.2)
|
<data>
|
yes | N/A (metadata) | block | no | |
<glossProperty>
(new in DITA 1.2)
|
<data>
|
yes | N/A (metadata) | block | no | |
<glossScopeNote>
(new in DITA 1.2)
|
<note>
|
yes | block | block | yes |
@othertype
|
<glossShortForm>
(new in DITA 1.2)
|
<title>
|
yes | block | block | yes | |
<glossStatus>
(new in DITA 1.2)
|
<data>
|
yes | N/A (metadata) | block | no | |
<glossSurfaceForm>
(new in DITA 1.2)
|
<p>
|
yes | block | block | yes | |
<glossSymbol>
(new in DITA 1.2)
|
<image>
|
yes | block when @placement = break, otherwise inline |
block when @placement = break, otherwise inline |
yes |
removes @alt
|
<glossSynonym>
(new in DITA 1.2)
|
<title>
|
yes | block | block | yes | |
<glossterm>
(new in DITA 1.2)
|
<title>
|
yes | block | block | yes | |
<glossUsage>
(new in DITA 1.2)
|
<note>
|
yes | block | block | yes |
@othertype
(removes @spectitle )
|
reference elements
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<propdesc>
|
<stentry>
|
yes | block | block | yes |
@specentry
2
|
<propdeschd>
|
<stentry>
|
yes | block | block | yes |
@specentry
2
|
<properties>
|
<simpletable>
|
yes | block | block | yes |
@spectitle
2
|
<property>
|
<strow>
|
yes | block | block | yes | |
<prophead>
|
<sthead>
|
yes | block | block | yes | |
<proptype>
|
<stentry>
|
yes | block | block | yes |
@specentry
2
|
<proptypehd>
|
<stentry>
|
yes | block | block | yes |
@specentry
2
|
<propvalue>
|
<stentry>
|
yes | block | block | yes |
@specentry
2
|
<propvaluehd>
|
<stentry>
|
yes | block | block | yes |
@specentry
2
|
<refbody>
|
<body>
|
yes | block | block | yes | |
<refbodydiv>
(new in DITA 1.2)
|
<bodydiv>
|
yes | block | block | yes | |
<reference>
|
<topic>
|
yes | block | block | yes | |
<refsyn>
|
<section>
|
yes | block | block | yes |
@spectitle
2
|
task elements
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<chdesc>
|
<stentry>
|
yes | block | block | yes |
@specentry
2
|
<chdeschd>
|
<stentry>
|
yes | block | block | yes |
@specentry
2
|
<chhead>
|
<sthead>
|
yes | block | block | yes | |
<choice>
|
<li>
|
yes | block | block | yes | |
<choices>
|
<ul>
|
yes | block | block | yes |
removes @spectitle
|
<choicetable>
|
<simpletable>
|
yes | block | block | yes |
@spectitle
2
|
<choption>
|
<stentry>
|
yes | block | block | yes |
@specentry
2
|
<choptionhd>
|
<stentry>
|
yes | block | block | yes |
@specentry
2
|
<chrow>
|
<strow>
|
yes | block | block | yes | |
<cmd>
|
<ph>
|
NO | inline | block | yes | |
<context>
|
<section>
|
yes | block | block | yes |
removes @spectitle
|
<info>
|
<itemgroup>
|
NO | inline | block | yes | |
<postreq>
|
<section>
|
yes | block | block | yes |
removes @spectitle
|
<prereq>
|
<section>
|
yes | block | block | yes |
removes @spectitle
|
<result>
|
<section>
|
yes | block | block | yes |
removes @spectitle
|
<step>
|
<li>
|
yes | block | block | yes | |
<stepresult>
|
<itemgroup>
|
NO | inline | block | yes | |
<steps>
|
<ol>
|
yes | block | block | yes |
removes @spectitle
|
<steps-informal>
(new in DITA 1.2)
|
<section>
|
yes | block | block | yes |
removes @spectitle
|
<steps-unordered>
|
<ul>
|
yes | block | block | yes |
removes @spectitle
|
<stepsection>
(new in DITA 1.2)
|
<li>
|
yes | block | block | yes | |
<steptroubleshooting>
(new in DITA 1.3)
|
<itemgroup>
|
yes | block | block | yes | |
<stepxmp>
|
<itemgroup>
|
NO | inline | block | yes | |
<substep>
|
<li>
|
yes | block | block | yes | |
<substeps>
|
<ol>
|
yes | block | block | yes |
removes @spectitle
|
<task>
|
<topic>
|
yes | block | block | yes | |
<taskbody>
|
<body>
|
yes | block | block | yes | |
<tasktroubleshooting>
|
<section>
|
yes | block | block | yes |
removes @spectitle
|
<tutorialinfo>
|
<itemgroup>
|
NO | inline | block | yes |
troubleshooting elements (new in DITA 1.3)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<cause>
|
<section>
|
yes | block | block | yes |
@specentry
2
|
<condition>
|
<section>
|
yes | block | block | yes |
@specentry
2
|
<remedy>
|
<section>
|
yes | block | block | yes |
@specentry
2
|
<responsibleParty>
|
<p>
|
yes | block | block | yes | |
<troublebody>
|
<body>
|
yes | block | block | yes | |
<troubleshooting>
|
<topic>
|
yes | block | block | yes | |
<troubleSolution>
|
<bodydiv>
|
yes | block | block | yes |
hi-d elements (highlight domain)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<b>
|
<ph>
|
yes | inline | inline | yes | |
<line-through>
(new in DITA 1.3)
|
yes | inline | inline | yes | ||
<i>
|
<ph>
|
yes | inline | inline | yes | |
<overline>
(new in DITA 1.3)
|
<ph>
|
yes | inline | inline | yes | |
<sub>
|
<ph>
|
yes | inline | inline | yes | |
<sup>
|
<ph>
|
yes | inline | inline | yes | |
<tt>
|
<ph>
|
yes | inline | inline | yes | |
<u>
|
<ph>
|
yes | inline | inline | yes |
indexing-d elements (indexing domain) (new in DITA 1.1)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<index-see>
|
<index-base>
|
yes | block***1 | block | yes | |
<index-see-also>
|
<index-base>
|
yes | block***1 | block | yes | |
<index-sort-as>
|
<index-base>
|
yes | block***1 | block | yes |
pr-d elements (programming domain)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<apiname>
|
<keyword>
|
yes | inline | inline | yes | |
<codeblock>
|
<pre>
|
yes | block | block | yes |
@spectitle
2
|
<codeph>
|
<ph>
|
yes | inline | inline | yes | |
<coderef>
(new in DITA 1.2)
|
<xref>
|
yes | inline | N/A (empty element) | N/A | |
<delim>
|
<ph>
|
yes | inline | inline | yes | |
<fragment>
|
<figgroup>
|
yes | block | block | yes | |
<fragref>
|
<xref>
|
yes | inline | inline | yes | |
<groupchoice>
|
<figgroup>
|
yes | block | block | yes | |
<groupcomp>
|
<figgroup>
|
yes | block | block | yes | |
<groupseq>
|
<figgroup>
|
yes | block | block | yes | |
<kwd>
|
<keyword>
|
yes | inline | inline | yes | |
<oper>
|
<ph>
|
yes | inline | inline | yes | |
<option>
|
<keyword>
|
yes | inline | inline | yes | |
<parml>
|
<dl>
|
yes | block | block | yes |
@spectitle
2
|
<parmname>
|
<keyword>
|
yes | inline | inline | yes | |
<pd>
|
<dd>
|
yes | block | block | yes | |
<plentry>
|
<dlentry>
|
yes | block | block | yes | |
<pt>
|
<dt>
|
yes | block | block | yes | |
<repsep>
|
<ph>
|
yes | inline | inline | yes | |
<sep>
|
<ph>
|
yes | inline | inline | yes | |
<synblk>
|
<figgroup>
|
yes | block | block | yes | |
<synnote>
|
<fn>
|
yes | block | block | yes | |
<synnoteref>
|
<xref>
|
yes | inline | inline | yes | |
<synph>
|
<ph>
|
yes | inline | inline | yes | |
<syntaxdiagram>
|
<fig>
|
yes | block | block | yes |
removes @spectitle
|
<var>
|
<ph>
|
yes | inline | inline | yes |
sw-d elements (software domain)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<cmdname>
|
<keyword>
|
yes | inline | inline | yes | |
<filepath>
|
<ph>
|
yes | inline | inline | yes | |
<msgblock>
|
<pre>
|
yes | block | block | yes |
@spectitle
2
|
<msgnum>
|
<keyword>
|
yes | inline | inline | yes | |
<msgph>
|
<ph>
|
yes | inline | inline | yes | |
<systemoutput>
|
<ph>
|
yes | inline | inline | yes | |
<userinput>
|
<ph>
|
yes | inline | inline | yes | |
<varname>
|
<keyword>
|
yes | inline | inline | yes |
ui-d elements (UI domain)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<menucascade>
|
<ph>
|
yes | inline | inline | yes | |
<screen>
|
<pre>
|
yes | block | block | yes |
@spectitle
2
|
<shortcut>
|
<keyword>
|
yes | inline | inline | yes | |
<uicontrol>
|
<ph>
|
yes | inline | inline | yes | |
<wintitle>
|
<keyword>
|
yes | inline | inline | yes |
ut-d elements (Utilities domain)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<area>
|
<figgroup>
|
yes | block | block | yes | |
<coords>
|
<ph>
|
NO | inline | inline | no | |
<imagemap>
|
<fig>
|
yes | block | block | yes (can contain translatable alternate text) |
@spectitle
2
|
<shape>
|
<keyword>
|
NO | inline | inline | no | |
<sort-as>
(new in DITA 1.3)
|
<data>
|
NO | block***1 | block | yes |
mapgroup-d elements (mapgroup domain)
As of DITA 1.2, the @navtitle
attribute is deprecated, for translation purposes, in favor
of the new <navtitle>
element.
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<anchorref>
(new in DITA 1.2)
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<keydef>
(new in DITA 1.2)
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<mapref>
(new in DITA 1.2)
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<topicgroup>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<topichead>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<topicset>
(new in DITA 1.2)
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<topicsetref>
(new in DITA 1.2)
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
ditavalref-d elements (ditavalref domain) (new in DITA 1.3)
The @navtitle
attribute is deprecated, for translation purposes, in favor
of the <navtitle>
element.
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<ditavalmeta>
|
<topicmeta>
|
yes | block | block | yes | |
<ditavalref>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<dvrKeyscopePrefix>
|
<data>
|
yes | N/A (metadata) | block | no | |
<dvrKeyscopeSuffix>
|
<data>
|
yes | N/A (metadata) | block | no | |
<dvrResourcePrefix>
|
<data>
|
yes | N/A (metadata) | block | no | |
<dvrResourceSuffix>
|
<data>
|
yes | N/A (metadata) | block | no |
xnal-d elements (XNAL domain) (new in DITA 1.1)
The XNAL information is all metadata, so it generally does not need to be translated. Exceptions might be needed when selections from this metadata are used for display purposes. The standard behavior might need to change based on local business rules. For example, in some cases it might be appropriate to translate the honorific, country, or organizationname elements.
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<addressdetails>
|
<ph>
|
no | block | block | no | |
<administrativearea>
|
<ph>
|
no | block | block | no | |
<authorinformation>
|
<author>
|
no | block | block | no | |
<contactnumber>
|
<data>
|
no | block | block | no | |
<contactnumbers>
|
<data>
|
no | block | block | no | |
<country>
|
<ph>
|
no | block | block | no | |
<emailaddress>
|
<data>
|
no | block | block | no | |
<emailaddresses>
|
<data>
|
no | block | block | no | |
<firstname>
|
<data>
|
no | block | block | no | |
<generationidentifier>
|
<data>
|
no | block | block | no | |
<honorific>
|
<data>
|
no | block | block | no | |
<lastname>
|
<data>
|
no | block | block | no | |
<locality>
|
<ph>
|
no | block | block | no | |
<localityname>
|
<ph>
|
no | block | block | no | |
<middlename>
|
<data>
|
no | block | block | no | |
<namedetails>
|
<data>
|
no | block | block | no | |
<organizationinfo>
|
<data>
|
no | block | block | no | |
<organizationname>
|
<ph>
|
no | block | block | no | |
<organizationnamedetails>
|
<ph>
|
no | block | block | no | |
<otherinfo>
|
<data>
|
no | block | block | no | |
<personinfo>
|
<data>
|
no | block | block | no | |
<personname>
|
<data>
|
no | block | block | no | |
<postalcode>
|
<ph>
|
no | block | block | no | |
<thoroughfare>
|
<ph>
|
no | block | block | no | |
<url>
|
<data>
|
no | block | block | no | |
<urls>
|
<data>
|
no | block | block | no |
Delayed Conref Resolution domain elements (new in DITA 1.2)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<anchorid>
|
<keyword>
|
no | N/A (metadata) | n/a | no | |
<anchorkey>
|
<keyword>
|
no | N/A (metadata) | n/a | no | |
<exportanchors>
|
<keywords>
|
no | N/A (metadata) | n/a | no |
Hazard Statement Domain (new in DITA 1.2)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<consequence>
|
<li>
|
yes | block | block | yes | |
<hazardstatement>
|
<note>
|
yes | block | block | yes |
@othertype , @spectitle
2
|
<hazardsymbol>
|
<image>
|
yes | block when @placement = break, otherwise inline |
block when @placement = break, otherwise inline |
yes |
removes @alt
|
<howtoavoid>
|
<li>
|
yes | block | block | yes | |
<messagepanel>
|
<ul>
|
yes | block | block | yes |
@spectitle
2
|
<typeofhazard>
|
<li>
|
yes | block | block | yes |
glossgroup elements (new in DITA 1.2)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<glossgroup>
|
<topic>
|
yes | block | block | yes |
glossref domain elements (new in DITA 1.2)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<glossref>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
abbreviated-form domain elements (new in DITA 1.2)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<abbreviated-form>
|
<term>
|
yes | inline | N/A empty element | N/A |
task requirements domain (new in DITA 1.2)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<closereqs>
|
<section> , <postreq>
|
yes | block | block | yes | |
<esttime>
|
<li>
|
yes | block | block | yes | |
<noconds>
|
<li>
|
yes | block | block | yes | |
<nosafety>
|
<li>
|
yes | block | block | yes | |
<nospares>
|
<data>
|
yes | N/A (metadata) | block | no | |
<nosupeq>
|
<data>
|
yes | N/A (metadata) | block | no | |
<nosupply>
|
<data>
|
yes | N/A (metadata) | block | no | |
<perscat>
|
<li>
|
yes | block | block | yes | |
<perskill>
|
<li>
|
yes | block | block | yes | |
<personnel>
|
<li>
|
yes | block | block | yes | |
<prelreqs>
|
<section> , <prereq>
|
yes | block | block | yes | |
<reqcond>
|
<li>
|
yes | block | block | yes | |
<reqconds>
|
<ol>
|
yes | block | block | yes | |
<reqcontp>
|
<li>
|
yes | block | block | yes | |
<reqpers>
|
<ol>
|
yes | block | block | yes | |
<safecond>
|
<li>
|
yes | block | block | yes | |
<safety>
|
<ol>
|
yes | block | block | yes | |
<spare>
|
<li>
|
yes | block | block | yes | |
<spares>
|
<p>
|
yes | block | block | yes | |
<sparesli>
|
<ul>
|
yes | block | block | yes |
@spectitle
2
|
<supeqli>
|
<ul>
|
yes | block | block | yes |
@spectitle
2
|
<supequi>
|
<li>
|
yes | block | block | yes | |
<supequip>
|
<p>
|
yes | block | block | yes | |
<supplies>
|
<p>
|
yes | block | block | yes | |
<supply>
|
<li>
|
yes | block | block | yes | |
<supplyli>
|
<ul>
|
yes | block | block | yes |
@spectitle
2
|
markup-d elements (markup domain) (new in DITA 1.3)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<markupname>
|
<keyword>
|
no | inline | inline | no |
xml-d elements (markup domain) (new in DITA 1.3)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<numcharref>
|
<keyword> , <markupname>
|
no | inline | inline | no | |
<parameterentity>
|
<keyword> , <markupname>
|
no | inline | inline | no | |
<textentity>
|
<keyword> , <markupname>
|
no | inline | inline | no | |
<xmlatt>
|
<keyword> , <markupname>
|
no | inline | inline | no | |
<xmlelement>
|
<keyword> , <markupname>
|
no | inline | inline | no | |
<xmlnsname>
|
<keyword> , <markupname>
|
no | inline | inline | no | |
<xmlpi>
|
<keyword> , <markupname>
|
no | inline | inline | no |
relmgmt-d elements (release management domain) (new in DITA 1.3)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<change-historylist>
|
<metadata>
|
NO | N/A (metadata) | N/A | no | |
<change-completed>
|
<data>
|
yes | N/A (metadata) | N/A | no | |
<change-item>
|
<data>
|
yes | N/A (metadata) | N/A | no | |
<change-person>
|
<data>
|
yes | N/A (metadata) | N/A | no | |
<change-organization>
|
<data>
|
yes | N/A (metadata) | N/A | no | |
<change-revisionid>
|
<data>
|
yes | N/A (metadata) | N/A | no | |
<change-request-reference>
|
<data>
|
yes | N/A (metadata) | N/A | no | |
<change-request-system>
|
<data>
|
yes | N/A (metadata) | N/A | no | |
<change-request-id>
|
<data>
|
yes | N/A (metadata) | N/A | no | |
<change-started>
|
<data>
|
yes | N/A (metadata) | N/A | no | |
<change-summary>
|
<data>
|
yes | N/A (metadata) | N/A | no |
equation-d elements (equation domain) (new in DITA 1.3)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<equation-inline>
|
<ph>
|
yes | inline | inline | yes | |
<equation-block>
|
<div>
|
yes | block | block | yes | |
<equation-number>
|
<ph>
|
yes | inline | inline | yes | |
<equation-figure>
|
<fig>
|
yes | block | block | yes |
mathml-d elements (MathML domain) (new in DITA 1.3)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<mathml>
|
<foreign>
|
yes | Variable: depends on math content | Depends on math content | Follow rules established for MathML standard | |
<mathmlref>
|
<xref>
|
yes | inline | N/A (empty) | no (empty) |
svg-d elements (SVG domain) (new in DITA 1.3)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<svg-container>
|
<foreign>
|
yes | Variable: depends on SVG content | Depends on SVG content | Follow rules established for SVG standard | |
<svgref>
|
<xref>
|
yes | inline | N/A (empty) | no (empty) |
classification domain elements (new in DITA 1.2)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<subjectCell>
|
<relcell>
|
yes | block | block | yes | |
<subjectref>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<topicapply>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<topicCell>
|
<relcell>
|
yes | block | block | yes | |
<topicsubject>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<topicSubjectHeader>
|
<relrow>
|
yes | block | block | yes | |
<topicSubjectRow>
|
<relrow>
|
yes | block | block | yes | |
<topicSubjectTable>
|
<reltable>
|
yes | block | block | yes |
subject scheme elements (new in DITA 1.2)
Element name | Specialized from | Inherits everything from ancestor? | Block/Inline (presentation) | Block/Inline (translation) | Translatable content? | Translatable attributes? |
---|---|---|---|---|---|---|
<attributedef>
|
<data>
|
yes | N/A (metadata | block | no | |
<defaultSubject>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<elementdef>
|
<data>
|
yes | N/A (metadata) | block | no | |
<enumerationdef>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<hasInstance>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<hasKind>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<hasNarrower>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<hasPart>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<hasRelated>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<relatedSubjects>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<subjectdef>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<subjectHead>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<subjectHeadMeta>
|
<topicmeta>
|
yes | block | block | yes | |
<schemeref>
|
<topicref>
|
yes | block | block | yes |
@navtitle
|
<subjectRel>
|
<relrow>
|
yes | block | block | yes | |
<subjectRelHeader>
|
<relrow>
|
yes | block | block | yes | |
<subjectRelTable>
|
<reltable>
|
yes | block | block | yes | |
<subjectRole>
|
<relcell>
|
yes | block | block | yes | |
<subjectScheme>
|
<map>
|
yes | block | block | yes |
removes @title
|
DITAVAL elements
The DITAVAL elements are not specialized, and are not rendered on their own, so related columns are dropped from this table. There are no translatable attributes in the DITAVAL element set.
As of DITA 1.2, the only element that directly contains text for translation is
<alt-text>
.
Element name | Block/Inline (translation) | Translatable content? |
---|---|---|
<alt-text>
|
block | yes |
<endflag>
|
block | yes (inside nested elements) |
<prop>
|
block | yes (inside nested elements) |
<revprop>
|
block | yes (inside nested elements) |
<startflag>
|
block | yes (inside nested elements) |
<style-conflict>
|
block | N/A (empty element) |
<val>
|
block | yes (inside nested elements) |
<indexterm>
,
<fn>
, and <draft-comment>
might divide a sentence in two, but should be treated as
blocks, and should not interrupt the sentence. @spectitle
and
@specentry
attributes can contain translatable text. The direct use of
fixed-in-the-DTD text by tools is discouraged, in favor of using the value as a lookup
string to find the translation outside of the file, using accepted localization methods
for generated text. <foreign>
element is likely to change for some specializations.<desc>
, <object>
,
and <image>
elements inside <foreign>
should
still be translatable; they provide an alternative display if the foreign content cannot be
processed.<foreign>
should still be translatable; they provide an alternative display if
the foreign content cannot be processed.<foreign>
element is likely to
change for some specializations.