DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:notification

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:notification [2019-07-10 08:39] solewniczakplugin:notification [2023-03-07 15:17] (current) solewniczak
Line 2: Line 2:
  
 ---- plugin ---- ---- plugin ----
-description: Display notifications from other plugins to dokuwiki users.+description: Display notifications from other plugins to DokuWiki users
 author     : Szymon Olewniczak  author     : Szymon Olewniczak 
 email      : it@rid.pl  email      : it@rid.pl 
 type       : action, syntax type       : action, syntax
-lastupdate : 2019-07-08 +lastupdate : 2023-03-07 
-compatible :  +compatible : Hogfather, Greebo 
-depends    : +depends    : sqlite
 conflicts  conflicts 
 similar    :  similar    : 
-tags       : +tags       : notification
  
 downloadurl: https://github.com/gkrid/dokuwiki-plugin-notification/zipball/master downloadurl: https://github.com/gkrid/dokuwiki-plugin-notification/zipball/master
 bugtracker : https://github.com/gkrid/dokuwiki-plugin-notification/issues bugtracker : https://github.com/gkrid/dokuwiki-plugin-notification/issues
 sourcerepo : https://github.com/gkrid/dokuwiki-plugin-notification/ sourcerepo : https://github.com/gkrid/dokuwiki-plugin-notification/
-donationurl:  
  
 screenshot_img :  screenshot_img : 
 ---- ----
  
-This plugin works as an aggregation hub for notifications from other dokuwiki plugins. More information soon.+===== Installation ===== 
 + 
 +:!: 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 ===== 
 + 
 +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 wikiCurrently 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_without_tasks'', ''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 [[phpfn>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]] 
  
plugin/notification.1562740752.txt.gz · Last modified: 2019-07-10 08:39 by solewniczak

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki