Differences

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

--- plugin:notification [2019-07-10 08:39] – solewniczak
+++ plugin:notification [2019-09-13 11:03] – solewniczak
@@ Line 7: / Line 7: @@
 type       : action, syntax
 lastupdate : 2019-07-08
-compatible :
+compatible : Greebo
 depends    :
 conflicts  :
@@ Line 21: / Line 21: @@
 ----
-This plugin works as an aggregation hub for notifications from other dokuwiki plugins. More information soon.
+===== Donation ====
+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 ;-)
+===== Description =====
+This plugin works as an aggregation hub for notifications from other dokuwiki plugins. The idea is to inform dokuwiki users about the actions they have to take in a wiki. Currently the following plugins integrates with this plugin:
+  * [[approve]] - inform the maintainers about pages that aren't approved. Plugins provided: ''approve''
+  * [[bez]] - inform the users about problems and tasks they have to resolve. Plugins provided: ''bez:problems_coming'', ''bez:problems_outdated'', ''bez:tasks_coming'', ''bez:tasks_outdated''
+  * [[ireadit]]- inform the users about the pages they have to read. Plugins provided: ''ireadit''
+===== Syntax =====
+==== List ====
+The basic syntax to display all the notifications from all the plugins for the currently login user is:
+<code>
+---- notification list ----
+----
+</code>
+Notifications are displayed as an unordered list with the date. For example:
+  * 2019-09-02 You have the page to approve: [[:dokuwiki]]
+  * 2019-09-03 You have a page to read: [[:acl]]
+You can user regular expression to limit the notifications to some plugins only:
+<code>
+---- notification list ----
+plugin: ^(approve|ireadit)
+----
+</code>
+You can also display notifications for concrete user:
+<code>
+---- notification list ----
+user: name
+----
+</code>
+or use a special syntax for the currently login user (default):
+<code>
+---- notification list ----
+user: $USER$
+----
+</code>
+Plugin also allows you to turn off the full message, using syntax:
+<code>
+---- notification list ----
+full:0
+----
+</code>
+This will cause the plugin to display only links to the pages. For example:
+  * 2019-09-02 [[:dokuwiki]]
+  * 2019-09-03 [[:acl]]
+You can also specify date format for the plugin using the ''date'' parameter:
+<code>
+---- notification list ----
+date: %Y-%m-%d %H:%M
+----
+</code>
+The date parameter is parsed by PHP's [[https://www.php.net/manual/en/function.strftime.php|strftime]] function.
+You can join several parameters:
+<code>
+---- notification list ----
+plugin: ^(approve|ireadit)
+user: name
+full:0
+date: %Y-%m-%d %H:%M
+----
+</code>
+===== Discussion =====
+[[https://github.com/gkrid/dokuwiki-plugin-notification/issues]]