    |
DocBook: The Definitive Guide 2.0.17 (Alpha) |
| |
DocBook: The Definitive Guide 2.0.17 (Alpha) |
$Revision$
$Date$
replaceable — Content that may or must be replaced by the user
replaceable ::= (#PCDATA|link|olink|ulink|optional|anchor|remark|subscript|superscript|inlinegraphic|inlinemediaobject|co)*
|
Name |
Type |
Default |
|||||
| class |
|
None |
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.”
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.
These elements contain replaceable:
accel, ackno, action, application, arg, artpagenums, attribution, authorinitials, bibliocoverage, biblioid, bibliomisc, bibliorelation, bibliosource, bridgehead, citation, citebiblioid, citetitle, city, classname, classsynopsisinfo, code, collabname, command, computeroutput, confdates, confnum, confsponsor, conftitle, constant, contractnum, contractsponsor, contrib, corpauthor, corpcredit, corpname, country, database, date, edition, email, emphasis, entry, envar, errorcode, errorname, errortext, errortype, exceptionname, fax, filename, firstname, firstterm, foreignphrase, funcdef, funcparams, funcsynopsisinfo, function, glosssee, glossseealso, glossterm, group, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, holder, honorific, initializer, interface, interfacename, invpartnumber, isbn, issn, issuenum, jobtitle, keycap, keycode, keysym, lineage, lineannotation, link, literal, literallayout, lotentry, markup, medialabel, member, methodname, modespec, modifier, mousebutton, msgaud, msglevel, msgorig, olink, option, optional, orgdiv, orgname, otheraddr, othername, package, 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, remark, 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, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocback, tocentry, tocfront, token, trademark, type, ulink, uri, userinput, varname, volumenum, year.
The following elements occur in replaceable:
anchor, co, inlinegraphic, inlinemediaobject, link, olink, optional, remark, subscript, superscript, ulink.
|
|
|
|
| remark | |
returnvalue |