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

9
我正在使用Confluence REST api,想要提取一些文档。文档正文可用多种格式:editorstorageviewexport_viewanonymous_export_view等等。但我没有找到任何关于它们的描述,也不知道每种格式的用途是什么。(这个答案提到了几种格式,但没有说明它们是什么。)在我的检查中,所有格式都有嵌入式HTML样式标记,但具有不同的非标准属性。请问有什么建议吗?
特别是,我正在寻找最佳格式以便转换为其他非Confluence格式。
示例查询:
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

这将返回多种格式,我看到了很多看起来随意的差异。那么这是怎么回事呢?

我猜测那个给你点踩的人可能不喜欢 Confluence API? - alexis
1
我找到了两个Atlassian支持页面,我认为它们描述了其中两种格式。这一个看起来像是STORAGE(基于XHML的格式):https://confluence.atlassian.com/doc/confluence-storage-format-790796544.html 而这一个则可能是EDITOR或STYLED_VIEW,不确定(Wiki Markup)https://confluence.atlassian.com/doc/confluence-wiki-markup-251003035.html - kuporific
谢谢,@kuporific!肯定会派上用场。 - alexis
1个回答

6

我找到的关于这些字段的最佳描述在Java API文档中的Confluence部分,具体来说是ContentRepresentation类。

您可能会注意到上面文档中的某些描述被截断了。它们只是由Javadoc渲染的文档注释,所以有些地方出了问题。恰好我在Atlassian Premier Support工作,所以我已经为您找到了完整的文档注释(通过代码搜索),让您阅读愉快:

  • ANONYMOUS_EXPORT_VIEW
    • HTML格式的表示,但是使用绝对URL而不是标记中的相对URL,并且宏被呈现为匿名用户查看。在需要导出但不想透露敏感数据或不想为导出付出权限检查成本的情况下非常有用。只要基础内容没有更改,此输出可以缓存。
  • EDITOR
    • 适用于富文本编辑器的表示形式
  • EXPORT_VIEW
    • HTML格式的表示,但是使用绝对URL而不是标记中的相对URL。用于导出非常有用。
  • PLAIN
    • 纯文本的原始数据库格式,没有XHTML或WIKI标记。可以通过将换行符转换为<br>并将URL表示为HTML链接来转换为VIEW表示形式。
  • RAW
    • 原始“数据库”格式。
  • STORAGE
    • 针对在我们的XML存储格式中存储数据的内容的原始数据库格式
  • STYLED_VIEW
    • 包含内联样式的呈现视图,包装在整个结构中的一个<div>元素中。

谢谢!所以“export_view”是经过身份验证的用户会看到的内容。当我上班后,我会自己尝试一下,但您是否知道所有这些是否都可以通过API获得?我不记得“plain”和“raw”在“body.expandables”部分中出现过。 - alexis
PS 看起来 javadoc 配置为呈现 docstring 直到第一个换行符,而你的一些换行符太早了... :-) - alexis

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接