ocPortal Tutorial: Custom structured content (via Wiki+)
Written by Chris Graham, ocProducts
This tutorial will describe the Wiki+ system, which is ocPortal's equivalent to a wiki.Table of contents
About Wiki+
Viewing a Wiki+ page |
Information is presented using Comcode and the Comcode attachment system, meaning there is excellent support for rich media. CEDI is ideal for storing collaboratively/interactively extended information with a high organisational factor; the speed of which information can be added is also particularly advantageous. This pattern works very well for types of ad-hoc guide, especially community-driven ones.
Pages and posts
Making a Wiki+ post |
Pages may also contain a list of pages that are 'underneath' the page; however, a page can be underneath any number of pages, as the Wiki+ hierarchy is loosely defined (technically it is a node based network rather than a real tree structure). When pages are accessed from different paths, the path to the page as it has been accessed is displayed, so that back-tracking is easier, and that the user does not get confused by the path suddenly changing when they enter a 'child' page.
If you do not choose to develop a tree structure then Wiki+ navigation will be much like the navigation of a wiki- Comcode has special wiki-like support for making quick links between Wiki+ pages just by writing [[pagename]].
This simple structure of posts, pages, and children, is Wiki+'s core. There are of course peripheral features, such as:
- Giving pages some 'page text', which sits above the posts on that page; this text is staff decided, and thus provides an authoritative space.
- Jumping to a random page.
- Seeing a list of recent changes to the database.
- Moving posts.
Editing the Wiki+ tree |
- Merging posts.
- Viewing the tree structure of the whole database (transferred in a compressed format, and reduced so as only to show a single path to any page).
- Search
- Editing posts
This simplicity is key to the flexibility of the system- it is a system of control built around organised text, and how that text is used and structured is completely up to the website staff.
Maintenance
The full Wiki+ structure and content may be manipulated from the page-view screens of Wiki+ itself. Wiki+ pages are created on an adhoc basis, by either:- referencing them in the child-list for a page (available under the 'Edit Tree' button),
- or by referencing them via the special Comcode syntax ([[pagename]]).
In a typical set-up, staff are given access to modify the Wiki+ tree, whilst ordinary users rely on the Comcode syntax to create new inline links. Whether ordinary users are given access to add new pages can vary substantially between deployments, depending heavily on what role Wiki+ is being used for.
Moderation
As Wiki+ is (by default) open to posting by any user, you may feel it is necessary to moderate posts: especially as they may detract from the quality of the database. When a member posts, an e-mail is sent to the staff e-mail address: this will help you to moderate posts on the system, as they are made.It is possible to provide greater open-access to Wiki+, so that anyone may edit all page details and navigation, in the same way that they may do so on a wiki. If you wish to enable the permissions for this (Security section of the Admin Zone, Global privileges icon, Wiki+ section) then you will likely want to make use of the page history feature to revert unwanted changes, as well as ocPortal's site-wide tracing and moderation abilities.