This contains a list of all current TC-approved elements, divided
up by module. It describes which are block elements and which are inline,
and lists which elements should be translated by default.
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 default should be 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 may 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 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.
topic elements
| Element name |
Specialized from |
Block/Inline (presentation) |
Block/Inline (translation) |
Translatable content? |
Translatable attributes? |
| alt |
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 |
|
| 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 |
|
| dd |
N/A |
block |
block |
yes |
|
| ddhd |
N/A |
block |
block |
yes |
|
| desc |
N/A |
block |
block |
yes |
|
| dl |
N/A |
block |
block |
yes |
@spectitle2 |
| 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 |
@spectitle2 |
| featnum |
N/A |
block (metadata) |
block |
yes |
|
| fig |
N/A |
block |
block |
yes |
@spectitle2 |
| figgroup |
N/A |
block |
block |
yes |
|
| fn |
N/A |
block***1 |
block |
yes |
|
| image |
N/A |
block when @placement=break, otherwise inline |
block when @placement=break, otherwise inline |
yes |
@alt3 |
| 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 |
yes |
|
| keywords |
N/A |
block |
block |
yes |
|
| li |
N/A |
block |
block |
yes |
|
| lines |
N/A |
block |
block |
yes |
@spectitle2 |
| link |
N/A |
block |
block |
yes |
|
| linkinfo |
N/A |
block |
block |
yes |
|
| linklist |
N/A |
block |
block |
yes |
@spectitle2 |
| 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, @spectitle2 |
| object |
N/A |
block |
block |
yes |
@standby |
| ol |
N/A |
block |
block |
yes |
@spectitle2 |
| 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 |
@spectitle2 |
| 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 |
@spectitle2 |
| series |
N/A |
block (metadata) |
block |
yes |
|
| shortdesc |
N/A |
block |
block |
yes |
|
| simpletable |
N/A |
block |
block |
yes |
@spectitle2 |
| sl |
N/A |
block |
block |
yes |
@spectitle2 |
| 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 |
@specentry2 |
| 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 |
|
| 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 |
@spectitle2 |
| vrm |
N/A |
block (metadata) |
block |
yes |
|
| vrmlist |
N/A |
block (metadata) |
block |
yes |
|
| xref |
N/A |
inline |
inline |
yes |
|
map elements
| 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 |
| 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 |
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 |
|
| concept |
topic |
yes |
block |
block |
yes |
|
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 |
@specentry2 |
| propdeschd |
stentry |
yes |
block |
block |
yes |
@specentry2 |
| properties |
simpletable |
yes |
block |
block |
yes |
@spectitle2 |
| property |
strow |
yes |
block |
block |
yes |
|
| prophead |
sthead |
yes |
block |
block |
yes |
|
| proptype |
stentry |
yes |
block |
block |
yes |
@specentry2 |
| proptypehd |
stentry |
yes |
block |
block |
yes |
@specentry2 |
| propvalue |
stentry |
yes |
block |
block |
yes |
@specentry2 |
| propvaluehd |
stentry |
yes |
block |
block |
yes |
@specentry2 |
| refbody |
body |
yes |
block |
block |
yes |
|
| reference |
topic |
yes |
block |
block |
yes |
|
| refsyn |
section |
yes |
block |
block |
yes |
@spectitle2 |
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 |
@specentry2 |
| chdeschd |
stentry |
yes |
block |
block |
yes |
@specentry2 |
| 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 |
@spectitle2 |
| choption |
stentry |
yes |
block |
block |
yes |
@specentry2 |
| choptionhd |
stentry |
yes |
block |
block |
yes |
@specentry2 |
| 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-unordered |
ul |
yes |
block |
block |
yes |
removes @spectitle |
| 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 |
|
| tutorialinfo |
itemgroup |
NO |
inline |
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 |
|
| i |
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 |
|
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 |
@spectitle2 |
| codeph |
ph |
yes |
inline |
inline |
yes |
|
| 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 |
@spectitle2 |
| 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 |
@spectitle2 |
| 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 |
@spectitle2 |
| 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) |
@spectitle2 |
| shape |
keyword |
NO |
inline |
inline |
no |
|
mapgroup-d elements (mapgroup domain)
| Element name |
Specialized from |
Inherits everything from ancestor? |
Block/Inline (presentation) |
Block/Inline (translation) |
Translatable content? |
Translatable attributes? |
| topicgroup |
topicref |
yes |
block |
block |
yes |
@navtitle |
| topichead |
topicref |
yes |
block |
block |
yes |
@navtitle |
1 This element is considered a "subflow"
element for translation. If it is located in the middle of a translation segment,
it should not be translated as part of that segment. For example, indexterm,
fn, and draft-comment may divide a sentence in two, but should be treated
as blocks, and should not interrupt the sentence.
2 The 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.