Name

prompt — A character or string indicating the start of an input field in a computer display

Synopsis

prompt ::= (text | co | phrase db._phrase | replaceable | Graphic inlines | Indexing inlines | Linking inlines | Ubiquitous inlines)*

Description

A prompt is a character or character string marking the beginning of an input field. The prompt element is generally used for command-line interfaces and not graphical user interfaces (GUIs). In GUIs, guilabel is usually more appropriate.

Processing expectations

Formatted inline.

See Also

computeroutput, constant, envar, filename, literal, markup, option, optional, parameter, replaceable, systemitem, tag, userinput, varname

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example prompt</title>

<para>Enter your username when the system presents the 
<prompt>login:</prompt> prompt.
</para>

</article>

Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.