By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM |
DocBook: The Definitive Guide | ||
---|---|---|
Prev | Next |
Symbol ::= ((#PCDATA|Replaceable|InlineGraphic|InlineMediaObject|IndexTerm)+)
Common attributes
Name | Type | Default |
Class | Enumeration: Limit | None |
Both the start- and end-tags are required for this element.
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.
Formatted inline.
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.
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.
Class indicates the type of Symbol.
ClassName, Interface, InterfaceDefinition, Property, StructField, StructName, Token, Type
<!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.
Prev | Home | Next |
Surname | Up | SynopFragment |
Back to: DocBook: The Definitive Guide
© 1999, O'Reilly & Associates, Inc.