Changes between Version 16 and Version 17 of BossaExampleOne

Timestamp:

Jul 21, 2008, 3:11:53 PM (17 years ago)

Author:

davea

Comment:

--

BossaExampleOne

@@ -20 +20 @@
 == Example application ==
 
-We'll create an application in which volunteers view images,
+We'll create an application in which volunteers view synthetic images,
 looking for ellipses on a noisy background.
 Their task is to click on the center of the ellipse,
@@ -28 +28 @@
 [[Image(bossa_test.png, nolink)]]
 
-(this has an ellipse slightly below/left of center).
+(there's an ellipse slightly below/left of center).
 
 Visit http://a.b.c/test_ops/bossa_ops.php,
@@ -35 +35 @@
 The application is define by three scripts in ~/projects/test/html/:
 
- * '''ops/bossa_example_make_files.php''': this creates image files.
- * '''ops/bossa_example_make_jobs.php''': this creates jobs.
- * '''inc/bossa_example.inc''': display jobs and handle completed jobs.
+ * '''ops/bossa_example_make_files.php''': a script that creates image files.
+ * '''ops/bossa_example_make_jobs.php''': a script that creates jobs.
+ * '''inc/bossa_example.inc''': display and policy functions.
 
 We'll go through these scripts and explain how they work.
@@ -44 +44 @@
 == Creating jobs ==
 
-To create some jobs, first we'll create some image files using the script
+First we'll create some image files using the script
 [source:/trunk/boinc/html/ops/bossa_example_make_files.php html/ops/bossa_example_make_files.php].
 
@@ -60 +60 @@
 
 Now, create jobs using
-[source:/trunk/boinc/html/ops/bossa_example_make_jobs.php html/ops/bossa_example_make_jobs.php].
+[source:/trunk/boinc/html/ops/bossa_example_make_jobs.php html/ops/bossa_example_make_jobs.php]:
 {{{
 php bossa_example_make_jobs --app_name bossa_example --dir example
@@ -68 +68 @@
 and collects them into a "batch".
 
-== Displaying jobs ==
+== Display and policy functions ==
 
-The application is described by a PHP file ([source:/trunk/boinc/html/inc/bossa_example.inchtml/inc/bossa_example.inc])
-that contains several functions.
-
-The first of these displays a job:
+The file ([source:/trunk/boinc/html/inc/bossa_example.inc html/inc/bossa_example.inc])
+contains display and policy functions.
+The display function is:
 {{{
 function job_show($job, $inst, $user) {
@@ -93 +92 @@
 }}}
 
-The second is called when a job is issued:
+The policy functions are as follows.
 
 {{{
@@ -101 +100 @@
 }}}
 
+This is called when a job is issued.
 It sets the job's priority to zero so that no further instances will be issued
 (unless this one times) out.
 
-The next function is called when a job instance is finished.
-It gets the user's response to the job,
-and stores it in the instance's app data field.
 {{{
 function job_finished($job, $inst) {
@@ -121 +118 @@
 }}}
 
-The next function is called when a job times out.
-It restores the priority to one so that the job will
-be issued to another volunteer.
+This is called when a job instance is finished.
+It gets the user's response to the job,
+and stores it in the instance's app data field.
+
 {{{
 function job_timed_out($job, $inst, $user) {
@@ -129 +127 @@
 }
 }}}
+This is called when a job times out.
+It restores the priority to one so that the job will
+be issued to another volunteer.
 
 The remaining functions return short strings
-that show the app data for jobs, instances, and users
-on the Admin page:
+that show the app data for jobs, instances, and users on the Admin page:
 {{{
 function job_summary($job) {