title

title — The text of the title of a section of a document or of a formal block-level element.

Synopsis

title ::=

Attributes

Common attributes and common linking attributes.

No additional attributes.

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, annotation, appendix, article, assembly, bibliodiv, biblioentry, bibliography, bibliolist, bibliomixed, bibliomset, biblioset, blockquote, book, calloutlist, caution, chapter, colophon, constraintdef, danger, dedication, equation, example, figure, formalgroup, formalpara, glossary, glossdiv, glosslist, important, index, indexdiv, info (db.info), info (db.titleonly.info), info (db.titleonlyreq.info), info (db.titlereq.info), itemizedlist, legalnotice, merge, msg, msgexplan, msgmain, msgrel, msgset, msgsub, note, orderedlist, part, partintro, personblurb, preface, procedure, productionset, qandadiv, qandaentry, qandaset, reference, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, relationships, revhistory, screenshot, sect1, sect2, sect3, sect4, sect5, section, segmentedlist, set, setindex, sidebar, simplesect, step, table (db.cals.table), task, taskprerequisites, taskrelated, tasksummary, tip, toc, tocdiv, topic, transforms, variablelist, warning.

Children

The following elements occur in title: text, abbrev, accel, acronym, alt, anchor, annotation, application, author, biblioref, buildtarget, citation, citebiblioid, citerefentry, citetitle, classname, code, command, computeroutput, constant, coref, database, date, editor, email, emphasis (db._emphasis), emphasis (db.emphasis), enumidentifier, enumname, enumvalue, envar, errorcode, errorname, errortext, errortype, exceptionname, filename, firstterm (db._firstterm), firstterm (db.firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), foreignphrase (db.foreignphrase), function, glossterm (db._glossterm), glossterm (db.glossterm), guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), initializer, inlineequation, inlinemediaobject, interfacename, jobtitle, keycap, keycode, keycombo, keysym, link, literal, macroname, markup, menuchoice, methodname, modifier, mousebutton, nonterminal, olink, ooclass, ooexception, oointerface, option, optional, org, orgname, package, parameter, person, personname, phrase (db._phrase), phrase (db.phrase), productname, productnumber, prompt, property, quote (db._quote), quote (db.quote), remark, replaceable, returnvalue, revnumber, shortcut, subscript, superscript, symbol, systemitem, tag, templatename, termdef, token, trademark, type, typedefname, unionname, uri, userinput, varname, 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>