Search the Catalog
DocBook: The Definitive Guide

DocBook: The Definitive Guide

By Norman Walsh & Leonard Muellner
1st Edition October 1999
1-56592-580-7, Order Number: 5807
652 pages, $36.95 , Includes CD-ROM

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.

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.

Back to: DocBook: The Definitive Guide


oreilly.com Home | O'Reilly Bookstores | How to Order | O'Reilly Contacts
International | About O'Reilly | Affiliated Companies | Privacy Policy

© 2001, O'Reilly & Associates, Inc.