Difference between revisions of "Reference:BlueSpiceReadConfirmation"
(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 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
Description[edit | edit source]
BlueSpice Read Confirmation askReadConfirmation asks for confirmation that
a page has been read by
Request and track read receipts.
- Active: as usual. A button is placed on the page; The user has to click; Confirmation is noted in the list.
- Passive: the page is called by the user; so it is considered as read and it is noted in the list.
Technical information[edit | edit source]
Configuration[edit | edit source]
ReadConfirmations can be enabled or disabled for each namespace individually, in NamespaceManager.
Rights (permissions)[edit | edit source]This extension requires no special permissions. User must be assigned to the page in order to confirm reading it. Read more on that here.
Requierements[edit | edit source]
ReadConfirmation requires PageAssignments and BlueSpiceFoundation.
User manual[edit | edit source]
For detailed description and usage please visit our user manual.
Try free our BlueSpice[edit | edit source]
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=askAsk for confirmation that an articlea page was read by certainassigned users.
|status=stable
|developer=HalloWelt
|type=BlueSpice
|edition=BlueSpice pro
|active=Yes
, BlueSpice Farm, BlueSpice Cloud
|compatible=BlueSpice
|category=Quality Assurance
|license=GPL v3 only
|package=ReadConfirmation
}}
==Description==
'''BlueSpice Read Confirmation''' ask for confirmation that an article was read by certain users. Responsible editors for an article will get an request to confirm that they have read the article.
==Usage / Features==
Request and track read receipts.
* Active: as usual. A button is placed on the page; The user has to click; Confirmation is noted in the list.
* Passive: the page is called by the user; so it is considered as read and it is noted in the list.
==Technical information==
===Configuration===
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]].
===Rights (permissions)===
This extension requires no special permissions. User must be assigned to the page in order to confirm reading it. Read more on that [[PageAssignments|here]].
===Requierements===
ReadConfirmation requires [[PageAssignments]] and [[BlueSpiceFoundation]].
==User manual==
For detailed description and usage please visit our [[Manual:Extension/BlueSpiceReadConfirmation|user manual]].
==Try free our BlueSpice==
[https://en.demo.bluespice.com/wiki/Main_Page BlueSpiceDemo.]
[[de:ReadConfirmation]][[en:{{FULLPAGENAME}}]][[Category:Extension]]|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>
}}| (16 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{BSExtensionInfo |
| − | |desc= | + | |desc=Ask for confirmation that a page was read by assigned users |
|status=stable | |status=stable | ||
|developer=HalloWelt | |developer=HalloWelt | ||
|type=BlueSpice | |type=BlueSpice | ||
| − | |edition=BlueSpice pro | + | |edition=BlueSpice pro, BlueSpice Farm, BlueSpice Cloud |
| − | |||
|compatible=BlueSpice | |compatible=BlueSpice | ||
|category=Quality Assurance | |category=Quality Assurance | ||
|license=GPL v3 only | |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> | ||
| − | |||
| − | + | }} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||