Mark as Read

Overview

Module enables users to mark documents such as regulations, terms etc. as read via form which is attached automatically to them. When document is created or updated users will get notification via e-mail which contains status, name and link to this document so that they will instantly be able to accept them. There is a way for administrators to change settings such as changing roles which are required to get notification, sending notification to author of document, changing email messages, changing text in acceptance submission form.

There is also a block provided, because since drupal 8 e-mail is not required for accounts and I want to give access to notifications to every user. In this block there is a list with documents which are waiting to be accepted. Another feature is to give ability to change document without sending notifications about it. It may be useful when document creator makes some kind of error in document for example typo. Also if document is unpublished notifications won't be sent, but when it is marked as published they will again be sent.
There is also tracking of revisions, because if acceptance submission was made to document and it changed substantially, author may want to again get acceptance from user or when he decides to rollback to previous version which was already accepted by user he shouldn't have to accept it again. Last feature is custom view which can be linked to for example in the footer.

Common Use Case

Requiring users to accept terms and conditions.

Example User Story

As a logged in user I should be able to tell whether I there are any documents waiting to be read. I should be able to get notifications through email about them. After i read them it should persist this state until document gets changed.