Difference between revisions of "Reference:BlueSpicePageAssignments"
(→Setting permissions for assigned users) |
(Tag: 2017 source edit) |
Extension: BlueSpicePageAssignments
Overview | |||
---|---|---|---|
Description: | Assigns individual Enables you to assign users or whole groups to pages, e.g. as responsible editors 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 free, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud | ||
Features
Contents
PageAssignments allows to assign pages to single users or user groups. Assigned users are notified about assignment changes via email or internal notifications.
- Assign responsible users to a page.
- Assign individual users or groups.
- The responsible editor(s) for the
- page can be viewed in the
In the right corner, as on image below, you will find the "MORE" menu, in the "MORE" menu, you will find "Edit Assignment"
In there you will find a list of users. You can chose wich user you will assign to this article, as on image below:
How to find articles for which you are assigned for?[edit | edit source]Assignments for the current user can be viewed on a special page (Special:PageAssignments)
On the next images you can see where you can find on which articles you are assigned. Go to the upper right corner, click on your name, and choose "assignments".You will see all assigned articles, as on this image below.
Setting permissions for assigned users[edit | edit source]
Go to "GlobalActions" and go "Preferences" (Admin rights necessary)
Click on "Preferences" and you should get:
Look for "PageAssignments":
Here is a combo box with all available settings. You can select here any number of permissions. Click on the permissions you want while holding down CTRL key.
Every user that is assigned to a page will get those permissions in addition to the ones they already have, meaning that these permissions set here are granted to all users that are responsible for one or more articles.Summary[edit | edit source]
- Articles can be assigned to single or multiple users or groups.
- These users / groups are informed about all changes to the site.
- On each article, it is clearly shown who is responsible for the examination of the content.
- A special page provides an overview of all assignments.
- Additional permissions to users may be granted.
special page on the wiki (Special:PageAssignments) shows a list of all the articles that you are responsible for.
- flyout "Page assignments" in the quality management tools.
- Users can view their assignments on the page Special:PageAssignments.
- Users with admin, maintenanceadmin or reviewer rights can manage all assignments on the page Special:ManagePageAssignments.
Display assignments in the title section
The page assignments can be displayed in the title section of the page. Activate this page assignments display in LocalSettings.php (or in the php file in the d.settings folder):
$GLOBALS['bsgBlueSpiceCalummaPageHeaderBeforeContentEnabledProviders'] = [ "pageheader-assignments" ];
Set the limit:
$GLOBALS['bsgPageAssignmentsPageHeaderLimit'] = 25;
Assign all users (with option to exclude some users)
To activate the option to assign all users to a page, a group everyone can be created. For this, the following code needs to be set in <bluepsice-installationpath>/extensions/BlueSpicePageAssignments/extension.json: "PageAssignmentsActivatedTypes": {
"value": [
"user",
"group",
"everyone"
]
},
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]
- BlueSpiceExtendedStatistics
- BlueSpicePageAssignments
- BlueSpicePrivacy
- BlueSpiceSMWConnector
Special pages[edit source]
- ManagePageAssignments
- PageAssignments
Permissions[edit source]
Name | Description | Role |
---|---|---|
pageassignable | Appear in the list of assignable users | reader, admin, author, editor, maintenanceadmin, reviewer |
pageassignments | Edit the assignments of a page | admin, maintenanceadmin, reviewer |
Configuration[edit source]
Name | Value |
---|---|
PageAssignmentsActivatedTypes | array ( 0 => 'user', 1 => 'group', ) |
PageAssignmentsLockdownGroups | array ( 0 => 'user', ) |
PageAssignmentsPageHeaderLimit | 3 |
PageAssignmentsSecureEnabledNamespaces | array ( ) |
PageAssignmentsSecureRemoveRightList | array ( 0 => 'edit', ) |
PageAssignmentsTarget | 'title' |
PageAssignmentsUseAdditionalPermissions | false |
User options[edit source]
Name | Value |
---|---|
echo-subscriptions-email-bs-pageassignments-action-cat | true |
echo-subscriptions-web-bs-pageassignments-action-cat | true |
API Modules[edit source]
- bs-mypageassignment-store
- bs-pageassignable-store
- bs-pageassignment-store
- bs-pageassignment-tasks
Hooks[edit source]
- ArticleDeleteComplete
- BSApiNamespaceStoreMakeData
- BSBookshelfBookManager
- BSBookshelfManagerGetBookDataRow
- BSDashboardsUserDashboardPortalConfig
- BSDashboardsUserDashboardPortalPortlets
- BSGroupManagerGroupDeleted
- BSGroupManagerGroupNameChanged
- BSUEModulePDFcollectMetaData
- BSUsageTrackerRegisterCollectors
- BSUserManagerAfterDeleteUser
- BSUserManagerAfterSetGroups
- BeforePageDisplay
- EchoGetDefaultNotifiedUsers
- LoadExtensionSchemaUpdates
- NamespaceManager::editNamespace
- NamespaceManager::getMetaFields
- NamespaceManager::writeNamespaceConfiguration
- PersonalUrls
- SkinTemplateNavigation
- SkinTemplateOutputPageBeforeExec
- TitleMoveComplete
- WikiExplorer::buildDataSets
- WikiExplorer::getColumnDefinitions
- WikiExplorer::getFieldDefinitions
- WikiExplorer::queryPagesWithFilter
{{BSExtensionInfoboxBSExtensionInfo |desc=Assigns individual users or whole groups to pages, e.g. as responsible editors. |status=stable |developer=HalloWelt |type=BlueSpice |edition=BlueSpice free, BlueSpice pro , BlueSpice Farm, BlueSpice Cloud |active=Yes |compatible=BlueSpice |category=Quality Assurance |docu=https://www.mediawiki.org/wiki/Extension:PageAssignments }} __TOC__ ==What is PageAssignments?== * The extension PageAssignments allows you to assign responsible editors to an articles. * An article can be assigned one single user, multiple users or even an entire group. * license=GPL v3 only |features='''PageAssignments''' allows to assign pages to single users or user groups. Assigned users are notified about assignment changes via email or internal notifications. *Assign responsible users to a page. *Assign individual users or groups. *The responsible editor(s) for the particular article can page can be viewed in the status bar of an article. * The user assigned to the article can transfer the resposibility to another user. * Users / groups are informed about all changes to the site and receive special permissions. * A special page on the wiki (Special:PageAssignments) shows a list of all the articles that you are responsible for. ==How can a user or group become assigned to an article?== In the right corner, as on image below, you will find the "MORE" menu, in the "MORE" menu, you will find "Edit Assignment" ::: [[File:PgeAssgnmt1.jpg|500x305px]] In there you will find a list of users. You can chose wich user you will assign to this article, as on image below: ::: [[File:PgeAssgnmt2.jpg|500x306px]] ==How to find articles for which you are assigned for?== Assignments for the current user can be viewed on a special page (Special:PageAssignments) On the next images you can see where you can find on which articles you are assigned. Go to the upper right corner, click on your name, and choose "assignments". ::: [[File:PgeAssgnmt3.jpg|500x306px]] You will see all assigned articles, as on this image below. ::: [[File:Assig2.png|500x296px]] ==Setting permissions for assigned users== <span style="color: #000000;">Go to "GlobalActions" and go "Preferences" (Admin rights necessary)<br /></span> ::: [[File:PgeAssgnmt4.jpg|500x302px]] ::: [[File:PgeAssgnmt5.jpg|500x254px]] Click on "Preferences" and you should get: ::: [[File:Pref1.png|500x320px]] Look for "PageAssignments": ::: [[File:Pref2.png|500x329px]] <span style="color: #000000;">Here is a combo box with all available settings. You can select here any number of permissions. Click on the permissions you want while holding down CTRL key.</span> ::: [[File:pref3.png|500x329px]] <br /><span style="color: #000000;"> Every user that is assigned to a page will get those permissions in addition to the ones they already have, meaning that these permissions set here are granted to all users that are responsible for one or more articles.</span> ==Summary== * Articles can be assigned to single or multiple users or groups. * These users / groups are informed about all changes to the site. * On each article, it is clearly shown who is responsible for the examination of the content. * A special page provides an overview of all assignments. * Additional permissions to users may be granted. special page on the wiki (Special:PageAssignments) shows a list of all the articles that you are responsible for. [[Category:Extension]]flyout "Page assignments" in the quality management tools. *Users can view their assignments on the page ''Special:PageAssignments''. *Users with ''admin, maintenanceadmin'' or ''reviewer'' rights can manage all assignments on the page ''Special:ManagePageAssignments.'' === Display assignments in the title section === The page assignments can be displayed in the title section of the page. Activate this page assignments display in ''LocalSettings.php'' (or in the php file in the ''d.settings'' folder): $GLOBALS['bsgBlueSpiceCalummaPageHeaderBeforeContentEnabledProviders'] = [ "pageheader-assignments" ]; Set the limit: $GLOBALS['bsgPageAssignmentsPageHeaderLimit'] = 25; === Assign all users (with option to exclude some users) === To activate the option to assign all users to a page, a group ''everyone'' can be created. For this, the following code needs to be set in ''<bluepsice-installationpath>/extensions/BlueSpicePageAssignments/extension.json'':<syntaxhighlight lang="json"> "PageAssignmentsActivatedTypes": { "value": [ "user", "group", "everyone" ] }, </syntaxhighlight>This allows users to add the group everyone to a page assignment. Individual users can be excluded from the assignment by creating the file ''MediaWiki:PageAssignments-everyone-blacklist''. Users can be added to this blacklist with using line breaks. <br /> [[File:pageassignments-blacklist.png|alt=Exclude users from page assignment "everyone"|center|thumb|650x650px|Exclude users from page assignment "everyone"]] }}
(26 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{BSExtensionInfo |
− | |desc=Assigns individual users or whole groups to pages, e.g. as responsible editors | + | |desc=Assigns individual users or whole groups to pages, e.g. as responsible editors. |
|status=stable | |status=stable | ||
|developer=HalloWelt | |developer=HalloWelt | ||
|type=BlueSpice | |type=BlueSpice | ||
− | |edition=BlueSpice free, BlueSpice pro | + | |edition=BlueSpice free, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud |
|active=Yes | |active=Yes | ||
|compatible=BlueSpice | |compatible=BlueSpice | ||
|category=Quality Assurance | |category=Quality Assurance | ||
− | | | + | |license=GPL v3 only |
− | + | |features='''PageAssignments''' allows to assign pages to single users or user groups. Assigned users are notified about assignment changes via email or internal notifications. | |
− | |||
+ | *Assign responsible users to a page. | ||
+ | *Assign individual users or groups. | ||
+ | *The responsible editor(s) for the page can be viewed in the flyout "Page assignments" in the quality management tools. | ||
+ | *Users can view their assignments on the page ''Special:PageAssignments''. | ||
+ | *Users with ''admin, maintenanceadmin'' or ''reviewer'' rights can manage all assignments on the page ''Special:ManagePageAssignments.'' | ||
+ | === Display assignments in the title section === | ||
+ | The page assignments can be displayed in the title section of the page. Activate this page assignments display in ''LocalSettings.php'' (or in the php file in the ''d.settings'' folder): | ||
+ | $GLOBALS['bsgBlueSpiceCalummaPageHeaderBeforeContentEnabledProviders'] = [ "pageheader-assignments" ]; | ||
+ | Set the limit: | ||
+ | $GLOBALS['bsgPageAssignmentsPageHeaderLimit'] = 25; | ||
− | == | + | === Assign all users (with option to exclude some users) === |
− | + | To activate the option to assign all users to a page, a group ''everyone'' can be created. For this, the following code needs to be set in ''<bluepsice-installationpath>/extensions/BlueSpicePageAssignments/extension.json'':<syntaxhighlight lang="json"> | |
− | + | "PageAssignmentsActivatedTypes": { | |
− | + | "value": [ | |
− | + | "user", | |
− | + | "group", | |
− | + | "everyone" | |
− | + | ] | |
− | + | }, | |
− | + | </syntaxhighlight>This allows users to add the group everyone to a page assignment. Individual users can be excluded from the assignment by creating the file ''MediaWiki:PageAssignments-everyone-blacklist''. Users can be added to this blacklist with using line breaks. | |
− | + | <br /> | |
− | + | [[File:pageassignments-blacklist.png|alt=Exclude users from page assignment "everyone"|center|thumb|650x650px|Exclude users from page assignment "everyone"]] | |
− | + | }} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | < | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | < | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− |