explain home explain home explain home explain homeexplain banner
Explanations - about explain | XML training | Consulting | XML resources | Publications | Open Source Software

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

Support status

Type

Comments

abbrev

abbrev

Not Supported

Character

abstract

abstract

abstract-title

Supported

Paragraph

Will be included in component metadata. May be preceded by a title.

accel

accel

Not Supported

Character

ackno

ackno

Not Supported

Paragraph

acronym

acronym

Not Supported

Character

action

action

Not Supported

Character

address

address

Supported

Paragraph

Address elements will be created where necessary in metadata, but mayalso be explicit.

affiliation

affiliation

Supported

Paragraph

May be included in metadata.

alt

alt

Not Supported

Character

anchor

anchor

Not Supported

Character

answer

answer

Supported

Paragraph

Must be preceded by a question.

appendix

appendix-title

Supported

Paragraph

appendixinfo

Supported

None

Created when required for metadata.

application

application

Supported

Character

area

area

Supported

Paragraph

Must be preceded by an areaspec element. No content is permitted.

areaspec

areaspec

Supported

Paragraph

Only effective when used with a callout element. No content is permitted.

arg

arg

Not Supported

Character

article

article-title

article-subtitle

article-titleabbrev

Supported

Paragraph

articleinfo is created if required for metadata. title, subtitle and titleabbrev created as required.

articleinfo

Supported

None

See article.

artpagenums

artpagenums

Not Supported

Paragraph

attribution

blockquote-attribution

Partial Support

Paragraph

Only supported for use with blockquote. Must be preceded by blockquote or blockquote-title.

audiodata

audiodata

Not Supported

Paragraph

audioobject

audioobject

Not Supported

Paragraph

author

author

Supported

Paragraph

Child elements are defined using character styles. Any other text content is ignored.

authorblurb

authorblurb

Not Supported

Paragraph

authorgroup

authorgroup

Not Supported

Paragraph

authorinitials

authorinitials

Supported

Character

beginpage

beginpage

Not Supported

Paragraph

bibliocoverage

bibliocoverage

Not Supported

Paragraph

bibliodiv

bibliodiv-title

Supported

Paragraph

Must be preceded by bibliography-title. title element created as required.

biblioentry

biblioentry-title

Supported

Paragraph

Must be preceded by bibliography-title. title element created as required.

biblioentry

biblioentry-title

Supported

Paragraph

Must be preceded by bibliography-title. title element created as required.

bibliography

bibliography-title

Supported

Paragraph

title element created as required.

bibliographyinfo

Not Supported

None

biblioid

biblioid

Not Supported

Paragraph

bibliolist

bibliolist

Not Supported

Paragraph

bibliomisc

bibliomisc

Supported

Paragraph

bibliomixed

bibliomixed

Not Supported

Paragraph

bibliomset

bibliomset

Not Supported

Paragraph

biblioref

biblioref

Not Supported

Character

bibliorelation

bibliorelation

Supported

Paragraph

biblioset

biblioset

Not Supported

Paragraph

bibliosource

bibliosource

Not Supported

Paragraph

blockinfo

Partial Support

None

Created when necessary for metadata.

blockquote

blockquote

blockquote-title

Supported

Paragraph

Consecutive blockquote elements are coalesced into a single blockquote element.

book

book-title

book-subtitle

book-titleabbrev

Supported

Paragraph

bookinfo is created if required for metadata. title, subtitle and titleabbrev created as required.

bookinfo

Supported

None

Created when required, see book.

bridgehead

bridgehead

Supported

Paragraph

callout

callout

Supported

Paragraph

calloutlist element created automatically. Consecutive callout elements are coalesced into a single calloutlist element.

calloutlist

Supported

None

calloutlist element created automatically, see callout element.

caption

caption

Supported

Paragraph

Must be preceded by mediaobject, table or figure.

caution

caution

caution-title

Supported

Paragraph

Consecutive cautions are colesced into a single caution element.

chapter

chapter-title

chapter-subtitle

chapter-titleabbrev

Supported

Paragraph

