Doc-O-Matic - Documentation Web Help

You are here: AutoDoc and Formatting > Formatting the Output > Formatting Topic Pages > Sections > See Also and Named Section

Doc-O-Matic 6

Related Settings

Section Appearance, Help Windows, Navigation Links

The See Also (Related Topics in Visual Studio templates) section is used to list related topics. In this section type you can insert a comma separated list of topic IDs or symbol names or list each topic ID or symbol name in a separate line. In addition, you can insert any text in a See Also (Related Topics in Visual Studio templates) section. Automatically created links to group topics and to additional information are presented in the Links (See Also section in Visual Studio templates) section. For details, see Navigation Links in Help Systems.

Items of See Also (Related Topics) sections are automatically linked when the autolinking feature is turned on for this section. For more information about how autolinking works, see Automatic Linking. Link text is the text that you have added to the See Also list.
To use the topic title (for example for symbols classname::membername or classname.membername), select the Replace link text with target title check box on the See Also (Related Topics) section definition page. This option applies also for manually added links. For more information about section definitions, see Editing and Creating Sections .
In the section definition you can replace one character (for example the comma) with another character (for example | ) a space or a paragraph (enter \n).
The See Also section is displayed as section and on a separate page in HTML Help systems and in a pop-up window in Windows Help by default. On the topic page a link to the See Also link list is shown.
To remove the additional See Also pages clear the See Also Section check box on the Files & FormatSectionsNavigation Links page.
To show See Also links in Windows Help on a separate page enter a file name for the See Also section on the settings page Help Windows.

To customize Named sections

You can use named sections, to present several link lists in your project and name them individually.
To name a named section insert the name of the section as first string after the section heading and separate it from the following section text by a comma.
Items in named sections can also be automatically linked and separators can be replaced in the output. Named sections are shown in-line.