Changes between Version 9 and Version 10 of BossaExampleOne

Timestamp:

Feb 12, 2008, 11:36:04 AM (16 years ago)

Author:

davea

Comment:

--

BossaExampleOne

@@ -30 +30 @@
 
 Visit http://a.b.c/test_ops/bossa_ops.php,
-and create an application with short name "ellipse".
+and create an application with short name "bossa_example".
+
+The application is define by three scripts in~/projects/test/html/:
+
+ * '''ops/bossa_example_workgen.php''': this generates more jobs.
+ * '''user/bossa_example_display.php''': show a job, and handle user response.
+ * '''inc/bossa_example_backend.php''': compare and handle completed jobs.
+
+We'll go through these scripts and explain how they work.
+To develop your own Bossa applications you'll need to write corresponding scripts.
 
 == A script to generate jobs ==
 
 First, let's generate some jobs.
-We'll do this with a PHP script, html/ops/bossa_test.php: copy this from
-[source:/trunk/boinc/html/ops/bossa_test.php html/ops/bossa_test.php].
+We'll do this with a PHP script, [source:/trunk/boinc/html/ops/bossa_example_workgen.php html/ops/bossa_example_workgen.php].
 
 The first part of this script is code for generating an image;
@@ -78 +86 @@
 }}}
 
-This function creates one job.
-It does the following:
+This function creates one job, as follows:
 
  * Choose a name for the job, and a name for the corresponding image file.
@@ -119 +126 @@
 looks up the application in the database, and creates some jobs.
 You can invoke this by visiting
-'''http://a.b.c/test_ops/bossa_test.php?make_jobs=10'''.
+'''http://a.b.c/test_ops/bossa_example_workgen.php?make_jobs=10'''
+(or use the link on the http://a.b.c/test_ops/bossa_ops.php).
 
 == Displaying jobs ==
 
-Next we'll need a script that displays a job to a volunteer,
-and handles their response.
-This uses a PHP script, html/user/ellipse_display.php: copy this from
-[source:/trunk/boinc/html/user/bossa_example.php html/user/bossa_example.php].
+Next we'll explain the script that displays a job to a volunteer
+and handles their response: [source:/trunk/boinc/html/user/bossa_example.php bossa_example_display.php].
 {{{
 function show_job($bj, $bji) {
@@ -132 +138 @@
     $img_url = $info.url;
     echo "
-        <form method=get action=ellipse_display.php>
+        <form method=get action=bossa_example_display.php>
         Click on the center of the ellipse.
         If you don't see one, click here:
@@ -166 +172 @@
 }}}
 
-The script calls '''Bossa::script_init()''' to get objects describing
+The script calls '''Bossa::script_init()''' to get PHP objects describing
 the user, the job, and the job instance.
 
@@ -181 +187 @@
 
 Finally, we need to specify how results are handled.
-This is specified in "html/inc/ellipse_handler.inc".
+This is specified in [source:/trunk/boinc/html/inc/bossa_example_backend.inc bossa_example_backend.inc].
 
 This defines two functions, which must have names '''X_compare''' and '''X_handle'''
@@ -188 +194 @@
 The first function compares two instances and decides if they are compatible:
 {{{
-function ellipse_compare($r1, $r2) {
+function bossa_example_compare($r1, $r2) {
     if ($r1->have_ellipse) {
         if ($r2->have_ellipse) {
@@ -208 +214 @@
 i.e. a consensus set has been found:
 {{{
-function ellipse_handle($bj, $c) {
+function bossa_example_handle($bj, $c) {
     $res = $c[0];
     if ($res->have_ellipse) {