Skip to main content
Version: DocBook V4.5

prompt

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

Synopsis

Mixed Content Model

prompt ::=
(#PCDATA|replaceable|inlinegraphic|inlinemediaobject|indexterm|
beginpage|co)*

Attributes

Common attributes

Name

Type

Default

moreinfo

Enumeration:

none

refentry

"none"

Description

A Prompt is a character or character string marking the beginning of an input field. Prompts are generally associated with command-line interfaces and not graphical user interfaces (GUIs). In GUIs, GUILabel is usually more appropriate.

Processing expectations

Formatted inline. The MoreInfo attribute can help generate a link or query to retrieve additional information.

Future Changes

Prompt was added in DocBook V3.0. It duplicates the semantics of <systemitem class="prompt">. The prompt attribute will be removed from SystemItem in the future.

Children

The following elements occur in prompt: beginpage, co, indexterm, inlinegraphic, inlinemediaobject, replaceable.

Attributes

moreinfo

If MoreInfo is set to RefEntry, it implies that a RefEntry exists which further describes the Prompt.

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
Enter your user name when the system presents the
<prompt>login:</prompt> prompt.
</para>

Enter your user name when the system presents the login: prompt.