How to navigate the New Siteimprove CMS Plugin

What's new

• Intuitive issue organization - clear categories and issue counts
• Consistent navigation model - fewer menus and buttons
• Prepublish view within the plugin - faster feature discovery In-context
• In-context recommendations – less switching to SI platform
• Updated issue filtering – new option to save filters

How to navigate the new Siteimprove CMS Plugin

The Siteimprove CMS plugin is a small overlay box, that, after installation, will appear in your CMS platform and inform you about the issues related to the site/page that you are working on. This article is intended to demonstrate how to navigate the Siteimprove CMS Plugin. 

The CMS plugin works as a small version of the Siteimprove Intelligence Platform. It requires the published site to be crawled by the Siteimprove Platform in order to provide data on the live pages in the plugin. 

If you have excluded pages based on a common URL element, no data will be shown regarding those pages. If you haven’t published pages, no data will display for those pages unless you use the Prepublish functionality.

Note: You'll need a subscription to Prepublish in order to use the feature. Contact Siteimprove if you have any questions regarding your subscription.

• What's new
• How to navigate the new Siteimprove CMS Plugin
• Plugin tab
• Live page
• Live Page Views
  • Grouped View (default)
  • List View
• Filtering 'List View'
• Prepublish view
• Unpublish risks
• Settings

Plugin tab

Once the plugin is configured, a tab appears within your CMS. The user will have to log in with their Siteimprove credentials to use the plugin.

Plugin tab shown in Adobe Experience Manager

If you are on a page that is published and crawled by Siteimprove, you’ll see the total issue count from when the page was last checked. This does not include the occurrences of each issue

You will see the message 'page is not found' or 'missing access to page' if the page is not found in the Siteimprove platform. Some common reasons for this include:

• The Siteimprove crawler has not crawled this page yet
• You are not logged into the Siteimprove account the page is connected to, or you do not have permission to view this page's content
• Does the URL in your CMS match what is stored on the Siteimprove platform? Check your plugin configuration settings. A difference as small as an extra symbol like '/' at the end of your URL can cause a mismatch.
• The page is part of a subdomain and settings need to be set up for our crawler to access pages. Please see Site Content Settings

When the tab is expanded you are presented with data on the Live Page, Prepublish view, and Unpublish risks.

Plugin overlay shown in Adobe Experience Manager

Live page

This section shows issues found on the published page when it was last checked by the Siteimprove crawler. At a glance, you can see the date it was last checked and its DCI Score.

Issues are organized in the following categories:

Accessibility

• Level A, AA, and AAA issues
• Level A, AA, and AAA potential issues
• WAI-ARIA authoring practices
• Accessibility best practices

Content

• Broken links
• Misspellings
• Potential misspellings
• Readability level

Policy

• Policy matches - marked as a 'High priority,' 'CMS Plugin,' 'Shared', and enabled for 'All sites' within the Siteimprove platform.

Policies must be enabled in the Siteimprove Platform to display in the plugin

Live Page Views

There are two ways to view issues on the live page tab: Grouped View (default) and List View.

Grouped View (default)

Grouped view organizes issues by category (Accessibility, Content, Policy, etc). If you select the arrow icons next to the category then issue you can view more details on the particular issues. Each issue includes a description for context, the number of occurrences of the issue, and links to view the issue details in the Siteimprove platform.

Grouped view

List View

From the default ‘Group View’ you can select ‘List View’ by selecting the ‘view all issue types’ link.

Select “view all issue types” to see List View

'List view' shows all issue types. If you select the arrow icons next to the issue you can view more details on the particular issues. Each issue includes a description for context, the number of occurrences of the issue, and links to view the issue details in the Siteimprove platform.

List view

Filtering 'List View'

In the ‘List View,’ you can filter what issues are shown with the option to save your settings for all future checks.

Prepublish view

Note: You’ll need a subscription to Prepublish in order to use the feature. Contact Siteimprove if you have any questions regarding your subscription. 

This section displays information from running Prepublish checks on your unpublished content. Select the Prepublish check button to run a Prepublish check. After running a Prepublish check the results are returned in the Prepublish view section of the plugin.

Each plugin may have a bit different steps for running Prepublish checks. For more specifics on how to run the Prepublish checks review this article 'How to Run a Prepublish Check with the New Plugin UI'

Prepublish button and check results in Adobe Experience Manager

You can analyze all the Prepublish check results by expanding the categories to see the exact issues, number of occurrences, and highlighting options. For visible issues on the page, you can highlight the specific HTML element. For example, a text element with uneven spacing.

Highlighted Level AAA issue from a Prepublish check

Checks available in Prepublish functionality:

Accessibility

• Level A, AA, and AAA issues
• Level A, AA, and AAA potential issues
• WAI-ARIA authoring practices
• Accessibility best practices

Content

• Misspellings
• Potential Misspellings
• Readability

Policy

• Policy matches - marked as a 'High priority,' 'CMS Plugin,' 'Shared', and enabled for 'All sites' within the Siteimprove platform.

Policies must be enabled in the Siteimprove Platform to display in the plugin

Unpublish risks

This section shows relevant data for when you’re considering unpublishing a page. Note: it does not unpublish a page, it provides information on:

• Documents on this page
• Documents only on this page
• Internal referring pages

A referring page would have a broken link if the current page was unpublished

Settings

Under the gear icon, you can access the settings for the plugin. This displays the Siteimprove user logged into the plugin, and options to position the plugin on the right or left side of the browser window.

Settings

You can find Information on how to disable the new UI by CMS in the following help center article: How to disable new cms plugin UI