1
.. IVLE - Informatics Virtual Learning Environment
2
Copyright (C) 2007-2010 The University of Melbourne
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.
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.
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
24
This page is designed to give a brief overview of IVLE, from a users point of
25
view (including administrator and lecturer users). Here we assume that you
26
have :ref:`set up a fresh copy of IVLE <ref-install>` and :ref:`installed the
27
sample data <sample-data>`. This page refers to the sample data specifically.
28
If you are just using an existing installation of IVLE, it might still make a
29
bit of sense, but your mileage may vary.
31
We will take the tour in three stages: first as a student, then as a lecturer,
32
and finally as an administrator.
37
Begin by logging into IVLE as a student (username: ``studenta``, password:
43
You will see the IVLE home screen, which displays the subjects you are
44
enrolled in, and your files for each subject. Along the top is the blue bar
45
which is always visible in IVLE. Clicking the IVLE logo always returns you to
48
The user ``studenta`` is enrolled in several subjects, and has several files
49
already in her Subversion repository, but they aren't immediately accessible.
51
First, click all of the *Checkout* buttons, to check out the Subversion
52
repositories. Now you can explore the sample files, for example, in the
55
Go into the ``stuff`` directory and left-click the file ``hello.py``. This will
56
open the build-in text editor, which lets you modify the file. Along the top,
57
there is a button marked *Serve*. Clicking this will *run* the Python code as
58
a CGI application -- this should open a new window which reads "Hello,
59
world!". You can also click *Run*, which will run the program in the built-in
60
Python console (which pops up from the bottom of the screen). This will be
61
much uglier, printing the CGI output.
63
* *Serve* runs Python programs as CGI applications, showing their web output.
64
* *Run* runs Python programs as command-line applications.
66
Note that you can also use the console at the bottom of the screen as a
67
generic Python console, whenever you wish.
69
You can also serve other files, such as HTML files (try ``Welcome to
70
IVLE.html``). This will just present them as normal web pages.
72
Files also have full Subversion histories. If you click on a file in the file
73
view (such as ``hello.py``), and go to *More Actions ‣ Subversion ‣ View Log*,
74
you will see the history of a file, and be able to "select" then view a "diff"
75
of the file. If you edit a file, you need to commit it (*More Actions ‣
76
Subversion ‣ Commit*). If you create a new file (*More Actions ‣ Directory
77
actions ‣ New file*), you need to add it (*More Actions ‣ Subversion ‣ Add*),
83
This student has already completed a project, and is ready to submit it. Go
84
into the *Intermediate IVLE ‣ mywork* directory. Select ``phase1.html`` and
85
choose *More Actions ‣ Publishing ‣ Submit*. This takes you to the Submit
88
Choose to submit to Phase 1, and click *Submit Project*. You should see a page
89
telling you the submission was successful, with a link to *Verify*. Verify
90
shows you exactly which files were submitted, and their contents at the time
91
of submission (if the files have changed since then, you'll still see the
92
submitted version). You should verify after each submission -- you can verify
93
any submitted project from the subject page.
95
If you go into the *Intermediate IVLE ‣ group1* directory, you will be able
96
to make a group submission to Phase 2 (which is a group project). Note that
97
the Phase 3 submission has already closed.
98
Also note that the file here (``phase2.html``) was edited by studenta and
99
studentb collaboratively, as you can see in the project's revision log.
104
Click on *Intermediate IVLE – Subject Home* from the home screen (or, from
105
the IVLE pulldown menu, choose *Subjects* and select Intermediate IVLE). There
106
is one worksheet, Worksheet Basics. Clicking this takes you to the worksheet,
107
where students are challenged by Python questions.
109
After reading the worksheet, attempt the first simple programming question,
110
which is to write the "Hello world" program.
112
First, click *Submit* without writing any code, and note that the system
113
automatically runs a test case, which fails. Now change the code to be "almost
114
right" (for example, write ``Hello world`` instead of ``Hello, world!``), and
115
press *Submit* again. It will tell you that you almost got it right. In this
116
way, the IVLE test framework can show users that they're on the right track.
117
If you get it exactly right and click *Submit* a third time, you will pass the
120
Note that you can also click *Run*, and it will execute your solution in the
121
Python console. This doesn't cost you an "attempt", nor does it run the test
122
cases. It just lets you test it out for yourself before making an official
125
Back on the subject page, you will notice that the exercise appears complete,
126
and you have been awarded a mark.
128
A sample solution to the second exercise follows::
143
Log into IVLE as a lecturer (username: ``lecturer``, password: ``password``).
144
Many of these things are also possible as a tutor (try username: ``tutor``,
145
password: ``password``).
147
Being a lecturer or tutor is a per-subject privilege, so it only applies to
148
certain subjects. All of your special powers are under the subject home for
149
the subjects you are a tutor in. Note that everything a lecturer can do, an
150
admin can also do, for all subjects in the system.
152
Click *Intermediate IVLE – Subject home* (the one which does not display a
153
semester -- implying the currently active semester). From here, you will see
154
largely the same view as a student, but with more buttons. *Change details*
155
allows you to modify the subject properties. *Administer enrolments* allows
156
you to add existing IVLE users as students or tutors of the subject you are
157
teaching, change the roles of existing members, and revoke enrolments.
162
Click *Manage projects* to go to the project management screen. Note that the
163
3 projects are grouped into "Solo projects" (projects submitted by each
164
individual student) and "Group projects". Try adding a new Solo project, by
165
clicking on *Add a new project* within that box. The fields should be fairly
169
You can't currently edit or delete a project after it has been created.
171
Group projects are complicated by what we call "project sets". A "project set"
172
is a set of group projects where the student groups are the same throughout.
173
For instance, you will see Phase 2 and Phase 3 inside the same project set
174
box. This means students will get into groups of 3 to submit Phase 2, and then
175
the same group will submit Phase 3.
177
Clicking *Manage groups* lets you put students into groups for a given project
180
Click *Add a new project set* and enter a group size of 6. Then, create a
181
project in the new set. Each student must get into a new group for each
182
project *set*. Note also that the groups will share a Subversion repository
183
for all projects in a set, but if you create a new set, the students will have
184
to start using a new repository.
186
Usually, the hassle of getting into new groups and creating new repositories
187
means that you will want to create just two project sets for a subject: one
188
for solo projects, and another for group projects.
193
Lecturers and tutors can view any student or group's project submission, using
194
an external Subversion client. As submissions are really just Subversion
195
commits, you can examine a student's work by simply checking out the correct
196
revision of the repository.
198
From the offering page, click *View submissions* under the project of interest.
199
This takes you to a page which lists the latest submissions from every student
200
(presumably you will just see the submission made by ``studenta`` earlier in
201
this tour). Next to each submission is a command line, beginning with
202
``svn co``. For instance, you might see the line::
204
svn co --username lecturer -r7 http://svn.ivle.localhost/users/studenta/ivle-102/phase1.html
206
Paste this line into a command-line (or, if you use a GUI Subversion client,
207
use the username, revision and URL given). Subversion will likely prompt for a
208
password. For the sample data, this password is ``password``, but in general, it
209
will **not** be your normal IVLE password. You can learn your Subversion
210
password by opening a Console in IVLE and typing::
213
ivle.config.Config()['user_info']['svn_pass']
215
This will check out the student's work into the current directory, to inspect.
217
You can also try to check out the group submission from Phase 2.
220
It is currently not possible to check out a single file (not a directory)
221
submission using the instructions given. Instead, run ``svn cat``, and
222
redirect the output into a file.
224
Managing worksheets and exercises
225
---------------------------------
227
Returning to the subject home page, click *Manage worksheets*. On this page,
228
you will see all of the worksheets for the subject. Here you can edit
229
worksheets, add new ones, and re-order them. You can also edit any worksheet
232
To get an idea of what a worksheet looks like in edit mode, click the edit
233
action (pencil) next to "Worksheet Basics".
235
* The *URL name* is the name of the worksheet as it appears in URLs.
236
* The *Assessable* checkbox will make the exercises in the worksheet count
237
towards each student's worksheet mark, if checked. Uncheck it for
238
informational worksheets.
239
* The *Format* selection controls the format used to write the worksheet in
240
the box below. Leave it on *reStructuredText* unless you have a reason not
243
Now, you can edit the worksheet content in reStructuredText. The existing text
244
briefly explains this format. See `A ReStruecturedText Primer
245
<http://docutils.sourceforge.net/docs/user/rst/quickstart.html>`_ for a full
246
guide. Note that the exercises themselves are not defined in the worksheet.
247
They are separate resources, which can be shared across subjects. Exercises
248
can be embedded with a line like this::
250
.. exercise:: factorial
252
Click *Manage exercises* to see the exercises (in the sample data, just
253
``factorial``). An exercise is a very complex thing, due to the fact that it
254
runs automated testing on the student code. The details are outside the scope
255
of this tour. Hopefully, you can figure out how they work by examining the
256
existing ``factorial`` exercise.
258
If you are game enough, create a new worksheet from scratch. If you are
259
*really* game, create a new exercise for your worksheet.
261
Viewing worksheet marks
262
-----------------------
264
You will probably have already noticed that the lecturer's worksheet view is
265
not quite like the student's. It has a table at the top which shows some
266
statistics about how students in this subject are going with each exercise.
267
(Depending on settings, tutors may also be able to access these stats.)
269
Lecturers (not tutors) can also get more specific feedback on individual
270
students by selecting "View worksheet marks" at the bottom of the subject
271
page. This shows the marks in each worksheet, and in the subject overall, for
272
each student, and can be used to calculate each student's final grade.
274
The "Download as CSV file" link provides these same statistics in CSV format,
275
which can be easily parsed.
277
An administrator's view
278
=======================
280
Log into IVLE as an admin (username: ``admin``, password: ``password``).
282
Administrator users in IVLE have significant privileges. Note, however, that
283
for technical reasons, admins cannot read or write other users' files. This
284
requires root access on the machine IVLE is installed on.
289
Firstly, pull down the IVLE menu (top-left). There is an additional item for
290
admins -- the *Users* page. This lists all users with an account in IVLE.
291
Clicking on a username takes you to the user's profile page. Try it with the
294
The profile page is exactly the same as the user himself would see it, but
295
with a few more buttons on the side. *Change password* is the same as the
296
user's own *Change password* page. However, *Reset password* is a special
297
admin page which lets you change a user's password without knowing the old
298
one. *Administer user* also lets you change administrative settings for the
299
user, such as their full name (more formal than display name, which the user
300
themselves can change) and student ID. You can also add/remove admin status
301
for, or disable/enable (i.e., ban from IVLE) any user (except yourself, of
302
course -- that could be bad).
305
Use this with care. Making a user an admin gives them complete control over
306
the system. They could even revoke *your* admin rights!
308
Administering subjects and offerings
309
------------------------------------
311
Admin users also enjoy the same privileges as lecturers, for all subject
312
offerings on the system. In addition, admins can enrol users in an offering as
313
lecturers (this is the only way to become a lecturer), and change or delete a
314
lecturer's enrolment. Go to the subject page for Advanced IVLE and enrol the
315
user ``lecturer`` as a lecturer in the subject.
317
Admins can also administer subjects. Here it is important to distinguish
318
between a "subject" (a course on a specific topic which is repeated over a
319
number of semesters or years) and an "offering" (a particular instance of a
320
subject, for one semester). Lecturers can administer *offerings* they are
321
enrolled in, but not *subjects*.
323
As an admin, go to the *Subjects* page. You will see a link *Manage subjects
324
and semesters*. The list at the top of the page shows all registered
325
subjects. Click *Create new subject* to create a brand new subject (i.e., a
326
new course). Call it "Introduction to Programming", with the URL name
327
``intro-prog`` and subject code 200101.
329
Now we have created a *subject* but not an *offering*, so nobody will be able
330
to teach or enrol in this subject. From the "Introduction to Programming"
331
page, click *Create new offering*. Select the semester in which the subject
332
will be first taught. If you wish to create the first offering of a semester
333
(e.g., 2011 semester 1), you will have to create a new semester first. Type
334
in a subject description. (Note that each offering has an independent
335
description.) Once you have created an offering, you can enrol lecturers, and
336
they can in turn enrol students.
338
Lecturers can take over administration duties of an offering (such as editing
339
the description and managing projects), however it remains the admin's duty to
340
administer the subjects, including creating new offerings each semester and
343
Administering semesters
344
-----------------------
346
An important duty of the administrator is controlling the *state* of each
347
semester. Return to the *Manage subjects and semesters* page. Note the
348
*Semesters* table contains a list of all known semesters, and whether they are
349
"past", "current" or "future".
352
IVLE could automatically create and manage semesters based on the system
353
clock, but it presently does not. That is because your institution may have
354
a different concept of a "semester" to ours. (For example, what are the
355
semester start and end dates?) IVLE has therefore been designed to require
356
admins to manually activate new semesters and disable old ones.
358
In the sample data, 2009 semester 2 is the "current" semester. Let us assume
359
that we are moving into the start of 2010. Edit 2009 semester 2 and set its
360
state to "Past". Then, edit 2010 semester 1 and set its state to "Current".
361
This affects the system in several ways. Mainly, it just changes the UI for
362
all users, in terms of which offerings are presented as "current".
365
Marking a semester as anything other than "current" will make it impossible
366
for students enrolled in offerings for that semester to submit projects.
367
Only do this after the semester has fully closed.
369
It is possible for multiple semesters to be marked as "current", if this is
370
desired. Therefore, there is no need to disable one semester before enabling
376
Unfortunately, there are still a few tasks which admins need to do which
377
haven't been implemented in the UI for the IVLE web application. These tasks
378
are available as command-line scripts which can be run by someone with root
379
access on the machine IVLE is installed on. They are gradually being migrated
380
over to proper UI features in IVLE itself.
382
Details on these scripts can be found in :ref:`ref-admin-scripts`.
added
removed
doc/man/tour.rst
