DocBook Publishers: The Definitive Guide  (Version 1.2.1 for DocBook 5.1)

literallayout

literallayout — A block of text in which line breaks and white space are to be reproduced faithfully.

Synopsis

literallayout ::= [-]

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

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.

The literallayout element does not imply a font change. 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.

Children

The following elements occur in literallayout: text, abbrev, acronym, alt, anchor, author, biblioref, citation, citebiblioid, citetitle, co, 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), info (db.titleforbidden.info), inlineequation, inlinemediaobject, jobtitle, link, literal, olink, optional, org, orgname, person, personname, phrase (db._phrase), phrase (db.phrase), productname, productnumber, quote (db._quote), quote (db.quote), remark, subscript, superscript, termdef, textobject, trademark, uri, wordasword, xref.

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!
—William Shakespeare, Henry V