Difference between revisions of "Reference:BlueSpiceReadConfirmation"

(Description)
(Tag: 2017 source edit)
 

Extension: BlueSpiceReadConfirmation


Overview
Description: Ask for confirmation that an article was read by certain users Extension to collect read confirmations for a page
State: stable Dependency: BlueSpice
Developer: HalloWelt License:

GPL-3.0-onlyProperty "BSExtensionInfoLicense" (as page type) with input value "</br>GPL-3.0-only" contains invalid characters or is incomplete and therefore can cause unexpected results during a query or annotation process.

Type: BlueSpice Category: Quality Assurance
Edition: BlueSpice pro, BlueSpice Farm, BlueSpice Cloud

Features

[edit source]

Description[edit | edit source]

Read Confirmation ask

ReadConfirmation asks for confirmation that

an article was

a page has been read by

certain users. Responsible editors for an article will get an request to confirm that they have read the article.

Accept ReadConfirmation[edit | edit source]

For the user who has been assigned to a specific page, a prominent message block appears at the beginning of the page for read verification. This will appear every time the page is accessed until the confirmation has actually been made

Check reading confirmation[edit | edit source]

When all prompted users have confirmed the current version of the article, the circle in Access Management changes from red to green in the "Read" column. More details about the confirmation, e.g. The date of the confirmation, you will be found in the read confirmation logbook (see below).

Delete assignments[edit | edit source]

The assignments are removed either via the delete button above the list in the access management or in the "Actions" column. First, activate the corresponding article.

The assignments for an article can only be deleted completely

The logbooks of ReadConfirmation[edit | edit source]

In the assignment manager you will find two icons in the "Actions" column, which lead to two logbooks

The assignment logbook is a special page that lists all assignments and their deletions     with date and actor
  • The read-only confirmation log shows all confirmations of the assigned users..
  • Requierements[edit | edit source]

    ReadConfirmation requires PageAssignments.

    users who have a page assignment for that page.

    When the feature is enabled for a namespace, users who are assigned to a page see a checkbox at the top of the page. By clicking the checkbox, they confirm that the page has been read.

    ReadConfirmations can be enabled or disabled for each namespace individually, in NamespaceManager.

    Page approval and read confirmation

    If a namespace has the feature Approval activated at the same time, the read confirmation is triggered if a new draft page has been created. This can be changed server-side using LocalSettings.php. If a read confirmation should be triggered after the page has been approved and not when the draft is created, the following setting needs to exist:

                            $GLOBALS['bsgReadConfirmationMechanism'] = "\\BlueSpice\\FlaggedRevsConnector\\ReadConfirmation\\Mechanism\\PageApproved::factory";
    
                        

    Technical Information[edit source]

    This information applies to BlueSpice 3 . Technical details for BlueSpice cloud can differ in some cases.

    Requirements[edit source]

    • MediaWiki: 1.31
    • BlueSpiceFoundation: 3.2

    Integrates into[edit source]

    • BlueSpicePrivacy

    Special pages[edit source]

    Permissions[edit source]

    Name Description Role
    readconfirmationremind Remind users that they have to confirm to have read the page admin, maintenanceadmin

    Configuration[edit source]

    Name Value
    Mechanism 'BlueSpice\\ReadConfirmation\\Mechanism\\NonMinorEdit::factory'

    API Modules[edit source]

    • bs-readconfirmation-tasks

    Hooks[edit source]


    Attachments

    Discussions