Differences

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

--- plugin:ireadit [2017-08-10 19:11] – 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.
+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 : 2016-03-22
+lastupdate : 2023-03-07
-compatible : Angua, Adora Belle, Weatherwax, Detritus
+compatible : Angua, Adora Belle, Weatherwax, Detritus, Elenor of Tsort, Frusterick Manners, Greebo, Hogfather, Igor
-depends    :
+depends    : sqlite
 conflicts  :
 similar    :
@@ Line 16: / Line 16: @@
 bugtracker : https://github.com/gkrid/dokuwiki-plugin-ireadit/issues
 sourcerepo : https://github.com/gkrid/dokuwiki-plugin-ireadit
-donationurl:
 screenshot_img :
 ----
-**WARNING!** New version of plugin (2016-02-22) is incompatible with the older ones but offers some new features you may find useful.
 ===== Installation =====
-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.
+:!: This Plugin depends on the following other plugins:
+  * [[plugin:sqlite]]
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
 ===== Usage =====
 When you place:
   ~~IREADIT~~
-anywhere on your dokuwiki page, you will see "I've read it" button on the bottom of page. Any user that clicks on this button will be wirte down into list of people that read that page.
+anywhere on your dokuwiki page, you will see "I've read it" button on the bottom of page. Any user that clicks on this button will be written down into list of people that read that page.
 If you want you can specify single users or user groups that are allowed to confirm the page read. For example:
@@ Line 39: / 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".
-=== Change Log ===
+==== List ====
+Plugin allows listing pages that currently login user have to read. Syntax:
+<code>
+---- ireadit list ----
+state: not read
+----
+</code>
-**2016-03-22:**
+You can also define other user that currently logged in. Syntax:
-  * You can specify users and groups that are allowed to confirm page read.
+<code>
+---- ireadit list ----
+user: other_user
+state: not read
+----
+</code>
-**2016-01-23:**
+Additionally you may list pages that was read already:
-  * Old revisions now remembers who has read the page.
+<code>
+---- ireadit list ----
+state: read
+----
+</code>
-=== Known Bugs and Issues ===
+Or list both read and not read pages:
+<code>
+---- ireadit list ----
+state: read, not read
+----
+</code>
-Please report bug and issus on the project's [[https://github.com/hafron/dokuwiki-plugin-ireadit/issues|github page]].
+You can narrow the results only to specific namespace:
-=== ToDo/Wish List ===
+<code>
+---- ireadit list ----
+namespace: some:namespace
+----
+</code>
-The standard text which appears is now 'Following peoples have read this page'. Shouldn't this be 'Following people have read this page'? Could you also provide an option for a translation to the active language?
+Show the page id's that satisfy the regular expression:
-Is it possible to put a message on top of the page while you are entering a page which you didn't read (but have to, according to users and/or group).
+<code>
-===== FAQ =====
+---- ireadit list ----
+filter: /regex/
+----
+</code>
-===== Discussion =====
+Get an overview of which pages have been read (by anyone allowed to ack, not just the logged in user):
-Is it possible to add some functionality to this plugin?
+<code>
-Turn on tag ~~IREADIT~~ only for exact group of users.
+---- ireadit list ----
+state: read
+overview: 1
+----
+</code>
-It's now possible.
+    * 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
-Hi, I like the plugin. That's what I was looking for! Now I need the option to create a list of pages that a user has not yet read, but that are marked with ~~IREADIT~~. Is that possible? Thanks! +1
+===== 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 =====
+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.
+===== Integration with notification plugin =====
+This plugin integrates with [[notification]] plugin and adds notifications for the users about the pages that they have to read.
+===== Discussion =====
-Would it be possible to trigger this automatically, so that users don't have to click the link but get added to the list right after opening the page? It's for an internal wiki for project management. Thank you!
+[[https://github.com/gkrid/dokuwiki-plugin-ireadit/issues]]