Resource Documents

The Resource Document feature enables a particular documentation configuration to be 'remembered', linking the loaded template within the Generate RTF Documentation dialog to the current highlighted package. If a particular template is always used with a specific package, and multiple cases of documentation exist to be propagated, saving these as Resource Documents can ease document generation later.

How to

To create and use Resource Documents



See also


Open the Generate RTF Document dialog.

Generate RTF Documents


Click on the Resource Document button.

The Save current as document definition dialog displays.




In the Enter Value field, type a name for the document and click on the OK button.

The document is added to the Resources window for easy future access.




To generate documentation from the Resources window, right-click on the required document.

The context menu displays.




Select the required context menu option:

Open Document - Opens the corresponding .RTF file, as specified by the RTF template Filename property
Generate Document - Opens the Generate RTF Documentation dialog, loaded with the specified template
Auto Generate Document - Generates documentation, with the document located at the path specified by the template's Filename property
Delete Document - Removes the specified document





See also

Batch Generate Resource Documents

To generate a number of RTF documents at the same time, right-click on the RTF Documents folder name and select the Generate Documents context menu option; the Batch Document Generation dialog displays.

The dialog lists all resource documents in the RTF Documents folder, defaulted to selected; deselect the checkbox against each document that you do not want to generate (or click on the Deselect All button to clear all selections, then select those you require).

Click on the OK button to generate each of the remaining reports into their respective target file locations.

The Generate All Documents context menu option automatically generates every document in the RTF Documents folder, without displaying the Batch Document Generation dialog.




Resource Documents, saved into the Resources window, save the package, output file destination and template name from the Generate tab of the Generate RTF Documentation dialog, plus the data separately defined in the Options, Advanced and Element Filter tabs of the dialog

Learn more