We have many Sidebar edition integrations. They all use the same Sidebar but they’re very different in other ways. This table attempts to provide an overview of the technical differences between the integrations.
Microsoft Office for Windows · Word · PowerPoint · Excel · Outlook |
|
---|---|
Platform | .NET (requires Microsoft .NET Framework version 4.5 or later) |
Web browser | Internet Explorer 11 |
Browser dependency | Acrolinx requires minimum Internet Explorer 11 |
Configurations | |
LocalStorage |
Latest versions
LocalStorage for Office is stored in registry at: Office version 1.1 and earlier HKEY_CURRENT_USER\Software\Acrolinx\PlugIns\Office\ServerAddress If no key is there, it will fall back to: HKEY_LOCAL_MACHINE\Software\Acrolinx\PlugIns\Office\ServerAddress Internet Explorer browser LocalStorage where cookies are stored: C:\Users\<USER>\Local Settings\Application Data\Microsoft\Internet Explorer\DOMStore |
Log file |
%temp%\Acrolinx\logs\<appname>\<date>_<appname>.log C:\Users\<user_name>\AppData\Local\Temp\Acrolinx\logs To set the log level, edit the following file: <ADDIN_INSTALL_DIR>\Acrolinx.Sidebar.log4net.xml Change level value to any one of the following: ALLfor example, <level value="DEBUG"/> |
Start page location | |
Interface language | Application language will be picked |
Installer language | Language is picked up according to System locale |
Prerequisite installation check |
64-bit(x64): HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\<Version>\<Application Name>\InstallRoot 32-bit(x86): HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Office\<Version>\<Application Name> Check for the following key: Key="Path" Value="C:\Program Files\Microsoft Office\root\Office16" |
Version: 15.0,16.0 |
Changes for Acrolinx for Office 1.6+
Acrolinx for Office v1.6 |
|
---|---|
Platform |
.NET Framework 4.7.2 or above |
Dependency (Windows 10 users) | WebView2 - Microsoft Edge Developer |
CORS Settings |
cors.allowedOrigins = https://extensions.acrolinx.cloud |
Oxygen · Standalone · EclipseOxygen Standalone |
|
---|---|
Platform | Java, Java FX and Swing |
Web browser | JavaFX WebView is a mini browser that is called as an embedded browser in JavaFX application. This browser is based on WebKit. |
Browser dependency | -- |
Configurations |
for Oxygen XML Author: oxyAuthorOptionsSaVERSION.xml <entry> <String>PLUGIN_CUSTOM_OPTIONS.acrolinxServerURL</String> <String>https://test-latest-ssl.acrolinx.com</String> </entry> |
LocalStorage |
for Oxygen XML Author: oxyAuthorOptionsSaVERSION.xml |
Log File |
Windows: C:\Users\<user_name>\AppData\Local\Temp\Acrolinx\Logs\ Linux: /tmp/acrolinx/logs/ Mac: /Users/<USERNAME>/Library/Logs/Acrolinx |
Start page location |
Windows: C:\Users\<user_name>\AppData\Local\Temp\Acrolinx\acrolinx_start_page_<version>/ Linux: /tmp/acrolinx/acrolinx_start_page_<version>/ Mac: /Users/<USERNAME>/Library/acrolinx/acrolinx_start_page_<version>/ |
Interface language |
Uses language set in Oxygen Language Options. If not available, English as default language. |
How to enable debug logging |
Follow instructions on: https://www.oxygenxml.com/doc/versions/25.0/ug-editor/topics/set-parameter-in-startup-script.html#ariaid-title4 and set -Dacrolog.level=debug |
Oxygen Eclipse |
||
---|---|---|
Platform | Java, SWT | |
Web browser | With SWT, Acrolinx uses operating systems default browser engine. | |
Browser dependency | Internet Explorer 11. other browser version not yet verified | |
Configurations |
eclipseInstallationDirectory/configuration/.settings/com.acrolinx.client.sidebar.oxygen.eclipse.plugin.prefs acrolinxServerURL=https://test-latest-ssl.acrolinx.com
|
|
LocalStorage |
Oxygen XML Author Oxygen XML |
|
Log File |
|
|
Start page location |
Windows: C:\Users\<user_name>\AppData\Local\Temp\Acrolinx\acrolinx_start_page_<version>/ Linux: /tmp/acrolinx/acrolinx_start_page_<version>/ Mac: /Users/<USERNAME>/Library/acrolinx/acrolinx_start_page_<version>/ |
|
Interface language |
Uses system default language, or if not available, English as default. |
|
How to enable debug logging |
Set -Dacrolog.level=debug within the eclipse.ini file in the Eclipse installation folder. |
Adobe FrameMaker |
|
---|---|
Platform | MFC C++ |
Web browser | Microsoft Edge Chromium based on WebView2 runtime x64 (Evergreen installer preferred for automatic updates from Windows) |
Browser dependency | Microsoft Edge Chromium |
Visual C++ Redistributable |
Dependency fulfilled by FrameMaker. If necessary can be downloaded from Microsoft |
LocalStorage |
1.2 FM and later LocalStorage for FM is stored in registry at: HKEY_CURRENT_USER\Software\Acrolinx\Plugins\Storage\AcrolinxStorage If no key is defined, it will fall back to: HKEY_LOCAL_MACHINE\SOFTWARE\Acrolinx\PlugIns\Storage\AcrolinxStorage\acrolinx.serverSelector.serverAddress FM 1.1 and 1.0 FrameMaker Sidebar saves Acrolinx URL in following registry path: HKEY_CURRENT_USER\Software\Acrolinx\PlugIns\FrameMakerSidebar\ServerAddress |
Log File |
%temp%\Acrolinx\logs\Adobe FrameMaker <fm-version>\<date>-Adobe FrameMaker <fm-version>.log (for example: 2018-6-29-Adobe FrameMaker 2017.log) Set the log level to debug: Add entry in registry HKEY_CURRENT_USER\Software\Acrolinx\Plugins\SdkCpp\enable.debug.log and set value to DWORD 1 |
Enable browser context menu for debugging |
Open Registry Computer\HKEY_CURRENT_USER\Software\Acrolinx\PlugIns Add new DWORD EnableContextMenu and set decimal value to 1 |
Startpage Directory |
FM 2022: %temp%\Acrolinx\startpage-Adobe FrameMaker 2022 FM 2020: %temp%\Acrolinx\startpage-Adobe FrameMaker 2022 |
WebView2 User Directory |
FM 2022: %temp%\Acrolinx\webview-Adobe FrameMaker 2020 FM 2020: %temp%\Acrolinx\webview-Adobe FrameMaker 2020 |
Interface language |
Uses the language of your FrameMaker installation for English, German, French, or Japanese. |
CORS Settings | cors.allowedOrigins = https://extensions.acrolinx.cloud |
MadCap · Flare · Contributor |
|
---|---|
Platform | .NET |
Web browser | Internet Explorer 11 |
Browser dependency | Acrolinx requires minimum Internet Explorer 11 |
Configurations | If you configure LocalStorage or proxy settings in Internet Explorer, Acrolinx falls back to use those settings |
LocalStorage |
Flare and Contributor Sidebar saves Acrolinx URL (from option dialog) in following registry path: HKEY_CURRENT_USER\Software\Acrolinx\Plugins\MadCapSidebar\ |
Log File |
Version 1.1: %temp%\Acrolinx\logs\<date>_<appname>.log Version 1.2: C:\Users\$USER$\AppData\Local\Temp\Acrolinx\logs\AcrolinxForMadCap To set the log level, edit the following file: Acrolinx.Sidebar.log4net.xml Use one of the Acrolinx.Sidebar.log4net.xml user can mention any one of the following: ALL |
Start page location |
|
Interface language |
English |
Changes Acrolinx for Madcap 1.5+ |
|
---|---|
Platform | .NET Framework 4.7.2 or above |
Dependency (Windows 10 users) | WebView2 - Microsoft Edge Developer |
CORS Settings |
cors.allowedOrigins = https://extensions.acrolinx.cloud |
Adobe Creative Cloud · InDesign · InCopy |
|
---|---|
Platform | Common Extensibility Platform (CEP)
|
Configurations | |
LocalStorage |
A file is created to hold the AcrolinxStorage, which will be shared by Adobe CC extensions. Mac: ~/Library/Application Support/Acrolinx/Storage Windows: %AppData%\Acrolinx\Storage |
Log File |
Mac: Windows: %TEMP%\Acrolinx\Logs\Adobe_InDesign |
Start page location |
Bundled with the build |
Interface language |
Acrolinx uses the interface language of InDesign or InCopy. |
JustSystems XMetaL |
|
---|---|
Platform | C#, .NET |
Web browser | Edge Chromium based on WebView2 |
Browser dependency | WebView2 Runtime installed |
Configurations |
Server address passed with msiexec will be stored at: CORS: https://extensions.acrolinx.cloud |
LocalStorage |
LocalStorage for XMetaL is stored in registry at: HKEY_CURRENT_USER\Software\Acrolinx\Plugins\Storage\AcrolinxStorage |
Log File |
%temp%\Acrolinx\XMetaL-<editorVersion>\ |
Interface language |
Sidebar only shows in English. |
PTC Arbortext |
|
---|---|
Platform | Java, Java FX and Swing |
Web browser | JavaFX WebView is a mini browser that is called as an embedded browser in JavaFX application. This browser is based on WebKit. |
Browser dependency | -- |
Configurations |
The configuration information for "Acrolinx for Arbortext" stores in the file: For default Acrolinx platform initialization - %ALLUSERSPROFILE%\Acrolinx\ArborText\Storage Version 2.1 and before For default Acrolinx Platform - HKEY_LOCAL_MACHINE\Software\Acrolinx\Plugins\ArbortextSidebarPlugin |
LocalStorage |
%APPDATA%\Acrolinx\ArborText\Storage (Non-Editable and managed by Sidebar) |
Log File |
%temp%\Acrolinx\Logs\AcrolinxForArbortext\AcrolinxForArbortext.log |
Start page location |
C:\Users\<USER>\AppData\Local\Temp\Acrolinx\acrolinx_start_page_<VERSION> %TEMP%\Acrolinx\acrolinx_start_page_<version> |
Interface language |
Uses system default language, or if not available, English as default. |
Mac · MS Office Word · MS Office PowerPoint · MS Outlook · Sketch |
|
---|---|
Platform | Objective C |
Web browser | Safari 11 |
Browser dependency | Acrolinx requires minimum Safari 11 |
Configurations | |
LocalStorage |
LocalStorage data is saved in user defaults.(can be found at ~/Library/Preferences/com.acrolinx.Acrolinx.baseclimb.plist and com.acrolinx.Acrolinx.plist). |
Log File |
/Users/<USERNAME>/Library/Logs/Acrolinx/yyyy-MM-dd HHmmss Acrolog.log |
Start page location |
Start page is embedded inside Acrolinx application dmg. |
Interface language |
Uses system default language |
Microsoft Visual Studio Code |
|
---|---|
Platform |
Version 1.1 and 1.0: Type Script, Node.js Version 1.0: Desktop sidebar |
Web browser | Chromium 53 |
Server dependency | Version 1.1: 5.5 and later |
Configurations | Electron: packaged Chromium |
LocalStorage |
Depending on your platform, the user settings file is located here: Version 1.1:
Version 1.0:
|
Log File |
Version 1.1: Default log level is info. To change the log level to debug: Goto File menu > Preferences > Settings > User Settings, set "acrolinx.loglevel": "debug". Restart Visual Studio Code to take effect User can use one of the following log levels: Version 1.0: No integration logs. Open Sidebar browser console. |
Start page location |
Version 1.1: Bundled with the Sidebar Version 1.0: loads the start page from the cloud. |
Interface language |
Version 1.1: Taken from Visual Studio locale language Version 1.0: Sidebar only shows in English. |
Desktop Checker |
|
---|---|
Platform | JavaScript |
Web browser | Electron: packaged Chromium |
Installation Folder |
|
Configurations |
|
LocalStorage |
Depending on your platform, the user settings file is located here:
|
Log File |
Log files are accessible from the Sidebar: About -> Open Log File. -OR- To obtain console logs: Open View -> Developer Tools and on Console tab right-click Save as... to save the .log file to your computer |
Start page location | Bundled with the build |
Interface language | Taken from system language |
Google Drive Apps |
|
---|---|
Platform |
JavaScript |
Web Browser |
Chrome / Firefox / Edge Chromium / Safari |
Browser dependency |
- |
Configurations |
|
LocalStorage |
Browser local storage, i.e., Google Chrome local storage |
Log File |
After installing the addon, please refer to Google Docs addon script page, where you can find the logged messages. |
Start page location |
Bundled in the App |
Interface language |
Uses Google Workspace language |
Browser Extensions - Chrome | Firefox | Microsoft Edge | Safari |
|
---|---|
Platform | JavaScript |
Configurations |
|
Start page location | Bundled in the extension. |
Interface language | Derived from the browser language. |
Chrome | |
---|---|
LocalStorage | Open Chrome -> Right click and select "Inspect" -> Go to Application tab -> In left side panel, Click on Storage -> Select Cookies |
Log file | Go to Console log -> Right click on Console -> Click on Save As |
Chrome
LocalStorage | Open Chrome -> Customize and control Google Chrome -> More tools -> Developer tools -> Go to Application tab -> In left side panel, Click on Storage -> Select LocalStorage |
Log file | Go to Console log -> Right click on Console -> Click on Save As |
Firefox | |
---|---|
LocalStorage | Open Firefox -> Right click and select "Inspect Element" -> Go to Storage tab -> In left side panel, Click Cookies. |
Log file | Go to Console log -> Right click on Console -> Click on Select All and Copy Log into file. |
Firefox
LocalStorage | Open Firefox -> Open Menu -> Web Developer -> Storage Inspector -> In left side panel, Click LocalStorage. |
Log file | Go to Console log -> Right click on Console -> Click on Select All and Copy Log into file. |
Microsoft Edge | |
---|---|
LocalStorage | Open Microsoft Edge -> Right click and select "Inspect Element"-> Go to Debugger tab -> in left side panel -> Cookies. |
Log file | Go to Console log -> Right click on Console -> Click on Copy All and Save to File. |
Microsoft Edge
LocalStorage | Open Microsoft Edge -> Settings and more -> Developer Tools -> Go to Debugger tab -> in left side panel -> LocalStorage. |
Log file | Go to Console log -> Right click on Console -> Click on Copy All and Save to File. |
Safari | |
---|---|
LocalStorage | Open Safari -> Click Develop from Menu -> Show JavaScript Console -> Select Storage tab -> On left side panel, select LocalStorage. |
Log file | Go to Console log -> Press Command+A -> Right click on the console -> Click on "Copy Selected" or "Save selected". |
Drupal |
|
---|---|
Platform | JavaScript |
Web browser | |
Browser dependency | |
Configurations | |
LocalStorage | |
Log File |
|
Start page location | |
Interface language |
AEM |
|
---|---|
Platform |
JavaScript and Java |
Web browser |
Chrome/Firefox/Microsoft Edge/Safari. Sidebar integration doesn’t support combination of IE11 with AEM 6.5 |
LocalStorage |
Browser Local Storage |
Log File |
/logs/project-acrolinx-for-aem.log |
Start page location |
Not applicable - single sign-on |
Debug Logs |
http://<aem-host>/system/console/configMgr |
WordPress |
|
---|---|
Platform | JavaScript |
Web browser |
Chrome / Firefox / Edge Chromium / Safari |
Browser dependency |
- |
Configurations |
Log level: |
LocalStorage |
Browser local storage |
Log File |
Browser console logs, |
Start page location |
Bundled with Sidebar SDK JS |
Interface language |
Uses WordPress language |
Oxygen XML Web Author |
|
---|---|
Platform | JavaScript |
Web browser | |
Browser dependency | |
Configurations | |
LocalStorage | |
Log File | |
Start page location | |
Interface language |
Microsoft Word Online |
|
---|---|
Platform | JavaScript |
Configurations |
|
Start page location | Bundled with Sidebar SDK JS |
Interface language | Derived from the Office interface language |
Local Storage |
Browser local storage |
Microsoft PowerPoint Online |
|
---|---|
Platform | JavaScript |
Web browser | |
Browser dependency | |
Configurations | |
LocalStorage | |
Log File |
|
Start page location | |
Interface language |
Content Analyzer |
|
---|---|
Platform | Python on Windows and Mac |
LocalStorage | Registry is used for LocalStorage |
Log File |
Windows: go to File Menu > Preferences > Logging tab. This will show the path of the log file. In Mac: go to Application Menu |
Interface language | Use UI Option to change this |
PAC file Errors |
If the content-analyzer-log.txt contains: UnicodeDecodeError: 'Ascii' codec can't decode byte -> PAC file contains umlaut characters. These aren’t supported If the content-analyzer-log.txt contains 1. This indicates the Content Analyzer wasn’t able to parse the PAC file. Is Wireless Proxy Auto-Discovery used on the customer side? WPAD has been disabled in Content Analyzer from 1.3.1 onwards. Suggest to the customer to have direct access to internet. 2. Check the PAC file. The PAC file shouldn’t have reassignments to the same variable. For for example, a variable like hostIP should be assigned value only once in the entire pac file.
|
Content Analyzer 2019 |
|
---|---|
Platform | Python on Windows and Mac |
LocalStorage | Registry is used for LocalStorage |
Log File |
Windows: go to File Menu > Preferences > Logging tab. This will show the path of the log file. In Mac: go to Application Menu For a more detailed log level in macOS: use the open command from the command line: open "Acrolinx Content Analyzer 2019.app"/ --args -d |
Interface language | Use UI Option to change this |
PAC file Errors |
If the content-analyzer-log.txt contains: UnicodeDecodeError: 'Ascii' codec can't decode byte -> PAC file contains umlaut characters. These aren’t supported If the content-analyzer-log.txt contains 1. This indicates the Content Analyzer wasn’t able to parse the PAC file. Is Wireless Proxy Auto-Discovery used on the customer side? WPAD has been disabled in Content Analyzer from 1.3.1 onwards. Suggest to the customer to have direct access to internet. 2. Check the PAC file. The PAC file shouldn’t have reassignments to the same variable. For for example, a variable like hostIP should be assigned value only once in the entire pac file.
|