← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/man/tour.rst

  • Committer: Matt Giuca
  • Date: 2010-02-24 05:44:14 UTC
  • Revision ID: matt.giuca@gmail.com-20100224054414-6nfrqpm2yegop1zc
doc/man/tour: Added more tour for admins. Now shows how to create and edit subjects and offerings, and how to manage semesters.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/tour.rst
267
267
for technical reasons, admins cannot read or write other users' files. This
268
268
requires root access on the machine IVLE is installed on.
269
269
 
270
 
Firstly, pull down the IVLE menu (top-left). There is an additional item for
 
270
Administering users
 
271
-------------------
 
272
 
 
273
Firstle, pull down the IVLE menu (top-left). There is an additional item for
271
274
admins -- the "Users" page. This lists all users with an account in IVLE.
272
275
Clicking on a username takes you to the user's profile page. Try it with the
273
276
user 'lecturer'.
286
289
   Use this with care. Making a user an admin gives them complete control over
287
290
   the system. They could even revoke *your* admin rights!
288
291
 
289
 
Admin users also enjoy the same privileges as lecturers, for all subjects on
290
 
the system. In addition, admins can enrol users in a subject as lecturers
291
 
(this is the only way to become a lecturer), and change or delete a lecturer's
292
 
enrolment. Go to the subject page for "Advanced IVLE" and enrol the user
293
 
"lecturer" as a Lecturer in the subject.
 
292
Administering subjects and offerings
 
293
------------------------------------
 
294
 
 
295
Admin users also enjoy the same privileges as lecturers, for all subject
 
296
offerings on the system. In addition, admins can enrol users in an offering as
 
297
lecturers (this is the only way to become a lecturer), and change or delete a
 
298
lecturer's enrolment. Go to the subject page for "Advanced IVLE" and enrol the
 
299
user "lecturer" as a Lecturer in the subject.
 
300
 
 
301
Admins can also administer subjects. Here it is important to distinguish
 
302
between a "subject" (a course on a specific topic which is repeated over a
 
303
number of semesters or years) and an "offering" (a particular instance of a
 
304
subject, for one semester). Lecturers can administer *offerings* they are
 
305
enrolled in, but not *subjects*.
 
306
 
 
307
As an admin, go to the "Subjects" page. You will see a link "Manage subjects
 
308
and semesters". The list at the top of the page shows all registered
 
309
subjects. Click "Create new subject" to create a brand new subject (i.e., a
 
310
new course). Call it "Introduction to Programming", with the URL name
 
311
"intro-prog" and subject code 200101.
 
312
 
 
313
Now we have created a *subject* but not an *offering*, so nobody will be able
 
314
to teach or enrol in this subject. From the "Introduction to Programming"
 
315
page, click "Create new offering". Select the semester in which the subject
 
316
will be first taught. If you wish to create the first offering of a semester
 
317
(e.g., 2011 semester 1), you will have to create a new semester first. Type
 
318
in a subject description. (Note that each offering has an independent
 
319
description.) Once you have created an offering, you can enrol lecturers, and
 
320
they can in turn enrol students.
 
321
 
 
322
Lecturers can take over administration duties of an offering (such as editing
 
323
the description and managing projects), however it remains the admin's duty to
 
324
administer the subjects, including creating new offerings each semester and
 
325
enrolling lecturers.
 
326
 
 
327
Administering semesters
 
328
-----------------------
 
329
 
 
330
An important duty of the administrator is controlling the *state* of each
 
331
semester. Return to the "Manage subjects and semesters" page. Note the
 
332
"Semesters" table contains a list of all known semesters, and whether they are
 
333
"past", "current" or "future".
 
334
 
 
335
.. note::
 
336
   IVLE could automatically create and manage semesters based on the system
 
337
   clock, but it presently does not. That is because your institution may have
 
338
   a different concept of a "semester" to ours. (For example, what are the
 
339
   semester start and end dates?) IVLE has therefore been designed to require
 
340
   admins to manually activate new semesters and disable old ones.
 
341
 
 
342
In the sample data, 2009 semester 2 is the "current" semester. Let us assume
 
343
that we are moving into the start of 2010. Edit 2009 semester 2 and set its
 
344
state to "Past". Then, edit 2010 semester 1 and set its state to "Current".
 
345
This affects the system in several ways. Mainly, it just changes the UI for
 
346
all users, in terms of which offerings are presented as "current".
 
347
 
 
348
.. warning::
 
349
   Marking a semester as anything other than "current" will make it impossible
 
350
   for students enrolled in offerings for that semester to submit projects.
 
351
   Only do this after the semester has fully closed.
 
352
 
 
353
It is possible for multiple semesters to be marked as "current", if this is
 
354
desired. Therefore, there is no need to disable one semester before enabling
 
355
another.
294
356
 
295
357
Admin scripts
296
358
-------------