User Help > Working With Documents > Bookmarking and Cross-Referencing Documents
Bookmarking and Cross-Referencing Documents
For large documents, you can enhance the organization and navigation by inserting bookmarks in rich content fields and cross-references to those bookmarks. For example, you can insert a bookmark to identify content that you frequently refer to in a document and then insert a cross-reference that links to that bookmark.
A bookmark identifies a key area of interest (text or image) in a document and is stored as a unique text string in an item’s rich content field. While hidden in the rich content field, a bookmark is visible as a tooltip in the text and when performing bookmarking and cross-referencing operations.
A cross-reference is a hyperlink to a bookmark in a document and is stored as a URL in an item’s rich content field. It displays as a blue underlined hyperlink in a rich content field and is accessible from the Document view only.
Key Considerations
• In PTC RV&S Client GUI, the commands for inserting bookmarks and cross references are only available from the Document view (GUI) with inline editing or the embedded item edit view enabled. In the GUI, you can edit and delete bookmarks and cross-references from all views that allow you to edit rich content fields.
• In PTC RV&S Client GUI cross-references are accessible from the Document view only. Clicking a cross-reference from the Item Details or Relationships views is unsupported.
• In the Refreshed Web Interface, the options for inserting bookmarks and cross-references are available only in the edit view of DocStudio. DocStudio also allows you to later edit or delete these bookmarks and cross-references. Clicking a cross-reference from the Item Details view or Relationships views is unsupported.
• In the PTC RV&S Web interface, you can only delete preexisting bookmarks and cross-references.
The following key considerations for bookmarks and cross references are applicable for both PTC RV&S Client GUI and Refreshed Web Interface:
• A rich content field can contain multiple bookmarks and cross-references.
• You can create bookmarks and cross references for the following:
◦ text
◦ text with hyperlink
◦ image
◦ image with hyperlink
◦ OLE object
However, the bookmark or cross reference can be created only on individual entities. The content selected for creating a bookmark or cross reference cannot be a combination of any or all of these entities.
• A bookmark can contain a maximum of 40 characters consisting of letters, numbers, and underscores. Spaces and ASCII characters (!@#$%^&*()-=+[]{}\|;:'",.<>/?) are not permitted. If you create a bookmark from selected text in a rich content field, any unpermitted characters in the selection are automatically removed from the text in the Name field.
• To avoid naming conflicts and easily identify bookmarks, PTC recommends specifying simple and unique names for bookmarks. If multiple bookmarks with the same name exist, a cross-reference to the bookmark name navigates to the first occurrence of the bookmark in the document.
• To assist you in locating bookmarks in a document, hovering the cursor over text in a rich content field displays a tooltip if a bookmark exists, for example, Bookmark “engineering”.
• If a bookmark exists in the current document, but document filtering has hidden the item containing the bookmark, clicking a cross-reference to the bookmark displays a message indicating that the item is currently hidden. Similarly, in DocStudio if a bookmark exists in the current document but is not loaded in the Content pane, clicking a cross-reference to the bookmark displays a message indicating that the item is not available.
• If you click a cross-reference in a parent document, PTC RV&S does not search for the bookmark in subdocuments. Similarly, if you click a cross-reference in a subdocument, PTC RV&S does not search for the bookmark in the parent document.
Was this helpful?