Differences

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

--- plugin:approve [2018-08-31 12:14] – solewniczak
+++ plugin:approve [2023-11-17 15:10] (current) – solewniczak
@@ Line 1: / Line 1: @@
-====== approve Plugin ======
+====== Approve Plugin ======
 ---- plugin ----
 description: An approval/draft system for DokuWiki
 author     : Szymon Olewniczak
-email      : solewniczak@rid.pl
+email      : it@rid.pl
 type       : action, syntax
-lastupdate : 2018-08-31
+lastupdate : 2023-11-17
-compatible : Greebo, Frusterick Manners
+compatible : Igor, Hogfather, Greebo, Frusterick Manners
-depends    :
+depends    : sqlite
 conflicts  :
 similar    : publish
@@ Line 15: / Line 15: @@
 downloadurl: https://github.com/gkrid/dokuwiki-plugin-approve/zipball/master
 bugtracker : https://github.com/gkrid/dokuwiki-plugin-approve/issues
-sourcerepo : https://github.com/gkrid/dokuwiki-plugin-approve/
+sourcerepo : https://github.com/gkrid/dokuwiki-plugin-approve
-donationurl: https://paypal.me/SzymonOlewniczak
 screenshot_img :
 ----
-===== Donation ====
+===== Installation =====
-If you like this plugin or want to thank me for development of your requested features please consider [[https://paypal.me/SzymonOlewniczak|buying me a coffee]]. Thank you ;-)
+:!: 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 and it differs in some ways:
+The plugin is an alternative to the [[publish]] plugin but it differs in some ways:
-  * the user always see the diff of the last approved version and the current draft before they can approve the page
+  * Approving (or marking ready for approval) the page doesn't make a new page revision.
-  * the plugin shows version numbers of approved pages
+  * User always see the diff of the last approved version and the current draft before approval.
-  * additional intermediate state: Ready for approval may be used (turn on in the plugin config)
+  * Approvals of page are counted and displayed in the banner.
-  * filtering on approval table
+  * Plugin allows additional intermediate state: Ready for approval may be used (turn on in the plugin config)
-  * it uses smaller banner on top of the page
-  * adds the nice looking banner on top of the document while printing (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 =====
-The syntax component allows you to place the table with all the pages and its states. The minimal syntax is:
+The syntax component allows you to place the table with wiki pages and its states. The minimal syntax is:
 <code>
@@ Line 64: / Line 66: @@
 <code>
 ---- approve table ----
-states: approved, draft, ready for approval
+states: approved, draft, ready_for_approval
 ----
 </code>
@@ Line 73: / Line 75: @@
 ---- 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>
@@ Line 82: / Line 100: @@
 namespace: some:namespace
 filter: /regex/
-states: approved, draft, ready for approval
+states: approved, draft, ready_for_approval
+approver: $USER$
 summarize: 0
 ----
 </code>
-You may need to add %%~~%%NOCACHE%%~~%% to the page.
+===== 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.
-===== Development =====
+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.
-=== Change Log ===
+===== Integration with notification plugin =====
-{{rss>https://github.com/gkrid/dokuwiki-plugin-approve/commits/develop.atom date}}
+This plugin integrates with [[notification]] plugin and adds notifications for approvers about the pages that aren't approved yet.
-**Releases:**
-{{rss>https://github.com/gkrid/dokuwiki-plugin-approve/releases.atom description author}}
 ===== Discussion =====