Overview
The Comala Read Confirmations App allows
- content viewers to confirm they have read a page or blog post
- content authors to request that users confirm they have read a page or blog post
Simple Read Confirmation
A user with at least view permission for the page or blog post can confirm reading the content by choosing Read Confirmation in the page tools menu.
Confirm the addition of a read confirmation to the page.
You will need to refresh your page in the browser.
This opens the read confirmation popup.
One or more users will need to be assigned to the read confirmation.
You can add these later and simply Close the read confirmation to add the read confirmation to the page.
Added to the page are
- the read confirmation byline breadcrumb to the page subtitle
- the read confirmation bar to the page footer
Choose the Assign button or the read confirmation byline breadcrumb to open the read confirmation popup and assign one or more users as readers.
The read confirmation popup will be updated with each assigned reader.
- read confirmation status lozenge is added
- each user assigned as a reader will receive a notification
- other users can also confirm reading the content
- the progress of each assigned reader confirmation is tracked in the popup
On the page the read confirmation byline breadcrumb and footer bar are updated with the read confirmation status.
Once all readers have confirmed reading the content the read confirmation status is set as CONFIRMED.
Users with edit permission for the content can use the read confirmation popup to assign readers to undertake the read confirmation
Macro read confirmation
Content editors can add a read confirmation using the Read Confirmation macro to add a read confirmation to the content.
The read confirmation byline breadcrumb is added to the page subtitle.
The read confirmation bar is added to the content
- users can choose to Confirm the read confirmation
- authors can choose to Assign users as readers
Editing content with an added read confirmation will require the read confirmation to be re-confirmed.
Read confirmation status
If a reader is assigned, the read confirmation byline will change to reflect the overall status of the read confirmation. A status lozenge will also be added to the read confirmation bar.
Overall read confirmation status will be shown as one of
- Pending if no assigned readers have confirmed
- Partial if one of assigned readers has confirmed but at least one other reader has not confirmed
- Confirmed if all assigned readers have confirmed
Read confirmation macro
To add a read confirmation to an individual page or blog post edit the content and add the read confirmation macro
- the macro can be edited to configure the display of the read confirmation on the content
User read confirmation
Once added to the content, any user with view permission for the content can confirm reading the content.
The user avatar for users who have confirmed is added to the read confirmation on the page.
Read confirmation details
Open the read confirmation popup to See who has confirmed reading the content, for what version and the time elapsed since the user read confirmation.
Assigning users as readers
Assign one or more users as readers for the read confirmation using the read confirmation popup.
- users do not need to be assigned to undertake a read confirmation
- all users with view permission for the content will be able to confirm reading the content
- all users assigned as readers must confirm reading the content for the overall read confirmation to be confirmed
Assigning a user as a reader will add an overall read confirmation status.
- the overall read confirmation status is displayed as a lozenge in the read confirmation popup
- the read confirmation byline on the page will change to display the current status
The status lozenges may also be displayed in the read confirmation bar on the page if the read confirmation was added using the read confirmation macro.
Remove a read confirmation
A user can remove a read confirmation from a page using the page tools menu.
