Document Bookmarks

If you want to create a complex document that consists of sections of one or more document reports, rather than one complete report, you can create a master document in Microsoft WordTM and within it create links to the report sections using their bookmarks. Bookmarks are GUID-based numbers that are automatically created for packages, diagrams and elements, and placed in a document when it is generated. Every object is bookmarked in the document according to the following rules:

All alphabetic and numeric characters remain the same
All other characters (including spaces) are converted to underscores
 

For example UC01: Use Case Model becomes UC01__Use_Case_Model. A Package bookmark applies from the beginning of a Package to the end, and includes all child Packages and elements underneath. You can also manually assign bookmarks if you want to have references to additional subdivisions of a model or document. If you change your model and regenerate your document report, you can simply refresh the links in the master document in Word to automatically update the Word document.

When you use bookmarks to add sections of a generated report to a Word master document, you work with Word and the Enterprise Architect Project Browser open at the same time.

Add a Bookmarked Section of an RTF Document to a Word Document

Step

Action

See also

1

Within the Word file, position the cursor at the point at which to insert the section of the document.

 

 

2

Select the Word Insert | File menu option.

The Insert File dialog displays.

 

 

3

Browse for and select the document file to insert, then click on the Range button.

 

 

4

In the Enterprise Architect Project Browser, right-click on the Package, diagram or element to include in the documentation.

The context menu displays.

 

 

5

To paste the object's bookmark into the clipboard, select the appropriate menu option:

Documentation | Copy Documentation Bookmark (Package)
Copy/Paste | Copy Documentation Bookmark (element)
Copy Documentation Bookmark (diagram)

 

 

6

In Word, in the Range cell of the Insert File dialog, press Ctrl+V to paste the information from the clipboard.

 

 

7

Click on the OK button.

 

 

8

Click on the drop-down arrow next to the Insert button. A short menu displays containing two options:

Insert embeds a permanent copy of the text
Insert as Link creates a link that can be updated if you alter the source document

 
Select the Insert as Link option.

 

 

9

Repeat steps 1 to 8 for each section of each document you want to include in the Word document.

 

 

10

Select the Word Tools | Options menu option and, on the Options dialog, select the General tab and select the Update automatic links at Open checkbox.

Whenever the Word document is opened, the links to the document sections will be automatically updated with any changes made to the generated documents.

 

 

Notes

You cannot use Bookmarking in Master Document elements, which effectively replace Bookmarking in Word
 
Bookmarking requires each bookmark to be unique; when you generate a report with a standard template (including in a single Model Document element), each bookmark is unique and there is a 1:1 association between the element details being generated and the elements in the repository
 
As Master Documents are intended to contain multiple sub-documents, the association ceases to be 1:1; there is no simple method that enables the generated data to be uniquely identified directly in association with the original element

Learn more

Insert Reference Links (manually insert bookmarks)