Wiki¶
A Wiki is a collection of wiki pages.
Wiki Object¶
-
Wiki.
_id
¶ The internal identifier of the Wiki object.
-
Wiki.
parent_id
¶ The identifier of the parent wiki. When wiki page references (names that match a
WikiPage.name
) are resolved to page identifiers (theWikiPage._id
values) the search is within the current wiki, and then if the wiki parent identifier is not None, process continues in the context of the parent wiki.
-
Wiki.
group_id
¶ The identifier of the group that “owns” the wiki. Access to the wiki pages is governed by roles of the members of the group.
Create Wiki¶
-
create_wiki
(group_id, parent_id)¶ Parameters: - group_id (id) – group identifier
- parent_id (id) – wiki identifier or None
Create a Wiki. The parent_id may be None if the wiki should not inherit the names of the parent wiki pages.
This transaction generates an additional
createWikiPage()
with a default name “FrontPage”.
Wiki Page Object¶
-
class
WikiPage
¶ A single page in a
WIki
.
-
WikiPage.
_id
¶ The internal identifier of the object.
-
WikiPage.
wiki_id
¶ The identifier of the wiki to which this page belongs.
-
WikiPage.
name
¶ The name of the wiki page, typically in upper camel case.
-
WikiPage.
title
¶ The title of the wiki page is typically the same as the name except for those cases when the page name is not in upper camel case. This attribute is an array of strings, each of which are are annotated with a language code.
-
WikiPage.
text
¶ The unformatted wiki text of the page. This attribute is an array of strings, each of which are are annotated with a language code.
-
WikiPage.
html
¶ The wiki text rendered as HTML. This attribute is an array of strings, each of which are are annotated with a language code.
-
WikiPage.
refs
¶ An array of object identifiers that this wiki page references. They are commonly references to wiki pages within the same wiki, but may also be identifiers of documents, tasks, users, etc.
Create Wiki Page¶
-
create_wiki_page
(wiki_id, name=value)¶ Parameters: - wiki_id (id) – wiki identifier
- name (str) – the name of the wiki page
Create a wiki page.