plugin:ireadit
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:ireadit [2018-05-28 23:00] – solewniczak | plugin:ireadit [2024-01-23 20:09] (current) – Aleksandr | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
---- plugin ---- | ---- plugin ---- | ||
- | description: | + | description: |
author | author | ||
- | email : solewniczak@rid.pl | + | email : it@rid.pl |
type : action | type : action | ||
- | lastupdate : 2018-05-28 | + | lastupdate : 2023-03-07 |
- | compatible : Angua, Adora Belle, Weatherwax, Detritus, Elenor | + | compatible : Angua, Adora Belle, Weatherwax, Detritus, Elenor |
- | depends | + | depends |
conflicts | conflicts | ||
similar | similar | ||
Line 16: | Line 16: | ||
bugtracker : https:// | bugtracker : https:// | ||
sourcerepo : https:// | sourcerepo : https:// | ||
- | donationurl: | + | |
screenshot_img : | screenshot_img : | ||
---- | ---- | ||
- | ===== Donation | + | ===== Installation ===== |
- | If you like this plugin | + | :!: This Plugin depends on the following other plugins: |
+ | * [[plugin:sqlite]] | ||
+ | |||
+ | Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[: | ||
===== Usage ===== | ===== Usage ===== | ||
Line 37: | Line 40: | ||
If you change the dokuwiki page, the reader' | If you change the dokuwiki page, the reader' | ||
- | ===== Development | + | ==== 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: | ||
+ | ---- | ||
+ | </ | ||
+ | |||
+ | 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 ==== | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | ===== Config ===== | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | ===== 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> | + | ===== Integration with notification |
- | **Releases: | + | This plugin integrates with [[notification]] |
- | {{rss> | + | |
===== Discussion ===== | ===== Discussion ===== | ||
[[https:// | [[https:// |
plugin/ireadit.1527541224.txt.gz · Last modified: 2018-05-28 23:00 by solewniczak