DocBook 5: The Definitive Guide

Name

MenuChoice -- A selection or series of selections from a menu

Synopsis

Content Model

MenuChoice ::= (Shortcut?, (GUIButton|GUIIcon|GUILabel|GUIMenu|GUIMenuItem|GUISubmenu| Interface)+)

Attributes

Common attributes

Tag Minimization

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

Parameter Entities

Description

In applications that present graphical user interfaces, it is often necessary to select an item, or a series of items, from a menu in order to accomplish some action. The MenuChoice element provides a wrapper to contain the complete combination of selections.

Processing expectations

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

MenuChoice may generate arrows or other punctuation between multiple GUI elements. The ShortCut may be suppressed, or sometimes it is presented in parentheses after the rest of the items.

Parents

These elements contain MenuChoice: 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, 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 MenuChoice: GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Interface, Shortcut.

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

Attributes

MoreInfo

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

See Also

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

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <para> You can exit from GNU Emacs with <menuchoice> <shortcut> <keycombo><keysym>C-x</keysym><keysym>C-c</keysym></keycombo> </shortcut> <guimenu>Files</guimenu> <guimenuitem>Exit Emacs</guimenuitem> </menuchoice>. </para>

You can exit from GNU Emacs with Files->Exit Emacs (C-x-C-c).

Compare this example with the similar example in GUIMenu. Here the KeyCombo and MenuChoice elements are required to process thier content in some intelligent way in order to produce useful output.

For additional examples, see also Shortcut.

Back to: DocBook: The Definitive Guide