siteimprove
Drupal 10
The new 2.0.x major version supports Drupal 9.2+ and Drupal 10. Deprecated JavaScript libraries has been replaced by their succeeders.
Siteimprove.ai Plugins – Your Insights Always Within Reach
The Siteimprove.ai plugin bridges the gap between Drupal and the Siteimprove.ai Intelligence Platform.
Thanks to the seamless integration, you are now able to put your Siteimprove.ai results to use where they are most valuable – during your content creation and editing process.
With analytics and content insights always at hand, contributors can test, fix, and optimize their work continuously. Once the detected issues have been assessed, you can directly re-check the relevant page when it is published and see if further actions are needed.
Delivering a superior digital experience has never been more efficient and convenient.
Siteimprove.ai Analytics
Enabling Siteimprove.ai Analytics to a Drupal site is out of scope of this module. Refer to Siteimprove.ai's documentation for adding Siteimprove Analytics Javascript to a website or install the Drupal module Siteimprove.ai Analytics.
About Siteimprove.ai
Siteimprove.ai offers the world's most comprehensive cloud-based Digital Presence Optimization (DPO) software. The Siteimprove.ai Intelligence Platform provides eye-opening insights that empower you and your team to create higher quality content, drive better traffic, measure digital performance, and work towards regulatory compliance—all from one place. Siteimprove.ai is also proud to offer best-in-class technical support, academy courses, services, and technology integrations.
Find out why more than 7,000 organizations around the world practice DPO using the Siteimprove Intelligence Platform at siteimprove.com
Installation guide
Siteimprove.ai Plugin can be installed like any other Drupal module.
Place it in the modules directory for your site and enable it on the 'admin/modules' page.
By default the plugin is only available for administrators. If you want to allow other roles to use the plugin, go to your permissions page and enable it on the option “Access Siteimprove.ai Plugin” (under the group “Siteimprove.ai Plugin”).
Frontend Domain Plugin
If a Drupal site has a domain for the frontend site that is different from the
backend domain, this can be configured with existing plugins, or you can make
your own.
Included with the module are two plugins for (1) the default case where the
frontend domain is the same as the backend domain, and (2) the frontend domain
is a single domain and doesn't need advanced configuration.
If you need Domain Access support, you can install the module
siteimprove_domain_access. This module doesn't need to be configured, just
enable it and it will make sure Siteimprove.ai is notified with the correct
url(s) for a given entity.
Adding your own plugin
Use the annotation discovery method with the annotation '@SiteimproveDomain'.
This annotation has the variables 'id', 'label' (translatable), and
'description' (translatable). See the plugin Simple
(src/Plugin/SiteimproveDomain/Simple.php) for a plugin with no additional
configuration, and the plugin Single (src/Plugin/SiteimproveDomain/Single.php)
for a plugin with configuration.
The plugin uses the ConfigFormBase trait, so if you want to save configuration
for your plugin, you have to add the function 'getEditableConfigNames()', that
should return a list of setting names. You can see the Single plugin for how to
save configuration in the 'submitForm()' function, or - if you need a more
advanced example - see the module siteimprove_domain_access.
The following methods are required in a custom plugin: 'buildForm()' (will be
displayed on the Siteimprove.ai settings page) and 'getUrls()' (returns the urls
for the current entity including http scheme "http://" or "https://").
The following methods are optional: 'validateForm()' (validates the form, if
your plugin requires configuration), 'submitForm()' (saves any changes to the
plugin's configuration), 'getEditableConfigNames()' (returns a list of setting
names).