chapterinfo is created if required for metadata. title, subtitle and titleabbrev created as required.

chapterinfo

Supported

None

Created when required, see chapter.

citation

citation

Not Supported

Character

citebiblioid

citebiblioid

Not Supported

Character

citerefentry

citerefentry

Not Supported

Character

citetitle

citetitle

Supported

Character

city

city

Supported

Character

classname

classname

Not Supported

Character

classsynopsis

classsynopsis

Not Supported

Paragraph

classsynopsisinfo

classsynopsisinfo

Not Supported

None

cmdsynopsis

cmdsynopsis

Not Supported

Paragraph

co

co

Not Supported

Character

code

code

Not Supported

Character

col

col

Not Supported

None

colgroup

colgroup

Not Supported

None

collab

collab

Not Supported

Character

collabname

collabname

Not Supported

Character

colophon

colophon

Not Supported

Paragraph

colspec

colspec

Supported

None

Created when required.

command

command

Not Supported

Character

computeroutput

computeroutput

Not Supported

Character

confdates

confdates

Not Supported

Character

confgroup

confgroup

Not Supported

None

confnum

confnum

Not Supported

Character

confsponsor

confsponsor

Not Supported

Character

conftitle

conftitle

Not Supported

Character

constant

constant

Not Supported

Character

constraint

constraint

Not Supported

Character

constraintdef

constraintdef

Not Supported

Character

constructorsynopsis

constructorsynopsis

Not Supported

Paragraph

contractnum

contractnum

Not Supported

Character

contractsponsor

contractsponsor

Not Supported

Character

contrib

contrib

Not Supported

Paragraph

copyright

copyright

Not Supported

Paragraph

coref

coref

Not Supported

Character

corpauthor

corpauthor

Not Supported

Paragraph

corpcredit

corpcredit

Not Supported

Character

corpname

corpname

Not Supported

Character

country

country

Supported

Character

database

database

Not Supported

Character

date

date

Supported

Character

dedication

dedication

Not Supported

Paragraph

destructorsynopsis

destructorsynopsis

Not Supported

Paragraph

edition

edition

Not Supported

Character

editor

editor

Not Supported

Paragraph

email

email

Supported

None

Created when a hyperlink refers to an email address.

emphasis

emphasis

emphasis-bold

emphasis-underline

Supported

Character

Also created when text is marked-up as bold, italic or underlined. The role attribute encodes the weight or style used.

entry

entry

Supported

None

Created for table cells.

entrytbl

entrytbl

Not Supported

None

envvar

envvar

Not Supported

Character

epigraph

epigraph

Not Supported

Paragraph

equation

equation

Not Supported

Paragraph

errorcode

errorcode

Not Supported

Character

errorname

errorname

Not Supported

Character

errortext

errortext

Not Supported

Character

errortype

errortype

Not Supported

Character

example

example-title

Supported

Paragraph

title element created as required. The immediately following block element is included in the example.

exceptionname

exceptionname

Not Supported

Character

fax

fax

Supported

Character

fieldsynopsis

fieldsynopsis

Not Supported

Character

figure

figure-title

Supported

Paragraph

Created for images in the document.

filename

filename

Supported

Character

firstname

firstname

Supported

Character

firstterm

firstterm

Not Supported

Character

footnote

Supported

None

Created for footnotes.

footnoteref

footnoteref

Not Supported

Character

foreignphrase

foreignphrase

Not Supported

Character

formalpara

formalpara

formalpara-title

Supported

Paragraph

Consecutive formal paragraphs are coalesced into a single formalpara element.

funcdef

funcdef

Not Supported

Character

funcparams

funcparams

Not Supported

Character

funcprototype

funcprototype

Not Supported

Character

funcsynposis

funcsynopsis

Not Supported

Paragraph

funcsynopsisinfo

funcsynopsisinfo

Not Supported

None

function

function

Not Supported

Character

glossary

glossary-title

Supported

Paragraph

glossaryinfo

Not Supported

Character

glossdef

glossdef

Not Supported

Paragraph

glossdiv

glossdiv-title

