    | 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) $
literallayout — A block of text in which line breaks and white space are to be reproduced faithfully
literallayout ::= (%para.char.mix;|co|coref|textobject|lineannotation)*
Name | Type | Default | |||
| width | CDATA | None | |||
| linenumbering |
| None | |||
| language | CDATA | None | |||
| xml:space |
| None | |||
| continuation |
| None | |||
| format |
| "linespecific" | |||
| class |
| "normal" | |||
| startinglinenumber | CDATA | None |
The following parameter entities contain literallayout:
LiteralLayout is a verbatim environment. Unlike the other
verbatim environments, it does not have strong semantic overtones and
may not imply a font change.
This element is displayed “verbatim”; whitespace and linebreaks within this element are significant.
Unlike
ProgramListing and Screen, which usually
imply a font change, LiteralLayout does not.
How spaces are to be represented faithfully in a proportional
font is not addressed by DocBook.
In DocBook V3.1, the Class attribute
was added to give users control over the font used in
LiteralLayouts. If the Class attribute is specified and its value is
Monospaced, then the LiteralLayout
will be presented in a monospaced font, probably the same one
used for other verbatim environments. The default value for
Class is Normal, meaning
that no font change will occur.
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 literallayout:
answer, appendix, article, bibliodiv, bibliography, blockquote, callout, caption, caution, chapter, colophon, constraintdef, dedication, entry, epigraph, example, figure, footnote, glossary, glossdef, glossdiv, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, para, partintro, preface, 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 literallayout:
abbrev, acronym, action, anchor, application, author, authorinitials, beginpage, biblioref, citation, citebiblioid, citerefentry, citetitle, classname, classsynopsis, cmdsynopsis, co, code, command, computeroutput, constant, constructorsynopsis, coref, corpauthor, corpcredit, database, destructorsynopsis, email, emphasis, envar, errorcode, errorname, errortext, errortype, exceptionname, fieldsynopsis, filename, firstterm, footnote, footnoteref, foreignphrase, funcsynopsis, function, glossterm, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, indexterm, inlineequation, inlinegraphic, inlinemediaobject, interface, interfacename, keycap, keycode, keycombo, keysym, lineannotation, link, literal, markup, medialabel, menuchoice, methodname, methodsynopsis, modespec, mousebutton, nonterminal, olink, ooclass, ooexception, oointerface, option, optional, orgname, othercredit, package, parameter, personname, phrase, productname, productnumber, prompt, property, quote, remark, replaceable, returnvalue, revhistory, sgmltag, structfield, structname, subscript, superscript, symbol, synopsis, systemitem, termdef, textobject, token, trademark, type, ulink, uri, userinput, varname, wordasword, xref.
Class distinguishes between literal layout
environments that are presented in a monospaced font and literal layout
environments that have no implicit font change.
The Format attribute applies the
linespecific notation to all LiteralLayouts.
All white space and line breaks must be preserved.
![[4.0]](figures/rev_4.0.png)
Line numbering indicates whether or not the lines
of a LiteralLayout are to be automatically numbered. The details
of numbering (every line or only selected lines, on the left or right, etc.)
are left up to the processing application. Be aware that not all processors
are capable of numbering lines.
Width specifies the width (in characters)
of the longest line in this LiteralLayout (formatters may use
this value to determine scaling or rotation).
<!DOCTYPE blockquote PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<blockquote>
<attribution>William Shakespeare, <citetitle>Henry V</citetitle></attribution>
<literallayout>
O, for a muse of fire, that would ascend
The brightest heaven of invention!
A kingdom for a stage, princes to act,
And monarchs to behold the swelling scene!
</literallayout>
</blockquote>
| ||
| --William Shakespeare, Henry V | ||
For additional examples, see also
attribution, part.
| | | |
| literal | | lot |