Which Editor Do You Use?
To see the content that's relevant for your editor, choose it from the menu above
Signing in to an Acrolinx Server
When you first use Acrolinx, or if you change your Acrolinx installation, you must register with the Acrolinx server. Depending on the configuration of your Acrolinx server, you might also have to enter a password or add custom user information.
To register with the Acrolinx server, follow these steps:
- Run a check or open the Acrolinx options.
When you are prompted, type your user ID.
Note: Usually, your Acrolinx administrator wants your user ID to be in a specific format. That way, your administrator can tell who's who when reviewing the list of user accounts.
For example, a lot of people ask their writers to register with their e-mail address.
If your administrator hasn't told you how to register, try registering with your e-mail address or ask them what they'd prefer.
- If you are prompted, type your password.
Acrolinx registers with the Acrolinx server.
Setting the Checking Options
Before you start checking, make sure that you have the right checking options. Even if your company has someone who sets up Acrolinx for you, it's still good to know what these options are for and how they work.
You select a checking profile
A checking profile contains all the Acrolinx presets that you might need to check a certain type of document. For example, you could have a checking profile for Word documents and another one for DITA topics. Whoever administers the Acrolinx server in your company can set these up for you.
Just select an item in the "Checking profile" dropdown, and the rest of the settings are configured for you.
You might notice that the checking options are disabled when you select a checking profile.This means that whoever set the profile up has "locked" it. They don't want you change the options and override it. But at least you don't have to think about what to options select.
You set the checking options yourself
If your administrator hasn't enabled the checking profiles feature, you won't see a "Checking profiles" dropdown. In this case, you can set the options yourself.
Setting the Checking Options Yourself
|Language||Select the language of the document you want to check.|
Select the rule set that you want to use for the check.
Rules are specific guidelines for your company writing style. Your administrator can group these rules into sets that apply to different types of content. For example, the guidelines on sentence length might depend on your audience. You can then select a rule set that applies to your audience.
Your administrator sets up the rule sets, so if you're unsure what to select, ask them
|Spelling||Check for spelling issues.|
|Grammar||Check for grammar issues.|
|Style||Check for style issues.|
Check for reuse issues.
Reuse issues are usually sentences that look like sentences which are already in a content repository such as a translation memory.
The idea is that you update the sentence you just wrote to be identical to the sentence that's already been translated. That way, the sentence doesn't need to be translated again.
Reuse is a licensed feature so if your company hasn't purchased it, the option will be disabled.
Check for SEO issues
This option is only relevant if you're writing content for the web and you want it to get high up in the search results.
Some administrators want to make sure that writers use specific keywords so that the content gets high-quality traffic.
SEO is a licensed feature so if your company hasn't purchased it, the option will be disabled.
|Deprecated terms||Check for terms which are deprecated in your terminology database.|
Check for terms which are either
in your terminology database.
You might do this if you want to see how often you use the correct terminology.
Check for terms which are admitted in your terminology database.
Admitted terms can be terms that are OK in certain contexts but have specific guidance on when they're appropriate. Some administrators want to draw your attention to them and make sure that you're aware of the conditions for using that term.
However, not everyone uses admitted terms, so this feature isn't enabled by default. Your Acrolinx administrator has to enable it first.
Identify words of phrases that look like they could be potential terms which you could add to your terminology database.
Some administrators like their writers to contribute terms to the terminology database so this option can help you do that.
Again, not everyone wants writers to contribute terms, so this option is often disabled. Your Acrolinx administrator has to enable it before you can use it.
Select the term sets that you want to use when you check for terminology issues.
Term sets provide a way to group different sets of terms for different audiences.
Your Acrolinx administrator sets these up, so if you're unsure what to select, ask your administrator.
There are also other options like the plug-in, filter, and advanced options but you can take a closer look at those once you've run a few checks.
After you've updated the checking options, you're ready to run your first check.
Run Your First Check
Before you get going, if you might want to consider which part of your content you want to check. Acrolinx doesn't some pretty heavy-duty linguistic processing so if you're working on a 300-page magnum opus, you probaby don't want to check the whole document in one go. It could take a while and you won't be able to continue writing until Acrolinx is done checking. However, If you're working on a 250-word article, it's fine to check the whole thing each time.
Once Acrolinx is done checking, you'll get a Scorecard that scores your content based on the types of issues that you're checking for. You'll also get an overall quality score.
Click OK to close the Scorecard dialog box and start reviewing the issues that Acrolinx highlighted in your content.