Index

How to get here: In Settings on the corresponding configuration tab, select AutoDoc > Index

To add keywords manually

Switch to the Editor.
Type the keywords and subkeywords in the Keywords box in the Topic Properties.

To use index presets

Click the IDE arrow.
In the IDE list, click the IDE system you want to integrate your Help system in.
The required index options for the integration are selected automatically.

Notes

To integrate your Help in IDE Help systems use index presets to make sure that your index is compatible with the IDE Help system. To integrate Help 2 into IDE Help system you can configure the context index separately on the Files & Format > Help 2 > Context Index page. The settings on this page influence only the visible index.

Terms

index A listing of keywords and associated data that point to the location of more comprehensive information, such as topics.

integration of help systems The combining of an Help system with the Help system of an IDE. For the integration index entries are required in a specific format.

VS.NET The Help system of the Visual Studio .NET IDEs.

MSDN 6 The HTML Help system of Visual Studio IDEs such as VS 6 and earlier.

generic topic A topic that is not associated with a source code symbol.

symbol topic A topic that is associated with a source code symbol.

fully qualified symbol name A symbol name that includes the namespace and the class name of the symbol.

enumeration A data type consisting of a sequence of named values given in a particular order. Doc-O-Matic does not create a symbol topic and an index entry for each enumeration value. Therefore index entries for enumeration values have to be included separately.