Doc-O-Matic - Documentation Web Help

You are here: Creating Documentation > AutoDoc Features > Creating Topic Overviews

Doc-O-Matic 6

Creating Topic Overviews

Collapse All

Related Settings

AutoDoc Folder, Index

Doc-O-Matic automatically includes navigation information for all topics that have subtopics on the page of the respective topic. For details, see Navigation Pages and Sections.

In addition, you can generate content for all folders of symbols contained in your project. In the Content Manager symbols are automatically sorted using the Symbol Reference, Classes, Functions, Macros folders. There are several ways to include them in the output. You can:

Show them as folders only.
Generate AutoDoc content for them.
Create a "real" topic and manually add text to these topics. Overviews are automatically generated.

To generate content for folders

On the Views Bar, click Settings.
Click the corresponding Configuration tab.
Select AutoDocAutoDoc Folder.
Select one of the check boxes, and then type the default text that you want to add.
The Always create content for member folders option, includes content for overloaded function folders and the Member Overview page. The Symbol Reference is the only folder for which you can not automatically create content.
You can use the following variables.
- NAME The name of the class.
- CATEGORY The type of symbols listed in this folder.
- CATEGORYL The type of symbols listed in this folder in lowercase.

To change folder names

On the Views Bar, click Settings.
Click the corresponding Configuration tab.
Select AutoDocAutoDoc ContentAutoDoc Titles.
Type the variables you want to use to create folder names in the corresponding boxes.

To create folder topics

In the Content Manager, select the grouping level for which you want to create a topic (for example Symbol Reference).
Click Create Documentation .
In the New Topic dialog box, the predefined special topic ID appears.
In the Topic Editor write text for your topic.
Doc-O-Matic automatically creates overviews of all subtopics of these topics. For example, all classes, variables, files and macros are listed on the Symbol Reference page. On the classes page all classes are listed. Additionally, all listed categories are available on a separate page in the Help systems.
To list folder topics in the Index, select the Add folder topics check box on the Index page.

Notes

All folder topics are symbol topics. Click the Symbol Topic tab on the Section Appearance page to determine which sections appear in the output.

Applies to: Doc-O-Matic Professional and Doc-O-Matic SRC