Not Supported

Paragraph

glossentry

glossentry

Not Supported

Paragraph

glosslist

glosslist

Not Supported

Paragraph

glosssee

glosssee

Not Supported

Character

glossseealso

glossseealso

Not Supported

Character

glossterm

glossterm

Not Supported

Paragraph

graphic

graphic

Not Supported

Paragraph

graphicco

graphicco

Not Supported

Paragraph

group

group

Not Supported

Paragraph

guibutton

guibutton

Not Supported

Paragraph

guiicon

guiicon

Not Supported

Paragraph

guilabel

guilabel

Not Supported

Paragraph

guimenu

guimenu

Not Supported

Paragraph

guimenuitem

guimenuitem

Not Supported

Paragraph

guisubmenu

guisubmenu

Not Supported

Paragraph

hardware

hardware

Not Supported

Character

highlights

highlights

highlights-caution

highlights-important

highlights-itemizedlist

highlights-note

highlights-orderedlist

highlights-tip

highlights-warning

Supported

Paragraph

Consecutive elements are coalesced into a single highlights element.

holder

holder

Not Supported

Character

honorific

honorific

Supported

Character

html:form

html:form

Not Supported

Paragraph

imagedata

Supported

Character

See informalfigure, imageobject or mediaobject.

imageobject

imageobject-imagedata

Supported

Paragraph

Also creates imagedata element. The content of the paragraph becomes the value of the imagedata element's fileref attribute.

imageobjectco

imageobjectco-imagedata

Supported

Paragraph

Also creates imagedata element. The content of the paragraph becomes the value of the imagedata element's fileref attribute.

important

important

important-title

Supported

Paragraph

Consecutive important paragraphs are coalesced into a single important element.

index

index-title

Supported

Paragraph

indexdiv

indexdiv-title

Not Supported

Paragraph

indexentry

indexentry-title

Not Supported

Paragraph

indexinfo

Not Supported

None

indexterm

Supported

Character

Created by index terms in the document.

informalequation

informalequation

Not Supported

Paragraph

informalexample

informalexample

Not Supported

Paragraph

informalfigure

informalfigure-imagedata

Supported

Paragraph

imageobject and imagedata elements created as required.

informaltable

Supported

None

Created for a table in the document.

initializer

initializer

Not Supported

Character

inlineequation

inlinequation

Not Supported

Character

inlinegraphic

inlinegraphic

Not Supported

Character

inlinemediaobject

inlinemediaobject

Not Supported

Character

interface

interface

Not Supported

Character

interfacename

interfacename

Not Supported

Character

invpartnumber

invpartnumber

Not Supported

Character

isbn

isbn

Supported

Paragraph

issn

issn

Not Supported

Paragraph

issuenum

issuenum

Not Supported

Character

itemizedlist

itemizedlist

itemizedlist1

itemizedlist2

itemizedlist3

itemizedlist4

Supported

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

Not Supported

None

jobtitle

jobtitle

Supported

Character

keycap

keycap

Not Supported

Character

keycode

keycode

Not Supported

Character

keycombo

keycombo

Not Supported

Character

keysym

keysym

Not Supported

Character

keyword

keyword

Not Supported

Character

keywordset

keywordset

Not Supported

Paragraph

label

label

Not Supported

Character

legalnotice

legalnotice

Not Supported

Paragraph

lhs

lhs

Not Supported

Character

lineage

lineage

Supported

Character

lineannotation

lineannotation

Not Supported

Character

link

link

Supported

Character

Created for hyperlinks.

listitem

Supported

None

Created automatically in lists.

literal

literal

Supported

Character

literallayout

literallayout

Supported

Paragraph

Line breaks are preserved in content. Consecutive literal layout paragraphs are coalesced into a single literallayoutelement.

lot

lot

Not Supported

Paragraph

lotentry

lotentry

Not Supported

Paragraph

manvolnum

manvolnum

Not Supported

Character

markup

markup

Not Supported

Character

medialabel

medialabel

Not Supported

Character

mediaobject

mediaobject-title

Supported

