Name

literal — Inline text that is some literal value

Synopsis

literal ::= (text | phrase db._phrase | replaceable | Graphic inlines | Indexing inlines | Linking inlines | Ubiquitous inlines)*

Description

A literal is some specific piece of data, taken literally, from a computer system. It is similar in some ways to userinput and computeroutput, but is somewhat more of a general classification. The sorts of things that constitute literals vary by domain.

Processing expectations

Formatted inline. A literal is frequently distinguished typographically and literal is often used wherever that typographic presentation is desired.

See Also

command, computeroutput, constant, markup, option, optional, parameter, prompt, replaceable, tag, userinput, varname

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example literal</title>

<para>There are several undocumented settings for <varname>debug</varname>,
among them <literal>3.27</literal> to enable a complete trace and
<literal>3.8</literal> to debug the spellchecker. For a complete
list of the possible settings,
see <filename class="headerfile">edit/debug.h</filename>.</para>

</article>

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.