You are here: Help Authoring Basics > Building Help Systems with Doc-To-Help

Building Help Systems with Doc-To-Help

As an author, you implement the five fundamental elements of a Help system by correlating your source documents with objects you define in a Doc-To-Help project. This sounds more complicated than it is; if you start with a good outline in Microsoft Word or your HTML files, you're well on your way to producing a full-fledged Help system.

Doc-To-Help defines the elements of a Help system as follows:

Topics

Contiguous source document regions delimited by active paragraph styles.

Contents

A hierarchy derived from paragraph style outline levels, similar to Word's document map.

Index

A set of associations between keywords and topics. Keywords can be generated from styles automatically, manually entered by the author, or scripted.

Navigation

Sequential navigation is defined by the order of topics within a document. Subtopic navigation is derived from paragraph style outline levels.

Hypertext

Words or phrases, formatted with an active character style that textually match a single topic, or a set of topics via an index element.

 

More:

Understanding the Doc-To-Help Build Options

Defining Help Topics

Organizing the Help Contents

Constructing the Index

Specifying Navigational Elements

Linking Related Topics