literallayout — A block of text in which line breaks and white space are to be reproduced faithfully
info
? (db.titleforbidden.info)lineannotation
alt
anchor
annotation
biblioref
co
code
command
computeroutput
constant
email
envar
filename
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
link
literal
markup
nonterminal
olink
option
optional
package
parameter
prompt
property
remark
replaceable
subscript
superscript
symbol
systemitem
tag
termdef
token
uri
userinput
xref
abbrev
acronym
coref
date
emphasis
(db.emphasis)firstterm
footnote
footnoteref
foreignphrase
glossterm
phrase
(db.phrase)quote
subscript
superscript
wordasword
alt
anchor
annotation
biblioref
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
link
olink
remark
subscript
superscript
xref
accel
alt
anchor
annotation
biblioref
co
code
command
computeroutput
constant
email
envar
filename
guibutton
guiicon
guilabel
guimenu
guimenuitem
guisubmenu
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
keycap
keycode
keycombo
keysym
link
literal
markup
menuchoice
mousebutton
nonterminal
olink
option
optional
package
parameter
prompt
property
remark
replaceable
shortcut
subscript
superscript
symbol
systemitem
tag
termdef
token
uri
userinput
xref
textobject
Common attributes and common linking attributes.
Additional attributes:
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.
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.
Common attributes and common linking attributes.
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 |
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). |
Identifies the language (i.e. programming language) of the verbatim content.
Determines whether lines are numbered.
Enumerated values: | |
---|---|
“numbered” |
Lines are numbered. |
“unnumbered” |
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: | |
---|---|
“preserve” |
Whitespace must be preserved. |
These elements contain literallayout
: acknowledgements
, annotation
, answer
, appendix
, article
, bibliodiv
, bibliography
, bibliolist
, blockquote
, callout
, calloutlist
,
caption
(db.caption), caution
, chapter
, colophon
, constraintdef
, cover
, dedication
, entry
, epigraph
, example
, figure
, footnote
, glossary
,
glossdef
, glossdiv
, glosslist
, html:fieldset
, html:form
, important
, index
, indexdiv
, informalexample
, informalfigure
, itemizedlist
, legalnotice
, listitem
, msgexplan
, msgtext
, note
, orderedlist
, para
, partintro
, preface
, procedure
, qandadiv
, qandaset
, question
, refsect1
, refsect2
, refsect3
, refsection
, refsynopsisdiv
, revdescription
, sect1
, sect2
,
sect3
, sect4
, sect5
, section
, setindex
, sidebar
, simplesect
,
step
, taskprerequisites
, taskrelated
, tasksummary
, td
, textobject
, th
, tip
, toc
, tocdiv
, variablelist
, warning
.
The following elements occur in literallayout: text, abbrev
, accel
, acronym
, alt
, anchor
, annotation
, application
, author
, biblioref
, citation
, citebiblioid
, citerefentry
,
citetitle
, classname
, co
, code
, command
, computeroutput
, constant
, coref
, database
, date
, editor
, email
, emphasis
(db.emphasis), envar
, errorcode
, errorname
, errortext
, errortype
, exceptionname
, filename
, firstterm
, footnote
, footnoteref
, foreignphrase
, function
, glossterm
, guibutton
, guiicon
, guilabel
, guimenu
, guimenuitem
, guisubmenu
, hardware
, html:button
, html:fieldset
, html:input
, html:label
, html:select
, html:textarea
, indexterm
(db.indexterm.endofrange), indexterm
(db.indexterm.singular), indexterm
(db.indexterm.startofrange), info
(db.titleforbidden.info), initializer
, inlineequation
, inlinemediaobject
, interfacename
, jobtitle
, keycap
, keycode
, keycombo
, keysym
, lineannotation
, link
, literal
, markup
, menuchoice
, methodname
, modifier
, mousebutton
, nonterminal
, olink
, ooclass
, ooexception
, oointerface
, option
, optional
, org
, orgname
, package
, parameter
, person
, personname
,
phrase
(db.phrase), productname
, productnumber
, prompt
, property
, quote
, remark
, replaceable
, returnvalue
, shortcut
, subscript
, superscript
, symbol
, systemitem
, tag
, termdef
, textobject
, token
, trademark
, type
, uri
, userinput
, varname
, wordasword
, xref
.
<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 |
||
--William Shakespeare, Henry V |