|Acrolinx Content Analyzer||1.2|
Installing the Acrolinx Content Analyzer
If you're tasked with installing the Acrolinx Content Analyzer yourself, ask your Acrolinx administrator for the installer file if you don't have it already.
To install the Acrolinx Content Analyzer, follow these steps:
If you're running the Content Analyzer on a Windows operating system, just double-click the installer and follow the on-screen instructions.
Important note: To use the Content Analyzer on Microsoft Windows, you need to install Microsoft Visual C++. We've included it in the Content Analyzer installer. When you run the Content Analyzer installation wizard, you might see a Microsoft Visual C++ window. Agree to the terms and click Install.
If you're running the Content Analyzer on Mac OS X, open the Acrolinx setup file.
Move the Acrolinx icon to your Applications folder.
The Start Window
When you start the Acrolinx Content Analyzer for the first time, you'll see the Preferences window:
Before you can check documents, you'll need to connect to an Acrolinx server and sign in.
To connect to an Acrolinx server and sign in, follow these steps:
Enter a server address in the
- Click Sign In to open the Acrolinx sign-in page in a browser.
Enter your username and password to sign in.
Click CONFIRM to allow the Content Analyzer to access your Acrolinx account.
You'll see a confirmation that you're successfully signed in.
- Click Save in the Preferences window.
Click to go to the main window and select your settings and content. Or open a settings file directly.
The Settings Window
From the settings window, you can select all your settings. Click LOAD CONTENT to import your content.
Supported File Types
|XML||*.xml, *.xhtml *.xhtm, *.xliff, *.xlf,*.dita, *.ditamap, *.ditaval, *.svg, *.resx|
Note that Acrolinx doesn't work consistently when checking PDFs. We recommend using the source document to check your content.
|MARKDOWN||*.md, *.markdown, *.mdown, *.mkdn, *.mkd|
Selecting Files to Check
The easiest way to get started, is to have all your files in one directory and use the Content Analyzer to scan that directory. However, if you want to batch check files across a set of directories, there's an option for that too . It just requires a bit more configuration. For now, let's assume you have all your files in one directory.
To select files to check, follow these steps:
- Click the Select Files or Folders if it's not already selected.
- Click on the three dots , browse to the folder that contains the files and click Select Folder .
- If you haven't already, define your check options.
- Click LOAD CONTENT .
If the directory contains files that you don't want to check, first select the unwanted files.
The Content Analyzer finds all files of type: TXT, XML, PDF, and HTML.Tip: If the directory contains mostly unwanted files, press CTRL+A to select all files in the list, deselect the files that you want to keep, then press Delete. You deselect files by clicking the file names while pressing CTRL.
Selecting Websites to Check
As well as locally stored files, the Content Analyzer can check web pages across one or more websites.
To find web pages, the Content Analyzer follows all the links from the given URLs, and continues following links on web pages that are found from the given URLs.
The Content Analyzer only searches for HTML pages.
To select websites to check, follow these steps:
- Click the Select Websites if it's not already selected.
Click on the three dots
. You'll see a window open where you can enter a URL or list of URLs.
Press Enter after each URL.Tip: If you want to search an entire website, then don't prefix your URLs with "www" . Not all web pages on a website have the prefix "www" so to be safe, leave it out.
- Click OK .
Select the settings for searching your website:
Try the default settings first. If you don't get the results you want, use the following guide to update the settings:
Table 2. Setting Descriptions Approximate page count
This setting defines approximately how many pages the Content Analyzer imports before stopping the search.
Maximum link depth
The link depth is the distance in links between each URL and a web page.
For example, if you enter 0 , the Content Analyzer finds the page that you entered as the start address only. If you enter 2, the Content Analyzer follows the links on the starting page and continues following the links on the pages that were found through the starting page. With Maximum link depth set to -1, the Content Analyzer follows all links that it comes across.Important: If a URL redirects to another URL, the redirection is considered as one level in the link depth. For example, if your starting URL redirects to another URL and you have a depth of 1 configured, the Content Analyzer interprets the redirection as one level and stops following any further links.
You can explicitly define which pages you want to include in the search of the websites you selected. Use the pipe symbol, | , to separate the keywords.
Example: If you want to include all contact and events pages, enter the following:
contact|eventsImportant: Enter the keywords without a space before or after.
Deny pages You can explicitly define which pages you don’t want to include in the search of the websites you selected.Important: Pages that are denied take precedence over pages that are allowed. Include headers and footers
By default, Acrolinx doesn’t include the content from the headers, footers, and iframes of your web content. Select the option Include headers and footers to add headers, footers, and iframes to the check.
- Try the default settings first. If you don't get the results you want, use the following guide to update the settings:
- If you haven't already, define your check options.
- Click LOAD CONTENT .
The Check Options
Before you start checking, make sure that you have the right check options.
|Language||Select the language of the documents that you want to check.|
|Writing guide||Select the set of style and grammar guidelines that you want to use.|
|Reuse sentence bank||
Select the sentence bank to store the sentences that are collected during the check.
You only need to do this if you've added sentence banks in your Acrolinx server. This option is only visible to users who have the Acrolinx reuse module installed.
Select the categories that you want to check for.
For example, many people start off by selecting Spelling , Grammar , Style , and Deprecated Terms .
You might use one of the other categories if you have a special use case.
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.
Starting a Check
After you're done with selecting your files, you're ready to start a check.
- Click Check .
You'll see the status window, that tells you which document the Content Analyzer is processing and at which stage it’s at. Depending on how many files you've selected, the check might take a while. Take a break and we'll let you know when the check is done.
Getting a Quick Overview
After you've checked, you can scan the Acrolinx Score in the results list to get a quick overview of an entire project. To show the document status, the text color of the Score appears in green, yellow, or red. Click on the Score to open the Scorecard.
Viewing a Content Analysis Report
When the check is finished, you're ready to create a content analysis report. You open the content analysis report to assess the overall quality of the documents that you checked and to view a breakdown of the statistics.
To see a content analysis report, follow this step:
to create a content analysis report.
The report is saved in the report folder defined in your preferences. You can also open the report directly by clicking the link.
The report opens in Microsoft Excel.
The content analysis report contains a summary as well as a breakdown of the statistics for each file.
The breakdown includes:
- The checked document and the Acrolinx Score for the document.
- Totals for the number of words, sentences, and issues.
- A breakdown of the issues.
- Averages for sentence length, Clarity score, Conversational score, and Liveliness score.
You can sort or filter on any column in the table.
You can always go back and change your preferences.
To see your preferences, follow this step:
- In the File menu, select Preferences .
- In the General tab, you can change your server address, your sign-in details, your report folder, and your interface language.
Configuring Extraction Settings
Most content doesn't just contain text, it also contains images, diagrams, and sometimes markup like XML or HTML. To check text correctly, Acrolinx needs to extract the text from your content. The Content Analyzer supports server-side content extraction processing. You can define the extraction settings by adding context segmentation definition (CSD) files to your server installation and updating your language configuration file. You can configure your extraction settings (segmentation and filter) using the instructions in the article Configuring Server-side Extraction. However, your guidance package also comes with a few CSDs.
To find out more on how you can get Acrolinx to read your text correctly see the article Getting Acrolinx to Read Your Text Correctly.