Supported Elements

The DocBook roundtripping system supports only a subset of DocBook elements. The status of support for the various elements is shown below.

Further, DocBook elements may only be combined in certain ways. Restrictions to how elements may be used together is also noted below.

Legend: dbk:yes fully supported; dbk:no not supported; dbk:partial limited support.

Element name	Style name	Type	Comments
`abbrev`	`abbrev`	Character
`abstract`	`abstract` `abstract-title`	Paragraph	Will be included in component metadata. May be preceded by a title.
`accel`	`accel`	Character
`ackno`	`ackno`	Paragraph
`acronym`	`acronym`	Character
`action`	`action`	Character
`address`	`address`	Paragraph	Address elements will be created where necessary in metadata, but mayalso be explicit.
`affiliation`	`affiliation`	Paragraph	May be included in metadata.
`alt`	`alt`	Character
`anchor`	`anchor`	Character
`answer`	`answer`	Paragraph	Must be preceded by a `question`.
`appendix`	`appendix-title`	Paragraph
`appendixinfo`		None	Created when required for metadata.
`application`	`application`	Character
`area`	`area`	Paragraph	Must be preceded by an `areaspec` element. No content is permitted.
`areaspec`	`areaspec`	Paragraph	Only effective when used with a callout element. No content is permitted.
`arg`	`arg`	Character
`article`	`article-title` `article-subtitle` `article-titleabbrev`	Paragraph	`articleinfo` is created if required for metadata. `title`, `subtitle` and `titleabbrev` created as required.
`articleinfo`		None	See `article`.
`artpagenums`	`artpagenums`	Paragraph
`attribution`	`blockquote-attribution`	Paragraph	Only supported for use with `blockquote`. Must be preceded by `blockquote` or `blockquote-title`.
`audiodata`	`audiodata`	Paragraph
`audioobject`	`audioobject`	Paragraph
`author`	`author`	Paragraph	Child elements are defined using character styles. Any other text content is ignored.
`authorblurb`	`authorblurb`	Paragraph
`authorgroup`	`authorgroup`	Paragraph
`authorinitials`	`authorinitials`	Character
`beginpage`	`beginpage`	Paragraph
`bibliocoverage`	`bibliocoverage`	Paragraph
`bibliodiv`	`bibliodiv-title`	Paragraph	Must be preceded by `bibliography-title`. `title` element created as required.
`biblioentry`	`biblioentry-title`	Paragraph	Must be preceded by `bibliography-title`. `title` element created as required.
`biblioentry`	`biblioentry-title`	Paragraph	Must be preceded by `bibliography-title`. `title` element created as required.
`bibliography`	`bibliography-title`	Paragraph	`title` element created as required.
`bibliographyinfo`		None
`biblioid`	`biblioid`	Paragraph
`bibliolist`	`bibliolist`	Paragraph
`bibliomisc`	`bibliomisc`	Paragraph
`bibliomixed`	`bibliomixed`	Paragraph
`bibliomset`	`bibliomset`	Paragraph
`biblioref`	`biblioref`	Character
`bibliorelation`	`bibliorelation`	Paragraph
`biblioset`	`biblioset`	Paragraph
`bibliosource`	`bibliosource`	Paragraph
`blockinfo`		None	Created when necessary for metadata.
`blockquote`	`blockquote` `blockquote-title`	Paragraph	Consecutive blockquote elements are coalesced into a single `blockquote` element.
`book`	`book-title` `book-subtitle` `book-titleabbrev`	Paragraph	`bookinfo` is created if required for metadata. `title`, `subtitle` and `titleabbrev` created as required.
`bookinfo`		None	Created when required, see `book`.
`bridgehead`	`bridgehead`	Paragraph
`callout`	`callout`	Paragraph	`calloutlist` element created automatically. Consecutive `callout` elements are coalesced into a single `calloutlist` element.
`calloutlist`		None	`calloutlist` element created automatically, see `callout` element.
`caption`	`caption`	Paragraph	Must be preceded by mediaobject, table or figure.
`caution`	`caution` `caution-title`	Paragraph	Consecutive cautions are colesced into a single `caution` element.
`chapter`	`chapter-title` `chapter-subtitle` `chapter-titleabbrev`	Paragraph	`chapterinfo` is created if required for metadata. `title`, `subtitle` and `titleabbrev` created as required.
`chapterinfo`		None	Created when required, see `chapter`.
`citation`	`citation`	Character
`citebiblioid`	`citebiblioid`	Character
`citerefentry`	`citerefentry`	Character
`citetitle`	`citetitle`	Character
`city`	`city`	Character
`classname`	`classname`	Character
`classsynopsis`	`classsynopsis`	Paragraph
`classsynopsisinfo`	`classsynopsisinfo`	None
`cmdsynopsis`	`cmdsynopsis`	Paragraph
`co`	`co`	Character
`code`	`code`	Character
`col`	`col`	None
`colgroup`	`colgroup`	None
`collab`	`collab`	Character
`collabname`	`collabname`	Character
`colophon`	`colophon`	Paragraph
`colspec`	`colspec`	None	Created when required.
`command`	`command`	Character
`computeroutput`	`computeroutput`	Character
`confdates`	`confdates`	Character
`confgroup`	`confgroup`	None
`confnum`	`confnum`	Character
`confsponsor`	`confsponsor`	Character
`conftitle`	`conftitle`	Character
`constant`	`constant`	Character
`constraint`	`constraint`	Character
`constraintdef`	`constraintdef`	Character
`constructorsynopsis`	`constructorsynopsis`	Paragraph
`contractnum`	`contractnum`	Character
`contractsponsor`	`contractsponsor`	Character
`contrib`	`contrib`	Paragraph
`copyright`	`copyright`	Paragraph
`coref`	`coref`	Character
`corpauthor`	`corpauthor`	Paragraph
`corpcredit`	`corpcredit`	Character
`corpname`	`corpname`	Character
`country`	`country`	Character
`database`	`database`	Character
`date`	`date`	Character
`dedication`	`dedication`	Paragraph
`destructorsynopsis`	`destructorsynopsis`	Paragraph
`edition`	`edition`	Character
`editor`	`editor`	Paragraph
`email`	`email`	None	Created when a hyperlink refers to an email address.
`emphasis`	`emphasis` `emphasis-bold` `emphasis-underline`	Character	Also created when text is marked-up as bold, italic or underlined. The `role` attribute encodes the weight or style used.
`entry`	`entry`	None	Created for table cells.
`entrytbl`	`entrytbl`	None
`envvar`	`envvar`	Character
`epigraph`	`epigraph`	Paragraph
`equation`	`equation`	Paragraph
`errorcode`	`errorcode`	Character
`errorname`	`errorname`	Character
`errortext`	`errortext`	Character
`errortype`	`errortype`	Character
`example`	`example-title`	Paragraph	`title` element created as required. The immediately following block element is included in the example.
`exceptionname`	`exceptionname`	Character
`fax`	`fax`	Character
`fieldsynopsis`	`fieldsynopsis`	Character
`figure`	`figure-title`	Paragraph	Created for images in the document.
`filename`	`filename`	Character
`firstname`	`firstname`	Character
`firstterm`	`firstterm`	Character
`footnote`		None	Created for footnotes.
`footnoteref`	`footnoteref`	Character
`foreignphrase`	`foreignphrase`	Character
`formalpara`	`formalpara` `formalpara-title`	Paragraph	Consecutive formal paragraphs are coalesced into a single `formalpara` element.
`funcdef`	`funcdef`	Character
`funcparams`	`funcparams`	Character
`funcprototype`	`funcprototype`	Character
`funcsynposis`	`funcsynopsis`	Paragraph
`funcsynopsisinfo`	`funcsynopsisinfo`	None
`function`	`function`	Character
`glossary`	`glossary-title`	Paragraph
`glossaryinfo`		Character
`glossdef`	`glossdef`	Paragraph
`glossdiv`	`glossdiv-title`	Paragraph
`glossentry`	`glossentry`	Paragraph
`glosslist`	`glosslist`	Paragraph
`glosssee`	`glosssee`	Character
`glossseealso`	`glossseealso`	Character
`glossterm`	`glossterm`	Paragraph
`graphic`	`graphic`	Paragraph
`graphicco`	`graphicco`	Paragraph
`group`	`group`	Paragraph
`guibutton`	`guibutton`	Paragraph
`guiicon`	`guiicon`	Paragraph
`guilabel`	`guilabel`	Paragraph
`guimenu`	`guimenu`	Paragraph
`guimenuitem`	`guimenuitem`	Paragraph
`guisubmenu`	`guisubmenu`	Paragraph
`hardware`	`hardware`	Character
`highlights`	`highlights` `highlights-caution` `highlights-important` `highlights-itemizedlist` `highlights-note` `highlights-orderedlist` `highlights-tip` `highlights-warning`	Paragraph	Consecutive elements are coalesced into a single `highlights` element.
`holder`	`holder`	Character
`honorific`	`honorific`	Character
`html:form`	`html:form`	Paragraph
`imagedata`		Character	See `informalfigure`, `imageobject` or `mediaobject`.
`imageobject`	`imageobject-imagedata`	Paragraph	Also creates `imagedata` element. The content of the paragraph becomes the value of the `imagedata` element's `fileref` attribute.
`imageobjectco`	`imageobjectco-imagedata`	Paragraph	Also creates `imagedata` element. The content of the paragraph becomes the value of the `imagedata` element's `fileref` attribute.
`important`	`important` `important-title`	Paragraph	Consecutive important paragraphs are coalesced into a single `important` element.
`index`	`index-title`	Paragraph
`indexdiv`	`indexdiv-title`	Paragraph
`indexentry`	`indexentry-title`	Paragraph
`indexinfo`		None
`indexterm`		Character	Created by index terms in the document.
`informalequation`	`informalequation`	Paragraph
`informalexample`	`informalexample`	Paragraph
`informalfigure`	`informalfigure-imagedata`	Paragraph	`imageobject` and `imagedata` elements created as required.
`informaltable`		None	Created for a table in the document.
`initializer`	`initializer`	Character
`inlineequation`	`inlinequation`	Character
`inlinegraphic`	`inlinegraphic`	Character
`inlinemediaobject`	`inlinemediaobject`	Character
`interface`	`interface`	Character
`interfacename`	`interfacename`	Character
`invpartnumber`	`invpartnumber`	Character
`isbn`	`isbn`	Paragraph
`issn`	`issn`	Paragraph
`issuenum`	`issuenum`	Character
`itemizedlist`	`itemizedlist` `itemizedlist1` `itemizedlist2` `itemizedlist3` `itemizedlist4`	Paragraph	Itemizedlist (bullet) list with nesting. Trailing digit refers to nesting level. Consecutive elements are coalesced into a single list element. `para-continue` style paragraphs become separate paragraphs within a list item.
`itermset`	`itermset`	None
`jobtitle`	`jobtitle`	Character
`keycap`	`keycap`	Character
`keycode`	`keycode`	Character
`keycombo`	`keycombo`	Character
`keysym`	`keysym`	Character
`keyword`	`keyword`	Character
`keywordset`	`keywordset`	Paragraph
`label`	`label`	Character
`legalnotice`	`legalnotice`	Paragraph
`lhs`	`lhs`	Character
`lineage`	`lineage`	Character
`lineannotation`	`lineannotation`	Character
`link`	`link`	Character	Created for hyperlinks.
`listitem`		None	Created automatically in lists.
`literal`	`literal`	Character
`literallayout`	`literallayout`	Paragraph	Line breaks are preserved in content. Consecutive literal layout paragraphs are coalesced into a single `literallayout`element.
`lot`	`lot`	Paragraph
`lotentry`	`lotentry`	Paragraph
`manvolnum`	`manvolnum`	Character
`markup`	`markup`	Character
`medialabel`	`medialabel`	Character
`mediaobject`	`mediaobject-title`	Paragraph	Following image and/or text objects are included in the `mediaobject` element.
`mediaobjectco`	`mediaobjectco`	Paragraph	Following image object callout is included in the `mediaobjectco`.
`member`	`member`	Paragraph
`menuchoice`	`menuchoice`	Character
`methodname`	`methodname`	Character
`methodparam`	`methodparam`	Character
`methodsynopsis`	`methodsynopsis`	Paragraph
`mml:math`	`mml:math`	Paragraph
`modespec`	`modespec`	Character
`modifier`	`modifier`	Character
`mousebutton`	`mousebutton`	Character
`msg`	`msg`	Paragraph
`msgaud`	`msgaud`	Character
`msgentry`	`msgentry`	Paragraph
`msgexplan`	`msgexplan`	Paragraph
`msginfo`	`msginfo`	None
`msglevel`	`msglevel`	Character
`msgmain`	`msgmain`	Paragraph
`msgorig`	`msgorig`	Character
`msgrel`	`msgrel`	Character
`msgset`	`msgset`	Paragraph
`msgsub`	`msgsub`	Character
`msgtext`	`msgtext`	Character
`nonterminal`	`nonterminal`	Character
`note`	`note`	Paragraph	Consecutive note paragraphs are coalesced into a single `note` element.
`objectinfo`	`objectinfo`	None	Created when required.
`olink`	`olink`	Character	Created from hyperlinks.
`ooclass`	`ooclass`	Character
`ooexception`	`ooexception`	Character
`oointerface`	`oointerface`	Character
`option`	`option`	Character
`optional`	`optional`	Character
`orderedlist`	`orderedlist` `orderedlist1` `orderedlist2` `orderedlist3` `orderedlist4`	Paragraph	Orderedlist (number) list with nesting. Trailing digit refers to nesting level. Consecutive elements are coalesced into a single list element. `para-continue` style paragraphs become separate paragraphs within a list item.
`orgdiv`	`orgdiv`	Character
`orgname`	`orgname`	Character
`otheraddr`	`otheraddr`	Character	May be automatically created when required.
`othercredit`	`othercredit`	Character
`othername`	`othername`	Character
`package`	`package`	Character
`pagenums`	`pagenums`	Character
`para`	`para`	Paragraph	May be created automatically when required. Paragraphs without a style use this element.
`paramdef`	`paramdef`	Character
`parameter`	`parameter`	Character
`part`	`part-title`	Paragraph	`partinfo` element is created when required.
`partinfo`		None	See `part`.
`partintro`	`partintro`	Paragraph
`personblurb`	`personblurb`	Paragraph
`personname`	`personname`	Character
`phone`	`phone`	Character
`phrase`	`phrase`	Character
`pob`	`pob`	Character
`postcode`	`postcode`	Character
`preface`	`preface-title`	Paragraph
`prefaceinfo`	`prefaceinfo`	None	See `preface`.
`primary`		None	See `indexterm`
`primaryie`	`primaryie`	Character
`printhistory`	`printhistory`	Paragraph
`procedure`	`procedure`	Paragraph
`production`	`production`	Character
`productionrecap`	`productionrecap`	Character
`productionset`	`productionset`	Character
`productionname`	`productionname`	Character
`productnumber`	`productnumber`	Character
`programlisting`	`programlisting`	Paragraph	Line breaks within the content are preserved. Consecutive paragraphs are coalesced into a single `programlisting` element.
`programlistingco`	`programlistingco`	Paragraph	Line breaks within the content are preserved. Consecutive paragraphs are coalesced into a single `programlistingco` element.
`prompt`	`prompt`	Character
`property`	`property`	Character
`pubdate`	`pubdate`	Paragraph
`publisher`	`publisher`	Paragraph
`publishername`	`publishername`	Paragraph
`pubsnumber`	`pubsnumber`	Character
`qandadiv`	`qandadiv-title`	Paragraph	Must be preceded by a `qandaset-title`.
`qandaentry`	`qandaentry-title`	Paragraph	Must be preceded by a `qandaset-title`. This element is created for a `question` element.
`qandaset`	`qandaset-title`	Paragraph
`question`	`question`	Paragraph	Must be preceded by `qandaset-title`. `qandaentry` element is created as required.
`quote`	`quote`	Character
`refclass`	`refclass`	Character
`refdescriptor`	`refdescriptor`	Paragraph
`refentry`	`refentry`	Paragraph
`refentryinfo`		None
`refentrytitle`	`refentrytitle`	Paragraph
`reference`	`reference-title`	Paragraph
`referenceinfo`		None
`refmeta`	`refmeta`	None
`refmiscinfo`	`refmiscinfo`	Character
`refname`	`refname`	Paragraph
`refnamediv`	`refnamediv`	Paragraph
`refpurpose`	`refpurpose`	Paragraph
`refsect1`	`refsect1-title`	Paragraph
`refsect1info`		None
`refsect2`	`refsect2-title`	Paragraph
`refsect2info`		None
`refsect3`	`refsect3-title`	Paragraph
`refsect3info`		None
`refsection`	`refsection-title`	Paragraph
`refsectioninfo`		None
`refsynopsisdiv`	`refsynopsisdiv-title`	Paragraph
`refsynopsisdivinfo`		None
`releaseinfo`	`releaseinfo`	Paragraph
`remark`	`remark`	Character
`replaceable`	`replaceable`	Character
`returnvalue`	`returnvalue`	Character
`revdescription`	`revdescription`	Paragraph
`revhistory`		None	Created as required.
`revision`	`revision`	Paragraph	Revision data is specified by character styles. Any other content is discarded.
`revnumber`	`revnumber`	Character
`revremark`	`revremark`	Paragraph	Must be preceded by `revision` paragraph.
`rhs`	`rhs`	Character
`row`		None	Created as required in tables.
`sbr`	`sbr`	Character
`screen`	`screen`	Paragraph
`screenco`	`screenco`	Paragraph
`screeninfo`	`screeninfo`	Paragraph
`screenshot`	`screenshot`	Paragraph
`secondary`	`secondary`	Character	See `indexterm`.
`secondaryie`	`secondaryie`	Character
`sect1`	`sect1-title` `sect1-subtitle`	Paragraph
`sect1info`		Paragraph	Created as required for metadata.
`sect2`	`sect2-title` `sect2-subtitle`	Paragraph
`sect2info`		Paragraph	Created as required for metadata.
`sect3`	`sect3-title` `sect3-subtitle`	Paragraph
`sect3info`		Paragraph	Created as required for metadata.
`sect4`	`sect4-title` `sect4-subtitle`	Paragraph
`sect4info`		Paragraph	Created as required for metadata.
`sect5`	`sect5-title` `sect5-subtitle`	Paragraph
`sect5info`		Paragraph	Created as required for metadata.
`section`	`section-title` `section-subtitle` `section-titleabbrev`	Paragraph
`sectioninfo`		Paragraph	Created as required for metadata.
`see`	`see`	Character
`seealso`	`seealso`	Character
`seealsoie`	`seealsoie`	Character
`seeie`	`seeie`	Character
`seg`	`seg`	Paragraph
`seglistitem`	`seglistitem`	Paragraph
`segmentedlist`		None
`segtitle`	`segtitle`	Paragraph
`seriesvolnums`	`seriesvolnums`	Paragraph
`set`	`set-title`	Paragraph
`setindex`	`setindex-title`	Paragraph
`setindexinfo`		None
`sgmltag`	`sgmltag`	Character
`shortaffil`	`shortaffil`	Character
`shortcut`	`shortcut`	Character
`sidebar`	`sidebar-title`	Paragraph
`sidebarinfo`		None
`simpara`	`simpara`	Paragraph
`simplelist`	`simplelist`	Paragraph
`simplemsgentry`	`simplemsgentry`	Paragraph
`simplesect`	`simplesect-title` `simplesect-subtitle`	Paragraph
`spanspec`		None
`state`	`state`	Character
`step`	`step`	Character
`stepalternatives`	`stepalternatives`	Character
`street`	`street`	Character
`structfield`	`structfield`	Character
`structname`	`structname`	Character
`subject`	`subject`	Character
`subjectset`	`subjectset`	Character
`subjectterm`	`subjectterm`	Character
`subscript`	`subscript`	Character
`substeps`	`substeps`	Character
`subtitle`		Paragraph	See component element.
`superscript`	`superscript`	Character
`surname`	`surname`	Character
`svg:svg`	`svg:svg`	Character
`symbol`	`symbol`	Character
`synopfragment`	`synopfragment`	Character
`synopfragmentref`	`synopfragmentref`	Character
`synopsis`	`synopsis`	Character
`systemitem`	`systemitem`	Character
`table`		None	Tables in the document are encoded using this element.
`task`	`task`	Paragraph
`taskprerequisites`	`taskprerequisites`	Paragraph
`taskrelated`	`taskrelated`	Paragraph
`tasksummary`	`tasksummary`	Paragraph
`tbody`		None	Created as required for tables.
`td`		None	See `entry`.
`term`	`variablelist-term`	Paragraph	See `variablelist`.
`tertiary`		Character	See `indexterm`.
`tertiaryie`	`tertiaryie`	Paragraph
`textdata`		Paragraph	See `textobject`.
`textobject`	`textobject-title`	Paragraph	Creates a `mediaobject` and `textdata` elements as required. Immediately following paragraph becomes part of the text data.
`tfoot`	`tfoot`	Paragraph
`tgroup`		None	Created as required for tables. See `table`.
`th`	`th`	Paragraph
`tip`	`tip` `tip-title`	Paragraph	Consecutive tip paragraphs are coalesced into a single `tip` element.
`title`		Paragraph	See component and division elements.
`titleabbrev`		Paragraph	See component and division elements.
`toc`	`toc-title`	Paragraph
`tocback`	`tocback`	Paragraph
`tocchap`	`tocchap`	Paragraph
`tocentry`	`tocentry`	Paragraph
`tocfront`	`tocfront`	Paragraph
`toclevel1`	`toclevel1`	Paragraph
`toclevel2`	`toclevel2`	Paragraph
`toclevel3`	`toclevel3`	Paragraph
`toclevel4`	`toclevel4`	Paragraph
`toclevel5`	`toclevel5`	Paragraph
`tocpart`	`tocpart`	Paragraph
`token`	`token`	Character
`tr`		None
`trademark`	`trademark`	Character
`type`	`type`	Character
`ulink`	`ulink`	Character	Created from hyperlinks, or explicitly.
`uri`	`uri`	Character
`userinput`	`userinput`	Character
`varargs`	`varargs`	Paragraph
`variablelist`	`variablelist-term` `variablelist-title` `variablelist-titleabbrev`	Paragraph	Consecutive terms are coalesced into a single `variablelist`. `varlistentry` elements are created as required.
`varlistentry`		Paragraph	See `variablelist`.
`varname`	`varname`	Character
`videodata`	`videodata`	Paragraph
`videoobject`	`videoobject`	Paragraph
`void`	`void`	Character
`volumenum`	`volumenum`	Character
`warning`	`warning` `warning-title`	Paragraph	Consecutive paragraphs are coalesced into a single `warning`element.
`wordasword`	`wordasword`	Character
`xref`	`xref`	Character
`year`	`year`	Character