    | DocBook: The Definitive Guide 2.0.17 (Alpha) |
| | DocBook: The Definitive Guide 2.0.17 (Alpha) |
$Revision: 1666 $
$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $
symbol — A name that is replaced by a value before processing
symbol ::= (#PCDATA|replaceable|inlinegraphic|inlinemediaobject|indexterm|beginpage)*
Name | Type | Default | ||
| class |
| None |
A Symbol is a name that represents a value. It should be used
in contexts in which the name will actually be replaced by a value before
processing. The canonical example is a #defined symbol in
a C program where the C preprocessor replaces every occurance of the symbol
with its value before compilation begins.
The Limit value of the Class attribute
identifies those symbols that represent system limitations (for example, the
number of characters allowed in a path name or the largest possible positive
integer). DocBook V3.1 introduced the Constant element,
which may be more suitable for some of these symbols.
These elements contain symbol:
action, application, attribution, bibliomisc, bridgehead, citation, citetitle, classsynopsisinfo, code, command, computeroutput, database, emphasis, entry, filename, firstterm, foreignphrase, funcparams, funcsynopsisinfo, function, glosssee, glossseealso, glossterm, hardware, interfacename, keycap, lineannotation, link, literal, literallayout, lotentry, member, msgaud, olink, option, optional, para, parameter, phrase, primary, primaryie, productname, programlisting, property, quote, refdescriptor, refentrytitle, refname, refpurpose, remark, screen, screeninfo, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subscript, subtitle, superscript, synopsis, systemitem, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocback, tocentry, tocfront, trademark, ulink, userinput.
The following elements occur in symbol:
beginpage, indexterm, inlinegraphic, inlinemediaobject, replaceable.
| | | |
| svg:svg | | synopfragment |