CMS deeplinking allows you to link, from a page with issues identified in our platform, to the editing environment for that same page in your CMS.
To enable CMS deeplinking
To get up and running with CMS Deeplinking follow these following steps:
- Go to the Siteimprove “Custom Setup” request form.
- Under Setup Services select “CMS Deeplink”.
- Enter your CMS name in the field provided.
- Give two examples of live page URLs from your website and the corresponding CMS editing URLs (see further explanation below).
- Click "Submit" to send your request to our support team.
CMS Deeplinking can be enabled on the majority of accounts but is dependant on your CMS environment.
How to determine the CMS editing URL
The CMS editing URL is the location URL shown in your browser when editing a page on your website. Here is an example from a WordPress CMS.
To find the CMS editing URL for the webpage "http://www.example.com/about", we log into WordPress and click on "Edit Page" for that page.
The URL shown in the browser location bar is the CMS editing URL for that page.
In the example below this is: "https://www.example.com/wp-admin/post.php?post=54&action=edit".
Based on this, we can now provide the following information to the Siteimprove Support team through the CMS Deeplinking form:
Live URL: http://www.example.com/about
CMS Editing URL: http://www.example.com/wp-admin/post.php?post=54&action=edit
Once you have found two examples of the Live URL and its corresponding CMS Editing URL along with filling out all the necessary information, you can submit the information on our support request form.
Note: Please do not choose your homepage as one of the examples provided. The examples of the CMS Editing URLs should not be identical. If they are then you are not providing the correct edit URL. In this case please ask your CMS provider for details on how to find the correct CMS Editing URLs for each page.
Once the CMS Deeplink has been implemented, a CMS Deeplinking button can be found in various locations through the Siteimprove Intelligence Platform. Typically, they are found right next to the page URL or at the top of your Page Reports:
CMS Deeplink button next to the page URL
CMS Deeplink button at the top of the Page Report
How meta tags can help
Once you provide us with examples of the editing URLs, we will evaluate them to determine what pattern your CMS editing URL follows. In our example above we can see that the editing URL contains parameter “post=54". This tells us that in order to link to your CMS editing URLs, we will need to be able to find the "post=" value for each page.
We will determine if we can find these values within the live pages HTML source code. If we find a consistent location to get this value we can use that to populate the editing URL pattern. A common method of providing the ID is using meta tags like the following:
<meta name="pageID" content="54"/>
If we cannot find the values in the source code we may need help from your web developers. For example, your web developer could implement a meta tag that points us directly to the CMS page location on each page as shown:
<meta name="editingPage" content="http://www.example.com/wp-admin/post.php?post=54&action=edit"/>
If you are asked to create meta tags, please add the name attribute before the content attribute. This allows for easier implementation.
Please contact Siteimprove Support if you have any questions regarding deeplinking.