    | DocBook: The Definitive Guide 2.0.17 (Alpha) |
| | DocBook: The Definitive Guide 2.0.17 (Alpha) |
$Revision: 1666 $
$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $
para — A paragraph
para ::= (#PCDATA|footnoteref|xref|biblioref|abbrev|acronym|citation|citerefentry|citetitle|citebiblioid|emphasis|firstterm|foreignphrase|glossterm|termdef|footnote|phrase|orgname|quote|trademark|wordasword|personname|link|olink|ulink|action|application|classname|methodname|interfacename|exceptionname|ooclass|oointerface|ooexception|package|command|computeroutput|database|envar|errorcode|errorname|errortype|errortext|filename|function|guibutton|guiicon|guilabel|guimenu|guimenuitem|guisubmenu|hardware|interface|keycap|keycode|keycombo|keysym|literal|code|constant|markup|medialabel|menuchoice|mousebutton|option|optional|parameter|prompt|property|replaceable|returnvalue|sgmltag|structfield|structname|symbol|systemitem|uri|token|type|userinput|varname|nonterminal|anchor|author|authorinitials|corpauthor|corpcredit|modespec|othercredit|productname|productnumber|revhistory|remark|subscript|superscript|inlinegraphic|inlinemediaobject|inlineequation|synopsis|cmdsynopsis|funcsynopsis|classsynopsis|fieldsynopsis|constructorsynopsis|destructorsynopsis|methodsynopsis|indexterm|beginpage|calloutlist|glosslist|bibliolist|itemizedlist|orderedlist|segmentedlist|simplelist|variablelist|caution|important|note|tip|warning|literallayout|programlisting|programlistingco|screen|screenco|screenshot|address|blockquote|graphic|graphicco|mediaobject|mediaobjectco|informalequation|informalexample|informalfigure|informaltable|equation|example|figure|table)*
A Para is a paragraph. Paragraphs in DocBook may contain
almost all inlines and most block elements. Sectioning and higher-level
structural elements are excluded. DocBook offers two variants of paragraph:
SimPara, which cannot contain block elements, and
FormalPara, which has a title.
Some processing systems may find the presence of block elements in a paragraph difficult to handle. On the other hand, it is frequently most logical, from a structural point of view, to include block elements, especially informal block elements, in the paragraphs that describe their content. There is no easy answer to this problem.
The InterfaceDefinition
element will be discarded in DocBook V4.0. It will no longer be available
in the content model of this element.
These elements contain para:
abstract, answer, appendix, article, authorblurb, bibliodiv, bibliography, blockquote, callout, caption, caution, chapter, colophon, constraintdef, dedication, entry, epigraph, example, footnote, formalpara, glossary, glossdef, glossdiv, highlights, important, index, indexdiv, informalexample, itemizedlist, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, partintro, personblurb, preface, printhistory, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, variablelist, warning.
The following elements occur in para:
abbrev, acronym, action, address, anchor, application, author, authorinitials, beginpage, bibliolist, biblioref, blockquote, calloutlist, caution, citation, citebiblioid, citerefentry, citetitle, classname, classsynopsis, cmdsynopsis, code, command, computeroutput, constant, constructorsynopsis, corpauthor, corpcredit, database, destructorsynopsis, email, emphasis, envar, equation, errorcode, errorname, errortext, errortype, example, exceptionname, fieldsynopsis, figure, filename, firstterm, footnote, footnoteref, foreignphrase, funcsynopsis, function, glosslist, glossterm, graphic, graphicco, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, important, indexterm, informalequation, informalexample, informalfigure, informaltable, inlineequation, inlinegraphic, inlinemediaobject, interface, interfacename, itemizedlist, keycap, keycode, keycombo, keysym, link, literal, literallayout, markup, medialabel, mediaobject, mediaobjectco, menuchoice, methodname, methodsynopsis, modespec, mousebutton, nonterminal, note, olink, ooclass, ooexception, oointerface, option, optional, orderedlist, orgname, othercredit, package, parameter, personname, phrase, productname, productnumber, programlisting, programlistingco, prompt, property, quote, remark, replaceable, returnvalue, revhistory, screen, screenco, screenshot, segmentedlist, sgmltag, simplelist, structfield, structname, subscript, superscript, symbol, synopsis, systemitem, table, termdef, tip, token, trademark, type, ulink, uri, userinput, variablelist, varname, warning, wordasword, xref.
Ordinary paragraphs can contain most block elements:
<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
The component suffered from three failings:
<itemizedlist>
<listitem><para>It was slow</para></listitem>
<listitem><para>It ran hot</para></listitem>
<listitem><para>It didn't actually work</para></listitem>
</itemizedlist>
Of these three, the last was probably the most important.
</para>The component suffered from three failings:
It was slow
It ran hot
It didn't actually work
Formal paragraphs include a title:
<!DOCTYPE formalpara PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<formalpara><title>A Test</title>
<para>
This is a test. This is only a test. Had this been a real
example, it would have made more sense.
</para>
</formalpara>A Test.
This is a test. This is only a test. Had this been a real example, it would have made more sense.
Simple paragraphs may not contain block elements:
<!DOCTYPE simpara PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<simpara>
Just the text, ma'am.
</simpara>Just the text, ma'am.
For additional examples, see also
abbrev, abstract, accel, ackno, acronym, action, address, anchor, appendix, application, article, authorgroup, beginpage, blockquote, book, bookinfo, caution, chapter, citation, citerefentry, citetitle, classname, collab, colophon, command, computeroutput, constant, contractsponsor, database, emphasis, envar, errorcode, filename, firstterm, footnote, footnoteref, foreignphrase, formalpara, glossary, glosslist, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, highlights, html-form, imageobject, important, indexterm, informalequation, informalfigure, inlineequation, inlinemediaobject, itemizedlist, keycap, keycode, keycombo, keysym, link, literal, manvolnum, markup, medialabel, menuchoice, mousebutton, msgset, note, olink, option, orderedlist, otheraddr, parameter, part, personname, phrase, printhistory, procedure, productionset, productname, productnumber, programlistingco, prompt, property, qandaset, quote, refentry, reference, remark, returnvalue, screenco, sect1info, section, segmentedlist, seriesvolnums, set, shortcut, sidebar, simplelist, simplesect, structfield, structname, subscript, superscript, symbol, systemitem, table, tip, title, titleabbrev, token, trademark, type, ulink, userinput, variablelist, varname, videoobject, warning, wordasword, xref.
| | | |
| pagenums | | paramdef |