Chamilo 集成
该插件支持您在 Chamilo 中使用 ONLYOFFICE 文档直接编辑办公文档。
功能特性
- 目前,可编辑的文档格式有:DOCX、ODP、ODS、ODT、PPTX、XLSX。
- 仅支持查看的文档格式如下:CSV、DJVU、DOC、EPUB、HTM、HTML、MHT、PDF、PPS、PPT、RTF、TXT、XLS、XPS。
- 该插件会在文档库中为 Office 文档添加使用 ONLYOFFICE 打开菜单选项。这使多个用户能够实时协作,并将更改保存回 Chamilo。
安装 ONLYOFFICE 文档
您需要一个 ONLYOFFICE 文档(文档服务器)实例,该实例必须能从 Chamilo 和任何终端客户端解析并连接。如果无法满足此条件,请使用官方的 ONLYOFFICE 文档安装指南。ONLYOFFICE 文档还必须能够直接向 Chamilo 发送 POST 请求。
ONLYOFFICE 文档和 Chamilo 可以安装在不同的计算机上,也可以安装在同一台机器上。如果您使用同一台机器,需要为文档服务器设置一个自定义端口,因为默认情况下 ONLYOFFICE 文档和 Chamilo 都使用 80 端口。
使用 Docker 是启动 ONLYOFFICE 文档实例的最简单方法。
下载更新版本的 Chamilo ONLYOFFICE 插件
当 Chamilo 批准并将该插件作为官方插件集成后,Chamilo 团队会努力在 Chamilo 软件包中提供最新稳定版本的插件。下载其他版本的插件可能会对您的安装产生负面影响。但是,如果您认为需要从第三方下载更新版本,以下是推荐的操作步骤:
-
运行以下命令获取代码仓库的最新版本:
git clone https://github.com/ONLYOFFICE/onlyoffice-chamilocd onlyoffice-chamilo -
获取子模块:
git submodule update --init --recursive -
获取插件依赖项:
composer install -
收集所有文件:
mkdir /tmp/onlyoffice-deploymkdir /tmp/onlyoffice-deploy/onlyofficecp -r ./ /tmp/onlyoffice-deploy/onlyofficecd /tmp/onlyoffice-deploy/onlyofficerm -rf ./.git*rm -rf */.git* -
将上一步中获取的文件进行归档:
cd ../zip onlyoffice.zip -r onlyoffice
安装 Chamilo ONLYOFFICE 插件
要在 Chamilo 中使用 ONLYOFFICE 文档,请按照以下步骤操作:
-
进入 Chamilo 的管理界面,选择插件部分。
-
选择 ONLYOFFICE 插件,然后点击启用所选插件按钮。
如果您想要使用该插件的更新版本,则需要用新收集的插件替换预安装的默认插件文件夹:
/var/www/html/chamilo-1.11.16/plugin/onlyoffice其中,chamilo-1.11.16 是您当前的 Chamilo 版本。
适用于低于 1.11.16 的 Chamilo 版本
- 进入 Chamilo 的管理界面,选择插件部分,然后点击上传插件按钮。
- 从版本发布部分上传onlyoffice.zip文件。您会看到插件列表。
- 从 Chamilo 的根文件夹运行
composer install命令。 - 返回插件列表,选择 ONLYOFFICE 插件,然后点击启用按钮。
配置 Chamilo ONLYOFFICE 插件
在插件页面中,找到 ONLYOFFICE 并点击配置。您会看到设置页面。启用该插件并指定 ONLYOFFICE 文档的地址:
https://<documentserver>/
其中,documentserver 是安装了 ONLYOFFICE 文档的服务器名称。该地址必须能被您的浏览器和 Chamilo 服务器访问。Chamilo 服务器地址也必须能被 ONLYOFFICE 文档访问,以确保正常工作。您可以注册免费的 ONLYOFFICE 云服务,并使用其公共 IP 地址或公共 DNS,可在云控制台的实例部分中找到。
从 7.2 版本开始,JWT 默认启用,并且会自动生成密钥,用于限制对 ONLYOFFICE 文档的访问,保障安全性和数据完整性。在 Chamilo 的设置页面指定您自己的密钥。在 ONLYOFFICE 文档的配置文件中,指定相同的密钥并启用验证。
工作原理
ONLYOFFICE 集成遵循此处记录的 API 规范。
对于教师/培训师
-
若要创建新文件,教师需打开文档文件夹,然后点击新建的 ONLYOFFICE 图标。
-
您会被重定向到文件创建页面,在此页面您需要输入文件名和格式(文本文档、电子表格或演示文稿)。浏览器会调用*/plugin/onlyoffice/create.php*方法。该方法会将一个空文件的副本添加到课程文件夹中。
-
若要打开现有文件,用户需选择正常编辑图标旁边的使用 ONLYOFFICE 打开图标。
-
请求会被发送到*/plugin/onlyoffice/editor.php?docId="文档标识符"*。服务器会处理该请求,并生成具有以下属性的编辑器初始化配置:
- url:ONLYOFFICE 文档用于下载文档的 URL;
- callbackUrl:ONLYOFFICE 文档用于通知文档编辑状态的 URL;
- documentServerUrl:客户端需要回复给 ONLYOFFICE 文档的 URL(可在管理设置页面设置);
- key:用于指示 ONLYOFFICE 文档是否需要重新下载文档的etag。
-
服务器会返回一个包含打开编辑器脚本的页面。
-
浏览器打开此页面并加载编辑器。
-
浏览器向 ONLYOFFICE 文档发出请求,并将文档配置传递给它。
-
ONLYOFFICE 文档加载文档,用户开始编辑。
-
ONLYOFFICE 文档向callbackUrl发送 POST 请求,通知 Chamilo 用户正在编辑文档。
-
当所有用户都完成编辑后,他们关闭编辑器窗口。
-
在10 秒不活动后,ONLYOFFICE 文档向callbackUrl发送 POST 请求,告知编辑已结束,并发送一个指向新文档版本的链接。
-
Chamilo 加载文档的新版本并覆盖原文件。
对于学习者
-
学习者可以在文档工具中访问所有 ONLYOFFICE 支持的文档旁边的 ONLYOFFICE 图标。
-
在学习路径中,查看器与 Chamilo 无缝集成,以打开支持的文档。
在此处下载 Chamilo 的 ONLYOFFICE 插件。