Paragraph

Following image and/or text objects are included in the mediaobject element.

mediaobjectco

mediaobjectco

Supported

Paragraph

Following image object callout is included in the mediaobjectco.

member

member

Not Supported

Paragraph

menuchoice

menuchoice

Not Supported

Character

methodname

methodname

Not Supported

Character

methodparam

methodparam

Not Supported

Character

methodsynopsis

methodsynopsis

Not Supported

Paragraph

mml:math

mml:math

Not Supported

Paragraph

modespec

modespec

Not Supported

Character

modifier

modifier

Not Supported

Character

mousebutton

mousebutton

Not Supported

Character

msg

msg

Not Supported

Paragraph

msgaud

msgaud

Not Supported

Character

msgentry

msgentry

Not Supported

Paragraph

msgexplan

msgexplan

Not Supported

Paragraph

msginfo

msginfo

Not Supported

None

msglevel

msglevel

Not Supported

Character

msgmain

msgmain

Not Supported

Paragraph

msgorig

msgorig

Not Supported

Character

msgrel

msgrel

Not Supported

Character

msgset

msgset

Not Supported

Paragraph

msgsub

msgsub

Not Supported

Character

msgtext

msgtext

Not Supported

Character

nonterminal

nonterminal

Not Supported

Character

note

note

Supported

Paragraph

Consecutive note paragraphs are coalesced into a single note element.

objectinfo

objectinfo

Supported

None

Created when required.

olink

olink

Supported

Character

Created from hyperlinks.

ooclass

ooclass

Not Supported

Character

ooexception

ooexception

Not Supported

Character

oointerface

oointerface

Not Supported

Character

option

option

Not Supported

Character

optional

optional

Not Supported

Character

orderedlist

orderedlist

orderedlist1

orderedlist2

orderedlist3

orderedlist4

Supported

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

Not Supported

Character

orgname

orgname

Supported

Character

otheraddr

otheraddr

Supported

Character

May be automatically created when required.

othercredit

othercredit

Not Supported

Character

othername

othername

Not Supported

Character

package

package

Not Supported

Character

pagenums

pagenums

Not Supported

Character

para

para

Supported

Paragraph

May be created automatically when required. Paragraphs without a style use this element.

paramdef

paramdef

Not Supported

Character

parameter

parameter

Not Supported

Character

part

part-title

Supported

Paragraph

partinfo element is created when required.

partinfo

Supported

None

See part.

partintro

partintro

Not Supported

Paragraph

personblurb

personblurb

Not Supported

Paragraph

personname

personname

Not Supported

Character

phone

phone

Not Supported

Character

phrase

phrase

Not Supported

Character

pob

pob

Not Supported

Character

postcode

postcode

Not Supported

Character

preface

preface-title

Supported

Paragraph

prefaceinfo

prefaceinfo

Supported

None

See preface.

primary

Partial Support

None

See indexterm

primaryie

primaryie

Not Supported

Character

printhistory

printhistory

Not Supported

Paragraph

procedure

procedure

Not Supported

Paragraph

production

production

Not Supported

Character

productionrecap

productionrecap

Not Supported

Character

productionset

productionset

Not Supported

Character

productionname

productionname

Not Supported

Character

productnumber

productnumber

Not Supported

Character

programlisting

programlisting

Supported

Paragraph

Line breaks within the content are preserved. Consecutive paragraphs are coalesced into a single programlisting element.

programlistingco

programlistingco

Supported

Paragraph

Line breaks within the content are preserved. Consecutive paragraphs are coalesced into a single programlistingco element.

prompt

prompt

Not Supported

Character

property

property

Not Supported

Character

pubdate

pubdate

Not Supported

Paragraph

publisher

publisher

Not Supported

Paragraph

publishername

publishername

Supported

Paragraph

pubsnumber

pubsnumber

Not Supported

Character

qandadiv

qandadiv-title

Supported

Paragraph

Must be preceded by a qandaset-title.

qandaentry

qandaentry-title

Supported

Paragraph

Must be preceded by a qandaset-title. This element is created for a question element.

