United States-English

Common Desktop Environment: Help System Author's and Programmer's Guide

Part II Part 2 — The Author's Job

»

Technical documentation


»	Feedback

» Table of Contents

» Glossary

» Index

Part 2 — The Author's Job

Table of Contents

2 Organizing and Writing a Help Volume

Help Volume Components

The Top Level Element: Part
Topics and Subtopics
Entities
Meta Information
Glossary

General Markup Guidelines

Markup in Your Source Files

A Help Volume at a Glance

Help Source Files

Creating Your volume.sgm File

Help Files in File Manager

See Also

Writing Your First Help Volume: A Step-by-Step Example

Create the Source Directory
Create the Master DocBook File
Create the Run-Time Help Files
Display the Help Volume

Creating a Topic Hierarchy

Example
To Create a Part
To Add a Topic to the Hierarchy

Creating Meta Information Topics

To Create a Meta Information Section

Adding a Nonhierarchical Topic

To Add a Nonhierarchical Topic

Accessing Topics

Rules for ID Names
Built-in IDs
To Add an ID to a DocBook Element

Using Entities

Rules for Entity Declarations
To Create a Text Entity
To Create a File Entity

3 Writing a Help Topic

Creating Help Topics

Example

Creating Structure within a Topic

To Start a Paragraph
To Enter an ItemizedList
To Enter an OrderedList
To Enter a SegmentedList
To Enter a VariableList
To Show a Computer Listing
To Add a Note, Caution, or Warning

Entering Inline Elements

To Emphasize a Word or Phrase
To Cite a Title
To Mark the Title of a Book, Chapter, or Section
To Display a Computer Literal
To Display a Filename
To Display a Variable

Creating Hyperlinks

Examples
To Create a Definition Link

Displaying Graphics

Syntax
To Create a Figure

Including Special Characters

To Include a Special Character

Including Writer's Comments

Syntax
To Insert a Comment

Creating an Index

To Mark an Index Entry

Creating a Glossary

To Mark a Glossary Term
To Define a Term in the Glossary

4 Processing and Displaying a Help Volume

DocBook Software
Viewing Your Volume

Creating Run-Time Help Files

To Create a Run-Time Help Volume
DocBook Output
To Run the dtdocbook Command Manually
To Review and Correct Parser Errors

Viewing a Help Volume

To Display a Help Volume

Adding Your Help to the Index Volume

Index Volume
Help Family File
To Create a Help Family
To Display the Index Volume

Printing Help Topics

Testing Your Help

Validating Hyperlinks
Verifying Entry Points
Checking Index Entries
Testing Graphics

5 Summary of Special Character Entities

6 Command Summary

Help System Commands

Processing DocBook Files (dtdocbook)

Command Syntax
Command Options

Displaying Help Topics (dthelpview)

Command Syntax

Generating a Browser Help Volume (dthelpgen)

Command Syntax
Options

7 Reading the DocBook Document Type Definition

Document Type Defintion

DocBook 2.1 DTD

DTD Components

Element Declarations
Element Declaration Keywords
Attribute List Declarations

Formal Markup

Formal Markup Caveats
Explicit Hierarchy of Elements
File Entity Declarations

Printable version


Privacy statement	Using this site means you accept its terms	Feedback to webmaster

© Hewlett-Packard Development Company, L.P.