Difference between revisions of "Manual:Extension/BlueSpiceReadConfirmation"
[unchecked revision] | [quality revision] |
(Tag: Visual edit) |
The extension ReadConfirmation allows to request read confirmations from users. If a user is assigned to a page, a mandatory read confirmation can be added to the page.
Contents
Enabling read confirmations[edit | edit source]
Read Confirmation ask for confirmation that an article was read by certain users.
Where to find Assignments that you are responsible for?[edit | edit source] Or go to upper right corner, click on your name and in combo box you will find:"assignments". When you click on "assignments" you will get an article or articles which you are assigned to. How to use read confirmationAn administrator must enable read confirmations for the namespace the page belongs to. This can be set using the Namespace manager:
Display[edit | edit source]
Click on one of the articles that you are assigned and you will get:
With ReadConfirmation responsible editors are required to confirm that they have had read the article. On an article they are responsible for, they will get a notification containing an option to confirm that the article has been read.
Create a read confirmationWhen read confirmations are active on a namespace, assigned users see a confirmation prompt. After checking the checkbox Yes, I have completely read this article and clicking Confirm, the page will be marked as read by that user.
Administration of read confirmations[edit | edit source]
When access is accessed, all articles of the wiki are listed. The "Assignments" column shows whether an article has already been assigned a read receipt or not.
In order to provide an article with a reading confirmation, you will first find the desired article by scrolling through the following buttons in the displayed list Or the articles. The sorting and filtering functions can be found in the drop-down list of the column header "page title": assign the users, select the appropriate item and click the "Edit" button above the list. A dialog box appears where you can use the drop-down list to assign the users and / or usergroups of the wiki to the article. By clicking on the "Request read confirmation" button, you are now starting the processSince the reading confirmation depends on the version of an article, you can repeatedly request the reading confirmation if the article has changed in the meantime. The process then starts from the beginning and the affected users are prompted again to issue a read receipt
Received for read receipt After the read confirmation has been established, the respective users receive an email and a message in the wiki. This requires that the users have activated the notifications for the page assignments in their user settings: Regardless of the notifications, the assignments of certain users to articles are also visible in the article info. Wiki admins can see an overview of all read confirmations by navigating to Global actions > Management > Assignment management. Read confirmation information is shown in the column Read on. A page can have multiple states:
- Read confirmation not enabled: BlueSpiceReadConfirmation is not enabled for the namespace to which the page belongs.
- Not read: BlueSpiceReadConfirmation is enabled, but the assigned users have not yet read the page.
-
Actions: In the columns for actions, there are two items related to read confirmations.
- Read confirmation log: Link to the read confirmation log for the page.
- Request read confirmation: Users get a reminder for their read confirmation.
Read confirmation in connection with page approval[edit | edit source]
If the approval feature is activated in a namespace at the same time, the read confirmation is triggered when a new draft is created. This can be changed via server configuration so that the read confirmaation is required after the draft page has been approved.Related info
__HIDETITLE__<br /><bs:bookshelf src="Book:User manual" /> __TOC__ ==What is ReadConfirmation?== Read Confirmation ask for confirmation that an article was read by certain users. ==Where to find Assignments that you are responsible for?== ::: [[File:ReadConf1.jpg|500x304px]] Or go to upper right corner, click on your name and in combo box you will find:"assignments". When you click on "assignments" you will get an article or articles which you are assigned to. ::: [[File:ReadConf2.jpg|500x303px]] ==How to use read confirmation== Click on one of the articles that you are assigned and you will get: ::: [[File:ReadCon2a.jpg|500x304px]] With ReadConfirmation responsible editors are required to confirm that they have had read the article. On an article they are responsible for, they will get a notification containing an option to confirm that the article has been read. ::: [[File:ReadCon3.jpg|500x299px]] ===Create a read confirmation=== When access is accessed, all articles of the wiki are listed. The "Assignments" column shows whether an article has already been assigned a read receipt or not. <br /> In order to provide an article with a reading confirmation, you will first find the desired article by scrolling through the following buttons in the displayed list <br /> Or the articles. The sorting and filtering functions can be found in the drop-down list of the column header "page title": assign the users, select the appropriate item and click the "Edit" button above the list. A dialog box appears where you can use the drop-down list to assign the users and / or usergroups of the wiki to the article. By clicking on the "Request read confirmation" button, you are now starting the process Since the reading confirmation depends on the version of an article, you can repeatedly request the reading confirmation if the article has changed in the meantime. The process then starts from the beginning and the affected users are prompted again to issue a read receipt <br /> Received for read receipt <br /> After the read confirmation has been established, the respective users receive an email and a message in the wiki. This requires that the users have activated the notifications for the page assignments in their user settings: <br /> Regardless of the notifications, the assignments of certain users to articles are also visible in the article info. {{DISPLAYTITLE:Read confirmation}} The extension '''ReadConfirmation''' allows to request read confirmations from users. If a user is assigned to a page, a mandatory read confirmation can be added to the page. ==Enabling read confirmations== An administrator must enable read confirmations for the namespace the page belongs to. This can be set using the [[Manual:Extension/NamespaceManager|Namespace manager]]: <br /> [[File:ReadConfirmation2.png|center|650x650px|alt=Activating read confirmations|thumb|Activating read confirmations in a namespace]] ==Display== [[File:ReadConfirmation1.png|center|650x650px|alt=Read confirmation checkbox|thumb|Read confirmation checkbox]] When read confirmations are active on a namespace, assigned users see a confirmation prompt. After checking the checkbox ''Yes, I have completely read this article'' and clicking ''Confirm,'' the page will be marked as read by that user. <br /> ==Administration of read confirmations== Wiki admins can see an overview of all read confirmations by navigating to ''Global actions > Management > Assignment management.'' Read confirmation information is shown in the column ''Read on''. A page can have multiple states: *''Read confirmation not enabled:'' BlueSpiceReadConfirmation is not enabled for the namespace to which the page belongs. *''Not read:'' BlueSpiceReadConfirmation is enabled, but the assigned users have not yet read the page. *''Actions:'' In the columns for actions, there are two items related to read confirmations. **''Read confirmation log:'' Link to the read confirmation log for the page. **''Request read confirmation:'' Users get a reminder for their read confirmation. [[File:ReadConfirmation3.png|thumb|link=https://en.wiki.bluespice.com/wiki/File:ReadConfirmation3.png|alt=Reviewing read confirmations|center|650x650px|Reviewing read confirmations]]<br /> == Read confirmation in connection with page approval == If the approval feature is activated in a namespace at the same time, the read confirmation is triggered when a new draft is created. This [[Reference:BlueSpiceReadConfirmation|can be changed via server configuration]] so that the read confirmaation is required after the draft page has been approved.{{Box Links-en|Topic1=[[Reference:BlueSpiceReadConfirmation]]}} <br /> [[en:{{FULLPAGENAME}}]] [[de:Handbuch:Erweiterung/BlueSpiceReadConfirmation]] [[Category:Quality]]
(51 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
− | + | {{DISPLAYTITLE:Read confirmation}} | |
− | + | The extension '''ReadConfirmation''' allows to request read confirmations from users. If a user is assigned to a page, a mandatory read confirmation can be added to the page. | |
− | == | + | ==Enabling read confirmations== |
+ | An administrator must enable read confirmations for the namespace the page belongs to. | ||
+ | This can be set using the [[Manual:Extension/NamespaceManager|Namespace manager]]: | ||
− | + | <br /> | |
+ | [[File:ReadConfirmation2.png|center|650x650px|alt=Activating read confirmations|thumb|Activating read confirmations in a namespace]] | ||
+ | ==Display== | ||
+ | [[File:ReadConfirmation1.png|center|650x650px|alt=Read confirmation checkbox|thumb|Read confirmation checkbox]] | ||
+ | When read confirmations are active on a namespace, assigned users see a confirmation prompt. After checking the checkbox ''Yes, I have completely read this article'' and clicking ''Confirm,'' the page will be marked as read by that user. | ||
− | == | + | <br /> |
+ | ==Administration of read confirmations== | ||
+ | Wiki admins can see an overview of all read confirmations by navigating to ''Global actions > Management > Assignment management.'' Read confirmation information is shown in the column ''Read on''. A page can have multiple states: | ||
− | ::: | + | *''Read confirmation not enabled:'' BlueSpiceReadConfirmation is not enabled for the namespace to which the page belongs. |
+ | *''Not read:'' BlueSpiceReadConfirmation is enabled, but the assigned users have not yet read the page. | ||
+ | *''Actions:'' In the columns for actions, there are two items related to read confirmations. | ||
+ | **''Read confirmation log:'' Link to the read confirmation log for the page. | ||
+ | **''Request read confirmation:'' Users get a reminder for their read confirmation. | ||
+ | [[File:ReadConfirmation3.png|thumb|link=https://en.wiki.bluespice.com/wiki/File:ReadConfirmation3.png|alt=Reviewing read confirmations|center|650x650px|Reviewing read confirmations]]<br /> | ||
− | + | == Read confirmation in connection with page approval == | |
+ | If the approval feature is activated in a namespace at the same time, the read confirmation is triggered when a new draft is created. This [[Reference:BlueSpiceReadConfirmation|can be changed via server configuration]] so that the read confirmaation is required after the draft page has been approved.{{Box Links-en|Topic1=[[Reference:BlueSpiceReadConfirmation]]}} | ||
+ | <br /> | ||
− | + | [[en:{{FULLPAGENAME}}]] | |
− | + | [[de:Handbuch:Erweiterung/BlueSpiceReadConfirmation]] | |
− | + | [[Category:Quality]] | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− |