*** empty log message ***

svn path=/trunk/boinc/; revision=8864

doc/boinc_news.inc

@@ -2,6 +2,15 @@
 
 $project_news = array(
 
+array("November 15, 2005",
+    "<a href=stats.php>Aggregate credit data</a>
+    (user and host credit data summed over all BOINC projects)
+    is now available in XML format.
+    This data can be used for applications
+    (like the 'Featured participant' above)
+    that reflect overall contribution to BOINC project.
+    "
+),
 array("November 1, 2005",
     "IBM's <a href=http://www.worldcommunitygrid.org/>World Community Grid</a>
     has launched a BOINC-based project (currenly Linux only)."
@@ -11,7 +20,7 @@ array("October 28, 2005",
     in a <a href=http://www.enterpriseleadership.org/listen/podcast-anderson>podcast at www.enterpriseleadership.org</a>."
 ),
 array("October 20, 2005",
-    "Version 5.2.2 of the BOINC client software has been release.
+    "Version 5.2.2 of the BOINC client software has been released.
     It includes a simpler registration procedure,
     security enhancements, and numerous other improvements."
 ),

doc/create_project.php

@@ -142,6 +142,7 @@ Communicating with participants via the web
 Miscellaneous
 </b></font>
 <ul>
+<li> <a href=db_dump.php#task>Export credit data as XML</a>
 <li> <a href=grid.php>Integrating BOINC projects with Grids</a>
 <li> <a href=gui_urls.php>Add project-specific buttons to the client GUI</a>
 </ul>

doc/db_dump.php

@@ -126,65 +126,22 @@ htmlspecialchars("
   <host_cpid>e129b5fa44ed8ba58e41c472822f2807</host_cpid>
 </host>
 "),"</pre>
-<hr>
+<a name=task>
-NOTE: YOU CAN IGNORE THE FOLLOWING;
+<h2>Exporting statistics data</h2>
-ALL PROJECTS EXPORT THE SAME INFO NOW.
 <p>
-A project can decide what data to export,
+Projects: to export statistics data, include an entry like
-and how it is divided into files.
+".html_text("
-This is described by a file <b>db_dump.xml</b> of the following form:
+    <tasks>
+        <task>
+            <cmd>db_dump -d 2 -dump_spec ../db_dump_spec.xml</cmd>
+            <output>db_dump.out</output>
+            <period>24 hours</period>
+        </task>
+    </tasks>
+")."
+in your config.xml file.
+Make sure the file db_dump_spec.xml is in your project's
+root directory.
 ";
-echo html_text("
-<boinc_db_dump_spec>
-  <enumeration>
-    <table>x</table>
-    <filename>x</filename>
-    <sort>x</sort>
-    <output>
-      <recs_per_file>n</recs_per_file>
-      <detail/>
-      <compression>x</compression>
-    </output>
-    ...
-  </enumeration>
-  ...
-</boinc_db_dump_spec>
-");
-echo "
-An 'enumeration' is a listing of particular table.
-The fields are:
-";
-list_start();
-list_item("table", "'user', 'host' or 'team'");
-list_item("filename", "The base filename.");
-list_item("sort", "The sorting criterion:
-    'total_credit', 'expavg_credit', or 'id'.
-    'id' is the default."
-);
-list_end();
-echo
-"An 'output' is a file or set of files containing an enumeration.
-The fields are:";
-list_start();
-list_item("recs_per_file",
-    "If present, the listing is divided into multiple files
-    with the given number of records per file.
-    The file names have the form xxx_N,
-    where xxx is the base filename.
-    For views that are ordered by ID,
-    each file contains a fixed-size segment of the ID range,
-    not a fixed number of records.
-    If the database ID allocation has gaps,
-    files will have fewer than this number of records.
-    <p>
-    If zero or absent,
-    the listing is written to a single file."
-);
-list_item("detail",
-    "If present, records are 'detailed':
-    user records include a list of hosts,
-    and team records include a list of users."
-);
-list_end();
 page_tail();
 ?>

doc/download.php

@@ -212,7 +212,7 @@ if ($xml) {
         <p>
         Download information can be restricted by
         platform and/or version number, 
-        and can be down in XML format.
+        and can be obtained in XML format.
         <a href=download_info.php>Details</a>.
     ";
     page_tail();

doc/web_rpc.php

@@ -5,6 +5,13 @@ page_head("Web Remote Procedure Calls (RPCs)");
 
 echo "
 <p>
+BOINC projects export a number of Web RPCs
+that can be used to create, query and update
+accounts and host records.
+These can be used for
+<a href=acct_mgt.php>account management systems</a> and
+credit statistics web sites.
+<p>
 BOINC's RPC mechanisms have the following conventions:
 <ul>
 <li> Each RPC is an HTTP GET transaction.
@@ -18,11 +25,6 @@ and val1 ... valn are the values.
 The output is XML.
 </ul>
 
-<h2>Account creation</h2>
-<p>
-The following RPCs are used to create accounts,
-typically as part of an
-<a href=acct_mgt.php>Account Management System</a>.
 <h3>Create account</h3>
 ";
 
@@ -56,7 +58,32 @@ list_item(
 list_end();
 
 echo "
-<h2>Query/modify existing account</h2>
+<h3>Look up account</h3>
+";
+list_start();
+list_item("URL", "project_url/lookup_account.php");
+list_item(
+    "input",
+        "email_addr: email address
+        <br>passwd_hash: the MD5 hash of the concatenation
+        of the user's password and the email address.
+");
+list_item(
+    "output",
+    html_text("<account_out>
+    [ <error_num>N</error_num> ]
+    [ <authenticator>XXX</authenticator> ]
+</account_out>
+    ")
+);
+list_item(
+    "action",
+    "If an account with the given email address and password hash exists,
+    return its account key."
+);
+
+list_end();
+echo "
 <h3>Get account info</h3>
 ";