Authoring - Detecting and correcting invalid bookmarks in hyperlinks

If a bookmark in a topic is removed then hyperlink that contain this bookmark will still open the hyperlink target but the jump to the bookmark in the hyperlink target will no longer work. In the Workbench the hyperlinks with invalid bookmarks are marked in the topic with an error sign: a red square with a white cross as shown in the next image.

Hyperlink with an invalid bookmark

Here we have removed the 'shark' bookmark in the 'About the shark' topic that was created in creating a bookmark. The next image gives you a closer look at that sign.

Hyperlink with an invalid bookmark

In a multi authoring environment other authors can change topics that are already retrieved in your Workbench. Bookmarks could be removed or re-inserted by other people while you are looking at the topic. So, if you have doubts about the invalidity of a hyperlink, just refresh the topic to see if the sign disappears or not.

You can also use the search function to scan a folder and its dependants for hyperlinks. The validity of the included bookmarks will be indicated in the search result.

Opening the search

Popup the menu of a folder and select 'Search'.

Searching for hyperlinks

On the 'Search' window you click on the 'Other' tab. Next, you choose the 'Hyperlinks' option and you start the search. The result is shown in the pane on the bottom of the Workbench..

Hyperlinks found

About the buttons of the search result

The buttons on the top right of the Search pane allow you to perform the following operations.

The Search pane

With the ‘Refresh’ button on the search result you can re-execute the last search. The folder or the topic that was the object of that search will be automatically reselected and the Search window will popup. The search options chosen before are preselected. You just have to click 'Start'.

 

With the ‘Print’ you can print the overview list. The content however is not included in the print.

 

The ‘History’ button on the search result pane allows you to reshow previous search lists (the 5 last search operations are kept in the history queue).

 

With the ‘Remove’ button you can clear a list from the history.

 

With the ‘Search’ button you can launch a new search on the object currently selected in the tree. The difference with the 'Refresh' is that you will have to set all the options and after the search operation, a new item will be added to the 'History' list.

 

The 'Bookmark' column indicates the hyperlinks with a bookmark. Invalid bookmarks are marked in red. You can click on the column heading to sort the result. If you double click on a found item or popup its menu and select 'Go to' the topic that contains the hyperlink will be located in the Workbench tree, the hyperlink in the topic will be selected. If you open the hyperlink properties by popping up the menu on the hyperlink and selecting 'Hyperlink properties' you can see that the bookmark field has a red background.

Hyperlink properties with invalid bookmark

Correcting

If the bookmark is no longer required, you can click on the 'Remove' button to remove it from the hyperlink properties. If you still require a bookmark you use the browse button to select another one.

Selecting another bookmark

In other cases you can re-insert the bookmark in the hyperlink target. To locate the hyperlink target, you can use the 'Where used' function of the hyperlink as demonstrated in the next image.

Requesting a hyperlink's where-used list

The 'Where used' pane on the bottom of the Workbench shows where the hyperlink target can be located.

Locating the hyperlink target to re-insert the bookmark

If there are multiple items in the list the 'Location' column can help you to find the correct item. Double click on the item in the list to locate it in the tree or popup the menu and select 'Go to'. Then you can recreate the bookmark in that topic.

About the buttons of the where used list

Authoring

 About HelpServer
 Starting up and logging on
 The basic working principles
 Using the content in help and documentation systems
 Formatting the content
 Searching and replacing text
 Reusing content with shares
 Navigating with hyperlinks
 Navigating with pointerpaths
 Using bookmarks and jumps
 Creating bookmarks
 Using jumps in topics
 Detecting and correcting invalid bookmarks in jumps
 Using bookmarks in hyperlinks
 Detecting and correcting invalid bookmarks in hyperlinks
 Duplicating content with clones
 Using tables
 Including media files
 Navigating to web pages
 Using embedded chunks
 Including html code
 Navigating with menus
 Using snippets
 Spelling checking
 Using the view mode
 Creating an index
 Creating a FAQ
 Creating a glossary
 Team authoring
 Working with projects
 Setting up structured authoring
 Generating file based output
 Creating printed output
 Importing files and folders
 Loading files in the project gallery
 Converting legacy content
 Including legacy content in real time
 Transferring objects between installations
 Smartcontent
 Notification
 Feedback
 Translating
 Customizing the look and feel
 User accounts
 Security
 Working with templates
 Working with metadata
 Versioning
 Auditing
 Workflow management
 Annotations
 Using event exits
 Appendix A: The URL parameters
 Appendix B: The object indicators
 Appendix C: Play Javascript