As you develop content, you want to ensure that there are no broken links between documents. In most cases, broken links result when linked documents are deleted and not available.
Note: The Related Documents, Derived Documents, and Broken Links toolpanes are empty if you select multiple documents from either the Library or Outline Editor. Select only ONE document to display the appropriate results.
To help you track the state of links between documents, you can display the Broken Links toolpane from the Library or any document editor and repair broken links for selected documents. For example:
If you are working in the Library, select one document to view its broken links.
If you open a document in an editor (other than the Outline Editor) such as a web page or glossary, broken links are displayed for the open document.
If you are working in the Outline Editor, the results are based on the selected document. For example, if you select the root document in the Outline Editor, broken links are displayed for all documents that appear in the outline as well as any related documents. As you select other documents in the outline, broken links are displayed for the selected document and child documents as well as their related documents.
The Broken Links toolpane displays the document you have selected or opened in an editor. If there are broken links for the selected document they automatically appear in the toolpane once a document is selected or opened. The Name column shows the related documents that have broken links and the Broken Link column identifies the document to which the link is broken.
If the broken link is the result of a deleted document, you see the Missing Document in the Broken Link column. You can repair a broken link by removing the link to the missing document. For example, if a section has a broken link because a linked topic was deleted, you can open the section in the Outline Editor and remove the missing topic from the section. If a broken link results because a glossary document was deleted, you can open the Properties toolpane for the document and either remove the linked glossary or assign a different glossary.
Note: Broken link documents also appear in left pane of the Outline Editor so you see where they are in the context of the outline.
Link to Package File
A broken link cannot be detected when you have a document that links to a file in a Package and the file is then deleted from the Package.
Multi-user Considerations
Broken links can happen for several reasons, and, in most cases, can result from working offline. For this reason, it is recommended that if you do work offline and establish links between documents, you should periodically go back online and check in your work.
A broken link can be created the following ways:
- You create a link to a document that was deleted by another author.
- You create a link to a new document that exists in your local cache but has not been checked in to the server. This appears as a broken link to other authors who view the source document until you check in the new document.
- You create a link to an external document on your computer that is not visible to the other users.
- A link target URL existed at the time the link was created but it was deleted or renamed.
- A link can be broken because you are offline and you do not have a document in your local cache that a document is linked to. You should go online and get the appropriate documents that you need.
Broken links are represented in two ways. The Missing Document label appears for a broken link document that was new (not under version control) and deleted. A document that is under version control and deleted is identified by its name and a red X on top of the standard document icon. To repair this type of broken link you can either restore the deleted document or remove the link to the document.
To view broken links:
Display the Broken Links toolpane.
Select ONE document that you want to review from the Library or Outline Editor.
If the Broken Links toolpane remains empty when you select a document, there are no broken links. If broken links exist for the selected document, each document with a broken link appears. You should take the appropriate steps to fix any broken links that are reported.
Missing Document in the Broken Link column. You can repair a broken link by removing the link to the missing document. For example, if a section has a broken link because a linked topic was deleted, you can open the section in the Outline Editor and remove the missing topic from the section. If a broken link results because a glossary document was deleted, you can open the Properties toolpane for the document and either remove the linked glossary or assign a different glossary.
To view broken links: