Create Linked Document on an Element

If you need to provide more extensive and structured documentation on an element, you can develop this as a formatted document directly linked to the element. You can develop the document from a blank page or using a system template or user-defined template, at several different points in the work area.

Access     Click on an element in the Project Browser, Diagram List, Package Browser, Specification Manager, Model Search or diagram, and either:
 
Right-click | (Create) Linked Document
Ctrl+Alt+D
Element | Linked Document
View | Notes: Linkeddocicon in toolbar, OR
Right-click | Properties > General: Linkeddocicon in Notes field toolbar

Create a linked document

Step

Action

See also

1

A default blank-page document opens in the Linked Document Editor, based on the Normal.rtf style template.

The New Linked Document from Template dialog might display, depending on whether you have previously selected the Show this dialog on document creation checkbox. In this case, go to step 3.

 

The Normal.rtf Style Template

2

If you do not want to apply a system template or user-defined template, go to step 6.

If you do want to base the document on a selected template, click on the newicon (New) icon in the editor toolbar.  A prompt displays for you to confirm that you are clearing the current document; click on the OK button.

The New Linked Document from Template dialog displays.

 

 

3

In the Template field, click on the drop-down arrow and select the template from which to create the document.

This can be either a system-supplied template or a template that you have previously created yourself.

 

 
 

Create Linked Document Templates

4

If you want to display the New Linked Document from Template dialog by default whenever you start to create a linked document, select the Show this dialog on document creation checkbox.

If you no longer want to display the dialog by default, deselect the checkbox.

 

 

5

Click on the OK button.

The new linked document opens in the Linked Document Editor. If you have based the document on a selected template, the document shows the content applied by the template.

 

 

6

Enter and format the text of the document, using the facilities of the Linked Document Editor.

 

Edit Linked Documents

Notes

You can create only one linked document on an element; if you need to create more, develop each document within its own Document Artifact element and link these to the model element
This operation is available in the Corporate, Business and Software Engineering, System Engineering and Ultimate editions
When you have saved the document, an A symbol displays in the bottom right corner of the element

Learn more