Discussion

Difference between revisions of "Manual:Extension/BlueSpiceReadConfirmation"

[quality revision][quality revision]
m
(Tag: 2017 source edit)
 


About read confirmations[edit | edit source]

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. This ensures that all assigned users actually have read the page they are assigned to.

If you are assigned to a page, you have to confirm with a checkbox setting that you have read the page. When a page has been edited by another user in the meantime, you will be asked for another confirmation. This continues until you have been removed as an assigned user. Every user can assign other users to a page.

To activate read confirmations, a user with administrator rights needs to enable read confirmations for a namespace.

Enabling read confirmations[edit | edit source]

An administrator must enable read confirmations for the namespace the page belongs to. This can be set using the NamespaceManager Namespace manager:

ReadConfirmation2.png


Confirming reading a page
Activating read confirmations
Activating read confirmations in a namespace

Display[edit | edit source]

Read confirmation checkbox
Read confirmation checkbox

When read confirmations are active on a namespace, assigned users see a confiramtion 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.

ReadConfirmation3.png


List Administration of read confirmations[edit | edit source]

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 - in case : BlueSpiceReadConfirmation is not enabled for the namespace that to which the page belongs to.
  • Not read - in case : BlueSpiceReadConfirmation is enabled, but the assigned user has users have not yet read the page.
  • [timestamp] - date and time when the page was read.
Technical details
  • 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.
Reviewing read confirmations
Reviewing read confirmations

Read confirmation in connection with page approval[edit | edit source]

Read confirmations are enabed by the extension BlueSpiceReadConfirmation. 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 



{{DISPLAYTITLE:Read confirmation}}
        
        
        __TOC__
            
            
            
            ==About read confirmations==
            
            
        
            
            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. This ensures that all assigned users actually have read the page they are assigned to.
            
            
            
            If you are assigned to a page, you have to confirm with a checkbox setting that you have read the page. When a page has been edited by another user in the meantime, you will be asked for another confirmation. This continues until you have been removed as an assigned user. Every user can assign other users to a page. 
            
            
            
            To activate read confirmations, a user with administrator rights needs to enable read confirmations for a namespace.
            
            
            
            
        
            
            
            
            
        ==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|NamespaceManager]]:
            
            
            
            
        Namespace manager]]:
            
            
            
            
            <br />
            
            
            
            
        [[File:ReadConfirmation2.png|center|750x750px]]
            
            ===Confirming reading a page===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 confiramtionconfirmation 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.
        
        
        [[File:ReadConfirmation3.png|thumb]]
            
            ==List
            
            
            <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 - in case :'' BlueSpiceReadConfirmation is not enabled for the namespace that to which the page belongs to.
            
            *.
            
            *''Not read - in case :'' BlueSpiceReadConfirmation is enabled, but the assigned user hasusers have not yet read the page.
        
        *[timestamp] - date and time when the page was read.
            
            
            
            ==Technical details==
            
            Read confirmations are enabed by the extension '''BlueSpiceReadConfirmation'''.
            
            
        ''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]]
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:Read confirmation}}
 
{{DISPLAYTITLE:Read confirmation}}
−
__TOC__
 
  
−
==About read confirmations==
+
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.  
−
If a user is assigned to a page, a mandatory read confirmation can be added to the page. This ensures that all assigned users actually have read the page they are assigned to.
 
  
−
If you are assigned to a page, you have to confirm with a checkbox setting that you have read the page. When a page has been edited by another user in the meantime, you will be asked for another confirmation. This continues until you have been removed as an assigned user. Every user can assign other users to a 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]]:
  
−
To activate read confirmations, a user with administrator rights needs to enable read confirmations for a namespace.
+
<br />
  
−
==Enabling read confirmations==
+
[[File:ReadConfirmation2.png|center|650x650px|alt=Activating read confirmations|thumb|Activating read confirmations in a namespace]]
−
An administrator must enable read confirmations for the namespace the page belongs to.
+
==Display==
−
This can be set using the [[Manual:Extension/NamespaceManager|NamespaceManager]]:
+
[[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.
  
−
[[File:ReadConfirmation2.png|center|750x750px]]
+
<br />
−
===Confirming reading a page===
+
==Administration of read confirmations==
−
[[File:ReadConfirmation1.png|center|650x650px]]
 
−
When read confirmations are active on a namespace, assigned users see a confiramtion 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.
 
−
[[File:ReadConfirmation3.png|thumb]]
 
−
==List 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:
 
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 - in case BlueSpiceReadConfirmation is not enabled for the namespace that the page belongs to.
+
*''Read confirmation not enabled:'' BlueSpiceReadConfirmation is not enabled for the namespace to which the page belongs.
−
*Not read - in case BlueSpiceReadConfirmation is enabled, but the assigned user has not yet read the page.
+
*''Not read:'' BlueSpiceReadConfirmation is enabled, but the assigned users have not yet read the page.
−
*[timestamp] - date and time when the page was read.
+
*''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 />
  
−
==Technical details==
+
== Read confirmation in connection with page approval ==
−
Read confirmations are enabed by the extension '''BlueSpiceReadConfirmation'''.
+
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]]}}
−
{{Box Links-en|Topic1=[[Reference:BlueSpiceReadConfirmation]]}}
 
 
<br />
 
<br />
  
−
[[en:]]
+
[[en:{{FULLPAGENAME}}]]
 
[[de:Handbuch:Erweiterung/BlueSpiceReadConfirmation]]
 
[[de:Handbuch:Erweiterung/BlueSpiceReadConfirmation]]
 +
[[Category:Quality]]
Retrieved from "https://bs3-en.wiki.bluespice.com/w/index.php?title=Manual:Extension/BlueSpiceReadConfirmation&oldid=28187"

Attachments

Discussions