prompt
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# prompt

## Name

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)*

### Attributes

Common attributes

Name | Type | Default
moreinfo | Enumeration:
none
refentry
| "none"

### Parameter Entities

The following parameter entities contain prompt:

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;` |

## Description

A `Prompt` is a character or character string marking the beginning of an input field. `Prompt`s 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.

### Parents

These elements contain prompt: `application`, `attribution`, `bibliomisc`, `bridgehead`, `citation`, `citetitle`, `classsynopsisinfo`, `command`, `computeroutput`, `emphasis`, `entry`, `foreignphrase`, `funcparams`, `funcsynopsisinfo`, `function`, `glosssee`, `glossseealso`, `glossterm`, `lineannotation`, `link`, `literal`, `literallayout`, `lotentry`, `member`, `msgaud`, `olink`, `optional`, `para`, `phrase`, `primary`, `primaryie`, `productname`, `programlisting`, `quote`, `refdescriptor`, `refentrytitle`, `refname`, `refpurpose`, `remark`, `screen`, `screeninfo`, `secondary`, `secondaryie`, `see`, `seealso`, `seealsoie`, `seeie`, `seg`, `segtitle`, `simpara`, `subtitle`, `synopsis`, `term`, `tertiary`, `tertiaryie`, `title`, `titleabbrev`, `tocback`, `tocentry`, `tocfront`, `trademark`, `ulink`, `userinput`.

### Children

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

## Attributes

moreinfo

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

## See Also

`computeroutput`, `constant`, `envar`, `filename`, `literal`, `markup`, `option`, `optional`, `parameter`, `replaceable`, `sgmltag`, `systemitem`, `userinput`, `varname`.

## 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.

Prev | Home | Next
programlistingco | Up | property

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.