@acrolinx/sidebar-sdk 中文文档教程
Acrolinx Sidebar SDK JS
这是一个用于将 Acrolinx 边栏集成到网络中的库应用。
请参阅：自定义集成入门
Live Demo
Acrolinx Sidebar Web Live Demo
Examples
The Acrolinx Sidebar
Acrolinx Sidebar 是旨在显示在您编辑内容的窗口旁边。 您可以使用它来检查、审阅和更正您的内容。 要了解侧边栏在现有集成中的外观，请查看 侧边栏入门。
Prerequisites
请联系 Acrolinx SDK 支持 用于咨询和获得集成认证。 此示例使用内部 Acrolinx URL 上的测试许可证。 此许可证仅用于演示和开发目的。 完成集成后，您必须从 Acrolinx 获得集成许可。
Acrolinx 提供不同的其他 SDK，以及用于开发集成的示例。
在开始开发自己的集成之前，您可能会从以下方面受益：
- Getting Started with Custom Integrations,
- the Guidance for the Development of Acrolinx Integrations,
- the Acrolinx SDKs, and
- the Acrolinx Demo Projects.
Getting Started
Installation
要将 SDK 安装到基于 npm 的 Acrolinx 集成项目调用：
npm install @acrolinx/sidebar-sdk
Instructions for Contributing Code
SDK Features
SDK 提供 < a href="https://acrolinx.github.io/sidebar-sdk-js/pluginDoc/modules/adapters_adapterinterface.html">适配器 用于：
contentEditablediv-elements,inputtext elements,- CodeMirror,
- CKEditor,
- Xeditor,
- TinyMCE, and a
MultiEditorAdapterthat can be used to combine different adapters as one document.
如果您需要支持其他编辑器，有时 ContentEditableAdapter 无需任何更改即可工作。 如果没有，请实施 AdapterInterface。
References
- The Sidebar DEMO JS is built based on this SDK.
- The Sidebar SDKs are based on the Acrolinx Sidebar Interface.
Running This Project
- Make sure you have a Chrome or chromium version later than 72.0.0. This is needed to execute the tests successfully.
- Run
npm i - Run
npm run buildto run all tests and build distribution
Serve for Development (Load local SDK in Browser)
- Run 'npm run webpack-dev-server'
- Include '' into your project.
- Check the output of the above npm task and correct the host port if needed.
License
版权所有 2015 年至今 Acrolinx GmbH
根据 Apache 许可证 2.0 版（“许可证”）获得许可； 除非遵守许可证，否则您不得使用此文件。 您可以在以下位置获得许可证的副本：
http://www.apache.org/licenses/LICENSE-2.0
除非适用法律要求或书面同意，软件 根据许可证分发是在“按原样”的基础上分发的， 没有任何明示或暗示的保证或条件。 请参阅许可证以获取特定语言的管理权限和 许可证下的限制。
如需更多信息，请访问：https://www.acrolinx.com
Acrolinx Sidebar SDK JS
This is a library for integrating the Acrolinx Sidebar into a web application.
See: Getting Started with Custom Integrations
Live Demo
Acrolinx Sidebar Web Live Demo
Examples
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 Get Started With the Sidebar.
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:
- Getting Started with Custom Integrations,
- the Guidance for the Development of Acrolinx Integrations,
- the Acrolinx SDKs, and
- the Acrolinx Demo Projects.
Getting Started
Installation
To install the SDK to your npm-based Acrolinx Integration project call:
npm install @acrolinx/sidebar-sdk
Instructions for Contributing Code
SDK Features
The SDK provides adapters for:
contentEditablediv-elements,inputtext elements,- CodeMirror,
- CKEditor,
- Xeditor,
- TinyMCE, and a
MultiEditorAdapterthat can be used to combine different adapters as one document.
If you need to support other editors, sometimes the ContentEditableAdapter works without any changes. If not, implement the AdapterInterface.
References
- The Sidebar DEMO JS is built based on this SDK.
- The Sidebar SDKs are based on the Acrolinx Sidebar Interface.
Running This Project
- Make sure you have a Chrome or chromium version later than 72.0.0. This is needed to execute the tests successfully.
- Run
npm i - Run
npm run buildto run all tests and build distribution
Serve for Development (Load local SDK in Browser)
- Run 'npm run webpack-dev-server'
- Include '' into your project.
- Check the output of the above npm task and correct the host port if needed.
License
Copyright 2015-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
