Differences

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

--- plugin:acknowledge [2019-08-21 23:50] – version upped andi
+++ plugin:acknowledge [2024-01-07 14:34] (current) – Aleksandr
@@ Line 1: / Line 1: @@
-====== acknowledge Plugin ======
+====== Acknowledge Plugin ======
 ---- plugin ----
@@ Line 6: / Line 6: @@
 email      : dokuwiki@cosmocode.de
 type       : syntax, admin
-lastupdate : 2019-08-21
+lastupdate : 2023-12-07
-compatible : Greebo
+compatible : Greebo, Hogfather, Igor, Jack Jackrum
 depends    :
 conflicts  :
-similar    :
+similar    : ireadit
-tags       :
+tags       : confirm, acknowledge
-downloadurl: http://github.com/cosmocode/dokuwiki-plugin-acknowledge/zipball/master
+downloadurl: https://github.com/cosmocode/dokuwiki-plugin-acknowledge/zipball/master
-bugtracker : http://github.com/cosmocode/dokuwiki-plugin-acknowledge/issues
+bugtracker : https://github.com/cosmocode/dokuwiki-plugin-acknowledge/issues
-sourcerepo : http://github.com/cosmocode/dokuwiki-plugin-acknowledge/
+sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-acknowledge
 donationurl:
 screenshot_img :
 ----
+[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png|A CosmoCode Plugin}}]]
 ===== Installation =====
-[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ http://cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]
 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.
@@ Line 30: / Line 31: @@
 The plugin provides a convenient way to manage acknowledgement of certain pages, for example meeting minutes or policy agreements. It consists of three components:
-  - "Acknowledge" button is placed on pages which  user is assigned to
+  - "Acknowledge" button is placed on pages which an user is assigned to
-  - a wiki page with an overview of the user's outstanding acknowledements
+  - A wiki page with an overview of the user's outstanding acknowledements
-  - admin overview of all current acknowledgements
+  - An admin overview of all current acknowledgements
-===== Syntax =====
+===== Syntax and Usage =====
+Users and groups can be assigned for acknowledgement on a page-by-page basis or centrally using assignment patterns.
 ==== Acknowledgement Widget ====
@@ Line 44: / Line 47: @@
 </code>
-The syntax accepts a comma separated list of users and/or groups (prefixed with an @) who need to acknowledge this page. Once a user has acknowledged a page, the date and time of acknowledging is shown instead of the form.
+The syntax accepts a comma separated list of users and/or groups (prefixed with an ''@'') who need to acknowledge this page. Once a user has acknowledged a page, the date and time of acknowledging is shown instead of the form.
+Example:
+<code>
+~~ACK:john,jane,@marketing~~
+</code>
 The form is only displayed to the listed users (or members of the listed groups). For all others, nothing is shown at all.
@@ Line 60: / Line 69: @@
 If no pages are marked to be acknowledged by the current user or all pages have already been acknowledged, a "Nothing found" text is shown instead.
-===== Admin: Acknowledgement Report =====
+==== All Acknowledgements of the Current User ====
-The admin component provides users with manager permission with a simple reporting table, which lists details of the current acknowledgements:
+You can also display a complete listing of the user's acknowledgment assignments, both pending and done:
-  * page
+<code>
-  * user name
+~~ACKNOWLEDGE all~~
-  * date and time
+</code>
+The dates of past acknowledgements are formatted using the [[config:dformat|dformat]] configuration setting.
+==== Admin: Acknowledgement Overview ====
+This admin component provides users with manager permission with some reporting on the current acknowledgements:
+  * A list of the most recent acknowledgements
+  * A report for a given user listing all pages they have to acknowledge
+  * A report for a given page pattern listing all users that have to acknowledge the matching pages
+The pattern for the last option uses the same syntax as the assignments explained in the next section.
+==== Admin: Acknowledgement Assignments ====
+This admin component allows for the central definition of acknowledgment assignments. This is useful when for example, the same group of users need to acknowledge all pages within a certain namespace. This component is only accessible to superusers.
+Whenever a page matches one of the patterns defined here, the given people and groups will be assigned.
+  * Namespaces excluding subnamespaces are assigned as ''<nowiki>namespace:*</nowiki>''.
+  * Namespaces including subnamespaces are assigned as ''<nowiki>namespace:**</nowiki>''.
+  * Pages as usual with their full page ID.
+  * Regular Expressions starting and ending with ''/'' - they are matched against a '':'' prefixed full page id.
-==== Historic data ====
+Assignees are defined either by username or ''@'' prefixed group name. Multiple assignees are separated by commas '',''.
-The only way to see previous, no longer valid acknowledgements is to query the database directly.
+This feature can be used together with manually assigned users. For pages that have assignments via these patterns, but do not use the [[#Acknowledgement Widget]], the widget is automatically appended at the end of the page.
 ===== Development =====
@@ Line 80: / Line 112: @@
 **Releases:**
 {{rss>https://github.com/cosmocode/dokuwiki-plugin-acknowledge/releases.atom description author}}