WOPI发现

WOPI 发现 是通过从在online office请求discovery XML 来帮助 WOPI 服务器发现 WOPI 客户端的过程。 WOPI 主机使用discovery XML 来指定如何与online office进行交互。 请求被发送到 https://documentserver/hosting/discovery 地址,其中 documentserver 是安装了 ONLYOFFICE 文档的服务器的名称。

发现XML的action元素提供了在线办公室的重要特征。此元素表示:

  • online office中可用的文档操作,
  • 支持的文件格式(扩展名)。
WOPI 操作
名称 描述
呈现文档的不可编辑视图。
允许用户编辑文档。
使用适合文件类型的空白文件模板创建新文档,并在online office中打开此文档进行编辑。
呈现为嵌入网页而优化的文档的不可编辑视图。此操作从7.2版开始可用。
二进制格式doc、ppt、xls)的文档转换为现代格式 (docx、pptx、xlsx),以便在线办公编辑。
属性
名称 描述
requires 使用操作所需的 WOPI REST 端点。
urlsrc 为了对特定文件调用操作而导航到的 URL。
示例
<action name="edit" ext="docx" requires="locks,update"
    urlsrc="https://word-edit.officeapps.live.com/we/wordeditorframe.aspx?
ui=en-us&thm=1&"/>

发现查询参数 是可以通过 urlsrc 属性中的文件存储公开的参数,以自定义编辑器行为。 例如,更改语言、主题或聊天。

参数
名称 描述 示例
指示 WOPI 服务器包含 [RFC1766]中所述格式的首选 UI 语言。 en-us
指示 WOPI 服务器包含 [RFC1766] 中所述格式的首选数据语言,用于语言可能影响数据计算的情况(在电子表格编辑器中)。 en-us
指示 WOPI 服务器包含一个值来指定使用的主题。当前值为 "1" 表示浅色主题, "2" 表示深色主题。 1
指示 WOPI 服务器包含dchat值为 "1",以加载一个不创建或加入聊天会话的文档视图。 1
表明操作的输出将嵌入网页 (true). true
指示 WOPI 服务器包含 WOPISrc 值。 它告诉 WOPI 客户端在对文件运行 WOPI 操作时回调到哪个 URL。 此参数是必需的。 https://<host_address>/wopi/files/(file_id)
参数
名称 描述 示例
表示Nextcloud WOPI服务器包含[RFC1766]中所述格式的文档语言。 使用editnew操作创建新文档时使用此语言。 en-us

请注意 Collabora 连接器的 discovery.xml 结构。 他们通过包含在以下结构的 app 元素中的 MIME 类型打开编辑器:

<app name="application/msword">
    <action default="true" ext="" name="edit" urlsrc="http://159.89.20.129:9980/loleaflet/ba528af/loleaflet.html?"/>
</app>

像这样的 app 元素:

<app name="Word" favIconUrl="http://localhost:8000/web-apps/apps/documenteditor/main/resources/img/favicon.ico">
    

被 Collabora 连接器忽略。