BlueSpiceReadConfirmation

Extension: BlueSpiceReadConfirmation

all extensions

Overview
Description:	Extension to collect read confirmations for a page
State:	stable	Dependency:	BlueSpice
Developer:	HalloWelt	License:	GPL-3.0-only
Type:	BlueSpice	Category:	Quality Assurance
Edition:	BlueSpice pro, BlueSpice Farm, BlueSpice Cloud	Version:	4.1+
View user help page

Features

ReadConfirmation asks for confirmation that a page has been read by users who have a page assignment for that page.

When the feature is enabled for a namespace through the NamespaceManager, 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.

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

This information applies to BlueSpice 4. Technical details for BlueSpice Cloud can differ in some cases.

Requirements

• MediaWiki: 1.36.0

• BlueSpiceFoundation: 4.1

BlueSpicePageAssignments: 4.1

Integrates into

• BlueSpiceDiscovery
• BlueSpicePrivacy
• UnifiedTaskOverview

Special pages

Permissions

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

Configuration

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

API Modules

• bs-readconfirmation-tasks

Hooks

• BSApiExtJSStoreBaseBeforePostProcessData
• BSApiNamespaceStoreMakeData
• BSPageAssignmentsManager
• BSPageAssignmentsOverview
• BSPageStoreDataProviderBeforeAppendRow
• BeforePageDisplay
• LoadExtensionSchemaUpdates
• NamespaceManager::editNamespace
• NamespaceManager::getMetaFields
• NamespaceManagerBeforePersistSettings
• PageSaveComplete
• SkinTemplateNavigation::Universal
• UnifiedTaskOverviewGetTaskDescriptors
• UserMergeAccountFields

{{#ifeq:Reference|Reference|[[de:Referenz:BlueSpiceReadConfirmation|}}

Accessibility

Test status:	wcagStatus::2-testing complete
Checked for:	Web
Last test date:	2022-08-08
WCAG level:	AA
WCAG support:	supports
Comments:	Screenreader: small issue in NVDA (works in JAWS): warning box heading is not announced, because focus is on input box. Therefore, there is a minor lack of context. erm:25475
Extension type:	core
Extension focus:	reader