This is a version controlled wiki component for the CubicWeb framework.
It uses Mercurial as a content storage and can be edited both with your favorite editor and the web GUI.
The wiki web GUI usage should be pretty straightforward. It can be used to:
ReStructured Text (ReST) formatted wikis benefit from CubicWeb's powerful ReST directives that make it easy to query the database and display the resultset in a view (e.g. eid, rql, rql-table).
Present cube also adds a wiki directive, which can be used as in following example content:
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`.
Currently, the easiest way to setup a new wiki is through the command line:
cubicweb-ctl new-vcwiki <instance-name> <wiki-name> <repo-path>
This creates a ReST formatted wiki named wiki-name from a pre-existing Mercurial repository located at repo-path on your disk in a pre-existing CubicWeb application instance named instance-name.
You will need the admin user login and password to use this.
An alternative is to use the web GUI, but it requires a few steps until now:
Note that the Wiki pages are available at an URL which has the following format:
|source repository||cubicweb-vcwiki repository|
|may be discussed on||<not specified>|
|use license||<not specified>|
- cubicweb #893243 Strange header levels rest-generated HTML
- cubicweb #370613 investigate markitup for rest edition
- TheCubicWebBook #541389 installation from debian package
- cubicweb #1279547 Include generated doc instead of source files in cubicweb-documentation package
- Continuous Integration platform for Mercurial with apycot