How to Avoid Broken Links and Support External Page Links in Confluence
When creating links to other pages in Confluence, it is essential to ensure that the links will work even if the page is renamed or moved to a different space. This article provides instructions to create links that remain functional even when the target page is renamed or moved.
Instructions
To avoid broken links for external pages on your Confluence pages:
Copy the content target of the page you want to link with. To do so, right-click the page title and select Copy Link Address or manually copy the page URL.
Next, find the space key to be added to the link. A space key is a unique identifier for a space in Confluence. Navigate to the space directory and look at the space URL. The space key is the string of characters shown after "display/".
Next, edit the link to include the space key. The correct format for a link that includes the space key is as follows:
<ri:page ri:space-key="TAS" ri:content-title="Title" ri:version-at-save="2"
Note that in this example,"TAS"is the space key and"Title"is the content title of the page. The version-at-save is optional, and it is the version of the page at the time it was saved.
To avoid broken links, it is important not to use the following format:<ri:page ri:content-title="Title" ri:version-at-save="2" />
This format only includes the content title of the page which changes if the page is renamed or moved to a different space.
With these steps, you can create links that remain functional even when the target page is renamed or moved to a different space in Confluence. This ensures that users can always access the required information and it helps maintain your Confluence pages' integrity.
Additionally, it is essential to test the links to ensure they are working correctly and update them if needed.