Wiki Staging & Approval tab
- Use this tab to allow wiki pages to be "staged (drafted) before they are "approved" (published)
- To Access
- From the Administer Wiki page, click the Staging and Approval tab.
- You must enable and configure the necessary categories before enabling this feature.
Wiki Page Staging and Approval
Requirements: This feature requires categories to be turned on and categories created before it will work (see below).
The information below may be a bit out of date now. For best results, see http://profiles.tiki.org/Staging_and_Approval
Introduced in Tiki2.
This feature is similar but different than the articles and submissions feature. Articles are like newspaper articles, once approved and published, they normally don't change. Whilst wiki pages are, by nature, always in flux.
This is a feature to allow wiki pages to be "staged" or drafted before they are approved (published). This is useful, for example, to have a staging area where open contributions are welcome, but at the same time to have an official pr published knowledge base that is extremely stable, hence needing some kind of approval before page changes are shown there. This feature works with the groups and categories features to have customizable access to pages with different status.
Documentation site has a policy that
Documentation site has a policy that
- approved pages are visible to the public, but are updated (approved) only by senior editors.
- meanwhile any registered user can edit the draft version of the page, which is reviewed periodically and approved (or not) by senior editors.
Sample use case
This is not meant to be definitive, but has been tested to work.
2 groups: author / approver
2 categories: staged / approved
- An author creates a page XXXX in the staged category.
- If category notification set, approver receives a message.
- Anyone can edit the page while it remains in the staged category.
- An approver approves the page for the 1st time by categorizing it to approved category.
- Tiki automatically creates a page *XXXX with the staged category and without the approved category.
- An author can see the page *XXXX and edits it again. If he tries to edit XXXX, tw redirects him to edit *XXXX. An approver is also redirected to edit *XXXX if he tries to edit XXXX.
- If category notification set, approver receives a message whoever edits *XXXX. Alternatively, approvers can check the "Out of Sync" category for pages that have edits not yet approved.
- When ready, an approver approves the page, by clicking on "approve" that appear on top of *XXXX. Moreover, if not ready, the authors/approvers/ etc.. can all conduct edit war on the *XXXX until they are happy, before approving.
Features that will be apparent
- A link to approve a page appears while viewing staging pages if they are out of sync.
- A link to show page history since the last approval (a diff) appears while viewing staging pages if the pages are out of sync. The determination of the version is based on the last edit date/time of the approved page, so it will not be correct if the approved page has been edited directly without going through the staging copy, another reason to use the "Force bounce option" above, but it is foreseeable that admins may want to be able to directly edit the approved page and consider that an "approved" version, so it depends on your needs.
- A note appears on the edit page screen indicating to a user that he is editing a staging page and if the page is out of sync.
Important notes about creating new pages
- When creating new pages as someone with permission to the approved category, place the page in the category for approved pages if this is a page that needs to be staged.
- When creating new pages as someone without permission to the approved category, it really doesn't matter in which category the page is stored. However, this page cannot be "approved" the automated way until it is approving for the first time by someone with permission to include it in the category for approved pages. For convenient locating of new items created by these users, it is possible (using another feature), to set the default category to a category you can create such as "New Pages", for the different groups/levels of contributors as you need.
Important admin notes
- Changing the categories settings explained above after initial install will require moving of pages to new categories to make sure that those specific features still work for those pages.
- Renaming or changing parent of categories have no effect (the system refers to categories by their ID, not name).
- Change the prefix setting after initial install will require Renaming the old staging copy pages in order to preserve the "link" between staging and approved versions.
- Direct Renaming of staging pages have been blocked in tiki-rename.php for usability reasons, and Renaming of pages now checks and renames staging copies as well (based on prefix) if this feature feature_wikiapproval is on. Admins that have custom code doing Renaming of pages should be careful.
See attached comment for an example of perms
- Wiki page attachments are not handled
- Structures are not handled
Evolution of this featureThis feature will be probably abandoned in future Tiki releases and Flagged revisions will be used instead for a similar behavior.