RTF Bookmarks

Bookmarks are markers that are automatically placed in your rich text document when you generate it. You can create a master document in Word and link to sections of an Enterprise Architect report based on bookmarks. For example, a Word document might have a section for a small part of your component model. Using bookmarks you can generate a full component model, and then link into just one section of the report.

This way you can maintain a complex Word document from parts of Enterprise Architect reports. If you link into Enterprise Architect reports, then you can regenerate the report and refresh Word links to update the master document without having manually changed anything. For more information on refreshing links, see the Refresh Links topic.

Bookmarks are GUID-based numbers that can be created for packages, diagrams and elements. A package bookmark applies from the beginning of a package to the end, and includes all child packages and elements underneath.


You cannot use RTF Bookmarking in Master Document elements, which effectively replace RTF Bookmarking in Word.
RTF Bookmarking requires each bookmark to be unique. When you generate a report with a standard RTF template (including in a single Model Document element), each bookmark is unique and there is a 1:1 association between the Elements-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.

Bookmark a Section of Enterprise Architect for RTF Documentation

  1. In the Enterprise Architect Project Browser, right-click on the package to include in the documentation. The context menu displays.
  2. Select the Documentation | Copy RTF Bookmark menu option to paste the package into the clipboard as a bookmark for use in Word.

Insert a Bookmarked Section of an Enterprise Architect RTF Document into Word

  1. Open the Word document and position the cursor at the point at which to insert the file.
  2. Select the Word Insert | File menu option. The Insert dialog displays.
  3. Locate and click on the file to insert, then click on the Range button.
  4. In the Range cell type or paste the information from the clipboard.
  5. Click on the OK button.
  6. Click on the drop-down arrow next to the Insert button. Select the Insert as Link option.

The Insert option sets a permanent copy; the Insert as Link option creates a link that is updateable on altering the source document. For Insert as Link to operate you must first set Refresh Links.

Every package is bookmarked in the RTF 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.