Siteimprove module

Analytics and optimization Unbundled: Extension

License

MLA

Issues

SIMPROVE

Nexus

Siteimprove module

Latest

1.2.1

Compatible with Magnolia 6.2.

The Siteimprove module enables you to perform SEO checks by using the cloud-based application Siteimprove. It is a tool to help you score higher ranking in search engines and check how your content is performing over all.

Module structure

artifactID Description

artifactID	Description
`magnolia-siteimprove`	Provides a default implementation to connect to Siteimprove.

magnolia-siteimprove

Provides a default implementation to connect to Siteimprove.

Installing with Maven

Maven is the easiest way to install the module. Add the following to your bundle:

<dependency>
  <groupId>info.magnolia.seo</groupId>
  <artifactId>magnolia-siteimprove</artifactId>
  <version>1.2.1</version>
</dependency>

Configuration

The module provides the following configuration options.

Property Description

Property	Description
`mapperClass`	optional, defaults to `info.magnolia.connector.siteimprove.mapper.SiteDefinitionDomainMapper` The default mapping implementation relies on the related site definition domain. You can add your custom implementation of the page mapping by implementing `info.magnolia.connector.siteimprove.mapper.SiteImproveMapper` and changing the related configuration.
`token`	required Token provided by Siteimprove. The first time Siteimprove is contacted the token is stored here. There is no need to set the token manually.
`username`	required, if using prepublish check The username (email) used to log into Siteimprove dashboard
`apiKey`	required, if using prepublish check To generate an api key for prepublish check visit Siteimprove dashboard → Integrations → API → API keys → Create API key (Manage API keys])

mapperClass

optional, defaults to `info.magnolia.connector.siteimprove.mapper.SiteDefinitionDomainMapper`

The default mapping implementation relies on the related site definition domain. You can add your custom implementation of the page mapping by implementing info.magnolia.connector.siteimprove.mapper.SiteImproveMapper and changing the related configuration.

token

required Token provided by Siteimprove. The first time Siteimprove is contacted the token is stored here. There is no need to set the token manually.

username

required, if using prepublish check

The username (email) used to log into Siteimprove dashboard

apiKey

required, if using prepublish check

To generate an api key for prepublish check visit Siteimprove dashboard → Integrations → API → API keys → Create API key (Manage API keys])

Usage

Using the Siteimprove connector helps you fix and improve website accessibility, SEO, content quality and more. Siteimprove crawls websites through public URLs, which means that all pages are indexed from their public addresses.

Accessing the Siteimprove dashboard

To access the Siteimprove dashboard for the first time:

Log into Magnolia.
Open a page in the Pages app.
Click the Siteimprove icon to the right of the page.
In the pop up window that opens, enter your Siteimprove credentials.

The Siteimprove dashboard then displays the SEO results for the page you have open (and site the page belongs to).

Siteimprove example

Once you have logged in for the first time, the Siteimprove dashboard remains available via the icon for each page you open.

If the Siteimprove icon is greyed out, log out of Magnolia and back in again.

Setting your website to be observed

Before any SEO check can be performed, you must set your website to be observed by Siteimprove. You can do this in the Siteimprove application itself.

Site and group access section

Performing an SEO check

To perform an SEO check on your site, tree or page, click Check page in the Siteimprove dashboard. Siteimprove analyzes the page’s content and displays results such as the DCI page score, number of broken links, misspellings and more.

The default spell checker integration we provide is to an external service TextGears, Siteimprove offers its own.

Performing a prepublish check

To enable the prepublish check, you need to provide a valid username and apiKey.

To perform a prepublish check click Siteimprove: Prepublish check in the page editor action bar. The Siteimprove overlay will show a progress indicator during it’s processing Once the processing is done the prepublish check results can be viewed on the results page Siteimprove: Prepublish results page

Changelog

Version Notes

Version	Notes
`1.2.1`	Released on June 1st, 2023. For Magnolia `6.2`. SIMPROVE-11
`1.2`	Released on October 8th, 2020. For Magnolia `6.2`. SIMPROVE-6 SIMPROVE-5 SIMPROVE-4
`1.1.6`	Released on October 6th, 2020. For Magnolia `6.1`. SIMPROVE-6 SIMPROVE-5
`1.1.5`	Released on February 5th, 2020. SIMPROVE-3
`1.1.4`	Released on September 23rd, 2019. The is now part of the Optimization Connector Pack. Siteimprove enables you to perform SEO checks using the cloud-based application Siteimprove. It is a tool to help you score higher ranking in search engines and check how your content is performing over all.
`1.1`	Released on December 1st, 2018. Updated for Magnolia `6.0` compatibility.
`1.0.4`	Released on October 12th, 2018. SIMPROVE-1
`1.0.3`	Released on October 5th, 2018. Initial release of the Extensions version of the module.

1.2.1

Released on June 1st, 2023.

For Magnolia 6.2.

SIMPROVE-11

1.2

Released on October 8th, 2020.

For Magnolia 6.2.

1.1.6

Released on October 6th, 2020.

For Magnolia 6.1.

1.1.5

Released on February 5th, 2020.

SIMPROVE-3

1.1.4

Released on September 23rd, 2019.

The is now part of the Optimization Connector Pack. Siteimprove enables you to perform SEO checks using the cloud-based application Siteimprove. It is a tool to help you score higher ranking in search engines and check how your content is performing over all.

1.1

Released on December 1st, 2018.

Updated for Magnolia 6.0 compatibility.

1.0.4

Released on October 12th, 2018.

SIMPROVE-1

1.0.3

Released on October 5th, 2018.

Initial release of the Extensions version of the module.