叶子文档生成器的汇合后端。
foliantcontrib.confluence的Python项目详细描述
叶子的汇合后端
Confluence后端生成一篇Confluence文章并将其上载到Confluence服务器。有了它，您可以创建和编辑汇合页面基于您的植物项目。
它还具有恢复用户内联注释的功能，这些注释是为文章添加的，即使在修改了注释片段之后也是如此。
此后端为您的foliantmake命令添加confluence目标。
安装
$ pip install foliantcontrib.confluence
The backend requires Pandoc to be installed in your system. Pandoc is needed to convert Markdown into HTML.
用法
要将叶型项目上载到Confluence服务器，请使用make confluence命令：
$ foliant make confluence Parsing config... Done Making confluence... Done ──────────────────── Result: https://my_confluence_server.org/pages/viewpage.action?pageId=123
配置
您必须为此后端设置配置才能正常工作。
在backend_config.confluence部分指定所有选项：
backend_config:confluence:host:'https://my_confluence_server.org'login:userpassword:passmode:singletoc:falseid:124443title:Title of the pagespace_key:"~user"parent_id:124442pandoc_path:pandoc
host
：必需汇流服务器的主机。
login
：有权创建和更新页面的用户的登录名。如果未提供登录名，则在生成过程中将提示它
password
：用户的密码。如果未提供密码，则在生成过程中将提示它
mode
：其中之一：single，multiple。在单模式后端，将整个叶面项目上载到指定的汇流页。在多模式下，后端将多个章节上传到用元数据定义的单独的合并页面中。更多信息请参见modes部分。默认值：single。
toc
：设置为true可将目录添加到文档开头。默认值：false
id
：内容将上载到的页的ID（仅与single模式一起使用）。{EM1}仅用于已经存在的页面
title
：要创建或更新的页的标题（仅与single模式一起使用）。
Remember that titles of the pages in one space are unique in Confluence.
space_key
：将在其中创建/编辑页的空间的键。
parent_id
：应在其下创建新页的父页的ID。{EM1}仅用于尚未存在的页面
pandoc_path
：pandoc可执行文件的路径（pandoc用于将标记转换为html）。
模式
后端合流可以在两种模式下工作：
single-整个项目被展平并上传到单个合流页面；
multiple-您可以将项目的几个章节上传到单独的合流页面中。
单模
要使用单模式，首先在foliant.yml中提供一个选项mode: single，然后在同一个foliant.yml配置文件中指定所有页属性（id或title&；space）。该项目将被构建、展平成一个页面并在定义的属性下上载。
多模式
借助多模式的强大功能，您可以使用一个make命令创建或更新多个汇流页。
要打开多模式，请在foliant.yml文件中添加一个选项mode: multiple。接下来，将定义合流页面的属性（如id或title&space）添加到要上载的每个章节的meta部分。
元节是文档开头的yaml字段值节，定义如下：
---field:valuefield2:value---Your chapter md-content
因此，如果要将一章上传到Confluence，请在它的开头添加类似的内容：
---title:My confluence pagespace_key:"~user"confluence:true# this is required---You chapter md-content
Notice that we've also added a
confluence: truekey, which is required for chapter to be uploaded. If the key isfalseor is not defined, the backend will ignore this chapter.
将属性添加到要上载的每个页面后，运行相同的make confluence命令：
$ foliant make confluence
Parsing config... Done
Making confluence... Done
────────────────────
Result:
https://my_confluence_server.org/pages/viewpage.action?pageId=1231
https://my_confluence_server.org/pages/viewpage.action?pageId=1232
https://my_confluence_server.org/pages/viewpage.action?pageId=1233
使用汇流后端创建页面
如果你想为你的植物项目中的内容创建一个新页面，只需在配置中提供标题和空格键。请记住，在合流页面中，标题在一个空间内是唯一的。如果使用已经存在的页面的标题，后端将尝试编辑它并用项目替换它的内容。
这种情况的配置示例如下：
backend_config:confluence:host:'https://my_confluence_server.org'login:userpassword:passtitle:My unique titlespace_key:"~user"
现在，如果您更改配置中的标题，那么confluence将创建一个新的页面，新标题，旧标题保持不变。
如果您想更改页面标题，请在下面的部分回答。
使用汇流后端更新页面
通常，要更新页面内容，可以使用创建页面时使用的相同配置（请参阅上一节）。
另外，您可以只指定页面的id，这样在构建之后，它的内容将被更新。
backend_config:confluence:host:'https://my_confluence_server.org'login:userpassword:passid:124443
这也是编辑页面标题的唯一方法。如果指定了title参数，则后端将尝试将页面标题更改为新标题：
backend_config:confluence:host:'https://my_confluence_server.org'login:userpassword:passid:124443title:New unique title
欢迎加入QQ群-->： 979659372
