DocBook 5: The Definitive Guide

Name

userinput — Data entered by the user

Synopsis

userinput ::= (text | Computer-output inlines | Graphic inlines | GUI inlines | Indexing inlines | Keyboard inlines | Linking inlines | Markup inlines | Operating system inlines | Technical inlines | Ubiquitous inlines | User-input inlines)*

Attribute synopsis

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.

See Also

computeroutput, constant, envar, filename, lineannotation, literal, literallayout, markup, option, optional, parameter, programlisting, prompt, replaceable, screen, screenshot, synopsis, systemitem, tag, varname

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.