← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to doc/man/roles.rst

  • Committer: William Grant
  • Date: 2010-02-17 08:57:40 UTC
  • Revision ID: grantw@unimelb.edu.au-20100217085740-3atwitguxi3ukx2l
Add a Projects breadcrumb.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/roles.rst
 
1
.. IVLE - Informatics Virtual Learning Environment
 
2
   Copyright (C) 2007-2009 The University of Melbourne
 
3
 
 
4
.. This program is free software; you can redistribute it and/or modify
 
5
   it under the terms of the GNU General Public License as published by
 
6
   the Free Software Foundation; either version 2 of the License, or
 
7
   (at your option) any later version.
 
8
 
 
9
.. This program is distributed in the hope that it will be useful,
 
10
   but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
   GNU General Public License for more details.
 
13
 
 
14
.. You should have received a copy of the GNU General Public License
 
15
   along with this program; if not, write to the Free Software
 
16
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
17
 
 
18
.. _ref-user-roles:
 
19
 
 
20
**********
 
21
User roles
 
22
**********
 
23
 
 
24
IVLE users can be given roles, giving them additional power in the system. The
 
25
roles are centered around a typical university teaching structure, with
 
26
tutors, lecturers and system administrators.
 
27
 
 
28
This page lists precisely what is permitted by each role.
 
29
 
 
30
Note that the roles are hierarchical. Being a member of a role implies all of
 
31
the powers of lesser roles.
 
32
 
 
33
Most roles are *per-offering*, which means the user only has the powers of
 
34
that role when dealing with a specific offering of a subject. (For example, a
 
35
lecturer of subject "ivle-101" for 2009 semester 1 is just an ordinary user
 
36
with respect to any other subject, or any other offering of "ivle-101").
 
37
 
 
38
Ordinary users
 
39
--------------
 
40
 
 
41
This is the default role for any user. Note that we do not refer to "ordinary
 
42
users" as "students", because "student" implies an enrolment in a particular
 
43
offering.
 
44
 
 
45
All users have the ability to:
 
46
 
 
47
* Store and edit files in the file system,
 
48
* Execute Python code in the Python console,
 
49
* Serve files privately and publicly,
 
50
* View and edit some of their own details (e.g., can edit display name, but
 
51
  not full name, which is required to be the user's formal name).
 
52
 
 
53
Students
 
54
--------
 
55
 
 
56
The role of "student" is offering-specific. Any user enrolled in an offering
 
57
is a "student" in that offering.
 
58
 
 
59
In addition to the abilities of ordinary users, students have the ability to:
 
60
 
 
61
* View the "subject page" for the offering,
 
62
* View any worksheet in the offering, and its exercises,
 
63
* Submit attempts at any exercise in any worksheet in the offering,
 
64
* Receive a mark for worksheet completion in the offering,
 
65
* Submit a solo project for the offering,
 
66
* Submit a group project for the offering, on behalf of any group they are in.
 
67
 
 
68
Tutors
 
69
------
 
70
 
 
71
The role of "tutor" is offering-specific. Users may be enrolled in an offering
 
72
as "tutor" by a lecturer or admin.
 
73
 
 
74
In addition to the abilities of students, tutors have the ability to:
 
75
 
 
76
* View submissions to projects in the offering,
 
77
* Check out (with an external Subversion client) the part of a student or
 
78
  group's Subversion repository which was submitted to a project in the
 
79
  offering,
 
80
* Enrol a user in the offering as a student, if the system administrator has
 
81
  allowed it (see ``tutors_can_enrol_students`` under
 
82
  :ref:`policy configuration <ref-configuration-policy>`). This is
 
83
  **disabled** by default,
 
84
* Create and edit worksheets for the offering, if the system administrator has
 
85
  allowed it (see ``tutors_can_edit_worksheets`` under
 
86
  :ref:`policy configuration <ref-configuration-policy>`). This is **enabled**
 
87
  by default,
 
88
* Create and edit exercises *for any offering* (as exercises are not
 
89
  offering-specific), if the system administrator has allowed it (see
 
90
  ``tutors_can_edit_worksheets`` under :ref:`policy configuration
 
91
  <ref-configuration-policy>`). This is **enabled** by default.
 
92
 
 
93
Lecturers
 
94
---------
 
95
 
 
96
The role of "lecturer" is offering-specific. Users may be enrolled in an
 
97
offering as "lecturer" by an admin.
 
98
 
 
99
In addition to the abilities of tutors, lecturers have the ability to:
 
100
 
 
101
* Enrol a user in the offering, as a student or tutor,
 
102
* Create and edit worksheets for the offering
 
103
* Create and edit exercises *for any offering* (as exercises are not
 
104
  offering-specific),
 
105
* Edit the details of the offering (such as description and URL),
 
106
* Create and edit projects and project sets for the offering,
 
107
* Create project groups, and add/remove students from them.
 
108
 
 
109
Admins
 
110
------
 
111
 
 
112
The ultimate role is "admin". This is a site-wide role (it is not specific to
 
113
any offering).
 
114
 
 
115
Admins have the ability to:
 
116
 
 
117
* Do anything a lecturer can do in any offering,
 
118
* See stack traces when IVLE generates an internal server error (normal users
 
119
  see a generic error page),
 
120
* See a list of all users in the system,
 
121
* View and edit all details for all users, including "fixed" fields such as
 
122
  full name, and change any user's password without knowing the old one,
 
123
* Enrol a user as a lecturer in any offering,
 
124
* Upgrade any user to admin status, or revoke admin status,
 
125
* Disable (ban) any user from accessing the system at all, or enable a user,
 
126
* See a list of all subjects and offerings in the system,
 
127
* Create new subjects and offerings,
 
128
* Edit the details of any subject (nb: not just an offering),
 
129
* Create new semesters,
 
130
* Change which subject/semester an offering is bound to.