Doc-O-Matic - Documentation Web Help

You are here: Creating Documentation > AutoDoc Features > Creating Indexes

Doc-O-Matic 6

Creating Indexes

Collapse All

See Also

Index, Indexing

Related Settings

Index, Index Prefixes, Topic Titles, AutoDoc Titles, Context Index

A very important part of your documentation is the index. There are several ways to create an index for your Help and your print documentation in Doc-O-Matic. For HTML Help two separate indexes one for the index pane and one for the Doc-O-Matic index page is created. For MS Help 2 an additional third context index for the integration into Visual Studio and Borland Developer Studio is created

Generic Topics

For your generic topics you can manually add keywords for each topic. Additionally you can add all topic titles to your index by selecting the Use topic title as index entry for generic topics check box on the Index page.

Symbol Topics

There are several options to customize your index entries for symbol topics. You can:

Manually add keywords and f-keywords for Help 2 context index in the Topic Properties for each topic.
Set index entries for symbol types by typing variables in the corresponding box on the Topic Titles page.
Add several types of index entries on the Index page.
Set index entries for AutoDoc topics by typing variables in the corresponding box, on the AutoDocAutoDoc ContentAutoDoc Titles page.
Remove prefix characters for your index entries.
- To remove the prefixes, type them in Prefixes on the Index Prefixes page. Doc-O-Matic removes the listed prefixes from the index.
- To sort index entries on the index page by titles without prefix and print titles with prefixes, select the Use modified index for sorting only check box.

To integrate you Help into another HTML or WinHelp Help system

On the Views Bar, click Settings.
Click the corresponding Configuration tab..
Select AutoDocIndex.
In the Index Presets box select the Help system in which you want to integrate your Help into.
Click Apply and the matching check boxes are selected automatically.

To integrate your Help 2 into Visual Studio or Borland Developer Studio

On the Views Bar, click Settings.
Click the Help 2 Configuration tab.
Select Files & FormatHelp 2Context Index.
Select the corresponding options.
The default setting creates the index entries needed for the integration.