userinput

$Revision: 1.3 $

$Date: 2002/06/12 11:18:42 $

userinput — Data entered by the user

Synopsis

Mixed Content Model

userinput ::=
(#PCDATA|link|ulink|command|computeroutput|email|filename|literal|
 option|replaceable|systemitem|userinput|inlinemediaobject)*

Attributes

Common attributes

Name

Type

Default

moreinfo

Enumeration:

none
refentry
"none"

Description

The UserInput element identifies words or phrases that the user is expected to provide as input to a computer program.

Note that UserInput is not a verbatim environment, but an inline.

Processing expectations

Formatted inline. The MoreInfo attribute can help generate a link or query to retrieve additional information. Often presented in a fixed width font.

Children

The following elements occur in userinput: command, computeroutput, email, filename, inlinemediaobject, link, literal, option, replaceable, systemitem, ulink, userinput.

Attributes

moreinfo

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

See Also

computeroutput, filename, lineannotation, literal, literallayout, option, programlisting, replaceable, systemitem.

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>
At the system prompt, enter <userinput>xyzzy</userinput> to gain
supervisor access to the system.
</para>

At the system prompt, enter xyzzy to gain supervisor access to the system.