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


literallayout ::=


Common linking attributes.


  • class (enumeration)
    • “monospaced”
    • “normal”
  • All of:
    • continuation (enumeration)
      • “continues”
      • “restarts”
    • linenumbering (enumeration)
      • “numbered”
      • “unnumbered”
    • startinglinenumber (integer)
    • xml:space (enumeration)
      • “preserve”
    • language

Additional Constraints

  • If this element is the root element, it must have a version attribute.


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.

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.

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, probably the same one used for other verbatim environments. The default value for class is normal, meaning that no font change will occur.


Common linking attributes.

any attribute

Any attribute in any other explicit namespace


Specifies the class of literal layout

Enumerated values:

The literal layout should be formatted with a monospaced font


The literal layout should be formatted with the current font


Determines whether line numbering continues from the previous element or restarts

Enumerated values:

Line numbering continues from the immediately preceding element with the same name.


Line numbering restarts (begins at 1, usually).


Identifies the language (i.e. programming language) of the verbatim content


Determines whether lines are numbered

Enumerated values:

Lines are numbered.


Lines are not numbered.


Specifies the initial line number


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:

Whitespace must be preserved.


The following elements occur in literallayout: text, abbrev, accel, acronym, alt, anchor, annotation, application, author, biblioref, buildtarget, citation, citebiblioid, citerefentry, citetitle, classname, co, 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), info (, initializer, inlineequation, inlinemediaobject, interfacename, jobtitle, keycap, keycode, keycombo, keysym, lineannotation, 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, textobject, token, trademark, type, typedefname, unionname, uri, userinput, varname, wordasword, xref.


 1 |<article xmlns=''>
   |<title>Example literallayout</title>
 5 |<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>
10 |</blockquote>
  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