You are here: More Information > Special Tasks
Special Tasks
Technical Reference
> Documenting without Editor > Creating Generic Topics
Close
Doc-O-Matic 10
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.

  1. Enter the following in your source code:
//@@Generic_Topic_1 // Here goes the text for generic topic 1.
  1. The @@ characters are the default Tokens.
  2. To create generic topics in DTX files, enter the following:
@@topic1 <TITLE Topic One> This is topic one, its topic id is "topic1".
  1. The default Topic Identifier is: "@@"

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.

Topic File Parsing

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