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

DocBook: The Definitive Guide
Prev		Next

---

Replaceable

Name

Replaceable -- Content that may or must be replaced by the user

Synopsis

Mixed Content Model

Replaceable ::=
((#PCDATA|Link|OLink|ULink|Optional|Anchor|Comment|Subscript|
  Superscript|InlineGraphic|InlineMediaObject)+)

Attributes

Common attributes

Name	Type	Default
Class	Enumeration: Command Function Option Parameter	None

Tag Minimization

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

Parameter Entities

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

Description

Replaceable is used to mark text that describes what a user is supposed to enter, but not the actual text that they are supposed to enter.

It is used to identify a class of object in the document, in which the user is expected to replace the text that identifies the class with some specific instance of that class. A canonical example is

<replaceable>filename</replaceable>

in which the user is expected to provide the name of some specific file to replace the text "filename."

Processing expectations

Formatted inline. Usually, the text is given special typographic treatment, such as italics, as a clue to the user that this is replaceable text. Often the font used is described in a "conventions" section at the beginning of the document.

Parents

These elements contain Replaceable: Accel, Ackno, Action, Application, Arg, ArtPageNums, Attribution, AuthorInitials, BiblioMisc, BridgeHead, Citation, CiteTitle, City, ClassName, CollabName, Command, Comment, ComputerOutput, ConfDates, ConfNum, ConfSponsor, ConfTitle, Constant, ContractNum, ContractSponsor, Contrib, CorpAuthor, CorpName, Country, Database, Date, Edition, Email, Emphasis, entry, EnVar, ErrorCode, ErrorName, ErrorType, Fax, Filename, FirstName, ForeignPhrase, FuncDef, FuncParams, FuncSynopsisInfo, Function, GlossSee, GlossSeeAlso, GlossTerm, Group, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, Holder, Honorific, Interface, InterfaceDefinition, InvPartNumber, ISBN, ISSN, IssueNum, JobTitle, KeyCap, KeyCode, KeySym, Lineage, LineAnnotation, Link, Literal, LiteralLayout, LoTentry, Markup, MediaLabel, Member, ModeSpec, MouseButton, MsgAud, MsgLevel, MsgOrig, OLink, Option, Optional, OrgDiv, OrgName, OtherAddr, OtherName, PageNums, Para, ParamDef, Parameter, Phone, Phrase, POB, Postcode, Primary, PrimaryIE, ProductName, ProductNumber, ProgramListing, Prompt, Property, PubDate, PublisherName, PubsNumber, Quote, RefDescriptor, RefEntryTitle, RefMiscInfo, RefName, RefPurpose, ReleaseInfo, ReturnValue, RevNumber, RevRemark, Screen, ScreenInfo, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, SeriesVolNums, SGMLTag, ShortAffil, SimPara, State, Street, StructField, StructName, Subscript, Subtitle, Superscript, Surname, Symbol, Synopsis, SystemItem, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Token, Trademark, Type, ULink, UserInput, VarName, VolumeNum, Year.

Children

The following elements occur in Replaceable: Anchor, Comment, InlineGraphic, InlineMediaObject, Link, OLink, Optional, Subscript, Superscript, ULink.

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

Attributes

Class

Class identifies the type of the replaceable information.

See Also

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

Examples

For examples, see CmdSynopsis, MediaLabel, MsgSet, SynopFragment.

---

Prev	Home	Next
ReleaseInfo	Up	ReturnValue

Back to: DocBook: The Definitive Guide