DocBook: The Definitive Guide
Prev Next

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|personname|link|olink|ulink|
 action|application|classname|methodname|interfacename|
 exceptionname|ooclass|oointerface|ooexception|command|
 computeroutput|database|email|envar|errorcode|errorname|
 errortype|errortext|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|co|coref|textobject|lineannotation)*
Attributes Common attributes

Name

Type

Default
width CDATA None
format
linespecific
"linespecific"
linenumbering
numbered
unnumbered
None
class
monospaced
normal
"normal"
Parameter Entities
admon.mix bookcomponent.content component.mix
divcomponent.mix example.mix figure.mix
footnote.mix glossdef.mix indexdivcomponent.mix
legalnotice.mix linespecific.class listpreamble.mix
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 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, meanings= "sgmltag">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|co|coref|textobject|lineannotation)* Attributes Common attributes

Name

Type

Default

width CDATA None format
linespecific
"linespecific" linenumbering
numbered
unnumbered
None class
monospaced
normal
"normal" Parameter Entities admon.mix bookcomponent.content component.mix divcomponent.mix example.mix figure.mix footnote.mix glossdef.mix indexdivcomponent.mix legalnotice.mix linespecific.class listpreamble.mix 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 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, meanings= "sgmltag">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|co|coref|textobject|lineannotation)* Attributes Common attributes

Name

Type

Default

width CDATA None format
linespecific
"linespecific" linenumbering
numbered
unnumbered
None class
monospaced
normal
"normal" Parameter Entities admon.mix bookcomponent.content component.mix divcomponent.mix example.mix figure.mix footnote.mix glossdef.mix indexdivcomponent.mix legalnotice.mix linespecific.class listpreamble.mix 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 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, meanings= "sgmltag">keysym|literal|constant|markup|medialabel|menuchoice| mousebutton|option|optional|parameter|prompt|property| replaceable|returnvalue