DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

Constant

Name

Constant -- A programming or system constant

Synopsis

Mixed Content Model

Constant ::=
(#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 Constant identifies a value as immutable. It is most often used to identify system limitations or other defined constants.

Processing expectations

Formatted inline.

Parents

These elements contain Constant: 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, Subtitle, Synopsis, SystemItem, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Trademark, ULink, UserInput.

Children

The following elements occur in Constant: 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 identifies constants that are system or application limits (for example, the maximum length of a filename).

See Also

Command, ComputerOutput, Literal, Markup, Option, Optional, Parameter, Prompt, Replaceable, SGMLTag, UserInput, VarName

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
In ACL, <constant>main::PCS</constant> contains the path component
separator character.
</para>

In ACL, main::PCS contains the path component separator character.

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
The maximum legal length for a path name is 
<constant class=limit>PATH_MAX</constant>, defined in
<filename class=headerfile>limits.h</filename>.
</para>

The maximum legal length for a path name is PATH_MAX, defined in limits.h.

PrevHomeNext
ConfTitleUpContractNum

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