parameter
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# parameter

## Name

parameter — A value or a symbolic reference to a value

##

# Synopsis

### Mixed Content Model

    parameter ::=
    (#PCDATA|replaceable|inlinegraphic|inlinemediaobject|indexterm|
     beginpage)*

### Attributes

Common attributes

Name | Type | Default
class | Enumeration:
command
function
option
| None
moreinfo | Enumeration:
none
refentry
| "none"

### Parameter Entities

The following parameter entities contain parameter:

Parameter Entities
`%cptr.char.mix;` | `%ndxterm.char.mix;` | `%para.char.mix;`
`%refinline.char.mix;` | `%refname.char.mix;` | `%tbl.entry.mdl;`
`%tech.char.class;` | `%title.char.mix;` |

## Description

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 an 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.

### Processing expectations

Formatted inline. The `MoreInfo` attribute can help generate a link or query to retrieve additional information.

### Future Changes

In DocBook V4.0, the content model of `Parameter` will be constrained to `(#PCDATA | Replaceable | InlineGraphic)`.

### Parents

These elements contain parameter: `application`, `attribution`, `bibliomisc`, `bridgehead`, `citation`, `citetitle`, `classsynopsisinfo`, `command`, `computeroutput`, `emphasis`, `entry`, `foreignphrase`, `funcparams`, `funcsynopsisinfo`, `function`, `glosssee`, `glossseealso`, `glossterm`, `lineannotation`, `link`, `literal`, `literallayout`, `lotentry`, `member`, `methodparam`, `msgaud`, `olink`, `optional`, `para`, `paramdef`, `phrase`, `primary`, `primaryie`, `productname`, `programlisting`, `quote`, `refdescriptor`, `refentrytitle`, `refname`, `refpurpose`, `remark`, `screen`, `screeninfo`, `secondary`, `secondaryie`, `see`, `seealso`, `seealsoie`, `seeie`, `seg`, `segtitle`, `simpara`, `subtitle`, `synopsis`, `term`, `tertiary`, `tertiaryie`, `title`, `titleabbrev`, `tocback`, `tocentry`, `tocfront`, `trademark`, `ulink`, `userinput`.

### Children

The following elements occur in parameter: `beginpage`, `indexterm`, `inlinegraphic`, `inlinemediaobject`, `replaceable`.

## Attributes

class

  `Class` indicates the type of `Parameter`.

moreinfo

  If `MoreInfo` is set to `RefEntry`, it implies that a `RefEntry` exists which further describes the `Parameter`.

## See Also

`computeroutput`, `constant`, `funcdef`, `funcparams`, `funcprototype`, `funcsynopsisinfo`, `function`, `literal`, `markup`, `option`, `optional`, `paramdef`, `prompt`, `replaceable`, `returnvalue`, `sgmltag`, `userinput`, `varargs`, `varname`, `void`.

## Examples

    <!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
              "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    <para>
    Using the <parameter class='command'>/w</parameter> parameter on the
    DOS <command>dir</command> command prints a wide directory listing.
    </para>

Using the `/w` parameter on the DOS dir command prints a wide directory listing.

For additional examples, see also `funcdef`, `funcsynopsis`, `paramdef` .

Prev | Home | Next
paramdef | Up | part

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.