Acrolinx for Wordpress Admin Guide

How Acrolinx Interacts with Your Web Application

The following diagram illustrates how Acrolinx fits into the architecture of your web application. The web application communicates exclusively with your web server proxy. Your web server then passes checking requests on to the Acrolinx server. Acrolinx uses single sign-on to authenticate users with your web application.

General Configurations

Set Up Acrolinx for Single Sign-On (SSO)

Before you can use Acrolinx for WordPress, you'll need to set up SSO for Acrolinx. To do this, follow the process in the article Set Up Acrolinx for Single Sign-on.

Connect to Your Acrolinx Core Platform

Once you've installed Acrolinx for WordPress, you need to configure WordPress to route internal checking requests to Acrolinx.

To enable WordPress to connect to Acrolinx, follow these steps:

  1. Go to Settings Acrolinx.
  2. Under Connection Settings Single sign-on, click Enabled.
  3. In the two fields, enter the following:

    For some reason, WordPress sometimes prefills these fields with your WordPress sign-in details. Remove these details first.

    1. In the first field, enter your Acrolinx URL. You need to enter the full address: <host_name>://<Acrolinx_URL>:<port_number>
    2. In the second field, enter the generic password that you configured in the core server properties file when enabling single sign-on for Acrolinx.
  4. Click Save.

You can now run checks in WordPress with Acrolinx!

 To connect without single sign-on

We don't recommend it, but you might need to disable single sign-on (SSO) for testing purposes. To do so, you'll need to create an Acrolinx user that WordPress can use to connect to Acrolinx.

  1. First, go to the Acrolinx Dashboard and create a user.

    The user should have the default role Technical Writer or, if the role isn’t there, a role with the privileges Check documents and Run Term Harvesting.

    Make a note of the sign-in details - you'll need them later.

  2. You need to enable Cross-Origin Resource Sharing (CORS).
  3. Configure your Acrolinx URL in the Plugin configuration field.

    Because you use a direct connection to Acrolinx, you need to enter the Acrolinx URL in the "serverProxyPath". Replace the variable <SERVER_NAME> with the name or address of your Acrolinx Core Platform. If necessary, adapt the port number.

  4. When you open the Sidebar the first-time click Connect. Then click SIGN IN to open the Acrolinx sign-in page. A browser window opens where you can enter your sign-in details and confirm the request to access.
  5. Click Save.

Modes

You can configure Acrolinx to check in 2 modes, Sidebar and Automated. And you can select both modes if that's what you want.

You'll find Modes under Settings Acrolinx in the admin console.

If you turn on automated mode, you get 2 new features:

Automated Checking

When you save a draft or update a post or page, Acrolinx automatically runs a check in the background. The next time you open the post or page, you'll see the updated score.

Batch Checking

You can see the Acrolinx Score of all your posts or pages in the Posts or Pages sections. The column Acrolinx Score shows the latest score for each item, with a link to a Content Analysis dashboard for all the posts or pages that you checked together.

You can check multiple posts or pages at once without editing them.

In the Posts or Pages sections, select the items that you want to check, then click Bulk Actions > Acrolinx Check > Apply. Acrolinx checks all the posts or pages that you selected, and updates the scores when you refresh the page.

If you run a batch check, your user is assigned to the check for each post or page.

Optional: Set the Default Checking Options in the Plugin Configuration Field

You can configure default checking options that are set automatically. This is helpful in environments where writers typically work with the same type of content (for example creating posts for the company blog) and always require the same checking options. This feature also prevents errors that can occur when writers select the wrong checking options by mistake.

You don't have to change all the settings, but we recommend that you change the ruleSetName and termSets settings.

For example, if you wanted to use the writing guide "Standard_US" as your default writing guide, you'd update the ruleSetName setting as follows: "ruleSetName" : "Standard_US",

If you wanted to use the term sets "techdoc" and "branding", you would update the termSets setting as follows: "termSets" : [ "techdoc", "branding" ],

To configure the default checking options, follow these steps:

  1. Go to Settings > Acrolinx.
  2. Update the following code in the Plugin configuration field:

    "defaultCheckSettings":  {
      "language" : "<LANGUAGE_ID>",
      "ruleSetName" : "<RULE_SET>",
      "clientInformation" : {},
      "checkSpelling" : <TRUE/FALSE>,
      "checkGrammar" : <TRUE/FALSE>,
      "checkStyle" : <TRUE/FALSE>,
      "checkReuse" : <TRUE/FALSE>,
      "checkSeo" : <TRUE/FALSE>,
      "harvestTerms" : <TRUE/FALSE>,
      "termSets" : [ "<TERM_SET>", "<TERM_SET>" ],
      "termStatuses" : [ "<TERMINOLOGY_OPTION>" ]
    }
            
    The following values are admitted for <TERMINOLOGY_OPTION>:
    • TERMINOLOGY_DEPRECATED to check for deprecated terms.
    • TERMINOLOGY_ADMITTED to check for admitted terms.
    • TERMINOLOGY_VALID to check for valid terms.
  3. Click Save.