DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

Symbol

Name

Symbol -- A name that is replaced by a value before processing

Synopsis

Mixed Content Model

Symbol ::=
((#PCDATA|Replaceable|InlineGraphic|InlineMediaObject|IndexTerm)+)

Attributes

Common attributes

Name

Type

Default

Class

Enumeration:

Limit

None

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

%cptr.char.mix;%ndxterm.char.mix;%para.char.mix;
%programlisting.content;%refinline.char.mix;%refname.char.mix;
%screen.content;%tbl.entry.mdl;%tech.char.class;
%title.char.mix;

Description

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.

Processing expectations

Formatted inline.

Parents

These elements contain Symbol: Action, Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Command, Comment, ComputerOutput, Database, Emphasis, entry, Filename, ForeignPhrase, FuncParams, FuncSynopsisInfo, Function, GlossSee, GlossSeeAlso, GlossTerm, Hardware, Interface, InterfaceDefinition, KeyCap, LineAnnotation, Link, Literal, LiteralLayout, LoTentry, Member, MsgAud, OLink, Option, Optional, Para, Parameter, Phrase, Primary, PrimaryIE, ProductName, ProgramListing, Property, Quote, RefDescriptor, RefEntryTitle, RefName, RefPurpose, Screen, ScreenInfo, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, SimPara, Subscript, Subtitle, Superscript, Synopsis, SystemItem, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Trademark, ULink, UserInput.

Children

The following elements occur in Symbol: IndexTerm, InlineGraphic, InlineMediaObject, Replaceable.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

In some contexts, the following elements are excluded: IndexTerm.

Attributes

Class

Class indicates the type of Symbol.

See Also

ClassName, Interface, InterfaceDefinition, Property, StructField, StructName, Token, Type

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
No filename may be more than <symbol class=limit>MAXPATHLEN</symbol>
characters long.
</para>

No filename may be more than MAXPATHLEN characters long.

PrevHomeNext
SurnameUpSynopFragment

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.