DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

GUILabel

Name

GUILabel -- The text of a label in a GUI

Synopsis

Mixed Content Model

GUILabel ::=
((#PCDATA|Replaceable|InlineGraphic|InlineMediaObject|IndexTerm|
  Accel)+)

Attributes

Common attributes

Name

Type

Default

MoreInfo

Enumeration:

None
RefEntry

"None"

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

%cptr.char.mix;%ndxterm.char.mix;%para.char.mix;
%programlisting.content;%refinline.char.mix;%refname.char.mix;
%screen.content;%tbl.entry.mdl;%tech.char.class;
%title.char.mix;

Description

GUILabel identifies text that appears as a label in a graphical user interface.

What constitutes a label may vary from application to application. In general, any text that appears in a GUI may be considered a label, for example a message in a dialog box or a window title.

Processing expectations

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

Parents

These elements contain GUILabel: Action, Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Command, Comment, ComputerOutput, Database, Emphasis, entry, Filename, ForeignPhrase, FuncParams, FuncSynopsisInfo, Function, GlossSee, GlossSeeAlso, GlossTerm, Hardware, Interface, InterfaceDefinition, KeyCap, LineAnnotation, Link, Literal, LiteralLayout, LoTentry, Member, MenuChoice, MsgAud, OLink, Option, Optional, Para, Parameter, Phrase, Primary, PrimaryIE, ProductName, ProgramListing, Property, Quote, RefDescriptor, RefEntryTitle, RefName, RefPurpose, Screen, ScreenInfo, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, SimPara, Subtitle, Synopsis, SystemItem, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Trademark, ULink, UserInput.

Children

The following elements occur in GUILabel: Accel, IndexTerm, InlineGraphic, InlineMediaObject, Replaceable.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

In some contexts, the following elements are excluded: IndexTerm.

Attributes

MoreInfo

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

See Also

Accel, GUIButton, GUIIcon, GUIMenu, GUIMenuItem, GUISubmenu, KeyCap, KeyCode, KeyCombo, KeySym, MenuChoice, MouseButton, Shortcut

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
The exact text of the <guilabel>Legend</> and other labels on the
graph is dependent upon the language of the current locale.  Likewise,
the text of the <guibutton>OK</> button and other buttons may vary.
The <guiicon><inlinegraphic fileref="figures/legend"></inlinegraphic></guiicon>
icon and the other icons on the left side of the display may be
configured by the local administrator, but they are not
generally expected to vary from locale to locale.
</para>

The exact text of the Legend and other labels on the graph is dependent upon the language of the current locale. Likewise, the text of the OK button and other buttons may vary. The icon and the other icons on the left side of the display may be configured by the local administrator, but they are not generally expected to vary from locale to locale.

For additional examples, see also GUIButton, GUIIcon.

PrevHomeNext
GUIIconUpGUIMenu

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.