Search the Catalog
DocBook: The Definitive Guide

DocBook: The Definitive Guide

By Norman Walsh & Leonard Muellner
1st Edition October 1999
1-56592-580-7, Order Number: 5807
652 pages, $36.95 , Includes CD-ROM

Interface

Name

Interface -- An element of a GUI

Synopsis

Mixed Content Model

Interface ::=
((#PCDATA|Link|OLink|ULink|Action|Application|ClassName|Command|
  ComputerOutput|Database|Email|EnVar|ErrorCode|ErrorName|
  ErrorType|Filename|Function|GUIButton|GUIIcon|GUILabel|GUIMenu|
  GUIMenuItem|GUISubmenu|Hardware|Interface|InterfaceDefinition|
  KeyCap|KeyCode|KeyCombo|KeySym|Literal|Constant|Markup|
  MediaLabel|MenuChoice|MouseButton|MsgText|Option|Optional|
  Parameter|Prompt|Property|Replaceable|ReturnValue|SGMLTag|
  StructField|StructName|Symbol|SystemItem|Token|Type|UserInput|
  VarName|Anchor|Comment|Subscript|Superscript|InlineGraphic|
  InlineMediaObject|IndexTerm|Accel)+)

Attributes

Common attributes

Name

Type

Default

Class

Enumeration:

Button
Icon
Menu
MenuItem

None
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

An Interface identifies some part of a graphical user interface. This element became obsolete in DocBook V3.0 with the introduction of GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, and GUISubMenu.

Processing expectations

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

(4.0) Future Changes

In DocBook V4.0, the Class attribute will be dropped from Interface. Use one of the GUI* tags instead or subclass locally with the Role attribute.

The content model of Interface will also be constrained to (#PCDATA | Replaceable | InlineGraphic).

Attributes

Class

Class indicates the type of the Interface.

MoreInfo

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

See Also

ClassName, InterfaceDefinition, Property, StructField, StructName, Symbol, Token, Type

Back to: DocBook: The Definitive Guide


oreilly.com Home | O'Reilly Bookstores | How to Order | O'Reilly Contacts
International | About O'Reilly | Affiliated Companies | Privacy Policy

© 2001, O'Reilly & Associates, Inc.