~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-04 07:06:08 UTC
  • Revision ID: matt.giuca@gmail.com-20100204070608-m4jmj0l5m4hy1vm9
Docs: Added 'Tour of IVLE', a quick tour of all IVLE's features from a user's perspective.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.. IVLE - Informatics Virtual Learning Environment
 
2
   Copyright (C) 2007-2010 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
.. _ivle-tour:
 
19
 
 
20
**************
 
21
A tour of IVLE
 
22
**************
 
23
 
 
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.
 
30
 
 
31
We will take the tour in three stages: first as a student, then as a lecturer,
 
32
and finally as an administrator.
 
33
 
 
34
A student's view
 
35
================
 
36
 
 
37
Begin by logging into IVLE as a student (username: 'studenta', password:
 
38
'password').
 
39
 
 
40
Files
 
41
-----
 
42
 
 
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
 
46
the home screen.
 
47
 
 
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.
 
50
 
 
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
 
53
"stuff" directory.
 
54
 
 
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.
 
62
 
 
63
* "Serve" runs Python programs as CGI applications, showing their web output.
 
64
* "Run" runs Python programs as command-line applications.
 
65
 
 
66
Note that you can also use the console at the bottom of the screen as a
 
67
generic Python console, whenever you wish.
 
68
 
 
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.
 
71
 
 
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),
 
78
then commit.
 
79
 
 
80
Submissions
 
81
-----------
 
82
 
 
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
 
86
Project screen.
 
87
 
 
88
Choose to submit to Phase 1, and click Submit Project.
 
89
 
 
90
.. warning::
 
91
   In the current sample data, the project deadline is in the past, so you
 
92
   won't actually be able to submit it.
 
93
 
 
94
If you go into the Intermediate Ivle -> group1 directory, you will be able to
 
95
make a group submission to either Phase 2 or 3 (which are group projects).
 
96
Note that the file here ("phase2.html") was edited by studenta and studentb
 
97
collaboratively, as you can see in the project's revision log.
 
98
 
 
99
Worksheets
 
100
----------
 
101
 
 
102
Click on Intermediate Ivle -> Subject Home from the home screen (or, from the
 
103
IVLE pulldown menu, choose Subjects and select Intermediate Ivle). There is
 
104
one worksheet, Worksheet Basics. Clicking this takes you to the worksheet,
 
105
where students are challenged by Python questions.
 
106
 
 
107
After reading the worksheet, attempt the simple programming question, which is
 
108
to write a factorial program.
 
109
 
 
110
A sample solution follows::
 
111
 
 
112
 def fac(n):
 
113
     if n == 0:
 
114
         return 1
 
115
     else:
 
116
         return n * fac(n-1)
 
117
 
 
118
 def main():
 
119
     f = int(raw_input())
 
120
     print fac(f)
 
121
 
 
122
First, click Submit, and note that the system automatically runs some test
 
123
cases, all of which fail. Now paste the solution to :func:`fac` (but not
 
124
:func:`main`). Clicking Submit again shows some test cases pass, but not all.
 
125
Finally, paste the solution to :func:`main`, and click Submit again. This
 
126
time, you will pass the test.
 
127
 
 
128
Note that you can also click "Run", and it will execute your solution in the
 
129
Python console. This doesn't cost you an "attempt", nor does it run the test
 
130
cases. It just lets you test it out for yourself before making an official
 
131
submission.
 
132
 
 
133
Back on the subject page, you will notice that the exercise appears complete,
 
134
and you have been awarded some marks.
 
135
 
 
136
A lecturer's view
 
137
=================
 
138
 
 
139
Log into IVLE as a lecturer (username: 'lecturer', password: 'password').
 
140
 
 
141
.. warning::
 
142
   To be written.
 
143
 
 
144
An administrator's view
 
145
=======================
 
146
 
 
147
Log into IVLE as an admin (username: 'admin', password: 'password').
 
148
 
 
149
.. warning::
 
150
   To be written.