qandaset

qandaset-title

Supported

Paragraph

question

question

Supported

Paragraph

Must be preceded by qandaset-title. qandaentry element is created as required.

quote

quote

Not Supported

Character

refclass

refclass

Not Supported

Character

refdescriptor

refdescriptor

Not Supported

Paragraph

refentry

refentry

Not Supported

Paragraph

refentryinfo

Not Supported

None

refentrytitle

refentrytitle

Not Supported

Paragraph

reference

reference-title

Not Supported

Paragraph

referenceinfo

Not Supported

None

refmeta

refmeta

Not Supported

None

refmiscinfo

refmiscinfo

Not Supported

Character

refname

refname

Not Supported

Paragraph

refnamediv

refnamediv

Not Supported

Paragraph

refpurpose

refpurpose

Not Supported

Paragraph

refsect1

refsect1-title

Not Supported

Paragraph

refsect1info

Not Supported

None

refsect2

refsect2-title

Not Supported

Paragraph

refsect2info

Not Supported

None

refsect3

refsect3-title

Not Supported

Paragraph

refsect3info

Not Supported

None

refsection

refsection-title

Not Supported

Paragraph

refsectioninfo

Not Supported

None

refsynopsisdiv

refsynopsisdiv-title

Not Supported

Paragraph

refsynopsisdivinfo

Not Supported

None

releaseinfo

releaseinfo

Supported

Paragraph

remark

remark

Not Supported

Character

replaceable

replaceable

Not Supported

Character

returnvalue

returnvalue

Not Supported

Character

revdescription

revdescription

Not Supported

Paragraph

revhistory

Supported

None

Created as required.

revision

revision

Supported

Paragraph

Revision data is specified by character styles. Any other content is discarded.

revnumber

revnumber

Supported

Character

revremark

revremark

Supported

Paragraph

Must be preceded by revision paragraph.

rhs

rhs

Not Supported

Character

row

Supported

None

Created as required in tables.

sbr

sbr

Not Supported

Character

screen

screen

Not Supported

Paragraph

screenco

screenco

Not Supported

Paragraph

screeninfo

screeninfo

Not Supported

Paragraph

screenshot

screenshot

Not Supported

Paragraph

secondary

secondary

Partial Support

Character

See indexterm.

secondaryie

secondaryie

Not Supported

Character

sect1

sect1-title

sect1-subtitle

Supported

Paragraph

sect1info

Supported

Paragraph

Created as required for metadata.

sect2

sect2-title

sect2-subtitle

Supported

Paragraph

sect2info

Supported

Paragraph

Created as required for metadata.

sect3

sect3-title

sect3-subtitle

Supported

Paragraph

sect3info

Supported

Paragraph

Created as required for metadata.

sect4

sect4-title

sect4-subtitle

Supported

Paragraph

sect4info

Supported

Paragraph

Created as required for metadata.

sect5

sect5-title

sect5-subtitle

Supported

Paragraph

sect5info

Supported

Paragraph

Created as required for metadata.

section

section-title

section-subtitle

section-titleabbrev

Supported

Paragraph

sectioninfo

Supported

Paragraph

Created as required for metadata.

see

see

Not Supported

Character

seealso

seealso

Not Supported

Character

seealsoie

seealsoie

Not Supported

Character

seeie

seeie

Not Supported

Character

seg

seg

Not Supported

Paragraph

seglistitem

seglistitem

Not Supported

Paragraph

segmentedlist

Not Supported

None

segtitle

segtitle

Not Supported

Paragraph

seriesvolnums

seriesvolnums

Not Supported

Paragraph

set

set-title

Not Supported

Paragraph

setindex

setindex-title

Not Supported

Paragraph

setindexinfo

Not Supported

None

sgmltag

sgmltag

Supported

Character

shortaffil

shortaffil

Not Supported

Character

shortcut

shortcut

Not Supported

Character

sidebar

sidebar-title

Not Supported

Paragraph

sidebarinfo

Not Supported

None

simpara

simpara

Supported

Paragraph

simplelist

