DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:ireadit

Ireadit Plugin

Compatible with DokuWiki

  • 2020-07-29 "Hogfather" yes
  • 2018-04-22 "Greebo" yes
  • 2017-02-19 "Frusterick Manners" yes
  • 2016-06-26 "Elenor Of Tsort" yes

plugin Allow dokuwiki users confirm that they have read the page

Last updated on
2020-05-15
Provides
Action
Repository
Source
Requires
sqlite

Similar to acknowledge

Tagged with annotations, page, statistic, users

Donation

If you like this plugin or want to thank me for development of your requested features please consider buying me a coffee. Thank you ;-)

Installation

:!: This Plugin depends on the following other plugins:

Search and install the plugin using the 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 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:

~~IREADIT szymon piotr~~

Means that only users szymon and piotr can confirm the page read. You can also use group names here. For example:

~~IREADIT @user~~

Means that only users in @user group are allowed to confirm the page read.

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”.

List

Plugin allows listing pages that currently login user have to read. Syntax:

---- ireadit list ----
state: not read
----

You can also define other user that currently logged in. Syntax:

---- ireadit list ----
user: other_user
state: not read
----

Additionally you may list pages that was read already:

---- ireadit list ----
state: read
----

Or list both read and not read pages:

---- ireadit list ----
state: read, not read
----

You can narrow the results only to specific namespace:

---- ireadit list ----
namespace: some:namespace
----

Show the page id's that satisfy the regular expression:

---- ireadit list ----
filter: /regex/
----

Get an overview of which pages have been read (by anyone allowed to ack, not just the logged in user):

---- ireadit list ----
state: read
overview: 1
  • 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.

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

plugin/ireadit.txt · Last modified: 2020-08-01 10:29 by solewniczak