|Acrolinx for FrameMaker||1.2 SR1|
What You Should Know Before Installing
Before you install Acrolinx for FrameMaker, make sure that you've installed the following:
Check our compatibility guide if you want to know if Acrolinx for FrameMaker works with your local platform and with your Acrolinx platform.
To get started, review the following tasks and concepts:
Acrolinx supports DITA and XML document formats.
Supported file types:
Note that Acrolinx doesn't support the following document types in FrameMaker:
- DITA map - *.ditamap
- Adobe FrameMaker book - *.book
If you do the installation yourself, ask your Acrolinx administrator for the installer file. You might have it already, if you and the Acrolinx administrator are the same person.
To install Acrolinx, follow these steps:
- Close all programs, including FrameMaker.
- Double-click the installer in Windows and follow the on-screen instructions.
You don't have to remove the previous version of Acrolinx before installing a newer version. To upgrade Acrolinx, follow the standard installation procedure.
To remove Acrolinx, close FrameMaker and follow the Microsoft Windows procedure for changing and removing programs.
Acrolinx is available as soon as you open FrameMaker, but you'll need to show the Sidebar before you can start checking. To show the Sidebar, follow these steps:
- Select Acrolinx in the top menu.
- Select Show Sidebar .
You can change your Acrolinx address by signing out and signing in again. Sign out from the slide-out menu in the Sidebar.
Acrolinx checks all the content that's in your document. Use the 'Author' and 'WYSIWYG' views to edit and check your content. It's best that you switch off track changes because Acrolinx doesn't support track changes and you might see some unexpected behavior.
By default, the Sidebar appears in English. If you set your FrameMaker language to German, French, Japanese, or Swedish, then your Sidebar will also appear in this language.
If your Acrolinx administrator enables embed check data on your Acrolinx Core Platform, Acrolinx saves check data in your documents as comments.
Here’s an example of how embedded check data looks for XML documents:
<?FM MARKER [Comment] acrolinxCheckData timeStarted="2018-02-25T12:20:01Z" score="100" status="green" scorecardUrl = "http://localhost:8031/output/en/faxSample_xml_admin_e9e97a25480c471d_27_report.html"?>
To learn more about activating and using the embed check data function, see our article on Embed Check Data for Sidebar Edition Integrations .
Optional: Specify your Acrolinx address with an MSI Installer Property
If you use the MSI installer properties to automate the installation of Acrolinx, you can also now specify your Acrolinx address. So, writers don't have to enter this information themselves. To set your Acrolinx address, use the property ACROLINX_SERVER_ADDRESS.
Specify the Acrolinx address.