Acrolinx Sidebar .NET SDK

This is a library for integrating the Acrolinx Sidebar into a .NET application.

You can use the Acrolinx Sidebar .NET SDK NuGet package to integrate Acrolinx in your .NET application.

It supports both .NET (8.0.0 and above) and .NET Framework (4.7.2 and above).

Live Demo

Acrolinx Sidebar Web Live Demo

Examples

Acrolinx Sidebar .NET Demo

The Acrolinx Sidebar

The Acrolinx Sidebar is designed to show up beside the window where you edit your content. You use it for checking, reviewing, and correcting your content. To get an impression what the Sidebar looks like in existing integrations, have a look at Sidebar Quick Start.

Prerequisites

Please contact Acrolinx SDK support for consulting and getting your integration certified. This sample works with a test license on an internal Acrolinx URL. This license is only meant for demonstration and developing purposes. Once you finished your integration, you'll have to get a license for your integration from Acrolinx.

Acrolinx offers different other SDKs, and examples for developing integrations.

Before you start developing your own integration, you might benefit from looking into:

• Build With Acrolinx,
• the Guidance for the Development of Acrolinx Integrations,
• the Acrolinx SDKs, and
• the Acrolinx Demo Projects.

Requirements

This SDK uses Microsoft WebView 2 based on Edge Chromoium to render the Sidebar.

The Evergreen WebView2 Runtime will be included as part of the Windows 11 operating system.

For prior operating systems - Please install WebView 2 evergreen runtime.

Download and install "Evergreen Standalone Installer" from Microsoft

Getting Started

Build Locally

1. Make sure that you have installed Microsoft Visual Studio with C# support version 2022 or later.
2. Since the Acrolinx Sidebar performs static code analysis to improve quality, you also have to install Code Contracts for .NET.
3. Open the solution file Acrolinx.Sidebar.Net.sln with Visual Studio.
4. Build the solution.

Visual Studio downloads the required dependencies and compiles the Acrolinx .NET Sidebar Demo solution using NuGet.

Note: The dependency download may fail on the first build. This problem can usually be solved by building a second time.

Releasing

1. Increment version number in AssemblyInfo.cs file.
2. Commit and push your changes to main branch
3. Create a tag with the same version number.
4. GitHub Action will run and publish the new version to nuget.org

Using the SDK

Have a look at the sample source code provided in the Acrolinx Sidebar .NET Demo. Use the Acrolinx Sidebar .NET SDK NuGet package.

SDK Features

1. Document Model - Provides lookup functionality.
2. Start page - Provides an interactive way to sign in to Acrolinx with built-in error handling.
3. Logger - Provides logging using Log4net.
4. Acrolinx Storage: Applications using the Internet Explorer web browser control may be denied to access LocalStorage. The SDK uses its own storage mechanism using the Windows registry:
   • Registry path: HKCU\Software\Acrolinx\Plugins\Storage\[KEY]
   • Fallback path: HKLM\Software\Acrolinx\Plugins\Storage\[KEY]

Deprecation

:warning: Sidebar v14 is getting deprecated

The process to update your existing integration is straightforward and involves the following steps:

1. Update to the Latest SDK Version: Please ensure that you’ve updated to the latest SDK version. The most recent version can be found on our Nuget package page here.

2. Remove the Initialization Config (Optional): If your current implementation includes the initialization config MinimumSidebarVersion=14.x.x, we recommend removing this configuration.

References

• The Sidebar DEMO .NET is built based on this SDK.
• The Sidebar SDKs are based on the Acrolinx Sidebar Interface.

License

Copyright 2016-present Acrolinx GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

For more information visit: https://www.acrolinx.com