Broken Links

Before publishing your help system, you want to make sure it is working correctly. The most obvious problem in an HTML based system is broken links: HTML tags include references to files which don't exist, possibly because they were removed or renamed.

Broken links can occur as:

• Images not appearing in the text
• Hyperlinks not working
• Clicking on an item in the table of contents or index resulting in a 'page not found'
• Missing references to css or js files.

The user consulting the help does not get the help he needs and be annoyed about it.

Scanning for broken links

When you press the Broken Links button, all references in topic files are checked. Any missing links are reported in the Broken links dockable window.

• On the Review ribbon tab, press the Broken Links button

After a scan of the help project, the broken links reports open:

Repairing broken links

To fix a broken link

1. Double-click on the line in the broken links dockable window
   This opens the selected document for editing
2. Make the required changes to the links
3. • Edit hyperlink in Design mode - or -
   • Edit hyperlink in Code mode 
4. Save the changes