ONLYOFFICE中的插件:开发人员快速入门指南

ONLYOFFICE中的插件是向编辑器添加新功能的简便方法。除了预安装的设置外,还可以使用ONLYOFFICE API添加自己的插件。阅读这篇文章,以了解从哪里开始,如果您想构建和集成您的插件。

插件在ONLYOFFICE

插件类型

我们区分以下几种类型:

  • 视觉和非视觉。非可视化插件提供了将某些转换应用于文档的按钮(例如,将所选文本转换为语音的“ 语音”插件,或允许从桌面应用程序以邮件附件权限发送文档的“ 发送”插件)。视觉插件会打开一个单独的窗口或面板(例如,突出显示代码,该代码可突出显示选择必要的语言,样式和背景颜色的代码的语法,或“ 照片编辑器”插件)。
  • OLE对象。允许将信息从外部资源保存到生成的文件中(例如,可将YouTube视频嵌入到文档中的插件)。
  • 系统与非系统。系统插件在启动编辑器时始终在后台运行(例如,桌面应用程序中的e2e 加密)。非系统插件首先单击相应的按钮(ONLYOFFICE中的大多数插件)。
  • 输入助手。具有自己的窗口,当您键入文本时该窗口会消失。它的位置与光标相关。一个示例是自动完成插件,可帮助用户更快地键入内容。

GitHub找到所有可用的插件示例。

插件结构

ONLYOFFICE中的插件始终是一个至少包含三个文件的文件夹:

  • 插件配置文件(config.json)。
  • 插件入口点(index.html)。
  • 代码文件本身(pluginCode.js)。

此文件夹还可以包含其他文件,例如图标,翻译,自述文件等。

如何构建自己的插件

创建一个新文件夹,您将在其中放置所有文件,然后执行以下步骤:

  1.  使用插件的JavaScript代码创建一个.js文件
  2. 创建一个主HTML文件,以指定插件在哪种iframe中工作。
  3.  使用在编辑器中注册插件所需的数据创建配置文件
  4. 如有必要,本地化您的插件。
  5. 创建一个关于页面。
如何将插件添加到ONLYOFFICE编辑器

完成上述步骤后,可以将插件添加到编辑器中。

  • 对于ONLYOFFICE服务器解决方案将plugin文件夹放入Document Server文件夹,或仅将相应的行添加到配置中。
  • 对于ONLYOFFICE Desktop Editors   存档您的插件文件夹,将其扩展名更改为.plugin。然后,转到编辑器中的“插件”选项卡,单击“管理插件”→“添加插件”,浏览以找到.plugin文件并将其上传到应用程序。
  • 对于Cloud Service和ONLYOFFICE Personal:在这种情况下,您可以将新插件添加为Chrome扩展程序。

发表者Ksenija  来源:ONLYOFFICE博客

联系我们

18701927405

在线咨询:点击这里给我发消息

邮件:info@oaooa.com

工作时间:周一至周五,9:30-18:30,节假日休息