RTF Document Options
The RTF Document Options dialog allows you to set the filter and order the elements. The Dialog has the following functions:
Control
|
Function
|
Only include objects
|
Allows elements to be filtered according to date created or modified.
|
Where Package Phase
|
Allows elements to be filtered according to the value of the package phase field.
|
With element status
|
Allows elements to be filtered according to its status.
|
Packages by
|
Orders packages in the generated documentation in either ascending or descending order of Name, Tree Order, Modified Date or Created date.
|
Elements by
|
Orders elements in the generated documentation in either ascending or descending order of Name, Tree Order, Modified Date or Created date.
|
Diagrams by
|
Orders diagrams in the generated documentation in either ascending or descending order of Name, Tree Order, Modified Date or Created date.
|
Hide 'note-less' elements
|
Excludes all elements without notes from the documentation.
|
Diagram Format
|
Sets the diagram format for the images included within the documentation to either Metafile or Bitmap.
|
Skip root package
|
Excludes the parent package from the documentation and includes only the child packages.
|
Overwrite document fields
|
When this option is unchecked, fields defined in a document section are generated with the appropriate values populated in these fields. Turning on this option will replace the fields with actual text.
|
Adjust Heading Levels
|
Setting this option will allow the RTF Generator to automatically adjust template headings based on the model depth
|
Exclude details for
|
Excludes all elements of the selected type or types to be excluded from the generated document.
|
OK
|
Applies the options to the documentation to be generated.
|
Cancel
|
Closes the dialog without applying the options.
|
Help
|
Opens the help to this page.
|