@acrolinx/sidebar-interface 中文文档教程
Acrolinx Sidebar Interface
该项目包含 Acrolinx Sidebar Interface 文档 从其 TypeScript 源代码 生成。
对于大多数用例，您不必直接使用 Acrolinx 边栏界面，但可以改用 Acrolinx SDK。
Live Demo
Acrolinx Sidebar Web Live Demo
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.
Installation Via NPM
对于大多数用例，您不必直接使用 Acrolinx 边栏界面， 但可以改用 Acrolinx Sidebar JavaScript SDK。
npm install @acrolinx/sidebar-interface
(Internal Only) Create a new release
- Make sure you have updated the version number in the package.json.
- On GitHub, navigate to the main page of the repository.
- To the right of the list of files, click Releases or Latest release.
- Click Draft a new release.
- Type a version number for your release.
- Use the drop-down menu to select the master branch for the release.
- Add title and description.
- If you're ready to publicize your release, click Publish release.
- Github Workflow will take care of publishing the new version to npm.
License
版权所有 2016 年至今 Acrolinx GmbH
根据 Apache 许可证 2.0 版（“许可证”）获得许可； 除非遵守许可证，否则您不得使用此文件。 您可以在以下位置获得许可证的副本：
http://www.apache.org/licenses/LICENSE-2.0
除非适用法律要求或书面同意，软件 根据许可证分发是在“按原样”的基础上分发的， 没有任何明示或暗示的保证或条件。 请参阅许可证以获取特定语言的管理权限和 许可证下的限制。
如需更多信息，请访问：https://www.acrolinx.com
Acrolinx Sidebar Interface
This project contains the Acrolinx Sidebar Interface documentation generated from its TypeScript source.
For the most use cases you don't have to use the Acrolinx Sidebar Interface directly, but can use instead the Acrolinx SDKs.
Live Demo
Acrolinx Sidebar Web Live 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 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.
Installation Via NPM
For the most use cases you don't have to use the Acrolinx Sidebar Interface directly, but can use instead the Acrolinx Sidebar JavaScript SDK.
npm install @acrolinx/sidebar-interface
(Internal Only) Create a new release
Follow the instruction for creating a release in Github
- Make sure you have updated the version number in the package.json.
- On GitHub, navigate to the main page of the repository.
- To the right of the list of files, click Releases or Latest release.
- Click Draft a new release.
- Type a version number for your release.
- Use the drop-down menu to select the master branch for the release.
- Add title and description.
- If you're ready to publicize your release, click Publish release.
- Github Workflow will take care of publishing the new version to npm.
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
