← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/man/sample.rst

  • Committer: William Grant
  • Date: 2010-02-03 04:13:06 UTC
  • mto: This revision was merged to the branch mainline in revision 1467.
  • Revision ID: grantw@unimelb.edu.au-20100203041306-mms3mre4r07gxt16
Replace the Packaging document with a general Releases one, and cover both source tarball and Ubuntu package releases.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/sample.rst
45
45
* Creates data directories and subversion repositories for all users, backing
46
46
  up directories for any existing users.
47
47
 
48
 
The script is executed with the following command from the IVLE source
49
 
directory::
 
48
The script is executed with the following command::
50
49
 
51
50
    sudo ivle-loadsampledata examples/db/sample.sql
52
51
 
54
53
   installation. Be sure you wish to do this.
55
54
 
56
55
.. note:: The script may fail at the "dropping database" phase if Apache or
57
 
   another process are using the database. It is best to *restart* (not stop)
58
 
   Apache before executing the script (``sudo /etc/init.d/apache2 restart``).
 
56
   another process are using the database. It is best to stop Apache before
 
57
   executing the script.
59
58
 
60
59
   If the database exists, but is not properly initialised, then the script
61
60
   may fail. In this case, you should manually run ``ivle-mountallusers -u``,
112
111
 
113
112
* admin/password: This user has administrative rights over the entire system.
114
113
* lecturer/password: This is a normal user, but is enrolled as a lecturer in
115
 
  ivle-101 (2009 semester 1) and ivle-102 (2009 semester 2).
 
114
  100101 (2009 semester 1) and 100102 (2009 semester 2).
116
115
* tutor/password: This is a normal user, but is enrolled as a tutor in
117
 
  ivle-102 (2009 semester 2).
118
 
* studenta/password: This is a normal user, enrolled in ivle-101 (2009
119
 
  semester 1) and ivle-102 (2009 semester 2).
120
 
* studentb/password: This is a normal user, enrolled in ivle-102 (2009
121
 
  semester 2). This student has not yet accepted the Terms of Service, so does
122
 
  not have a jail created, etc.
 
116
  100102 (2009 semester 2).
 
117
* studenta/password: This is a normal user, enrolled in 100101 (2009 semester
 
118
  1) and 100102 (2009 semester 2).
 
119
* studentb/password: This is a normal user, enrolled in 100102 (2009 semester
 
120
  2). This student has not yet accepted the Terms of Service, so does not have
 
121
  a jail created, etc.
123
122
 
124
123
.. note:: For the first three users, the Subversion password is also
125
124
   "password". This means it is possible to access their SVN repository
137
136
directories must be checked out (using the Checkout button) before the files
138
137
can be seen from the IVLE application.
139
138
 
140
 
* :file:`stuff/Welcome to IVLE.html`: A simple web page, which can be
141
 
  displayed with the "Serve" command.
142
 
* :file:`stuff/hello.py`: A simple Python script, which can be executed with
143
 
  the "Serve" command. This file has a few edits in its revision history.
144
 
* :file:`ivle-102/mywork/phase1.html`: A file for a student's project
145
 
  submission.
146
 
* :file:`group1/phase2.html`: A file for a group project submission. This
147
 
  contains edits by both studenta and studentb, and is also accessible if
148
 
  logged in as studentb.
 
139
* In the :file:`stuff` directory is a sample file, :file:`hello.py`. This is a
 
140
  simple Python script, which can be executed with the "Serve" command.
149
141
 
150
142
Projects
151
143
--------
152
144
 
153
 
The subject ivle-102 (2009 semester 2) has two project sets and three
154
 
projects. This demonstrates the relationship between project sets and
155
 
projects.
 
145
The subject 100102 has two project sets and three projects. This demonstrates
 
146
the relationship between project sets and projects.
156
147
 
157
148
The first project set is a solo project set (every student works by
158
149
themselves on all projects). It has one project in it.
162
153
two projects in it, demonstrating that the students get to keep their group
163
154
(including all of the group files) across the two projects in this set.
164
155
 
165
 
Projects 1 and 2 have their due date set in the year 3009, so they will always
166
 
be submittable. Project 3 was due in 2009, so it has already closed.
167
 
 
168
156
Finally, there is a single group for projects 2 and 3, which has the students
169
157
studenta and studentb enlisted.
170
158
 
 
159
Worksheets
 
160
----------
 
161
 
 
162
There are not yet any worksheets.
 
163
 
171
164
Exercises
172
165
---------
173
166
 
174
 
There are two sample exercises, ``hello``, which prompts the user to write
175
 
a simple Hello world program, and ``factorial``, which prompts the user to
 
167
There is currently a single exercise, ``factorial``, which prompts the user to
176
168
write a factorial function and tests its correctness.
177
169
 
178
 
Both exercises have realistic test suites, taking advantage of most of the
179
 
features of the IVLE exercise testing framework. For example, ``hello`` uses a
180
 
regular expression to test whether the user has got it almost right, and gives
181
 
them encouraging feedback.
182
 
 
183
 
Worksheets
184
 
----------
185
 
 
186
 
There is currently a single worksheet in the subject ivle-102 (2009 semester
187
 
2). It embeds the exercises ``hello`` and ``factorial``.
188
 
 
189
170
Updating the sample data
190
171
========================
191
172
 
199
180
Then check the diff. You may hand-edit the SQL file, but only for the purpose
200
181
of fixing up unsightly data -- it should be possible to reload from the script
201
182
and re-export with no diff.
202
 
 
203
 
If the contents of the Subversion repositories have changed, run this
204
 
command::
205
 
 
206
 
    svnadmin dump /var/lib/ivle/svn/repositories/<repo> > examples/userrepos/<dumpfile>