Acrolinx for JustSystems XMetaL - Version 1.1 (22. December 2017)
We're excited to introduce the new start page - we've moved the options and about menu items. So, you’ll find everything you need in the Sidebar itself.
It’s more intuitive to find all features of the Sidebar in the Sidebar. That’s why we’ve removed the separate dialog windows for options and about information. So, you’ll find that the Acrolinx menu includes only the Show Sidebar option. All other features, settings, help, and access to log files are directly in the Sidebar.
One Sidebar for All Documents
Acrolinx used to open a separate Sidebar for each document you checked. This meant that you could conceivably have dozens of Sidebars open at the same time. Too many open Sidebars could be confusing. Also you might have noticed compromised performance on some computers. We’ve changed this to increase performance and to ease your workflow.
New Logging Levels in Log Files
Acrolinx was a little overzealous when it came to writing the log files. Often the log file included too much information and Acrolinx wrote in the log files too often. Too many log entries caused some performance issues on low-end computers. That's why we temporarily disabled logging by default in 1.0 SR2. Now, we’ve introduced logging levels to prioritize entries. These levels include: DEBUG, INFO, WARNING, ERROR, DISABLED. We enabled logging again and the default log level is INFO. So, the log files should contain less noise and you shouldn’t experience performance issues anymore.
XMetaL Now Quits Properly After You Used Acrolinx
If you used Acrolinx and then quit XMetaL, the xmetal.exe process refused to call it a day and would still appear as active in the task manager. We've fixed this issue. Now, if you finish using Acrolinx and close XMetaL, then the application will quit completely.
Show Sidebar Menu Item Works as Expected
The Show Sidebar menu item appeared grayed when you opened a document that contained the macro On_Document_Activate. This was because Acrolinx used the macro On_Document_Activate itself. To avoid this clash, we’ve renamed the macro that Acrolinx uses to On_Application_Document_Activate. Acrolinx now works as you expect with documents that contain the On_Document_Activate macro.
Updated System Requirements for a Client Computer
We updated the system requirements for client computers to reflect the recommended disk space, memory, and RAM for using the Sidebar edition.
See the article System Requirements for a Client Computer .
Cross-Origin Resource Sharing (CORS) Enablement No Longer Required
With the new Sidebar for XMetaL, you don't have to enable Cross-Origin Resource Sharing (CORS) on the Acrolinx Server anymore.
Internet Explorer Script Error Appears
If you use Acrolinx 5.3.x with XMetaL and click the filter button in the Sidebar, a script error message appears. The message is annoying but Acrolinx works just fine. You can simply cancel the message. This issue doesn't appear with Acrolinx 5.2.4. We'll fix this issue in the upcoming Sidebar that will ship with the Acrolinx 5.4 Server.
XMetaL Won’t Quit Properly if You Abruptly Close the Application while Acrolinx is Running
XMetaL won’t be able to quit properly if you close it while Acrolinx is still checking your content. To exit XMetaL, let Acrolinx to finish checking, or cancel a check, then close all open documents, and finally close XMetaL.
We've developed and tested this version of Acrolinx with XMetaL versions 10, 11 and 12.
Acrolinx for XMetaL requires the following Acrolinx products:
Acrolinx version 5.2.4 or later
Acrolinx guidance package version 5.2 or later
Acrolinx Sidebar version 14.3.x or later.
Acrolinx for JustSystems XMetaL - Version 1.0 SR2 (2 November 2017)
With this service release, we've fixed an issue with performance that you might experience on low-end computers.
In some environments, XMetaL Couldn’t Shut Down
If you’re on a slow running computer, and you tried to shut down XMetaL, you might have seen the following message:
"The application couldn't shut down completely because an unknown script is still running."
With this service release, we’ve made sure that scripts related to Acrolinx don’t stop you from shutting XMetaL down. And, we've disabled default logging for Acrolinx for XMetaL.
If you need to enable logging, follow these steps:
- Open <XMETAL INSTALL DIR>\Acrolinx\logger.js file.
- Set the parameter this.logEnabled to true .
- Restart XMetaL.
In the next release of Acrolinx for XMetaL, we’ll make more improvements to performance so that even if you’re running on a slow computer, you won’t have any issues. And we’ll re-enable logging by default again.
Acrolinx for JustSystems XMetaL - Version 1.0 SR1 (6 September 2017)
With this service release, we're excited to introduce the new Acrolinx Storage.
“Page could not be displayed” Message
If you used Acrolinx for XMetaL with a CMS, and you tried to open the Sidebar, you might have seen the message “Page could not be displayed”. This meant that the Sidebar wouldn’t load and you couldn’t use Acrolinx. Oh no! This happened because of the way Acrolinx stored your Acrolinx settings on your system. We’ve solved this issue by introducing a new Acrolinx Storage option in the Sidebar. We announced it here in the release notes for the 14.4.3 Sidebar too. So, previously, Acrolinx tried to save your settings in the local storage of the browser that loads the Sidebar. This didn’t always work. But now, Acrolinx saves your settings to the Windows registry and you shouldn’t see this issue anymore.
Acrolinx saves the Acrolinx Server address (from Options dialog) at the following registry path: HKEY_CURRENT_USER\Software\acrolinx\Plugins\XMetaLSidebar
Acrolinx saves the settings from the Sidebar in local storage at the following registry path: HKEY_CURRENT_USER\Software\Acrolinx\Plugins\Storage\AcrolinxStorage
The Acrolinx plug-in works best with Acrolinx server version 5.2.4 or later. If you use an older server, you might encounter the known issues listed below.
Script Error: Sidebar Doesn’t Load
If you use Acrolinx for XMetaL with Acrolinx Server versions 5.2.1, 5.2.2 or 5.2.3, you might sometimes see a script error in the Sidebar. To avoid this script error, you’ll need to follow these steps at least once before you use the Sidebar:
- Close all your open documents.
- Open the Options dialog.
- Enter the Acrolinx Server address if it’s not already there.
- Click Connect. Do this even if you haven’t changed the Acrolinx Server address.
- Open your document and run a check with the Sidebar when you’re ready.
Acrolinx for JustSystems XMetaL - Version 1.0 (28 April 2017)
The Sidebar for Acrolinx for XMetaL offers you a new way of checking and correcting your content. Learn more about the differences between the two editions in the article Acrolinx Plug-ins Now Come In Two Editions—What's the Difference? .
Manage Extraction Settings on the Server
In the Acrolinx classic edition, you could configure the extraction settings in the plug-in. For the Sidebar, you can configure the extraction settings in the Acrolinx server. This also offers you the option to set specific guidelines for working with attributes. Your guidance package includes default Context Segmentation Definition (CSD) and context definition files, especially for XMetaL. You'll need to update to a new guidance package or get these files from Acrolinx and install them separately. See the article Configuring Server-side Extraction for more information. If you'd like help converting your extraction settings contact Acrolinx Support. They'll be more than happy to help.
Sidebar Appears in the Resource Manager
The Sidebar loads in the resource manager pane on the left side of the XMetaL Author. If you prefer, you can move the Sidebar by drag and drop to the right side of the screen. And you can adjust the pane to show the Sidebar in its fixed dimensions.
Use Acrolinx in Different XMetaL Editor Views
You can use Acrolinx in plain Text, Normal, and Tags On views.
Supported File Types
Acrolinx supports DITA and XML document formats. Supported file types include concept, reference, task, topic, troubleshooting, dita, glossentry, and glossgroup.
Tracked Changes Support
You can use Track Changes in the Tags On and the Normal view. If you turn on Track Changes, Acrolinx will highlight issues in tracked changes. Acrolinx ignores content that's tracked for deletion.
Before You Update Remove Classic Edition
You need to remove the Acrolinx classic edition before you install the Sidebar edition. A parallel installation of both classic and Sidebar editions of Acrolinx isn’t possible.
Request a new license to get the Sidebar activated for your server.
Specify the Address of an Acrolinx Server with an MSI Installer Property
If your administrator uses the MSI installer properties to automate the installation of Acrolinx, they can also now specify the address of an Acrolinx server. So, writers don't have to enter this information themselves. To set that Acrolinx server address, use the property ACROLINX_SERVER_ADDRESS.
Enable Cross-origin Resource Sharing (CORS)
To use Acrolinx for XMetaL sidebar edition, you’ll need to enable CORS on your Acrolinx server. See the article Setting up the Acrolinx Sidebar .
Using Acrolinx with XMetaL 10 Requires Update to Windows Registry
If you use version 10, you must update a key in your Windows registry. Otherwise, you won't be able to show the Acrolinx sidebar. See Why won't the Acrolinx Sidebar load on XMetaL 10? for more details.
Sidebar Cards for Variables Become Deactivated
Acrolinx can read content from variables in your documents. However, by design, variables are read-only because the information is preset and often populated during printing. If the issue cards appear for variables, the cards don't get the "read-only" padlock icon. Instead, if you click a card, then the card becomes deactivated.
Cards for Issue Text with Mixed Formatting Become Deactivated When Clicked
As mentioned in the comment above, Acrolinx doesn't support mix formatted text. So, if you click on the card of such highlighted text, the card will be deactivated.
Sidebar Doesn't Appear after Successful Installation
On all versions of Windows, we've observed that the Sidebar doesn’t load when you select Load Sidebar from the Acrolinx menu. If you encounter this, try adding file://127.0.0.1 to the trusted site list of Internet Explorer settings.
Sidebar Cards Become Deactivated and Acrolinx Doesn’t Select Issue Text
If Acrolinx finds an issue for a text longer than 248 characters, clicking on the Sidebar card results in deactivating the card. That's because XMetaL API has a limitation that prevents Acrolinx from selecting long spans of text. This issue occurs in versions 10, 11, and 12.0.0.047. XMetaL version 12.0.0.057 allows selection of longer texts. Install that update to avoid this issue.
We've developed and tested this version of Acrolinx with XMetaL versions 10, 11 and 12.
The plug-in requires the following Acrolinx products:
- Acrolinx server version 5.1 or later
- Acrolinx guidance package version 5.1 or later
- Acrolinx sidebar version 14.2 or later.