Extension: BlueSpiceReadConfirmation
| 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"BlueSpice Cloud" is not in the list (BlueSpice free, BlueSpice free (deactivated), BlueSpice pro, BlueSpice pro (deactivated), BlueSpice farm, BlueSpice farm (deactivated), BlueSpice cloud, BlueSpice cloud (deactivated)) of allowed values for the "BSExtensionInfoEdition" property. | Version: | 4.1+ |
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.39.0
- BlueSpiceFoundation: 4.3
BlueSpicePageAssignments: 4.3
Integrates into
- BlueSpiceDiscovery
- BlueSpicePrivacy
- Notifications
- UnifiedTaskOverview
Special pages
Permissions
| Name | Description | Role |
|---|---|---|
| readconfirmationremind | Remind users that they have to confirm to have read the page | admin, maintenanceadmin |
| readconfirmationviewconfirmations | View the status of read confirmations | admin, maintenanceadmin, structureadmin |
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
- StandardDialogsRegisterPageInfoPanelModules
- UnifiedTaskOverviewGetTaskDescriptors
- UserMergeAccountFields
Accessibility
| Test status: | 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 |
