You are here: More Information > Special Tasks
Special Tasks
Technical Reference
> File and Parsing Options > Adding Other File Types > Plain Text Files > Assigning Topic IDs
Assigning Topic IDs
Close
Doc-O-Matic 10
Assigning Topic IDs

Doc-O-Matic automatically assigns the file name of a plain text file as topic ID. If your plain text file contains comments for more than one source code symbol, you need to add topic IDs to each comment block using the default Topic Identifier @@ and the name of the symbol to which the documentation should be associated. 

Assume you have a function Sort:

@@List::Sort The Sort function sorts the list.

Doc-O-Matic detects the identifier only, if he is the first string of a line, no white spaces are allowed between the identifier and the beginning of the line. All text between an identifier line and the next identifier line is taken as description. Text in plain text files is not enclosed in source code comment characters. 

After successfully adjusting your plain text files, Doc-O-Matic associates your comments with the corresponding source code symbol. Comments appear in the Topic Editor (converted files) or in the Topic Preview.

Topic File Parsing

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