各种Confluence文档格式有何不同?

时间:2018-06-19 10:33:23

标签: confluence confluence-rest-api

我正在使用Confluence REST api,并希望提取一些文档。文档正文有多种格式:editorstorageviewexport_viewanonymous_export_view,...但我在任何地方都找不到说明他们是什么,或每个人的目的是什么。 (This answer提到了几种格式,但没有说明它们是什么。)在我的检查中,所有格式都嵌入了HTML样式的标记,但具有不同的非标准属性。有什么指针吗?

具体来说,我正在寻找用于转换为其他非融合格式的最佳格式。

示例查询:

https://confuence.example.com/rest/api/content?spaceKey=doc&expand=body.editor,body.storage,body.anonymous_export_view,body.view,body.export_view&start=0&limit=50

这会返回几种替代格式,我看到很多随机看似的差异。那故事是什么?

1 个答案:

答案 0 :(得分:2)

我发现的每个字段的最佳描述是在Confluence的Java API文档中,尤其是ContentRepresentation类。

您可能会注意到上面文档中的某些描述被截断了。它们只是Javadoc渲染的文档注释,所以那里出了点问题。碰巧的是,我为Atlassian Premier Support工作,所以为了您的阅读乐趣,我一直在跟踪完整的文档注释(是,代码搜索):

  • ANONYMOUS_EXPORT_VIEW
    • 用于查看的HTML表示形式,但是具有绝对URL,而不是标记中的相对URL,并且呈现宏,就像匿名用户正在查看它一样。在您可能不想泄露敏感数据或不想为导出支付权限检查费用的情况下进行导出时很有用。只要基础内容未更改,就可以缓存其输出。
  • 编辑者
    • 适合在富文本编辑器中使用的表示形式
  • EXPORT_VIEW
    • 用于查看的HTML表示形式,但具有绝对URL,而不是标记中的相对URL。对于导出很有用。
  • PLAIN
    • 原始数据库格式为纯文本,没有XHTML或WIKI标记。通过将换行符转换为
      并将URL表示为HTML链接,可以将其转换为VIEW表示形式。
  • RAW
    • 原始的“数据库”格式。
  • 存储
    • 原始数据库格式,用于以XML存储格式存储数据的内容
  • STYLED_VIEW
    • 呈现的视图,其中包含元素中的内嵌样式,并包裹在整个结构中。