Using QuickDoc and Templates

Doc-O-Matic includes a QuickDoc feature that helps you speed up your documentation process. With QuickDoc you can determine the process of creating and saving topics for each symbol and topic type in advance. When you actually create a new topic or documentation you only need one click for this process.

You can use each topic in your project as template for new topics or you can use special template topics. Template topics are topics with a topic ID starting with !!TEMPLATE_. They are not exported to the output and they are stored in the Templates & Special Topics folder. You can create your own template topics or you can use the predefined template topics, that are included in your installation in the template.dtx file such as !!TEMPLATE_Function, !!TEMPLATE_FunctionEx, !!TEMPLATE_Source.

To configure QuickDoc

On the Manage tab, in the Create Content group, click QuickDoc , and then click QuickDoc Settings.
Select the symbol or topic type for which you want to configure QuickDoc. Topics are all generic topics in your project.
Browse for the topic, that you want to use as template topic for this symbol type.
Select Adjust template, to adjust your template for the documentation of functions.
To use a blank notepad, leave the Template Topic box empty, and then select the Options you want to turn on. You can:
- Set the Topic Property Version Specific to your project version number.
- Mark the new topic as Unfinished.
Click the Save Topic Behavior tab.
Under Save Topic click the option you want to use.
To save your topics in .dtx files, do the following:
- Select one of the filename options.
- Browse for a folder.

To use QuickDoc

Select the symbol you want to document in the symbol hierarchy.
On the Manage tab, in the Create Content group, click QuickDoc , and then click QuickDoc .
Click Save .

To add template.dtx file to your project

On the Project tab, in the Add group, click Add Files .
Find the Doc-O-Matic directory.
Select the template.dtx file, in the support subdirectory.

Notes

To ensure a consistent look of your documentation all programmers or technical writers working on the same documentation project can use the same template topic.