This is an old revision of the document!
Table of Contents
ireadit Plugin
Compatible with DokuWiki
Angua, Adora Belle, Weatherwax, Detritus, Elenor Of Tsort, Frusterick Manners, Greebo
This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.
Similar to acknowledge
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: all ----
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.