Doc-O-Matic - Documentation Web Help

You are here: AutoDoc and Formatting > Formatting the Output > Formatting Topic Pages > Navigation Information

Doc-O-Matic 6

Navigation Information

Collapse All

Related Settings

AutoDoc Content, Automatic Sections, Section Options, Member Listing, Local Class Hierarchy, Local Class Hierarchy Layout, Sections Format, Sections

Formatting Elements

Class Hierarchy, Navigation Paragraph, Navigation Table

Navigation information is automatically added to your documentation. There are several ways how to format navigation information. Navigation information consists of symbol names (linked to the corresponding topic) and a description of this topic.

To customize description columns

On the Views Bar, click Settings.
Click the corresponding Configuration tab.
Select AutoDocAutoDoc Content.
In the Settings for box, select the topic type you want to set options for.
Select the section you want to use as description.
To omit topics and symbols without description text from navigation tables, select a specific section and then select Include topics that supply navigation description only.
Click the Word count limit arrow to set how many words you want show in the description section. Note that only section text till the first heading, list, table or preformatted code and preformat text is used as description text.
To make sure that description text does not exceed one sentence you can use the AutoDoc feature Automatic Sections to create one sentence summaries from your default section. In this case use the summary section as description text.

To customize name columns

On the Views Bar, click Settings.
Click the corresponding Configuration tab.
Select AutoDoc Section Options.
Select symbol titles, symbol names or symbol declarations for the left column of your navigation tables.

To include base class members

On the Views Bar, click Settings.
Click the corresponding Configuration tab.
Select AutoDocAutoDoc ContentContent Options.
Select how you want to include base class members in your navigation tables.

To format navigation information

You can format navigation information as tables or as paragraphs.
Format your navigation information on the Files & FormatSectionsFormat page. The formatting applies to navigation pages and for navigation sections.
For both styles there exists separate Formatting Elements.
There are additional Formatting Elements for the titles of navigation subpages. Headings of navigation section and pages (for example Members) are created automatically.
To change the words used as headings in navigation sections and pages translate them in the dictionary file. For details, see Translating the Output.
You can omit table headers on the AutoDocAutoDoc ContentContent Options page.
You can format navigation tables in the Visual Studio 2005 style with three columns and showing Name and Description in table headers on the AutoDocAutoDoc ContentContent Options page.

To customize local class hierarchies

You can create your class hierarchies as graphic or as text. You can:
Select the format on the AutoDocLocal Class Hierarchy page.
Customize your local class hierarchy graphic on the AutoDocLocal Class Hierarchy page.
Include ancestor classes defined in other projects. In this case add project databases including ancestor class information of these projects to your current project.
Customize your text class hierarchy on the AutoDocLocal Class Hierarchy page.
Add derived classes to the class hierarchy on this page.
Format character and paragraph style of the class hierarchy by editing the Class Hierarchy (Inheritance Hierarchy in Visual Studio templates) Formatting Element.
Change the heading of the class hierarchy by renaming the Class Hierarchy section on the [General Settings]->Sections page.