cubicweb-vcwiki 0.4.1

摘要

这是一个为CubicWeb框架提供的版本控制wiki组件。

它使用Mercurial作为内容存储，并可以使用您喜欢的编辑器和Web GUI进行编辑。

功能

Wiki Web GUI的使用应该是相当直接的。它可以用来

• 从一个尚不知道的wiki的子页URL创建wiki页面

• 使用可选的提交消息编辑现有页面

• 查看页面历史并比较版本

• 将页面恢复到以前版本。

ReStructured Text (ReST)格式化的wiki可以从CubicWeb强大的ReST指令中受益，这使得查询数据库并在视图中显示结果集变得容易（例如，eid，rql，rql-table）。

现有的cube还添加了一个wiki指令，可以在以下示例内容中使用

This is a **formatted page content** with a link to
:wiki:`subdirectory/page`.

This displays a "subdirectory/page" text in the page, that links to URL
<current-page-url>/subdirectory/page, and which path in the Mercurial
repository is `<current-page-path>/subdirectory/page.rst`.

You can also specify a link text that is different from the page's URL
path. The URL path can be specified either from the wiki's root, like
:wiki:`/subdirectory/other:this one`, or relatively to the current page, like
:wiki:`current_page_sibling:this other one`.

Wiki设置

目前，设置新Wiki的最简单方法是通过命令行

cubicweb-ctl new-vcwiki <instance-name> <wiki-name> <repo-path>

这将在名为wiki-name的预存在Mercurial仓库中创建一个ReST格式的wiki，该仓库位于磁盘上的repo-path，在名为instance-name的预存在CubicWeb应用程序实例中。

使用此功能需要管理员用户名和密码。

另一个选择是使用Web GUI，但到目前为止需要几个步骤

1. 管理员必须创建一个Repository实体，并将其实例的path属性设置为有效路径，指向一个Mercurial仓库（必须事先创建）。

2. 管理员必须通过左侧屏幕的动作，为 仓库 添加写入权限（通过 localperms 立方体）。

3. 管理员必须执行“刷新仓库”动作，同样可在屏幕左侧找到。

4. 创建一个 VcWiki 实体，并设置 rst 作为默认扩展。

5. 您应该能够通过左侧的“wiki首页”动作创建您的wiki首页。

请注意，Wiki页面可在以下格式的URL中找到

<base-url>/wiki/<wiki-name>/<page-name>