Commit 74bab258 authored by Kristina Hoeppner's avatar Kristina Hoeppner
Browse files

Update the "Groups" section in the site admin area

Update information, screenshots and add Mahara 1.5
features
parent df01811d
......@@ -8,42 +8,77 @@
Groups
----------------
*Site administration -> Groups*
In the *Groups* menu of the *Site administration* you can:
* add administrators to groups
* delete groups
* manage group categories
Overview
~~~~~~~~~~~~~~~~
Administer groups
~~~~~~~~~~~~~~~~~~~
*Site administration -> Groups -> Administer groups*
You see an overview of all the groups on the site.
.. figure:: /images/site_admin/groups_administer.*
:alt: Administer groups
The first page you see when you click on the *Groups* menu is the *Administer Groups* page.
Administer groups
#. Search a group by its name or category.
#. Group name. The table is sorted alphabetically according to the group names.
#. Number of group members
#. Number of group administrators
#. Group type
#. Group category
#. Visibility
#. **Group name**: The table is sorted alphabetically according to the group names.
#. **Members**: Number of group members in each individual group.
#. **Admins**: Number of group administrators per group.
#. **Group type**: Overview of whether and how users can join this group.
#. **Group category**: Display of the group category that is associated with this group.
#. **Visibility**: Overview of who has access to this group - members or the public.
#. Click the *Manage* button |manage| to add or remove group administrators.
#. Click the *Delete* button |delete| to delete a group.
Add / remove group administrators
.. warning::
When you delete a group all its content - forum posts, files and pages - will be deleted permanently and cannot be restored.
Manage a group
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can add to or remove administrators from a group by clicking on the *Manage* button |manage| on the *Administer Groups* page.
You can change the file quota and the administrators for a group.
.. index::
pair: Group file quota update; New in Mahara 1.5
|new15| Group file quota
^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can :ref:`specify a default group file quota <plugin_file>` in *Plugins*. This allows you to limit the file space that each group can take up.
.. figure:: /images/site_admin/groups_quota.*
:alt: Change the group file quota
Change the group file quota
You get to this page by clicking on the *Manage* button |manage| next to a group on the *Administer groups* page.
#. **File quota**: Change the file quota that his particular group can have.
#. Click the *Save* button to save your change.
Add or remove administrators
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Add to or remove administrators from a group by clicking on the *Manage* button |manage| next to a group on the *Administer groups* page.
.. figure:: /images/site_admin/groups_admins.*
:alt: Add or remove group administrators
Add or remove group administrators
#. From the list under **Potential Admins**, select the group members you wish to make group administrators. You can also select multiple users at once using Ctrl and Shift click.
#. If you have too many users on your site and you cannot see / find the user you want, you can search for him in the **Search** box.
#. Add the potential administrator to the right-hand side - **Current Admins** - by clicking on the *right-arrow* button |right-arrow|.
#. If you want to remove an existing or accidentally added group administrator, you can remove him from the list on the right-hand side by clicking on him.
#. Then click on the *left-arrow* button |left-arrow|, and he is removed from the list.
#. From the list under **Potential admins**, select the users you wish to make group administrators. You can also select multiple users at once using Ctrl and Shift click.
#. If you have too many users on your and you cannot see / find the person you want, you can search for the user in the **Search** box.
#. Add the potential administrator to the right-hand side - **Current admins** - by clicking on the *right-arrow* button |right-arrow|.
#. If you want to remove an existing or accidentally added group administrator, you can remove the user from the list on the right-hand side by clicking on the name.
#. Then click on the *left-arrow* button |left-arrow|, and he user is removed from the list.
#. When you have chosen all members you wish to make group administrators, click the *Save* button.
.. _group_categories:
......@@ -51,20 +86,137 @@ You can add to or remove administrators from a group by clicking on the *Manage*
Manage group categories
~~~~~~~~~~~~~~~~~~~~~~~~~~
Group categories help you to filter your groups more easily on the *My groups* and *Find groups* pages. A group administrator can always assign one group category to a group if categories are enabled.
*Site administration -> Groups -> Group categories*
Site administrators can manage group categories on the *Group Categories* page under *Groups* in the *Site Administration*.
Group categories help you to filter your groups more easily on the *My groups* and *Find groups* pages. A group administrator can always assign one group category to a group if categories are enabled.
.. figure:: /images/site_admin/groups_categories.*
:alt: Manage group categories
Manage group categories
#. Enable group categories for the entire site by placing a checkmark into the check box and then click the *Submit* button.
#. Enable group categories for the entire site by placing a check mark into the check box and then click on the *Submit* button.
#. Existing group categories are listed.
#. Create a new group category by typing its name and then clicking on the *Add* button.
#. Edit a group category name by clicking on the *Edit* button |edit|, change the name and then click on the *Update* button. If you want to abort the action, click on the *Cancel* button.
#. Click on the *Delete* button |delete| to permanently delete a group.
#. Click on the *Delete* button |delete| to permanently delete this group category.
.. note::
Group categories are not hierarchical and are available to everybody on the site. Any user who can create groups can assign a group category when the feature has been enabled.
.. index::
pair: Add groups by CSV; New in Mahara 1.5
pair: Update groups by CSV; New in Mahara 1.5
.. _groups_csv_add:
|new15| Add and update groups by CSV
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Site administration -> Groups -> Add groups by CSV*
You can create multiple groups at once by uploading basic information about them via a CSV file.
.. figure:: /images/site_admin/groups_csv_add.*
:alt: Add and update groups by CSV
Add and update groups by CSV
#. Create a CSV file that contains at a minimum the fields ``shortname,displayname,roles``.
#. **Institution**: Choose the institution for which you want to create the groups. This is just for internal administrative purposes so that institution administrators do not overwrite each other's groups.
#. **CSV file**: Choose the CSV file from your computer that contains the groups.
#. **Update groups**: Place a check mark in this box if you are updating already existing groups.
#. Click the *Add groups by CSV* button to make the changes.
Here is a full list of all the possible fields that you can specify:
* **controlled** - Group administrators can add users to the group without their consent, and members cannot leave the group.
* **description** - Brief description about the purpose of this group.
* **displayname** - The group name that appears around the site.
* **editroles** - You can choose which roles will be allowed to create and edit pages owned by the group. If your group contains only members and admins, then "Group admins" and "Everyone except members" are identical. These edit permissions will also be used by default for new group files. Permissions can be changed on individual files in the group files area.
* all: everyone in the group
* notmembers: everyone except members in a course group that has tutors and admins
* admin: only group admins
* **hidden** - Choose to list this group on the *Find groups* page.
* **hidemembers** - Choose to hide group members from non-members.
* **hidemembersfrommembers** - Choose to hide group members from everybody but the group admin.
* **invitefriends** - Choose to allow group members to invite their friends to the group.
* **open** - Allow users to join the group without approval from the group admin.
* **public** - Allow people who are not logged in to view this group including the forums.
* **quota** - Define the group file quota.
* **request** - Allow users to send membership requests to group administrators.
* **roles** - Choose to have a course or standard group. The roles in these group types are:
* course: member, tutor, admin
* standard: member, admin
* **shortname** - This is the name used to identify this group in the database. This should be only one word. It is also used to identify the group when you :ref:`add or update its members by CSV <groups_update_members>`.
* **submitpages** - Choose to allow the submission of pages to this group. If you create a course group, this setting is automatically chosen.
* **suggestfriends** - Allow group members to send their friends a recommendation to join this group.
* **usersautoadded** - Choose to have all new users on the site added to the group automatically.
For fields that require a Yes / No value, you need to put a numeric value into the CSV file:
* No = 0
* Yes = 1
.. figure:: /images/site_admin/groups_csv.*
:alt: Sample CSV file for a group upload
Sample CSV file for a group upload
When you look at your CSV file in a text editor and not a spreadsheet software, the above sample file looks like this:
| ``"shortname","displayname","roles","usersautoadded","public","hidemembersfrommembers"``
| ``"public","Public group","standard",0,1,1``
| ``"course","Course group","course",1,0,0``
.. warning::
Do not delete this CSV file if you intend to make changes to your groups in bulk or if you want to add group members in bulk to these groups. There is no easy way to retrieve the group shortname unless you consult the database on the backend of Mahara.
.. index::
pair: Update group members by CSV; New in Mahara 1.5
.. _groups_update_members:
|new15| Update group members by CSV
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Site administration -> Groups -> Update group members by CSV*
You can easily update members of :ref:`groups that you have created via a CSV file <groups_csv_add>`.
.. figure:: /images/site_admin/groups_update_members.*
:alt: Update group members by CSV
Update group members by CSV
#. Create a CSV file that contains the following fields: ``shortname,username,role`` in the first row. Then add groups and users that should become members of these groups. You can check their usernames on the :ref:`User search <user_search>` page.
#. **Institution**: Choose the institution in which the groups were created.
#. **CSV file**: Choose the CSV file from your computer that contains the group members mapped to groups.
#. Click the *Update group members by CSV* button to add to or remove members from the groups that you have specified.
.. warning::
If you manually added users to a group whose members you want to update via CSV file, these users will be removed from that group when you update the group membership and do not have them listed in the CSV file. Thus, be careful once you have added users manually.
.. note::
You can only update group membership by CSV of users who belong to the institution in which you created the groups by CSV. All other users must be added manually.
.. figure:: /images/site_admin/groups_csv_members.*
:alt: Sample CSV file for updating group membership
Sample CSV file for updating group membership
When you look at your CSV file in a text editor and not a spreadsheet software, the above sample file looks like this:
| ``"shortname","username","role"``
| ``"public","petra","admin"``
| ``"public","paula","member"``
| ``"course","petra","admin"``
| ``"course","percy","tutor"``
| ``"course","paula","member"``
.. note::
Group categories are not hierarchical and are available to everybody on the site. Any user who can create groups can assign a group category.
If you have many groups and could easily lose the overview, create one CSV file per group.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment