|Acrolinx for Visual Studio Code||1.1|
What You Should Know Before Installing
Before you install Acrolinx for Visual Studio Code (VS Code), make sure that you've installed the following:
|Acrolinx Core Platform||5.5 or later|
|Microsoft Visual Studio Code||1.25.1|
Check our Compatibility Guide if you want to know whether Acrolinx for VS Code works with your local platforms.
IntroductionYou can use Acrolinx for VS Code to include content quality in your content creation process.
To get started, review the following tasks and concepts:
|Acrolinx Version||File types|
|5.5||text, html, xml, markdown, JSON, .properties, Java comments, C++ comments|
To install Acrolinx for VS Code, follow these steps:
- Open Visual Studio Code and navigate to Extensions from the Activity Bar.
- Type "Acrolinx" in the search bar.
- When Acrolinx for Visual Studio Code appears, click Install.
- Click Reload to activate the extension.
- Before you can connect to Acrolinx, your Acrolinx administrator needs to set the CORS property to null.
- Acrolinx for VS Code is ready to use!
Once you've installed Acrolinx for VS Code directly from the Marketplace, you can update it like any other extension. By default, VS Code will update your extensions for you. You generally have to reload VS Code to activate an extension update.
If you're updating from a version of Acrolinx for VS Code that wasn't on the Marketplace, the process is a little different.
To update from a version that wasn't on the marketplace, follow these steps:
- Open VS Code and navigate to Extensions from the Activity Bar.
- Find Acrolinx for Visual Studio Code and click to open the extension.
- Click Uninstall.
- Reload VS Code to deactivate the extension.
- Restart (close and reopen) VS Code.
- Follow the regular installation instructions described above.
Show the Sidebar by clicking in the title area of your document's editor region.
The Sidebar will open in the next editor region. You can move the Sidebar around like a regular document in VS Code. To learn more about editor regions, take a look at the VS Code documentation on this feature.
You can't use the Sidebar on a document that's in the same editor region. If you try to do this, you'll see an error message saying: "To check and review your content, move the Acrolinx Sidebar to a different editor region." Simply drag and drop the Sidebar to a different editor region to continue using the Sidebar on your document.
Acrolinx for VS Code can check a selected section of your content.
To use check selection, follow these steps:
- Select some content by highlighting it with your cursor.
- Click CHECK SELECTION in your Sidebar. You can find it in the drop-down menu next to the CHECK button.
- Voila! The Sidebar will only show you cards for the content you've selected.
Set the CORS Property to Null
Although Acrolinx for VS Code doesn't require CORS, the integration will only work if you
null to the properties file as follows:
See the article on CORS for more details.
Optional: Install Acrolinx for VS Code from the Command Line
You can install Acrolinx for VS Code using the following command:
code --install-extension acrolinx.vscode-sidebar
Optional: Preset the Acrolinx URL
As an administrator, you can preset the Acrolinx URL that your writers use to connect to Acrolinx. Writers can always manually change their Acrolinx URL by signing out of the Sidebar and signing in again. How you preset the Acrolinx URL depends on whether a computer has Acrolinx Storage or not.
If a Computer Already Has Acrolinx Storage
If you've previously installed Acrolinx for VS Code or some other Acrolinx Integration on a computer, then it will probably already have an Acrolinx Storage file. You can check whether a computer has Acrolinx Storage under the following path, depending on your operating system:
If a computer already has Acrolinx Storage, follow these steps to preset the Acrolinx URL:
- Open the
acrolinxStorage.jsonJSON file in your Acrolinx Storage folder.
- Add or edit the following property:
If a Computer Doesn't Have Acrolinx Storage
If a computer doesn't already have Acrolinx Storage, you can set the Acrolinx URL before
installation using the VS Code user setting
acrolinx.serverAddress. VS Code
stores its user settings as a .json file. The VS Code documentation has
more detailed information about these files. If you want every user to use the same settings,
you can create the user setting file once and copy it to all other computers.
Note: When Acrolinx for VS Code initializes for the first time, it creates
acrolinxStorage.json file in Acrolinx Storage. This file overrides the user
acrolinx.serverAddress, making it obsolete.