Name

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

Synopsis

literallayout ::= (infodb.titleforbidden.info, ((text | lineannotation | Bibliography inlines | Computer-output inlines | 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 | Technical inlines | Ubiquitous inlines | User-input inlines)* | textobject))

Attribute synopsis

Common attributes and common linking attributes.

Additional attributes:

  • class (enumeration) = “monospaced” | “normal”

  • continuation (enumeration) = “continues” | “restarts”

  • linenumbering (enumeration) = “numbered” | “unnumbered”

  • startinglinenumber (integer)

  • language

  • xml:space (enumeration) = “preserve”

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.

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 ...

Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.