You are here: AutoDoc and Formatting > Formatting the Output > Formatting Topic Pages > Navigation Information
Close
Doc-O-Matic 10
Navigation Information

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.

  1. On the Quick Access Toolbar, click Settings .
  2. Click the corresponding Configuration tab.
  3. Select AutoDoc > AutoDoc Content.
  4. In the Settings for box, select the topic type you want to set options for.
  5. Select the section you want to use as description.
  6. 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.
  7. 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.
  8. 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.
  1. On the Quick Access Toolbar, click Settings .
  2. Click the corresponding Configuration tab.
  3. Select AutoDoc > Section Options.
  4. Select symbol titles, symbol names or symbol declarations for the left column of your navigation tables.
  1. On the Quick Access Toolbar, click Settings .
  2. Click the corresponding Configuration tab.
  3. Select AutoDoc > AutoDoc Content > Content Options.
  4. Select how you want to include base class members in your navigation tables.
  1. You can format navigation information as tables or as paragraphs.
  2. Format your navigation information on the Files & Format > Sections > Format page. The formatting applies to navigation pages and for navigation sections.
  3. For both styles there exists separate Formatting Elements.
  4. There are additional Formatting Elements for the titles of navigation subpages. Headings of navigation section and pages (for example Members) are created automatically.
  5. To change the words used as headings in navigation sections and pages translate them in the dictionary file. For details, see Translating the Output.
  6. You can omit table headers on the AutoDoc > AutoDoc Content > Content Options page.
  7. You can format navigation tables with three columns and showing Name and Description in table headers on the AutoDoc > AutoDoc Content > Content Options page.
  1. You can create your class hierarchies as graphic or as text. You can:
  2. Select the format on the AutoDoc > Local Class Hierarchy page.
  3. Customize your local class hierarchy graphic on the AutoDoc > Local Class Hierarchy page.
  4. Include ancestor classes defined in other projects. In this case add project databases including ancestor class information of these projects to your current project.
  5. Customize your text class hierarchy on the AutoDoc > Local Class Hierarchy page.
  6. Add derived classes to the class hierarchy on this page.
  7. Format character and paragraph style of the class hierarchy by editing the Class Hierarchy (Inheritance Hierarchy in Visual Studio templates) Formatting Element.
  8. Change the heading of the class hierarchy by renaming the Class Hierarchy section on the [General Settings]->Sections page.

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

Class Hierarchy, Navigation Paragraph, Navigation Table

Copyright © 2000-2020 toolsfactory software inc. All rights reserved.