跳到主要内容

入门指南

ONLYOFFICE 支持三种扩展编辑器功能的方式：插件、宏和自定义 AI 工具。本页面帮助您选择合适的方案并快速上手。

如果您希望直接开始编写代码，请前往快速入门指南，或在交互式 Playground 中体验。

您可以构建什么​

插件 — 具有丰富界面的交互式工具​

构建与 ONLYOFFICE 原生体验融为一体的复杂集成。

适用场景：

  • 嵌入外部内容（YouTube、媒体库）
  • 第三方集成（Translator、Zotero、CRM 系统）
  • 高级处理（OCR、图像处理、数据可视化）
  • 自定义工作流（表单构建器、审批系统、模板）

开发概况：

  • 时间： 2-7 天 | 技能： 中级 | 技术栈： HTML/CSS/JavaScript
  • 分发方式： ONLYOFFICE 应用市场或私有部署

在 ONLYOFFICE 应用市场浏览示例

宏 — 即时自动化脚本​

轻量级 JavaScript，直接在文档中运行，无需安装。

适用场景：

  • 一键格式化（重置文本属性 — 快速将文本重置为默认格式）
  • 批量操作（删除空表格 — 删除整个文档中的所有空表格）
  • 自定义计算（加权平均值 — 计算所选范围的加权平均值）
  • 文档清理（删除空段落 — 删除整个演示文稿中所有不必要的空段落）

开发概况：

  • 时间： 30 分钟 - 2 小时 | 技能： 入门 | 技术栈： JavaScript 基础
  • 分发方式： 复制粘贴代码或嵌入文档模板

浏览所有宏示例

自定义 AI 工具 — 智能助手​

结合 AI 能力的自定义工具，实现新一代文档工作流。

适用场景：

开发概况：

  • 时间： 3-10 天 | 技能： 高级 | 技术栈： 插件 API + AI 提供商集成
  • 要求： OpenAI、Claude 或自定义 AI 服务的 API 密钥

浏览所有 AI 函数示例

如何选择方案？​

回答以下问题，找到最适合您的方向：

ONLYOFFICE API Scheme ONLYOFFICE API Scheme

详细对比​

功能插件宏AI 插件
是什么？嵌入编辑器的 HTML/CSS/JS 应用文档中的 JavaScript 代码插件 + AI 提供商集成
安装需要（应用市场或手动）无需（嵌入文档）需要（与插件相同）
用户界面✅ 完整自定义 UI❌ 无 UI✅ 完整自定义 UI
外部 API✅ 支持（REST、GraphQL 等）❌ 不支持✅ 支持（需要 AI 服务）
离线使用⚠️ 取决于功能✅ 完全离线❌ 需要网络
技能要求中级入门高级
开发时间2-7 天30 分钟 - 2 小时3-10 天
分发方式应用市场、GitHub、私有复制粘贴、模板应用市场、私有
最适合可复用工具、集成个人自动化AI 驱动功能
框架支持✅ React、Vue、Angular❌ 仅限原生 JS✅ 任意框架

故障排除​

插件问题​

插件不显示：

  • 检查 config.json 中是否有唯一的 GUID
  • 确认文件路径正确
  • 重启 ONLYOFFICE

JavaScript 错误：

  • 打开浏览器开发者工具（F12）
  • 在 Console 标签页中查看错误信息
  • 确认 plugin.js 已加载

API 方法调用失败：

  • 确认您的 ONLYOFFICE 版本支持该方法
  • 在 API 参考中检查方法语法
  • 确认编辑器类型兼容性

宏问题​

宏无法运行：

  • 检查工具 → 设置中是否已启用宏
  • 在宏编辑器中检查语法错误
  • 确认 API 方法名称正确

结果不符合预期：

  • 添加 console.log() 语句进行调试
  • 逐步单独测试每个步骤
  • 运行前检查文档状态

需要更多帮助？

资源​

开发工具​

示例代码​

文档​

社区​

下一步​

开始构建：

实验探索：

深入学习：