Differences

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

--- plugin:ireadit [2019-09-02 12:59] – solewniczak
+++ plugin:ireadit [2024-01-23 20:09] (current) – Aleksandr
@@ Line 1: / Line 1: @@
-====== ireadit Plugin ======
+====== Ireadit Plugin ======
 ---- plugin ----
 description: Allow dokuwiki users confirm that they have read the page
 author     : Szymon Olewniczak
-email      : solewniczak@rid.pl
+email      : it@rid.pl
 type       : action
-lastupdate : 2019-09-02
+lastupdate : 2023-03-07
-compatible : Angua, Adora Belle, Weatherwax, Detritus, Elenor Of Tsort, Frusterick Manners, Greebo
+compatible : Angua, Adora Belle, Weatherwax, Detritus, Elenor of Tsort, Frusterick Manners, Greebo, Hogfather, Igor
 depends    : sqlite
 conflicts  :
@@ Line 16: / Line 16: @@
 bugtracker : https://github.com/gkrid/dokuwiki-plugin-ireadit/issues
 sourcerepo : https://github.com/gkrid/dokuwiki-plugin-ireadit
-donationurl: https://paypal.me/SzymonOlewniczak
 screenshot_img :
 ----
-===== 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 ;-)
 ===== Installation =====
@@ Line 45: / Line 40: @@
 If you change the dokuwiki page, the reader's list will be cleaned. Readers must confirm that they notice the changes. The history of readers will be preserved in "Old revisions".
-===== Development =====
+==== List ====
+Plugin allows listing pages that currently login user have to read. Syntax:
+<code>
+---- ireadit list ----
+state: not read
+----
+</code>
+You can also define other user that currently logged in. Syntax:
+<code>
+---- ireadit list ----
+user: other_user
+state: not read
+----
+</code>
+Additionally you may list pages that was read already:
+<code>
+---- ireadit list ----
+state: read
+----
+</code>
+Or list both read and not read pages:
+<code>
+---- ireadit list ----
+state: read, not read
+----
+</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 =====
+  * ''print'' - default: **OFF**. Show list of users who have read the page when printing.
+  * ''minor_edit_keeps_readers'' - default: **ON**. When option is turned on, minor edits won't break list of readers.
+  * ''approve_integration'' - default: **OFF**. Turn on integration with [[approve]] plugin.
+  * ''show_not_read_list'' - default: **OFF**. In addition to list of users who read the page, show also the list of users who haven't done it yet.
+===== Integration with approve plugin =====
-=== Change Log ===
+This plugin integrates with [[approve]] plugin (when turned on in config). In this case when the page is under control of approve plugin, the ireadit works only for approved revisions.
-{{rss>https://github.com/gkrid/dokuwiki-plugin-ireadit/commits/develop.atom date}}
+===== Integration with notification plugin =====
-**Releases:**
+This plugin integrates with [[notification]] plugin and adds notifications for the users about the pages that they have to read.
-{{rss>https://github.com/gkrid/dokuwiki-plugin-ireadit/releases.atom description author}}
 ===== Discussion =====
 [[https://github.com/gkrid/dokuwiki-plugin-ireadit/issues]]