Differences

This shows you the differences between two versions of the page.

--- plugin:approve [2015-07-10 05:51] – old revision restored (2015-02-20 09:07) 2001:4dd0:ff00:9581:64af:4f6b:7189:995a
+++ plugin:approve [2023-11-17 15:10] (current) – solewniczak
@@ Line 1: / Line 1: @@
-====== approve plugin ======
+====== Approve Plugin ======
 ---- plugin ----
-description: Simple version of approval/draft system for DokuWiki
+description: An approval/draft system for DokuWiki
 author     : Szymon Olewniczak
-email      : dokuwiki@imz.re
+email      : it@rid.pl
 type       : action, syntax
-lastupdate : 2015-02-19
+lastupdate : 2023-11-17
-compatible :
+compatible : Igor, Hogfather, Greebo, Frusterick Manners
-depends    :
+depends    : sqlite
 conflicts  :
 similar    : publish
 tags       : moderation
-downloadurl: http://github.com/hafron/dokuwiki-plugin-approve/zipball/master
+downloadurl: https://github.com/gkrid/dokuwiki-plugin-approve/zipball/master
-bugtracker : http://github.com/hafron/dokuwiki-plugin-approve/issues
+bugtracker : https://github.com/gkrid/dokuwiki-plugin-approve/issues
-sourcerepo : http://github.com/hafron/dokuwiki-plugin-approve/
+sourcerepo : https://github.com/gkrid/dokuwiki-plugin-approve
-donationurl:
 screenshot_img :
 ----
-This is a simple remake of dokuwiki [[plugin:publish]] plugin, based on changes history rather than metadata. To approve a page simple save a page revision with the "Approved" keyword in the Edit summary or use a special link in the top right corner of the page.
 ===== Installation =====
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
+:!: This Plugin depends on the following other plugins:
+  * [[sqlite]]
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
+===== Description =====
+The plugin is an alternative to the [[publish]] plugin but it differs in some ways:
+  * Approving (or marking ready for approval) the page doesn't make a new page revision.
+  * User always see the diff of the last approved version and the current draft before approval.
+  * Approvals of page are counted and displayed in the banner.
+  * Plugin allows additional intermediate state: Ready for approval may be used (turn on in the plugin config)
+Like in the [[publish]] plugin pages can be approved by the users that has ''AUTH_DELETE'' permission for the page.
 ===== Syntax =====
-=== Change Log ===
+The syntax component allows you to place the table with wiki pages and its states. The minimal syntax is:
-{{rss>https://github.com/hafron/dokuwiki-plugin-approve/commits/master.atom date}}
+<code>
+---- approve table ----
+----
+</code>
-===== Discussion =====
+You can narrow the results only to specific namespace:
+<code>
+---- approve table ----
+namespace: some:namespace
+----
+</code>
+Show the page id's that satisfy the regular expression:
+<code>
+---- approve table ----
+filter: /regex/
+----
+</code>
+Show the pages that have some status:
+<code>
+---- approve table ----
+states: approved, draft, ready_for_approval
+----
+</code>
+Hide the summarize at the bottom of the table:
+<code>
+---- approve table ----
+summarize: 0
+----
+</code>
+You can show only a pages for specific approver:
+<code>
+---- approve table ----
+approver: user
+----
+</code>
+Approver can be currently login user:
+<code>
+---- approve table ----
+approver: $USER$
+----
+</code>
+You may join several filters:
+<code>
+---- approve table ----
+namespace: some:namespace
+filter: /regex/
+states: approved, draft, ready_for_approval
+approver: $USER$
+summarize: 0
+----
+</code>
+===== Approve Assignments =====
+The plugins adds additional admin panel "Approve Assignments" that has two main tasks:
+  - It allows to define pages and/or namespaces where the plugin will be used.
+  - It allows define the page/namespace approver - a person or group (with @ prefix) who will be responsible for approving the page. The approver will be displayed in the plugin's banner, approve table and will receive notifications if the [[notification]] plugin is used.
+When the page has its approver, the user or group members are the only ones who can approve the page (this can be turned off in plugins configuration). Approver needs only ''AUTH_VIEW'' permission to approve the page. When the approver isn't set, all users with ''AUTH_DELETE'' permission can approve the page.
+===== Configuration =====
+  * ''no_apr_namespaces'' - here you can put a list of space separated pages and/or namespaces where the plugin won't be used.
+  * ''prettyprint'' - adds nice looking banner while page is printed (tested only with default template)
+  * ''ready_for_approval'' - turn on additional intermediate ready for approval state.
+  * ''strict_approver'' - when this option is turned on only the page approver can approve the page. Otherwise all users with ''AUTH_DELETE'' permission (and the approver)  can approve the page.
+  * ''hide_drafts_for_viewers'' - when turned on, users without EDIT permission will see last approved version of page instead of last draft.
+===== Integration with notification plugin =====
+This plugin integrates with [[notification]] plugin and adds notifications for approvers about the pages that aren't approved yet.
+===== Discussion =====
+[[https://github.com/gkrid/dokuwiki-plugin-approve/issues]]