Prev Next

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

Select an element in the Project Browser, Diagram List, Package Browser, Specification Manager, Model Search or diagram, then use any of the methods outlined here to open the 'Linked Document' tab of the Document window.

Ribbon

Start > Explore > Properties > Linked Document

Design > Element > Properties > Linked Document

Keyboard Shortcuts

Ctrl+Alt+D

Create a linked document

Step

Action

See also

1

The 'Linked Document' tab opens in Read mode. Click on the icon and select the 'Edit Mode' option.

The 'Linked Document' tab switches to Edit Mode, and a default blank-page document opens, based on the Normal.rtf style template.

The 'Document - Edit' ribbon also displays in the Ribbon Bar.

 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, select the 'Document - Edit > File > File > New (Clear Document)' ribbon option.  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' tab. 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 Document - Edit ribbon.

 Document Edit Ribbon 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 Professional, Corporate, Unified and Ultimate editions
  • When you have saved the document, an A symbol displays in the bottom right corner of the element

Learn more