Creating Generic Topics

Doc-O-Matic provides a method for adding "stand alone" topics that do not describe a specific symbol. For example, use generic topics to explain the general intention of your code.

You can insert generic topics in your source code or in a file that you have added to your project. Topic IDs of generic topics do not match a symbol's topic ID.

To create generic topics

Enter the following in your source code:

//@@Generic_Topic_1
// Here goes the text for generic topic 1.

The @@ characters are the default Tokens.
To create generic topics in DTX files, enter the following:

@@topic1
<TITLE Topic One>
This is topic one, its topic id is "topic1".

The default Topic Identifier is: "@@"

Notes

If you assign topic IDs that cannot be IDs for symbols (by using characters in the ID that are not allowed in symbol identifiers), they can not be mixed up easily.

Related Settings

Topic File Parsing