simplelist

Not Supported

Paragraph

simplemsgentry

simplemsgentry

Not Supported

Paragraph

simplesect

simplesect-title

simplesect-subtitle

Not Supported

Paragraph

spanspec

Not Supported

None

state

state

Not Supported

Character

step

step

Not Supported

Character

stepalternatives

stepalternatives

Not Supported

Character

street

street

Not Supported

Character

structfield

structfield

Not Supported

Character

structname

structname

Not Supported

Character

subject

subject

Not Supported

Character

subjectset

subjectset

Not Supported

Character

subjectterm

subjectterm

Not Supported

Character

subscript

subscript

Not Supported

Character

substeps

substeps

Not Supported

Character

subtitle

Supported

Paragraph

See component element.

superscript

superscript

Not Supported

Character

surname

surname

Supported

Character

svg:svg

svg:svg

Not Supported

Character

symbol

symbol

Not Supported

Character

synopfragment

synopfragment

Not Supported

Character

synopfragmentref

synopfragmentref

Not Supported

Character

synopsis

synopsis

Not Supported

Character

systemitem

systemitem

Not Supported

Character

table

Supported

None

Tables in the document are encoded using this element.

task

task

Not Supported

Paragraph

taskprerequisites

taskprerequisites

Not Supported

Paragraph

taskrelated

taskrelated

Not Supported

Paragraph

tasksummary

tasksummary

Not Supported

Paragraph

tbody

Supported

None

Created as required for tables.

td

Not Supported

None

See entry.

term

variablelist-term

Supported

Paragraph

See variablelist.

tertiary

Partial Support

Character

See indexterm.

tertiaryie

tertiaryie

Not Supported

Paragraph

textdata

Supported

Paragraph

See textobject.

textobject

textobject-title

Supported

Paragraph

Creates a mediaobject and textdata elements as required. Immediately following paragraph becomes part of the text data.

tfoot

tfoot

Not Supported

Paragraph

tgroup

Supported

None

Created as required for tables. See table.

th

th

Not Supported

Paragraph

tip

tip

tip-title

Supported

Paragraph

Consecutive tip paragraphs are coalesced into a single tip element.

title

Supported

Paragraph

See component and division elements.

titleabbrev

Supported

Paragraph

See component and division elements.

toc

toc-title

Not Supported

Paragraph

tocback

tocback

Not Supported

Paragraph

tocchap

tocchap

Not Supported

Paragraph

tocentry

tocentry

Not Supported

Paragraph

tocfront

tocfront

Not Supported

Paragraph

toclevel1

toclevel1

Not Supported

Paragraph

toclevel2

toclevel2

Not Supported

Paragraph

toclevel3

toclevel3

Not Supported

Paragraph

toclevel4

toclevel4

Not Supported

Paragraph

toclevel5

toclevel5

Not Supported

Paragraph

tocpart

tocpart

Not Supported

Paragraph

token

token

Not Supported

Character

tr

Not Supported

None

trademark

trademark

Not Supported

Character

type

type

Not Supported

Character

ulink

ulink

Supported

Character

Created from hyperlinks, or explicitly.

uri

uri

Not Supported

Character

userinput

userinput

Not Supported

Character

varargs

varargs

Not Supported

Paragraph

variablelist

variablelist-term

variablelist-title

variablelist-titleabbrev

Supported

Paragraph

Consecutive terms are coalesced into a single variablelist. varlistentry elements are created as required.

varlistentry

Supported

Paragraph

See variablelist.

varname

varname

Not Supported

Character

videodata

videodata

Not Supported

Paragraph

videoobject

videoobject

Not Supported

Paragraph

void

void

Not Supported

Character

volumenum

volumenum

Not Supported

Character

warning

warning

warning-title

Supported

Paragraph

Consecutive paragraphs are coalesced into a single warningelement.

wordasword

wordasword

Not Supported

Character

xref

xref

Not Supported

Character

year

year

Not Supported

Character


Copyright © 2005 explain All rights reserved. Legal notices. Comments or questions about this website? Contact the webperson.