literallayout
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# literallayout

## Name

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

##

# Synopsis

### Mixed Content Model

    literallayout ::=
    (#PCDATA|footnoteref|xref|abbrev|acronym|citation|citerefentry|
     citetitle|emphasis|firstterm|foreignphrase|glossterm|footnote|
     phrase|quote|trademark|wordasword|link|olink|ulink|action|
     application|classname|methodname|interfacename|exceptionname|
     ooclass|oointerface|ooexception|command|computeroutput|database|
     email|envar|errorcode|errorname|errortype|filename|function|
     guibutton|guiicon|guilabel|guimenu|guimenuitem|guisubmenu|
     hardware|interface|keycap|keycode|keycombo|keysym|literal|
     constant|markup|medialabel|menuchoice|mousebutton|option|
     optional|parameter|prompt|property|replaceable|returnvalue|
     sgmltag|structfield|structname|symbol|systemitem|token|type|
     userinput|varname|nonterminal|anchor|author|authorinitials|
     corpauthor|modespec|othercredit|productname|productnumber|
     revhistory|remark|subscript|superscript|inlinegraphic|
     inlinemediaobject|inlineequation|synopsis|cmdsynopsis|
     funcsynopsis|classsynopsis|fieldsynopsis|constructorsynopsis|
     destructorsynopsis|methodsynopsis|indexterm|beginpage|
     lineannotation|co)*

### Attributes

Common attributes

Name | Type | Default
width | CDATA | None
class | Enumeration:
monospaced
normal
| "normal"
format | Enumerated notation:
linespecific
| "linespecific"
linenumbering | Enumeration:
numbered
unnumbered
| None

### Parameter Entities

The following parameter entities contain literallayout:

Parameter Entities
`%admon.mix;` | `%bookcomponent.content;` | `%component.mix;`
`%divcomponent.mix;` | `%example.mix;` | `%figure.mix;`
`%footnote.mix;` | `%glossdef.mix;` | `%indexdivcomponent.mix;`
`%legalnotice.mix;` | `%linespecific.class;` | `%para.mix;`
`%qandaset.mix;` | `%refcomponent.mix;` | `%revdescription.mix;`
`%sidebar.mix;` | `%tabentry.mix;` | `%tbl.entry.mdl;`
`%textobject.mix;` |  |

## Description

`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 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 `LiteralLayout`s. 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.

### Future Changes

The `InterfaceDefinition` element will be discarded in DocBook V4.0. It will no longer be available in the content model of this element.

### Future Changes

The `xml:space` attribute is automatically provided in the XML DTD.

### Parents

These elements contain literallayout: `answer`, `appendix`, `article`, `bibliodiv`, `bibliography`, `blockquote`, `callout`, `caption`, `caution`, `chapter`, `colophon`, `constraintdef`, `dedication`, `entry`, `example`, `figure`, `footnote`, `glossary`, `glossdef`, `glossdiv`, `important`, `index`, `indexdiv`, `informalexample`, `informalfigure`, `legalnotice`, `listitem`, `msgexplan`, `msgtext`, `note`, `para`, `partintro`, `preface`, `procedure`, `qandadiv`, `qandaset`, `question`, `refsect1`, `refsect2`, `refsect3`, `refsynopsisdiv`, `revdescription`, `sect1`, `sect2`, `sect3`, `sect4`, `sect5`, `section`, `setindex`, `sidebar`, `simplesect`, `step`, `textobject`, `tip`, `warning`.

### Children

The following elements occur in literallayout: `abbrev`, `acronym`, `action`, `anchor`, `application`, `author`, `authorinitials`, `beginpage`, `citation`, `citerefentry`, `citetitle`, `classname`, `classsynopsis`, `cmdsynopsis`, `co`, `command`, `computeroutput`, `constant`, `constructorsynopsis`, `corpauthor`, `database`, `destructorsynopsis`, `email`, `emphasis`, `envar`, `errorcode`, `errorname`, `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`, `othercredit`, `parameter`, `phrase`, `productname`, `productnumber`, `prompt`, `property`, `quote`, `remark`, `replaceable`, `returnvalue`, `revhistory`, `sgmltag`, `structfield`, `structname`, `subscript`, `superscript`, `symbol`, `synopsis`, `systemitem`, `token`, `trademark`, `type`, `ulink`, `userinput`, `varname`, `wordasword`, `xref`.

## Attributes

class

  `Class` distinguishes between literal layout environments that are presented in a monospaced font and literal layout environments that have no implicit font change.

format

  The `Format` attribute applies the `linespecific` notation to all `LiteralLayout`s. All white space and line breaks must be preserved.

linenumbering

  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

  `Width` specifies the width (in characters) of the longest line in this `LiteralLayout` (formatters may use this value to determine scaling or rotation).

## See Also

`computeroutput`, `lineannotation`, `programlisting`, `screen`, `screenshot`, `synopsis`, `userinput`.

## Examples

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

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

For additional examples, see also `part` .

Prev | Home | Next
literal | Up | lot

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.