Simplified DocBook: The Definitive Guide  (Version 0.9.1 for Simplified DocBook 5.1)

userinput

userinput — Data entered by the user.

Synopsis

userinput ::= [x]  [+]

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, link, literallayout, orgdiv, para, phrase (db.phrase), programlisting, quote, subtitle, td, term, th, title, titleabbrev, userinput.

Children

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

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.