userinput

userinput — Data entered by the user.

Synopsis

userinput ::=

Zero or more of:
- text
- Computer-output inlines
- Graphic inlines
  - inlinemediaobject
- Markup inlines
  - email
  - literal
- Operating system inlines
- Technical inlines
- Ubiquitous inlines
- User-input inlines

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: caption (db.html.caption), citetitle, computeroutput, emphasis, entry, html:button, html:label, html:legend, link (db.link), literallayout, para, phrase (db.phrase), programlisting, quote, rddl:resource, subtitle, summary, td, term, th, title, titleabbrev, userinput.

Children

The following elements occur in userinput: text, command, computeroutput, email, filename, inlinemediaobject, literal, option, rddl:resource, replaceable, subscript, superscript, systemitem, userinput.

Examples

1 |<article xmlns='http://docbook.org/ns/docbook'>
  |<title>Example userinput</title>
  | 
  |<para>At the system prompt, enter <userinput>xyzzy</userinput> to gain
5 |supervisor access to the system.
  |</para>
  | 
  |</article>

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