You are here: More Information > Special Tasks
Special Tasks
Technical Reference
> Documenting without Editor > Creating Generic Topics > Using DTX Files
Using DTX Files
Close
Doc-O-Matic 10
Using DTX Files

You can either add existing DTX files to your project or create new DTX files by using Windows Explorer or any other application.

  1. On the Project tab, in the Add group, click Add Files .
  2. Locate and open the folder that contains the file you want to add.
  3. Click Open.
  4. Do one of the following:
    • Click No, to add plain text files to your project. The Topic Preview displays the content of the files. You can export the content of the files to the output formats but you can not edit the text in the Doc-O-Matic Topic Editor.
    • Click Yes, to convert files into DTX files. The content the files is saved as DTX files and added to your project. You can edit the text in the Doc-O-Matic Topic Editor. The files are not altered in any way.
  • Assign a topic ID that equals the symbol name (object) that you want to document. For details, see Assigning Topic IDs.
  • You can describe symbols (objects) that are already documented in your source and symbols without comments.
  • You can use the Editor to spell check your comments.
  • Comments stored in multiple locations (for example in your source and in a DTX file) appear on separate tabs.
  • With the Multiple Descriptions Handling feature you can specify the order and the appearance of comment parts located in different places.

In addition, you can add files using the Import Folder or the Add Folder command on the Project tab or the Manage tab of the Project Manager. If you import topic files Doc-O-Matic extracts all relevant files from the added directory and adds them to the project. If you add a directory Doc-O-Matic attempts to detect relevant files in the added directory each time you parse your project. With this feature you can make sure that all files in a directory are included in your Doc-O-Matic project.

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