← 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-11 03:17:12 UTC
  • Revision ID: matt.giuca@gmail.com-20100211031712-79c74lgh3mj7507s
docs: Tour of IVLE: Added lecturer tour (complete).

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/tour.rst
133
133
A lecturer's view
134
134
=================
135
135
 
136
 
Log into IVLE as a lecturer (username: 'lecturer', password: 'password').
 
136
Log into IVLE as a lecturer (username: 'lecturer', password: 'password'). Many
 
137
of these things are also possible as a tutor (try username: 'tutor', password:
 
138
'password').
 
139
 
 
140
Being a lecturer or tutor is a per-subject privilege, so it only applies to
 
141
certain subjects. All of your special powers are under the subject home for
 
142
the subjects you are a tutor in. Note that everything a lecturer can do, an
 
143
admin can also do, for all subjects in the system.
 
144
 
 
145
Click "Intermediate IVLE - Subject home". From here, you will see largely the
 
146
same view as a student, but with more buttons. "Change details" allows you to
 
147
modify the subject properties. "Enrol users" allows you to add existing IVLE
 
148
users as students or tutors of the subject you are teaching (this is currently
 
149
an irreversible action).
 
150
 
 
151
Managing projects
 
152
-----------------
 
153
 
 
154
Click "Manage projects" to go to the project management screen. Note that the
 
155
3 projects are grouped into "Solo projects" (projects submitted by each
 
156
individual student) and "Group projects". Try adding a new Solo project, by
 
157
clicking on "Add a new project" within that box. The fields should be fairly
 
158
self-explanatory.
137
159
 
138
160
.. warning::
139
 
   To be written.
 
161
   You can't currently edit or delete a project after it has been created.
 
162
 
 
163
Group projects are complicated by what we call "project sets". A "project set"
 
164
is a set of group projects where the student groups are the same throughout.
 
165
For instance, you will see Phase 2 and Phase 3 inside the same project set
 
166
box. This means students will get into groups of 3 to submit Phase 2, and then
 
167
the same group will submit Phase 3.
 
168
 
 
169
Clicking "Manage groups" lets you put students into groups for a given project
 
170
set.
 
171
 
 
172
Click "Add a new project set" and enter a group size of 6. Then, create a
 
173
project in the new set. Each student must get into a new group for each
 
174
project *set*. Note also that the groups will share a Subversion repository
 
175
for all projects in a set, but if you create a new set, the students will have
 
176
to start using a new repository.
 
177
 
 
178
Usually, the hassle of getting into new groups and creating new repositories
 
179
means that you will want to create a single project set for a subject, and
 
180
just partition the projects into solo and group projects.
 
181
 
 
182
Managing worksheets and exercises
 
183
---------------------------------
 
184
 
 
185
Return to the subject home page. Click "Manage worksheets". On this page, you
 
186
will see all of the worksheets for the subject. Here you can edit worksheets,
 
187
add new ones, and re-order them. You can also edit any worksheet from its own
 
188
page.
 
189
 
 
190
To get an idea of what a worksheet looks like in edit mode, click the edit
 
191
action (pencil) next to "Worksheet Basics".
 
192
 
 
193
* The "URL name" is the name of the worksheet as it appears in URLs.
 
194
* The "Assessable" checkbox will make the exercises in the worksheet count
 
195
  towards each student's worksheet mark, if checked. Uncheck it for
 
196
  informational worksheets.
 
197
* The "Format" selection controls the format used to write the worksheet in
 
198
  the box below. Leave it on "reStructuredText" unless you have a reason not
 
199
  to.
 
200
 
 
201
Now, you can edit the worksheet content in reStructuredText. The existing text
 
202
briefly explains this format. See `A ReStruecturedText Primer
 
203
<http://docutils.sourceforge.net/docs/user/rst/quickstart.html>`_ for a full
 
204
guide. Note that the exercises themselves are not in the worksheet. They are
 
205
separate resources, which can be shared across subjects. Exercises can be
 
206
embedded with a line like this::
 
207
 
 
208
 .. exercise:: factorial
 
209
 
 
210
Click "Manage exercises" to see the exercises (in the sample data, just
 
211
"factorial"). An exercise is a very complex thing, due to the fact that it
 
212
runs automated testing on the student code. The details are outside the scope
 
213
of this tour. Hopefully, you can figure out how they work by examining the
 
214
existing "factorial" exercise.
 
215
 
 
216
If you are game enough, create a new worksheet from scratch. If you are
 
217
*really* game, create a new exercise for your worksheet.
140
218
 
141
219
An administrator's view
142
220
=======================