Add Section Content

In the Document Template Designer, as you select the check boxes in the Sections panel to report on the different objects and features of the model, pairs of highlighted tags are added to the Contents panel. Many of these pairs of tags have a short instruction between them, as indicated below:

sectionname >
[right-click-to-insert-<objectname>-fields]
< sectionname

Where the text message is shown, you can delete it and use the space between the tags to provide the content of the report, by:

Typing or pasting boiler-plate text that you want to include in your reports, and
Inserting fields that extract the values of specific characteristics and properties of the object

Access     Project | Documentation | Document Template Designer > Content

Add information content to template

Action

Detail

See also

Add text

Click in the space between the tags (or anywhere else in the template) and type or paste (Ctrl+V) the text you want to display in the report.

Highlight and right-click on text to format it, using the RTF Editor commands.

 

 

Custom Template Design Options

Insert fields

Right-click in the area between the opening and closing tags, and select the Insert Field context menu option; this displays a context-sensitive list of fields to add to this section of the template.

Click on the name of the field you want to add. The Document Template Editor displays the field tag in the text space. For example:
 

{Element.ParentPackage}

 

When you generate a report from the template, the report generator replaces the field name with the actual value. You might need to type lead-in text and add spaces to support the field value, or use the fields in a table with row and column headings.

You can insert as many fields as you want from the list; you usually apply each field once, as the report generator applies the template instructions to each instance of the object.

 

 

 

 

 

 

 

Create Tables

Notes

As the model and linked document tags do not require fields, you cannot display the editor context menu between these tags
The child element, embedded element and child package tags represent sections that, can have defined fields, but these fields prevent the sections from replicating the structure of their parent element and package sections; as it is preferable to use the parent structures, these tags do not prompt you to add fields with the [right-click-to-insert-<objectname>-fields] message, although the message is still applicable
If you select a field with short date format (such as Pkg.DateCreatedShort, Diagram.DateModifiedShort or Element.DateCreatedShort) the format is actually drawn from the MS Windows settings
 
To use a different short date format, click on the Start icon on the Windows desktop and select the Control Panel | Regional and Language Options | Customize option

Learn more

Learning Center topics

(Alt+F1) | Reporting | RTF Templates | Add a Field