Document Options

When defining the contents of your document, you can set a wide range of options for selecting the reported items by type and property, and you can organize the information within each type in order of position in the Project Browser or by created or modified date.These Document options are provided in two different ways:

As the Options and Advanced tabs on the Generate Documentation dialog, to be set for a specific instance of a report; the options are reset when you exit the dialog or select a different template
As panels on the Document Options dialog, to be configured in a template as the default settings to be applied to every report generated using that template; these settings can be overridden by the 'specific instance' settings on the Generate Documentation dialog

 

The listed options are the same for both dialogs, except that the Document Options dialog:

Includes the Template Fragment option
Includes the Custom Query tab
Includes the Element Filters and Other Filters tabs from the Generate Documentation dialog
Does not provide these options (as found on the Advanced tab of the Generate Documentation dialog):
The Switch generator button
The Disable large OLE file support option
The Insert page breaks when generating a Master Document option

 

Access    Project Browser package: ( F8 ) > Options
Project Browser package: ( F8 ) > Advanced, or
 
Project | Documentation | Document Template Designer: <template> > Content | File | Document Options

Options

Field

Usage

See also

Only include objects

Filter elements according to the date they were created or last modified. In the:

First field, select the value Modified or Created from the drop-down list
Second field, select the value After or Before from the drop-down list
Third field, select the checkbox and set the appropriate date

 

 

Where Package Phase

Filter elements according to the value of the Package Phase field.

In the first field select the qualifier, and in the second type the required phase (or leave the default value All).

 

 

With element status

Filter elements according to status.

In the first field, select the qualifier (like, not like, in, not in) and in the second field type the value to be used.

Values should be enclosed in quotes; for example: "Proposed".

If you type more than one value, separate them with a comma; for example: "Proposed", "Implemented".

 

 

Connector Direction

Filter connectors according to direction.

If you select Both, the connector is documented twice; once for the source element and once for the target.

For the remaining two values, the connector is documented only for the source or target element, as appropriate.

 

 

Packages by

Order packages in the generated documentation in either ascending or descending order of Name, Tree Order, Modified Date or Created Date.

 

 

Elements by

Order elements in the generated documentation in either ascending or descending order of Name, Tree Order, Modified Date or Created Date.

 

 

Diagrams by

Order diagrams in the generated documentation in either ascending or descending order of Name, Tree Order, Modified Date or Created Date.

 

 

Exclude details for

Exclude all elements of the selected type or types from the generated document.

 

 

Exclude connector type

 

Exclude all connectors of the selected type or types from the generated document.

 

 

Advanced Options

Field

Usage

See also

Hide 'note-less' elements

 

Exclude all elements without notes from the documentation.

 

Diagram Format

Set the diagram format for the images included within the documentation to either Metafile or Bitmap.

 

 

Skip root package

Exclude the parent package from the documentation and include only the child packages.

 

 

No bookmarks

Prevent RTF bookmarks from being inserted into the generated document.

 

 

Adjust Heading Levels

Enable the RTF Generator to automatically restrict the levels of heading generated for nested sub-packages in a document

The generator reproduces heading levels down to the value you set; for example, if you have four nested levels of sub-packages and you set this field to:

Heading 2, all sub-packages in the report are documented under level 2 headings
Heading 4, the first level of subpackages are documented under level 2 headings, the next level under level 3 headings, and the remainder all under level 4 headings
Heading 6, the first level of subpackages are documented under level 2 headings, the next level under level 3 headings, the next under level 4 headings, and the next under level 5 headings; if you added further levels of sub-package they would all be documented under level 6 headings

 

The field defaults to Heading 9 to accommodate the maximum number of levels of nested subpackages.

 

 

Hide <Anonymous> elements

 

Hide anonymous elements in the documentation.

 

Use style defined in template for notes

Override the character formatting specified in your Notes fields with the formatting set for the field in the template.

 

 

Disable large OLE file support

 

Disable support for large Object Linking and Embedding (OLE) files.

 

Insert page breaks when generating a Master Document

 

Insert a page break after each Model Document in a Master Document.

Virtual Documents

Include child elements even if the parent element is filtered out

 

Document all child elements that are not otherwise filtered out by the restrictions, even if the parent elements are filtered out.

 

Hide 'note-less' connectors

 

Exclude all connectors without notes from the documentation.

 

Template Fragment

Enabling this option marks the current RTF Template as a Template Fragment.

 

RTF Template Fragments

 

Switch generator

Switch from this Generate RTF Documentation dialog (the Enhanced Template Driven Generator) to the Rich Text Format Report dialog (Legacy Generator).

This button is not available if you displayed the dialog from the Diagram List, Package Browser or Model Search.

 

The Legacy RTF Report Generator

Learn more

Learning Center topics

(Alt+F1) | Reporting | RTF Templates | Filter Elements
(Alt+F1) | Reporting | RTF Templates | Filter Connectors