Finding Broken Links
This How-to applies to: 2.1, 2.5
This how-to assumes you are using Kupu 1.4 or higher.
One of the challenges to maintaining a website is keeping track of all those hyperlinks. Pages, images, or files might get moved or deleted, and if anything was linked to those items, the link will break. You may have, from time to time, wanted to delete something but were unsure if there were any links referencing it.
Plone can help you out by tracking down any links that are broken!
To begin, you need to access the Kupu settings. That is found via the Site Setup link, usually found in the upper right corner of your website near the Search box.
Click on the Site Setup link. You should now see a screen that looks something like this:
Look for the Kupu visual editor (the one with the butterfly) and click on it. Now find the Links tab located at the top of the Kupu Configuration page. It should be between Documentation and Toolbar. You should now see a screen like this one:
At the top of this page is a list of all your Content Types. The contents of this list will vary depending on what add-on products have been installed on your site. You may also notice that certain content types are listed several times, such as Page in the above example. This stems from the fact that the Page content type is being used by more than one Plone product. You may need to look at each to see what the differences are.
Select a content type to check for broken links, then click Check Links at the bottom of the page. The next page you should see looks like this:
Each of the broken links is hyperlinked so that you can click on them and go check on the problem. The most common issue is that the linked item has been deleted or moved to a different folder. If you created a link via the HTML code, Kupu might flag them as "bad" because they weren't created using the Internal Link function.
Keeping Links from Breaking - Enabling UID links
UID is short for Unique Identifier. Links created by Kupu can use unique ids so that the links remain valid even if the target object is renamed or moved elsewhere on the site. Versions of Kupu 1.4 and higher have this feature, and it is recommended that it be used. Read the How-To for turning this function on
Return to the Links screen and notice the relative paths -> UIDs button. Select a content type from the list and click this button. You'll now see a screen like this:
Click the commit selected changes button to convert all relative links to UID links. Now you can go back and re-check for bad links.
- How to Prevent Your Links from Breaking
- In version of Kupu 1.4 and up, there is a function called "Link using UIDs" that will keep links from breaking, should you move the location of page or other content item.