Skip to main content
 

How can we help?

Search

Articles in this section

Assign Style Guides

  • Updated

"Targets" now called "style guides"

To make the language in Acrolinx a little more intuitive, we've renamed Targets to style guides. The feature itself will still work as expected.

Now that you’ve created a style guide, you need to make sure that the right writers are using it.

For example, you might want technical writers to check with a style guide for technical content. Whereas your marketing team might need to check content like blog posts or company announcements. With style guide assignments, you can limit access to different style guides.

Manage your assignments directly in the style guides section in Acrolinx. To do this, you'll need the Acrolinx privilege Edit style guides.

Manage assignments

You’ll find a list of your style guides in the slide-out menu that opens when you click MANAGE ASSIGNMENTS.

Tip

You'll see the number of style guides that need an assignment in the red notification at the upper-right corner of this button.

35463214.png

Assign a style guide

To assign a style guide to your writers, follow these steps:

  1. Navigate to Style > Style guides and click MANAGE ASSIGNMENTS to open the slide-out menu.

  2. You’ll find unassigned style guides at the bottom of the list. Click on the arrow to expand the list.

  3. You can either assign the style guide to all writers, or select which content contributors should check with the style guide.

    1. To assign the style guide to all users, click the plus group icon Targets-AssignToAll.png Assign to all. Or click the pen icon Targets-_Edit.png Edit. and toggle the switch button Targets-Switch.png

    2. Click the pen icon Targets-_Edit.png Edit. Use the dropdown section User to search writers.

      You can select users based on the following criteria:

      • Acrolinx role. To select roles, click the check boxes in the list view.

      • Custom user information that is set to mandatory. To select custom user information, click the check boxes in the list view.

      • Usernames. You can search for usernames in the search field or click the check boxes in the list view.

  4. Select one or more criteria.

    Warning

    If you select more than one criteria, these have an "OR" relationship.

    Suppose that you select the department "Electronics" and the Acrolinx role Term contributor. The assignment applies to users who are in the "Electronics" division or who have the Acrolinx role Term contributor.

  5. Click SAVE

Tip

After you've assigned a style guide to one or more users, you can start with Target Batch Mapping. There, you can add document criteria for batch checking with GitHub, AEM, Wordpress, the CLI, or via the Acrolinx API.

Edit a style guide assignment

To edit an assignment, follow these steps:

  1. Open the MANAGE ASSIGNMENTS slide-out menu.

  2. Browse through the list of style guides, and click the pen icon 35463217.png Edit to edit the one you want to update.

  3. To make the changes you need, follow the steps described in Assign a style guide.

  4. Click SAVE.

Preferred assignments

In the "Options" tab of the Sidebar menu, writers can find a list of their assigned style guides. Depending on what they write, they may use a few different style guides from this list. To help writers use the right style guides, you can set up Acrolinx to show style guides in a specific order.

To set the order of the style guide list in the Sidebar, follow these steps:

  1. Navigate to Style > Style guides and click MANAGE ASSIGNMENTS to open the slide-out menu.

  2. Hover over a style guide assignment card and drag it to the preferred position. The style guide at the top of the list will be the preferred style guide for the assigned writers.

    Tip

    Different writers will see different lists in their Sidebar options depending on the style guides assigned to them.

Example 1. Example

Let's say you have a style guide called "Company Content" that's assigned to all writers. Your technical writers Christina and Gustav (no, that’s not us) also need the style guide "Technical Documentation" as their default. In this case, you would drag "Technical Documentation" to the top of the list so it appears above "Company Content."

All other writers would still have "Company Content" as their preferred style guide, but Christina and Gustav would see "Technical Content first." If needed, they could still switch to "Company Content."

assignments order


Warning

The preferred style guide is selected by default when a writer connects to the Sidebar for the first time. If a writer selects a different style guide in a specific integration, the change gets stored in the user properties. When they reopen the Sidebar in that integration, their selection becomes the default.

Delete assignments

If you want to delete assignments, you'll need to deselect the chosen criteria for each field. This might take a little longer, but it ensures that nobody accidentally deletes all their assignments.