Home Prev Up Next DocBook: The Definitive Guide 0.0.25 for DocBook V5.0 (Alpha)

userinput

userinput — Data entered by the user

Synopsis

userinput ::= [-]

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, caption (db.html.caption), 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, accel, alt, anchor, annotation, biblioref, co, code, command, computeroutput, constant, email, envar, filename, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, keycap, keycode, keycombo, keysym, link, literal, markup, menuchoice, mousebutton, nonterminal, olink, option, optional, package, parameter, prompt, property, remark, replaceable, shortcut, subscript, superscript, symbol, systemitem, tag, termdef, token, uri, userinput, xref.

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.

ChangeLog

This alpha reference page is $Revision: 7120 $ published Sun, 22 Jul 2007.

Prev  Home  Next
uri  Up  varargs

Copyright © 2004-2008 Norman Walsh. Portions Copright © 1999-2003 O'Reilly & Associates, Inc. All rights reserved.