如何为自己的ONLYOFFICE开发创建一个功能插件_onlyoffice开发教程

link之家

链接快照平台

输入网页链接，自动生成快照
标签化管理网页链接

第一步：准备

开发一个插件并且要发布在ONLYOFFICE官方的插件市场上，你需要有一个 GitHub 账号，注册一个新账号或登陆你自己的账号。

将ONLYOFFICE官方插件市场源码文件仓库新开一份分叉到你的账号下： https://github.com/ONLYOFFICE/onlyoffice.github.io.

我点击这个测试用插件的按钮，自动插入Hello World。为了更简化开发，不用手写一行代码，直接打开官方提供的Hello World代码库。

直接把下载的hello world示例文件夹的内容拷贝进自己的hello world文件夹内即可。

第三步：调试插件的风格样式

添加ONLYOFFICE的 Style风格Sheet 到 index.html 文件，调试你的插件的风格样式

<link rel="stylesheet" href="https://onlyoffice.github.io/sdkjs-plugins/v1/plugins.css">

准备图标，置于 resources 文件夹内，在 config.json 文件中创建配置图标的详情在这里

注意总共需要准备8个图标文件，四种不同的大小比例：125%、150%、175%、200%以及正常和黑暗两种模式。

不要忘了 readme 说明文件，说明功能特征、安装卸载、使用方法、以及其它任何你想告知使用者的信息，推荐为markdown格式。

第六步：测试

准备好上述所有文件后可以推送到你的远程代码仓库上，就可以用你的在线版和本地版ONLYOFFICE测试功能了。

在桌面版ONLYOFFICE编辑器中测试

在线测试之前先要完全在本地测试一遍，在配置文件 config.json 中找到插件的唯一GUID识别代号：

看到这个画面，web网页开发工程师就心里踏实了，这不就是最熟悉的debug工具功能吗，这里就可以查看调试自己所开发的任意代码了。

在线版ONLYOFFICE编辑器中测试

本地测试通过后再推送到网络上，在网页浏览器里面测试在线ONLYOFFICE版本使用新开发的插件的功能。

如果有自己团队架设了ONLYOFFICE文档服务器，那就安装到自己的文档服务器上测试使用， ONLYOFFICE文档服务器端安装测试新开发的插件的操作说明在这里。但是我更建议在部署到文档服务器之前，先安装到网页浏览器里面测试插件功能，这样有几个好处：你没有自己的文档服务器可以用ONLYOFFICE的官方免费个人在线版来测试，官方在线ONLYOFFICE或者团队的ONLYOFFICE文档服务器不是你能去操作服务器端安装插件的，在浏览器里面不管连接哪一家的文档服务器都能使用自己开发的新插件。

首先别忘了把自己开发的新插件推送到自己Github账户下分叉出来的 onlyoffice.github.io 这个代码库上，在网页上查看确认自己写的HelloWorld确实存在了

然后打开本地文件 onlyoffice.github.io/store/plugin-dev/extension/inject.js ，向参数 URL_TO_PLUGIN 添加你开发的插件在GitHub上的网络路径

var URL_TO_PLUGIN = "https://YOUR-USERNAME.github.io/onlyoffice.github.io/sdkjs-plugins/content/helloworld/"

这个地址需要根据自己的Page修改，然而按照手册的这个地址自己反复测试也不通过，最后自己采用了比较简单粗暴的方法，直接把这个 helloworld 文件夹整体拷贝到自己的Pages的根路径下反倒是能够最终测试成功，

第七步：公开发布

如果想把你开发的插件贡献到ONLYOFFICE的官方插件市场上，从你的fork分支向官方的 https://github.com/ONLYOFFICE/onlyoffice.github.io 发起一个 pull request ，功能正常的话，你的pull request将被批准并上线官方插件市场。

最后，你可以讨论插件的开发、请求新功能、或者报告bug等等，只需要在 marketplace repository插件市场库中提交一个issue提案。

Getting started with plugins

Hello World

文档编辑器中的插件具有高度的便捷性和实用性，这对工作效率的提高至关重要， ONLYOFFICE 功能的强大也离不开丰富的插件资源。现在，您可以自己制作插件并上架到 ONLYOFFICE ，一起帮助广大用户更高效地办公，并获得相应的回报。只有办公桌面编辑器 8.1版推出后，用户可以享受到许多增强功能和改进。新版本不仅提升了性能，还引入了一些新的本地化选项，特别是改进了从右至左语言（RTL语言）的支持。这意味着使用阿拉伯文本、希伯来文或乌尔都语的用户现在可以更流畅地在 ONLYOFFICE 中编辑和处理文档，享受到更加符合他们阅读习惯的体验。此外，8.1版还可能增强了用户界面的布局调整功能，确保所有的界面元素在RTL语言环境下也能正常显示和操作。这种改进不仅提高了软件的易用性，也增强了全球用户的满意度和使用体验。最近公司系统插件从金格换成了 OnlyOffice ，需要重新安装部署，做个记录。安装 onlyoffice 有两种方式，第一种是独立安装nginx、epel、PostgreSQL、RabbitMQ等依赖项，再安装 OnlyOffice 文档插件。此种方式较为繁琐，暂不赘述，附同事分享的文档在资源内。第二种为docker安装部署，省心方便，操作快捷。这里对第二种方式进行介绍。相信大家已经有所了解 ONLYOFFICE 这个神中神办公软件真正的办公神器- ONLYOFFICE 你了解多少？，最近公司产品突然提出一个需求要实现文档实时在线浏览编辑等一系列功能，需求评审我直接举手，这个活我来！之前对 ONLYOFFICE 有一定的了解，但是对于二次开发与整合方面一直没深入探索，正好借着本次机会，上班学习走起！本篇给大家讲一下 ONLYOFFICE 本地部署的相关步骤与注意事项。拉取 onlyoffice 镜像查看镜像是否下载完成启动 onlyoffice 以下是将本机的9001端口映射到docker的80端口上，访问时通过服务器ip：9001访问，并且用 -v 将本机机==/data/aws_s3/file-storage==文件夹挂载到docker的 /var/www/ onlyoffice /documentserver/web-apps/wsData文件下，后续直接通过http请求读取对应的文件夹打开浏览器输入ip:9001出现以下页面就安装成功。我们发布了2024 插件开发大赛：为 ONLYOFFICE 开发适合中国用户的插件，获得福利与证书。如果您想要参加，阅读本文了解如何为 ONLYOFFICE 开发插件。