Difference between revisions of "Reference:BlueSpicePageAssignments"

(Tag: 2017 source edit)
 
What is PageAssignments?[edit | edit source]
  • 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

    Extension: BlueSpicePageAssignments


    Overview
    Description: Enables you to assign users or groups to 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

    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?[edit | edit source]

    In the right corner, as on image below, you will find the "MORE" menu:

    MoreMenu.jpg

    In the "MORE" menu, you will find "Edit Assignment", as on image below: 

    Edit.jpg

    In there you will find a list of users. You can chose wich user you will assign to this article, as on image below:

    PageAssignment3.png
    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".
    Assign1.jpg

    You will see all assigned articles, as on this image below.

    Assig2.png

    Setting permissions for assigned users[edit | edit source]

    Go to "GlobalActions" and go "Preferences" (Admin rights necessary)

    GlobalActions1.jpg
    GlobalActions2.jpg

    Click on "Preferences" and you should get:

    Pref1.png

    Look for "PageAssignments":

    Pref2.png

    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.

    pref3.png
    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"
    			]
    },
    
                        
    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.


    Exclude users from page assignment "everyone"
    Exclude users from page assignment "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]


    Attachments

    Discussions