    | DocBook: The Definitive Guide 0.0.12 for DocBook V5.0b1 (Alpha) |
| | DocBook: The Definitive Guide 0.0.12 for DocBook V5.0b1 (Alpha) |
parameter — A value or a symbolic reference to a value
parameter ::=
altanchorannotationbibliorefindexterm (db.indexterm.endofrange)indexterm (db.indexterm.singular)indexterm (db.indexterm.startofrange)inlinemediaobjectlinkolinkphrase (db._phrase)remarkreplaceablesubscriptsuperscriptxrefCommon attributes and common linking attributes.
Additional attributes:
A Parameter identifies something passed from one part of a
computer system to another. In this regard Parameter is
fairly generic, but it may have a more constrained semantic in some
contexts (for example in a ParamDef).
In a document that describes more than one kind of parameter,
for example, parameters to functions and commands, the
Class attribute can be used to distinguish
between them, if necessary.
Common attributes and common linking attributes.
FIXME:
Enumerated values: | |
|---|---|
| “command” | FIXME: |
| “function” | FIXME: |
| “option” | FIXME: |
These elements contain parameter: bridgehead, citation, citetitle, classsynopsisinfo, emphasis (db.emphasis), entry, firstterm, funcsynopsisinfo, glosssee, glossseealso, glossterm, html:button, html:label, html:legend, link, literallayout, member, methodparam, olink, orgdiv, para, paramdef, phrase (db.phrase), primary, primaryie, programlisting, quote, refdescriptor, refentrytitle, refname, refpurpose, screen, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry.
The following elements occur in parameter: text, alt, anchor, annotation, biblioref, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), remark, replaceable, subscript, superscript, xref.
computeroutput, constant, funcdef, funcparams, funcprototype, funcsynopsisinfo, function, literal, markup, option, optional, paramdef, prompt, replaceable, returnvalue, tag, userinput, varargs, varname, void<article xmlns='http://docbook.org/ns/docbook'> <title>Example parameter</title> <para>Using the <parameter class='command'>/w</parameter> parameter on the DOS <command>dir</command> command prints a wide directory listing. </para> </article>
Using the /w parameter on the
DOS dir command prints a wide directory listing.
| | | |
| paramdef | | part |