DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:ireadit

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
Last revision
plugin:ireadit [2020-01-18 13:47]
solewniczak
plugin:ireadit [2020-08-01 10:29]
solewniczak
Line 1: Line 1:
-====== ireadit Plugin ======+====== Ireadit Plugin ======
  
 ---- plugin ---- ---- plugin ----
Line 6: Line 6:
 email      : it@rid.pl email      : it@rid.pl
 type       : action type       : action
-lastupdate : 2020-01-18 +lastupdate : 2020-05-15 
-compatible : Angua, Adora Belle, Weatherwax, Detritus, Elenor Of Tsort, Frusterick Manners, Greebo+compatible : Hogfather, Angua, Adora Belle, Weatherwax, Detritus, Elenor Of Tsort, Frusterick Manners, Greebo
 depends    : sqlite depends    : sqlite
 conflicts  conflicts 
Line 71: Line 71:
 <code> <code>
 ---- ireadit list ---- ---- ireadit list ----
-state: all+state: read, not read
 ---- ----
 </code> </code>
 +
 +You can narrow the results only to specific namespace:
 +
 +<code>
 +---- ireadit list ----
 +namespace: some:namespace
 +----
 +</code>
 +
 +Show the page id's that satisfy the regular expression:
 +
 +<code>
 +---- ireadit list ----
 +filter: /regex/
 +----
 +</code>
 +
 +Get an overview of which pages have been read (by anyone allowed to ack, not just the logged in user):
 +
 +<code>
 +---- ireadit list ----
 +state: read
 +overview: 1
 +</code>
 +
 +    * overview + read: show the page if anyone has read it
 +    * overview + unread: show the page if no one has ever read it
 +    * overview + outdated: show the page if no one has read it's last revision but was read by someone previously
 +    * overview + not read: show the page if no one has read it's last revision
 +
 +===== Syntax =====
 +==== ireadit list ====
 +    * ''user'' - The user whose list is displayed. By default the currently login user.
 +    * ''state'':
 +      * ''read'' - Show the pages which was read by the user.
 +      * ''outdated'' - Show the pages which previous revisions were read by the user but the current is not.
 +      * ''unread'' - Show the pages that was never read by the user.
 +      * ''not read'' = ''outdated'' + ''unread''
 +      * ''all'' = ''read'' + ''not read''
 +    * ''lastread'' - ''0'' or ''1''. If this option is set to ''1'', the ''outdated'' pages will link to the last revision which was read by the user (not to the current version). Default: ''0''.
 +    * ''filter'' - regex matching pages to list. Default blank, matches all.
 +    * ''namespace'' - limits list to namespace. Default none.
 +    * ''overview'' - ''0'' or ''1''. Combine this option with ''state'' to get an overview of which pages is in the state. See example above for details.
  
 ===== Config ===== ===== Config =====
plugin/ireadit.txt · Last modified: 2021-01-27 12:01 by solewniczak