literal

$Revision: 1666 $

$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $

literal — Inline text that is some literal value

Synopsis

Mixed Content Model

literal ::=
(%cptr.char.mix;)*

Attributes

Common attributes

Name

Type

Default

moreinfo
Enumeration:
none
refentry
"none"

Parameter Entities

The following parameter entities contain literal:

Parameter Entities
%cptr.char.mix;%ndxterm.char.mix;%para.char.mix;
%refinline.char.mix;%refname.char.mix;%tbl.entry.mdl;
%tech.char.class;%title.char.mix; 

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 varies by domain.

Processing expectations

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

The MoreInfo attribute can help generate a link or query to retrieve additional information.

Future Changes

The content model of Literal will be constrained to (#PCDATA | Replaceable | InlineGraphic) in DocBook V4.0.

Attributes

moreinfo

If MoreInfo is set to RefEntry, it implies that a RefEntry exists which further describes the Literal.

See Also

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

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<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 spell checker. For a complete
list of the possible settings,
see <filename class="headerfile">edit/debug.h</filename>.</para>

There are several undocumented settings for debug, among them 3.27 to enable a complete trace and 3.8 to debug the spell checker. For a complete list of the possible settings, see edit/debug.h.

For additional examples, see also programlistingco.