userinput

userinput — Data entered by the user

Synopsis

Content Model

userinput ::=

Zero or more of:
- text
- alt
- anchor
- annotation
- biblioref
- co
- code
- command
- computeroutput
- constant
- email
- envar
- filename
- indexterm (db.indexterm.endofrange)
- indexterm (db.indexterm.singular)
- indexterm (db.indexterm.startofrange)
- inlinemediaobject
- link
- literal
- markup
- nonterminal
- olink
- option
- optional
- package
- prompt
- property
- remark
- replaceable
- subscript
- superscript
- symbol
- systemitem
- tag
- termdef
- token
- uri
- userinput
- xref

Attributes

Common attributes and common linking attributes.

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. Often presented in a fixed width font.

Parents

These elements contain userinput: bridgehead, citation, citetitle, classsynopsisinfo, computeroutput, emphasis (db.emphasis), entry, firstterm, funcsynopsisinfo, glosssee, glossseealso, glossterm, html:button, html:label, html:legend, link, literallayout, member, olink, orgdiv, para, 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, userinput.

Children

The following elements occur in userinput: text, alt, anchor, annotation, biblioref, co, code, command, computeroutput, constant, email, envar, filename, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, literal, markup, nonterminal, olink, option, optional, package, prompt, property, remark, replaceable, subscript, superscript, symbol, systemitem, tag, termdef, token, uri, userinput, xref.

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example userinput</title>

<para>At the system prompt, enter <userinput>xyzzy</userinput> to gain
supervisor access to the system.
</para>

</article>

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

ChangeLog

This alpha reference page is $Revision: 1.4 $ published $Date: 2005/10/31 12:31:57 $.


uri		varargs