replaceable

replaceable — Content that may or must be replaced by the user.

Synopsis

replaceable ::=

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • class (enumeration)
    • “command”
    • “function”
    • “option”
    • “parameter”

Description

A replaceable is used to mark text that describes what a user is supposed to enter, but not the actual text that the user is 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.

Attributes

Common attributes and common linking attributes.

class

Identifies the nature of the replaceable text

Enumerated values:
“command”

A command

“function”

A function

“option”

An option

“parameter”

A parameter

Parents

These elements contain replaceable: abbrev, acronym, attribution, authorinitials, bibliomisc, bibliomixed, bibliomset, caption (db.html.caption), citetitle, command, computeroutput, edition, email, emphasis, entry, filename, firstname, givenname, holder, honorific, issuenum, lineage, lineannotation, link, literal, literallayout, option, orgname, othername, para, personname, phrase (db._phrase), phrase (db.phrase), programlisting, publishername, quote, releaseinfo, replaceable, revnumber, revremark, subscript, subtitle, superscript, surname, systemitem, td, term, th, title, titleabbrev, trademark, userinput, volumenum, year.

Children

The following elements occur in replaceable: text, inlinemediaobject, phrase (db._phrase), replaceable, subscript, superscript.

See Also

Related elements: command, computeroutput, literal, option, userinput.