Documentation Home
> Common Desktop Environment: Help System Author's and Programmer's Guide
Common Desktop Environment: Help System Author's and Programmer's Guide
Book Information
Preface
Part I Introduction
Chapter 1 Introducing the Help System
Introduction to the Help System
Developer's Toolkit
For Authors
For Application Developers
Overview of Online Help
Help Information Model
Part of the Application
Types of Help
How Users Get Help
Help Key
Help Menu
Help Buttons
Help User Interface
Help Windows
Hyperlinks
Help Navigation
Help Navigation Buttons
Help Menus
Help Index
Printing from Help
Help Topic Organization
Help Topic
Help Volume
Help Family
Help Browser Volume
The Author's Job
Objectives for Online Help
Know Your Audience
Consider How Your Help Is Accessed
Application Help
Standalone Help Volumes
Evaluate How to Present Help
Collaborate With the Application Programmer
Author's Workflow
Write Help Topics With HelpTag
Shorthand Markup
Formal Markup
Structured Editors
Using Formal Markup
See Also
Think Structure, Not Format
Create Runtime Help Files
Review Help as the User Will See It
Programmer's Job
Consider How Your Help Is Accessed
Collaborate With the Help Author
Identify Help Entry Points
Create and Manage Help Dialogs
Package and Distribute Help
Part II The Author's Job
Chapter 2 Organizing and Writing a Help Volume
Help Volume Components
Home Topic
Topics and Subtopics
Entities
Meta Information
Glossary
General Markup Guidelines
Markup in Your Source Files
Shorthand Markup
Formal Markup
Displaying HelpTag Symbols
A Help Volume at a Glance
Help Source Files
Creating Your volume.htg File
Multiple Source Files
Example
Help Files in File Manager
See Also
Writing Your First Help Volume: A Step-by-Step Example
Create the Source Directory
Create the Build Directory
Create the Master HelpTag File
Create the helptag.opt File
Create the Run-Time Help Files
Display the Help Volume
See Also
Creating a Topic Hierarchy
Example
See Also
To Create a Home Topic
Examples
To Add a Topic to the Hierarchy
Example
Creating Meta Information Topics
To Create a Meta Information Section
Example
See Also
Adding a Nonhierarchical Topic
To Add a Nonhierarchical Topic
Example
See Also
Accessing Topics
Rules for ID Names
To Add an ID to a Topic
Built-in IDs
To Add an ID to an Element Within a Topic
Examples
Using Entities
Rules for Entity Declarations
To Create a Text Entity
Example
To Create a File Entity
Example: Text File Entities
Example: A Graphic File Entity
See Also
Chapter 3 Writing a Help Topic
Creating Help Topics
Example
See Also
Creating Structure within a Topic
To Start a Paragraph
Examples
To Enter a List
Examples
To Enter a Lablist
Example
To Enter a Lablist with Headings
Example
See Also
To Provide Subheadings within a Topic
Example
To Show a Computer Listing
Example
See Also
To Add a Note, Caution, or Warning
Example
See Also
Entering Inline Elements
To Emphasize a Word or Phrase
Example
To Enter a Book Title
Example
To Emphasize Using a Bold Font
To Display a Computer Literal
Example
To Display a Variable
Example
Creating Hyperlinks
Using the <xref> Element
To Create a Link Using <xref>
Using the Link Element
To Create a Link Using <link>
Example
To Create a Link to a Predefined ID
Example
To Create a Link to a Topic in a Different Volume
Examples
See Also
To Create a Definition Link
Example
See Also
To Create a Man Page Link
Example
See Also
To Create an Application-Defined Link
Example
To Link to a Meta Information Topic
See Also
Execution Link Control
Execution Policy Default Behavior
Execution Aliases
To Create an Execution Alias
Examples
Using Execution Aliases in Hyperlinks
To Create an Execution Link Using an Execution Alias
Examples
DtNexecutionPolicy Resource
See Also
Displaying Graphics
To Create a Figure
Examples
See Also
To Display an Inline Graphic
Example
To Wrap Text Around a Graphic
Example
See Also
Including Special Characters
To Include a Special Character
Examples
See Also
Including Comments and Writer's Memos
To Insert a Comment
Example
To Insert a Writer's Memo
Example
Creating an Index
To Mark an Index Entry
Examples
Creating a Glossary
To Mark a Glossary Term
Examples
To Define a Term in the Glossary
Example
See Also
Chapter 4 Processing and Displaying a Help Volume
Overview
HelpTag Software
Viewing Your Volume
Creating RunTime Help Files
To Create a RunTime Help Volume
HelpTag Output
To Run the dthelptag Command Manually
Example: Commands
Example: A helptag.opt File
See Also
To Review and Correct Parser Errors
Common Errors
Viewing a Help Volume
To Display a Help Volume
To Run the dthelpview Command Manually
Example
See Also
Example: A Personal Help Directory
Adding Your Help to the Browser Volume
Browser Volume
Help Family File
To Create a Help Family
Example
See Also
To Display the Browser Volume
To Display the Browser Volume Manually
See Also
Printing Help Topics
Testing Your Help
Validating Hyperlinks
Verifying Entry Points
Checking Index Entries
Testing Graphics
Checking for Parser Errors
See Also
Chapter 5 HelpTag Markup Reference
Element Descriptions
<!-- ... -->
Syntax
Example
See Also
<abbrev>
Syntax
Examples
See Also
<abstract>
Syntax
Example
Note
See Also
<<annotation text>>
Syntax
Example
<book>
Syntax
Example
<caution>
Syntax
Example
See Also
<chapter>
Syntax
Example
See Also
<computer>
Syntax
Examples
See Also
<copyright>
Syntax
Example
See Also
<dterm>
Syntax
Example
See Also
<emph>
Syntax
Example
See Also
<!entity>
Syntax
Purposes for Entities
Examples
See Also
<esc>
Syntax
See Also
<ex>
Syntax
Example
See Also
<figure>
Syntax
Examples
See Also
<glossary>
Syntax
Example
See Also
<graphic>
Syntax
Examples:
See Also
<head>
Syntax
Examples
See Also
<helpvolume>
Syntax
See Also
<hometopic>
Syntax
Example
See Also
<idx>
Syntax
Examples
<image>
Syntax
See Also
<item>
Syntax
See Also
<keycap>
Syntax
Example
See Also
<lablist>
Syntax
Example
See Also
<lineno>
Syntax
Example
See Also
<link>
Syntax
Notes
Examples
See Also
<list>
Syntax
Examples
See Also
<location>
Syntax
Examples
See Also
<memo>
Syntax
Examples
See Also
<metainfo>
Syntax
Example
See Also
<newline>
Syntax
Example
See Also
<note>
Syntax
Examples
See Also
<otherfront>
Syntax
See Also
<otherhead>
Syntax
Example
See Also
<p>
Syntax
Examples
See Also
<procedure>
Syntax
Example
See Also
<quote>
Syntax
Example
See Also
<rsect>
Syntax
Example
See Also
<s1>...<s9>
Syntax
Examples
See Also
<sub>
Syntax
Example
See Also
<super>
Syntax
Example
See Also
<term>
Syntax
Example
See Also
<title>
Syntax
Example
See Also
<user>
Syntax
Example
See Also
<var>
Syntax
Example
See Also
<vex>
Syntax
Example
See Also
<warning>
Syntax
Example
See Also
<xref>
Syntax
Examples
See Also
Chapter 6 Summary of Special Character Entities
Special Character Tables
Chapter 7 Command Summary
Help System Commands
Processing HelpTag Files (dthelptag)
Command Syntax
Command Options
Parser Options
See Also
Displaying Help Topics (dthelpview)
Command Syntax
See Also
Generating a Browser Help Volume (dthelpgen)
Command Syntax
Options
See Also
Chapter 8 Reading the HelpTag Document Type Definition
Document Type Definition
Helptag 1.3 DTD
See Also
DTD Components
Element Declarations
Examples
Element Declaration Keywords
Attribute List Declarations
Formal Markup
Formal Markup Caveats
Explicit Start and End Tags
Explicit Hierarchy of Elements
Example
File Entity Declarations
Example
Processing Formal Markup
Part III The Programmer's Job
Chapter 9 Creating and Managing Help Dialog Boxes
Help Dialog Boxes
Standard Xt Paradigm
General Help Dialog
To Create a General Help Dialog
Example
See Also
Quick Help Dialog
To Create a Quick Help Dialog
Example
See Also
Summary of Application Program Interface
Chapter 10 Responding to Help Requests
Requesting Help
Context Sensitivity
Entry Points
Displaying Help Topics
See Also
To Display a Help Topic
Example
To Display a String of Text
Example
To Display a Text File
Example
To Display a Man Page
Example
Enabling the Help Key (F1)
To Add a Help Callback
Importance of Client Data
Example
Providing a Help Menu
See Also
Supporting Item Help Mode
To Add Support for Item Help
Example
Chapter 11 Handling Events in Help Dialogs
Supporting Help Dialog Events
Hyperlink Events
When Dialogs Are Dismissed
Quick Help Buttons
See Also
Responding to Hyperlink Events
To Provide a Hyperlink Callback
Example
Detecting When Help Dialogs Are Dismissed
Using the Application-Configured Button
To Enable the Application-Configured Button
Example
See Also
Chapter 12 Providing Help on Help
Providing Help on Help
For Application Help
For Standalone Help
How Help on Help Is Found
Accessing Help on Help in an Application
To Set the helpOnHelpVolume Resource
Examples
To Provide a Using Help Command
Example
To Display Help on Help
Example
See Also
Writing Your Own Help on Help Volume
Required Entry Points
To Copy the Help4Help Source Files
Example
Chapter 13 Preparing an Installation Package
Overview
Delivering Online Help
Creating an Installation Package
RunTime Help File
Graphics Files
Help Family File
Registering Your Application and Its Help
Standalone Help
What Happens When the Application Is Registered
How a Help Volume Is Found
Product Preparation Checklists
For Authors
For Product Integrators
For Programmers
Part IV Internationalization
Chapter 14 Native Language Support
Internationalized Online Help
Internationalization Factors
Character Sets and Multibyte Characters
Language and Territory Names
Locale and Character Set
Examples
HelpTag Software
DtHelp Message Catalog
LANG Environment Variable
See Also
helplang.ent File
Formatting Tables
Font Schemes
See Also
Understanding Font Schemes
Font Resources
Sample Font Schemes
To Choose a Font Scheme
Example
Creating a Formatting Table
Sample Formatting Table
To Create a Message Catalog
See Also
Displaying a Localized Help Volume
Preparing Online Help for International Audiences
See Also
Appendix A HelpTag 1.3 DTD
Glossary
Index
Numbers and Symbols
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
© 2010, Oracle Corporation and/or its affiliates