[ Previous | Next | Contents | Glossary | Home | Search ]
Motif 2.1 Widget Writer's Guide



What DocBook SGML Markup Means

This book is written in the Structured Generalized Markup Language (SGML) using the DocBook Document Type Definition (DTD). The following table describes the DocBook markup used for various semantic elements.

Table 1. DocBook SGML Markup

Markup Appearance

Semantic Element(s)

Example

AaBbCc123

The names of commands.

Use the ls command to list files.

AaBbCc123

The names of command options.

Use ls -a to list all files.

AaBbCc123

Command-line placeholder: replace with a real name or value.

To delete a file, type rm filename.

AaBbCc123

The names of files and directories.

Edit your .login file.

AaBbCc123

Book titles, new words or terms, or words to be emphasized.

Read Chapter 6 in User's Guide. These are called class options. You must be root to do this.

Terminology Conventions

We use the term primitive to mean any subclass of XmPrimitive. We use the term manager to mean any subclass of XmManager. Note that both of these terms are in lowercase.

Keyboard Conventions

Because not all keyboards are the same, it is difficult to specify keys that are correct for every manufacturer's keyboard. To solve this problem, this guide describes keys that use a virtual key mechanism. The term virtual implies that the keys as described do not necessarily correspond to a fixed set of actual keys. Instead, virtual keys are linked to actual keys by means of virtual bindings. A given virtual key may be bound to different physical keys for different keyboards.

See Chapter 2 of this guide for information on the mechanism for binding virtual keys to actual keys. For details, see the VirtualBindings(3) reference page in the Motif Programmer's Reference.

Mouse Conventions

In this guide, mouse buttons are described using a virtual button mechanism to better describe behavior independent from the number of buttons on the mouse. This guide assumes a 3-button mouse. On a 3-button mouse, the leftmost mouse button is usually defined as BSelect, the middle mouse button is usually defined as BTransfer, and the rightmost mouse button is usually defined as BMenu. For details about how virtual mouse buttons are usually defined, see the VirtualBindings(3) reference page in the Motif Programmer's Reference.


[ Previous | Next | Contents | Glossary | Home | Search ]