Difference between revisions of "Reference:BlueSpiceReadConfirmation"
(Tag: 2017 source edit) |
(Tag: 2017 source edit) |
Extension: BlueSpiceReadConfirmation
| Overview | |||
|---|---|---|---|
| Description: | Ask for confirmation that Extension to collect read confirmations for a page was read by assigned users | ||
| State: | stable | Dependency: | BlueSpice |
| Developer: | HalloWelt | License: |
GPL v3 only-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
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, 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
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]
- BSApiExtJSStoreBaseBeforePostProcessData
- BSApiNamespaceStoreMakeData
- BSPageAssignmentsManager
- BSPageAssignmentsOverview
- BSPageStoreDataProviderBeforeAppendRow
- BeforePageDisplay
- LoadExtensionSchemaUpdates
- NamespaceManager::editNamespace
- NamespaceManager::getMetaFields
- NamespaceManager::writeNamespaceConfiguration
- PageContentSaveComplete
{{BSExtensionInfoboxBSExtensionInfo
|desc=Ask for confirmation that a page was read by assigned users
|status=stable
|developer=HalloWelt
|type=BlueSpice
|edition=BlueSpice pro, BlueSpice Farm, BlueSpice Cloud
|compatible=BlueSpice
|category=Quality Assurance
|license=GPL v3 only
|features='''ReadConfirmation''' asks for confirmation that a page has been read by users who have a [[Reference:BlueSpicePageAssignments|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 [[Reference:NamespaceManager|NamespaceManager]].
===Page approval and read confirmation===
If a namespace has the feature [[Reference:FlaggedRevs|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:
<syntaxhighlight lang="text">
$GLOBALS['bsgReadConfirmationMechanism'] = "\\BlueSpice\\FlaggedRevsConnector\\ReadConfirmation\\Mechanism\\PageApproved::factory";
</syntaxhighlight>
}}| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{BSExtensionInfo |
|desc=Ask for confirmation that a page was read by assigned users | |desc=Ask for confirmation that a page was read by assigned users | ||
|status=stable | |status=stable | ||
| Line 13: | Line 13: | ||
ReadConfirmations can be enabled or disabled for each namespace individually, in [[Reference:NamespaceManager|NamespaceManager]]. | ReadConfirmations can be enabled or disabled for each namespace individually, in [[Reference:NamespaceManager|NamespaceManager]]. | ||
| + | |||
| + | ===Page approval and read confirmation=== | ||
| + | If a namespace has the feature [[Reference:FlaggedRevs|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: | ||
| + | <syntaxhighlight lang="text"> | ||
| + | $GLOBALS['bsgReadConfirmationMechanism'] = "\\BlueSpice\\FlaggedRevsConnector\\ReadConfirmation\\Mechanism\\PageApproved::factory"; | ||
| + | </syntaxhighlight> | ||
}} | }} | ||