title
title — The text of the title of a section of a document or of a formal block-level element.
Synopsis
title ::=
- Zero or more of:
- text
inlinestagedir
templatename
- Bibliography inlines
- Graphic inlines
- Indexing inlines
- Linking inlines
- Markup inlines
- Math inlines
- Product inlines
- Publishing inlines
abbrev
acronym
coref
date
emphasis
(db.emphasis)firstterm
(db._firstterm)firstterm
(db.firstterm)footnote
footnoteref
foreignphrase
(db.foreignphrase)glossterm
(db._glossterm)glossterm
(db.glossterm)phrase
(db.phrase)quote
(db.quote)revnumber
subscript
superscript
wordasword
- Technical inlines
- Ubiquitous inlines
abbrev
acronym
alt
anchor
biblioref
coref
date
emphasis
(db._emphasis)firstterm
(db._firstterm)footnote
footnoteref
foreignphrase
(db._foreignphrase)glossterm
(db._glossterm)indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
link
olink
phrase
(db._phrase)quote
(db._quote)remark
subscript
superscript
trademark
wordasword
xref
Attributes
Common attributes and common linking attributes.
No additional attributes.
Additional Constraints
- If this element is the root element, it must have a version attribute.
Description
The title
element is widely
used in DocBook. It identifies the titles of documents and parts of
documents, and is the required caption on formal objects. It is also
allowed as an optional title or caption on many additional block
elements.
Titles are so common, and so often the only “info” elements
associated with their parent, that they (title
,
subtitle
, and titleabbrev
) are allowed outside
the info
element. This is a tradeoff favoring author
convenience over a small amount of additional complexity in
processing. However, the title elements must either all be outside of
the info
wrapper or all inside, you cannot have some
outside and some inside.
Processing expectations
Formatted as a displayed block. Titles are often repeated in several locations: for example, at the location where the object occurs, in the table of contents, and in running headers and footers.
DocBook does not offer any mechanism for indicating where a line break should occur in long titles. Titles are often repeated and no single line break is likely to be correct in all of the places where a title is used. Instead, you will have to rely on your processing system to provide a mechanism, such as a processing instruction, for identifying the location of forced line breaks.
Attributes
Common attributes and common linking attributes.
- any attribute
Any attribute in any other explicit namespace
Parents
These elements contain title
: abstract
, acknowledgements
, appendix
, article
, bibliodiv
, biblioentry
, bibliography
, bibliolist
, bibliomixed
, bibliomset
, biblioset
, blockquote
, book
, calloutlist
, caution
, chapter
, colophon
, danger
, dedication
, dialogue
, drama
, equation
, example
, figure
, formalgroup
, formalpara
, glossary
, glossdiv
, glosslist
, important
, index
, info
(db.info), info
(db.titleonly.info), info
(db.titleonlyreq.info), info
(db.titlereq.info), itemizedlist
, legalnotice
, note
, orderedlist
, part
, partintro
, personblurb
, poetry
, preface
, procedure
, qandadiv
, qandaentry
, qandaset
, revhistory
, section
, set
, setindex
, sidebar
, simplesect
, step
, table
, task
, taskprerequisites
, taskrelated
, tasksummary
, tip
, toc
, variablelist
, warning
.
Children
The following elements occur in title
: text, abbrev
, acronym
, alt
, anchor
, author
, biblioref
, citation
, citebiblioid
, citetitle
, coref
, date
, editor
, email
, emphasis
(db._emphasis), emphasis
(db.emphasis), firstterm
(db._firstterm), firstterm
(db.firstterm), footnote
, footnoteref
, foreignphrase
(db._foreignphrase), foreignphrase
(db.foreignphrase), glossterm
(db._glossterm), glossterm
(db.glossterm), indexterm
(db.indexterm.endofrange), indexterm
(db.indexterm.singular), indexterm
(db.indexterm.startofrange), inlineequation
, inlinemediaobject
, inlinestagedir
, jobtitle
, link
, literal
, olink
, optional
, org
, orgname
, person
, personname
, phrase
(db._phrase), phrase
(db.phrase), productname
, productnumber
, quote
(db._quote), quote
(db.quote), remark
, revnumber
, subscript
, superscript
, templatename
, termdef
, trademark
, uri
, wordasword
, xref
.
See Also
Related elements: subtitle
, titleabbrev
.
Examples
1 |<article xmlns='http://docbook.org/ns/docbook'>
|<title>Example title</title>
||
<section>
5 |<title>A Top Level Section</title>
||
<para>Actual content.</para>
|</section>
|10 |
</article>