    | DocBook: The Definitive Guide 2.0.17 (Alpha) |
| | DocBook: The Definitive Guide 2.0.17 (Alpha) |
$Revision: 1666 $
$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $
userinput — Data entered by the user
userinput ::= (%cptr.char.mix;|co)*
Name | Type | Default | |||
| moreinfo |
| "none" |
The following parameter entities contain userinput:
| Parameter Entities | ||
%cptr.char.mix; | %ndxterm.char.mix; | %para.char.mix; |
%refinline.char.mix; | %refname.char.mix; | %tbl.entry.mdl; |
%tech.char.class; | %title.char.mix; | |
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.
Formatted inline. The MoreInfo attribute
can help generate a link or query to retrieve additional information. Often presented in a fixed width font.
The InterfaceDefinition
element will be discarded in DocBook V4.0. It will no longer be available
in the content model of this element.
These elements contain userinput:
action, application, attribution, bibliomisc, bridgehead, citation, citetitle, classsynopsisinfo, code, command, computeroutput, database, emphasis, entry, filename, firstterm, foreignphrase, funcparams, funcsynopsisinfo, function, glosssee, glossseealso, glossterm, hardware, interfacename, keycap, lineannotation, link, literal, literallayout, lotentry, member, msgaud, olink, option, optional, para, parameter, phrase, primary, primaryie, productname, programlisting, property, quote, refdescriptor, refentrytitle, refname, refpurpose, remark, screen, screeninfo, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, systemitem, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocback, tocentry, tocfront, trademark, ulink, userinput.
The following elements occur in userinput:
action, anchor, application, beginpage, classname, co, code, command, computeroutput, constant, database, email, envar, errorcode, errorname, errortext, errortype, exceptionname, filename, function, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, indexterm, inlinegraphic, inlinemediaobject, interface, interfacename, keycap, keycode, keycombo, keysym, link, literal, markup, medialabel, menuchoice, methodname, mousebutton, nonterminal, olink, ooclass, ooexception, oointerface, option, optional, package, parameter, prompt, property, remark, replaceable, returnvalue, sgmltag, structfield, structname, subscript, superscript, symbol, systemitem, token, type, ulink, uri, userinput, varname.
computeroutput, constant, envar, filename, lineannotation, literal, literallayout, markup, option, optional, parameter, programlisting, prompt, replaceable, screen, screenshot, sgmltag, synopsis, systemitem, varname.
<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
At the system prompt, enter <userinput>xyzzy</userinput> to gain
supervisor access to the system.
</para>
At the system prompt, enter xyzzy to gain
supervisor access to the system.
| | | |
| uri | | varargs |