literallayout
literallayout — A block of text in which line breaks and white space are to be reproduced faithfully.
Synopsis
literallayout ::= ![[-]](figs/web/nav/down.gif)
![[+]](figs/web/nav/right.gif)
- Sequence of:
info? (db.titleforbidden.info)- One of:
- Zero or more of:
- text
lineannotation- Bibliography inlines
- Computer-output inlines
abbrevacronymaltanchorannotationbibliorefcocodecommandcomputeroutputconstantcorefdateemailemphasis(db._emphasis)envarfilenamefirstterm(db._firstterm)footnotefootnoterefforeignphrase(db._foreignphrase)glossterm(db._glossterm)indexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectlinkliteralmarkupnonterminalolinkoptionoptionalpackageparameterphrase(db._phrase)promptpropertyquote(db._quote)remarkreplaceablesubscriptsuperscriptsymbolsystemitemtagtermdeftokentrademarkuriuserinputwordaswordxref
- Error inlines
- Graphic inlines
- GUI inlines
- Indexing inlines
- Keyboard inlines
- Linking inlines
- Markup inlines
- Math inlines
- Object-oriented programming inlines
- Operating system inlines
- Product inlines
- Programming inlines
- Publishing inlines
abbrevacronymcorefdateemphasis(db.emphasis)firstterm(db._firstterm)firstterm(db.firstterm)footnotefootnoterefforeignphrase(db.foreignphrase)glossterm(db._glossterm)glossterm(db.glossterm)phrase(db.phrase)quote(db.quote)subscriptsuperscriptwordasword
- Technical inlines
- Ubiquitous inlines
abbrevacronymaltanchorannotationbibliorefcorefdateemphasis(db._emphasis)firstterm(db._firstterm)footnotefootnoterefforeignphrase(db._foreignphrase)glossterm(db._glossterm)indexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectlinkolinkphrase(db._phrase)quote(db._quote)remarksubscriptsuperscripttrademarkwordaswordxref
- User-input inlines
abbrevaccelacronymaltanchorannotationbibliorefcocodecommandcomputeroutputconstantcorefdateemailemphasis(db._emphasis)envarfilenamefirstterm(db._firstterm)footnotefootnoterefforeignphrase(db._foreignphrase)glossterm(db._glossterm)guibuttonguiiconguilabelguimenuguimenuitemguisubmenuindexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectkeycapkeycodekeycombokeysymlinkliteralmarkupmenuchoicemousebuttonnonterminalolinkoptionoptionalpackageparameterphrase(db._phrase)promptpropertyquote(db._quote)remarkreplaceableshortcutsubscriptsuperscriptsymbolsystemitemtagtermdeftokentrademarkuriuserinputwordaswordxref
textobject
- Zero or more of:
Attributes
Common attributes and common linking attributes.
Additional attributes:
- class (enumeration)
- “monospaced”
- “normal”
- All of:
- continuation (enumeration)
- “continues”
- “restarts”
- linenumbering (enumeration)
- “numbered”
- “unnumbered”
- startinglinenumber (integer)
- xml:space (enumeration)
- “preserve”
- language
- continuation (enumeration)
Additional Constraints
- If this element is the root element, it must have a version attribute.
Description
A literallayout is a verbatim environment. Unlike the
other verbatim environments, it does not have strong semantic
overtones and may not imply a font change.
Processing expectations
This element is displayed “verbatim”; whitespace and line breaks within this element are significant.
How spaces are to be represented faithfully in a proportional font is not addressed by DocBook.
The class attribute gives 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. The
default value for class is
normal, meaning that no font change will
occur.
Attributes
Common attributes and common linking attributes.
- class
Specifies the class of literal layout
Enumerated values: “monospaced” The literal layout should be formatted with a monospaced font
“normal” The literal layout should be formatted with the current font
- continuation
Determines whether line numbering continues from the previous element or restarts.
Enumerated values: “continues” Line numbering continues from the immediately preceding element with the same name.
“restarts” Line numbering restarts (begins at 1, usually).
- language
Identifies the language (i.e. programming language) of the verbatim content.
- linenumbering
Determines whether lines are numbered.
Enumerated values: “numbered” Lines are numbered.
“unnumbered” Lines are not numbered.
- startinglinenumber
Specifies the initial line number.
- xml:space
Can be used to indicate explicitly that whitespace in the verbatim environment is preserved. Whitespace must always be preserved in verbatim environments whether this attribute is specified or not.
Enumerated values: “preserve” Whitespace must be preserved.
Parents
These elements contain literallayout: acknowledgements, annotation, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, colophon, constraintdef, cover, dedication, entry, epigraph, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, result, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, topic, variablelist, warning.
Children
The following elements occur in literallayout: text, abbrev, accel, acronym, alt, anchor, annotation, application, author, biblioref, citation, citebiblioid, citerefentry, citetitle, classname, co, code, command, computeroutput, constant, coref, database, date, editor, email, emphasis (db._emphasis), emphasis (db.emphasis), 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), info (db.titleforbidden.info), initializer, inlineequation, inlinemediaobject, interfacename, jobtitle, keycap, keycode, keycombo, keysym, lineannotation, link, literal, 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, shortcut, subscript, superscript, symbol, systemitem, tag, termdef, textobject, token, trademark, type, uri, userinput, varname, wordasword, xref.
See Also
Examples
<article xmlns='http://docbook.org/ns/docbook'>
<title>Example literallayout</title>
<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>
</article>
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!