New WordPress Plugin
Note: This article applies to version 2.0.0 and after of the WordPress CMS Plugin should you choose to opt-in to use 'latest experience' under the plugin configurations. If you want to opt-out of the latest plugin experience follow this guide to opt out: How to Disable New CMS Plugin UI. Then you will be using the Old Plugin Experience and need to follow the Old WordPress Plugin and How to navigate the old CMS Plugin.
The Siteimprove CMS plugin is an overlay that, after installation, appears in your CMS platform informing you about issues related to the site/page that you are working on.
The Siteimprove WordPress plugin is the CMS Plugin used specifically with WordPress. The plugin works like a small version of the Siteimprove Intelligence Platform and shows information about published/live pages that are available to the Siteimprove crawler.
The Siteimprove WordPress plugin has the added advantage of Siteimprove’s Prepublish check functionality which allows you to check for certain content issues before publishing.
Note: You'll need a Siteimprove subscription to Prepublish in order to use the feature. Contact Siteimprove if you have any questions regarding your subscription
Pre-installation
- Make sure that the CMS site you are installing the plugin on is set up as a site being crawled in the Siteimprove platform (not a local environment). If it is not, see Adding a Site (Tips & Tricks). If you want to test the plugin on a test environment first please reference this article for steps to do so: How to test the Siteimprove CMS Plugin.
Installation
The installation of the plugin is easy and it follows the standards of any other plugin installation inside WordPress.
- Under the 'Plugins' menu item select 'Add New.' Then the installation can be done in one of the following ways:
a. By searching for the plugin under the search box on the 'Add Plugins' page and selecting the 'Install Now' button.
b. Install it by selecting the 'Upload Plugin' button and then uploading the plugin file you can download from the WordPress Plugin Marketing Site page or here: https://wordpress.org/plugins/siteimprove/.
- After that, the plugin can be activated in one of two ways:
a. Immediately, by selecting the 'Activate' button on the 'Add New' page.
b. Selecting 'Activate' on the 'Installed plugins' listing page
Configuration
- Once the plugin is activated a new menu option will show up on the left sidebar called 'Siteimprove.'
- To continue the plugin's configuration, the user should click on the 'Siteimprove' menu.
- Token: this field is filled automatically and should not be changed unless a new token is needed. Then if that’s the case the user should click on 'Request new token' to generate a new one.
- Public URL(optional): should be used in the case that the admin of the website and the final version are located on different domains. For example, he WordPress CMS Editor is located at https://stg-thewebsite.com but the final domain, where the content is published be displayed to the public is located at https://thewebsite.com. In that case, the Public URL field should be https://thewebsite.com.
- Plugin Experience: you have the option to opt out of the latest version of the plugin by unchecking the checkbox next to ‘Use latest experience.’ See more about the latest plugin experience here: How to navigate the New Siteimprove CMS Plugin
- API Credentials (optional): can be filled to use the Prepublish feature. You will need to create an API key following the instructions under How to connect to the Siteimprove API and have a Siteimprove subscription to Prepublish in order to use this feature. Contact Siteimprove if you have any questions regarding the subscription.
Note: It is recommended to create an API key for an generic user for this, with Account Owner or Administrator level permissions and access to the appropriate sites in the Siteimprove Platform, so that it doesn't change with updates to users and cause issues with accessing this feature in the plugin. - After filling in the fields, select ‘Save Settings’ to save the settings.
After configuring the plugin, someone with Account Owner level permissions in the Siteimprove Platform will need to log into the plugin and accept the plugin terms and conditions.*
*You can also read the Siteimprove CMS plugin terms and conditions under Settings > Integrations > CMS Plugin Setup
Usage
New Plugin Experience Usage
For usage information with the new plugin experience (with the ‘Use latest experience’ checked under the plugin configuration) follow the guide below.
How to navigate the New Siteimprove CMS Plugin
Old Plugin Experience Usage
For usage information with the old plugin experience (with the ‘Use latest experience’ unchecked following these instructions: How to Disable New CMS Plugin UI follow the guide below.
Did you find it helpful? Yes No
Send feedback