From 9eb08dc8d6a8ec0677ccc08ed77d97146d33e3c5 Mon Sep 17 00:00:00 2001
From: David Anderson <davea@ssl.berkeley.edu>
Date: Tue, 8 Nov 2005 03:31:50 +0000
Subject: [PATCH] *** empty log message ***

svn path=/trunk/boinc/; revision=8828
---
 doc/db_dump.php |  35 ++-------------------
 doc/stats.odg   | Bin 9789 -> 9865 bytes
 doc/stats.php   |  82 +++++++++++++++++++++++++++++++++++++++++++++++-
 3 files changed, 83 insertions(+), 34 deletions(-)

diff --git a/doc/db_dump.php b/doc/db_dump.php
index 332eb18c4c..b40a5d24ec 100644
--- a/doc/db_dump.php
+++ b/doc/db_dump.php
@@ -1,42 +1,11 @@
 <?php
 require_once("docutil.php");
-page_head("Downloadable statistics data");
+page_head("File-based project statistics data");
 echo "
 
 <p>
-BOINC projects can export <b>statistics data</b>
-describing teams, users and hosts.
-This data can be used for various purposes:
-<ul>
-<li> To produce
-web sites that show statistics and leaderboards
-for one or more BOINC projects.
-Examples are listed at <a href=stats_sites.php>here</a>.
-
-<li> To produce dynamically-generated images
-(typically used as message-board signatures)
-that show user and/or team credit, possible across projects.
-Examples are listed at <a href=stats_sites.php>here</a>.
-
-<li> To produce downloadable XML files that
-summarize cross-project statistics.
-We're trying to <a href=stats_xml.php> standardize the XML format</a>.
-
-<li> To produce web RPC interfaces to XML summaries of
-individual user or team statistics.
-We're trying to <a href=stats_xml.php> standardize the XML format</a>.
-Examples are here:
-<a href=http://www.boinc.dk/index.php?page=download_stats_xml>
-http://www.boinc.dk/index.php?page=download_stats_xml</a> and
-<a href=http://www.boincstats.com/xml/xml_user_example.php>http://www.boincstats.com/xml/xml_user_example.php</a>.
-
-</ul>
-
-<p>
-Statistics data is exported in XML-format files.
-<p>
+Projects export statistics data in XML-format files.
 Most projects regenerate the files every 24 hours.
-<p>
 These files are contained in a download directory,
 linked to from the project's web site
 (generally X/stats/, where X is the project URL).
diff --git a/doc/stats.odg b/doc/stats.odg
index 42e2b2e34b86d1ed62f3c334a459f1d82156cf2a..8b8a6c3f02f5dcbe13afc327666969797c4945e4 100644
GIT binary patch
delta 2361
zcmZuzc{tQ-8~)kGSQ6PAL=l;38Z(x$?-VljEZGgpp0VVNGpUIzVGPwLL`Ig#PGdVN
z`&6>WkisBBA0b&f=A83g-`910?;p>7UC(>J_j^Bo-A}7U;zeF7b2fG%fO$w|Bwh^b
zVReNuYqA`HROW~J>*}AvbBNv{!8mL%4jvs8xZ?6TcvhAFV7eG#C*&WObS#4Qp5j{P
zlCLM?h_lTnh$l9TjBuExl4BDOzU*#Z(4fE-*JV22c5$hKa_-~^__a|>3fAX~n`QH+
zY#fZ7VhTJcP*gU^Nvw#*!{}coOxt00KCeGi8}}06z)AVO&?vZ43UYFOxh5W3+}V=d
zYBdVW^`qQLx^8yN`8CZWkD(m&d>*-Zx!nG)5F=JA+m)X-Dc1_^MutyFoui8XQ6qhi
zYG|VB{V(;iHxz5n)l|QZGA@TB^|X60h-;_Mz*7e?qJ3qs4eFC1RY;u@!Mf|-@vT^Q
z!P<&;ee?U3POy@fdWA}iWZ~l`jsgCH&KcF~Va`qzT<)Zm>ha??8FBXECOpzC5mfKg
zX431SjY>Mhf33-N^@h5mfa*j)d)T!7>(G{`4+>sCOuttDsx5Cz>U8JW?$fuGj>yQf
zmh@YS9@aX}Z<3tn`)kUDvj`}=7w`@h+|*!MKw?boef+D(8OTJf_vTXRXn%qJjG%lL
z$<Z4IMU9gTy7Y{mkfs=KMRssva_B<E&ltj{lH&jo*D>JfrDB$xL6JlnAL}fv0O~Yz
z?okH(FMX`DSscF7bO{1~XkaDY_HKfu29A0wS#mNXnWkoMl)UD&Nl<g&GvEp@A7<lW
z&6s{=l?55eft5a9@pY|XS<WEgg*o1YT8f>+%otQWKtGf5EEt?@^tBELNmn5scc$<l
z+>Mm<+<d}>6sN!d#4o+Ct%&dEFsdcB-Nwij3;V&_nckt8SSa^V=ms!}-NiNHi}DN2
z9wSn2*JM*xbVlwH<n3A&oVK{c24NgWi4u-!b$!b-rlhzs{{-~ej(*P^uO@{6#Z|4P
z3@jwVxRAj;i0K{0A*hK4d0<glxW_fp8?r)>I?gA?GQDnAr8@PpsEPc?z&1oq0{Z!=
z^4$v2C;t}RhP~=E?0?y_CEs*!UwCm}j~=hhKB1SlaFLBLvBUjMCckmcOwj3V$M7c|
znRi^Cj}&Y@A6+YG!RBYKhqjonpB|g1D%Ng~(4`nbWS*>_!i#LTxp(Q@!jVrt?s-=A
zf-WbvR~T1IlEUU_#~O%PR4-}FDRY&ct7n$2Q)#by0^<vniKL{4SSfzgK0`!YE$W*%
zrOU+4@?99A>f!IflBRvy?{jr>C&?*QrLkX6C%@ua;%&%tx5y>2@-+nd-HclKHY!_u
zA~3lNTH8rBt^7^<yuw~^pKZtHrt~w@vzzF(Rw?#bq1J|M%WuWAB_+v@AyjC254%!p
zQJCv;@MxF?%}J%V`_qA0gww^+7Mbe>d)sTeoSgwU!VcJec{Y|cUD^2=54Vckkpe!h
zzNSh0+hvuxSb}^eU4E4vn_}2^UX5gTOv~7k_4yfBpOp3EXBtj=#gFwom;^A*X}GSA
z59%j<@_1!ZQZ6N?M;H)W4j~pv<n?JaBj%80eA>+LlS7|2%r@$xki_y!*~R;UC%<WI
zD31~_Aku!#v3h0KkO%d-3u&7j7eziaif-!9G9UvEpSthb-zu8$*a#?BUdex!AZrO*
z9`$Cy=*;BQ<n3m`do<w9Wa}_1Ey3=kT#ICwqo@r%9y5O(Um0I_!&FhF*I>dTpdOb3
zVpxfUu}^Ge#Z){y`o_Xyb%!SU73y-|{v6@y3U$1p=PABC076Y2;QgSVWYFNJHn#ov
zXYjQr6NVcTX>(a;J)0fAER3})hhf<0D7Q?I#`(Za<#)!lxHOOnic27mZ{d^7-ui6w
z@-)E>%T>XaXsfE9^{Dp8>6#9K$*?6(CBloi`ILC;c6VI#6$Bdm@WTM2Wp*w5odO|u
zhKmREg^oZ(dU;570H=n!4SDhXnTYnD0ZA@49;yR_d#Xuod`jy4YqoU2#~<`4)(S`S
zmy}AVQi}5Omh3PwZE8CLG3^5Fy-<-2L}*1_{~#MmX=%iC`&lrWqT>q9iBH1t;C6>1
zn6I(j;LK!ryCEP!nPn^G7s59aE+d;{v0X{sM)mc!(A|6o5E36%k~L;redp@beQi-K
zdXC7*77NsHnBXx!o&Uv6P*<^Pr7&f6M&HAm80&ts+u*$hw<I17I*1{t(4a)$y(5z=
z3X-)ix0At<GrDgNzJH}1m2Zp-Cmw<MICsfFJnk5c8@u{MW4zdHx)ll9-lz`irV;K{
zODMXzA~fMdG+IQ`usL?|IZA3?`<CtVCfyjpevSj18qKOSC7*HEIeN|FX${+6h(%PP
zju&kwutf7-xLzbgmwVd}y7k_`w{jGcy8k%OMW1Er+RY2}tZ-WvMO;XT*Qv3{N1n9n
z>)@APVc6{7P@)QJ=tzR@ohRS(g^V<zjZt<CRoHR?2WJ+<<~FojfI_{3F+NpxRZLhN
zjNbj-FvPb-#&IwD$KacXw<woU8czezXW4K%#u9mI)wi(;NK)JsCm+N64|iT@#*lg@
zfoSMC7cq0;%!?{)!g_kZxQpP%XYD0?`SQt1^ZPF5aA4M>@{t-`G2_f=#lgJN@aD!&
z`r>dvt4>?P><R00KRK<;Il=3K-5-NE0iag{0RE0~FaSP`@!BI`ZBC8_LBGgxGUn*$
zsnrP&qwj~jOq2icn0d|&_i_3Xe25(YhHB6AyRdPhG>`}llrp(YP?rToUJ^uboJT5O
zMAu3Q39}ro1hp!{;~*yTOJw|ol#?;cK3Q5;nF$WET1?24RpDcb|JNRQOcr{A+4^56
z-2W^Ue}e^CMo!%R7f*-2z`t<t`~VPy#d$J!4=ZyPRv|#>kineT4~57s)y)C{K-}S+
zV!ynKAg9U6GkramlhCx10Dy2T4tFKkFZ}<><d9vt)K~yO_3(4yUu5RUM^7t&++>-}
FKLIRFAJ_l@

delta 2294
zcmY*bc{tQtAOFoTmfKhxWk#|Lt}WTJw+zWLmZ8NXgc+tRV;Pe*#t^bJm>FeXi`*&F
zs1ONJMv@`xwM4>|M1(6`bKm!Udi$Q|`F_s%F6Vrn^Uvp-Y};f5#h`h3VF1@!N;0AL
z;63lA&h@E^<d%}lI{&8r>-Oy-E---P9YE3uC-{%K%m+;CiSA5PXr6-&ftm3Q-U`DS
zkpM(o_KKs&E=QceWbR`e8r>4#9$sIdlPsmn)ny!~`t8JJlRM$T&jW>NWn)ZxrUBx(
zSZ<OJ@rax`{fxqLpR5gjkW-Z2Ozx~&o&WTVNiq_O))saoi_!07Z0o8_t_#%CuerXx
zgx;5%b~Zn0)1XDG^Hsu0I~`j8MVv$An?Y5J6|D5yh1u59P}Bu;cW<RpPCI=^EyUBo
zxHx>+DW?-$S^Br`BD0Z=jK~Eq1Sh5jb)}q#DY;kQjd1Y7op;l?&E{Yn$wp^0XCqXL
z2+;3R_5LWNhQx+yvVe=aQ)XQMMLi|R7e5)ggst^~<?HXp`zOI+jkylAc!3w*l;I^*
zsh!&MLVQ!%g3psAJelgVWH8;jh|!AMDZ%oV2Bf8K9^P&EOWI~dChTcmU1{*d<81#_
z)uKe_!0fxV_lnAWaH?mO$@GFereAL5ts=<$3~E_XXrC!0c(=GN9og(@ax*NGk7x-I
z%rU9S2&CN*%Up7J_nz1w_BOsLeTNvfHQ8g8rr-J@*wfHv1^l}de#IayG799i&U?hJ
zb-d(-S3-X!o8%W*SE(PzS*{;}PMT+G6Wl-L<WIO}!Mn*+cJnZKYS1x5t`d=reRxgC
z%$vZ_F+tKA+^?Q7{zE5)6)`v11~2!Inv(hGn7oYeKv=GYs7V->odO>*rKM+srhOzq
zGZBacN-Z3OErVGPufN1kyoZijc&MoNoJGXMcZ*tRQ(NI*KgNU9y+(=l{)%LzL=s9g
z_~9S1-$hB=66BIuh;4J6DNRX~g5hCi@-=oeD`ehteA3m&AWP4x$oG}fur0`*D-DcU
zh5YW4A21Tih~A~?k?=4-uYB6T1_9|#&#SSf3JFaPhU0z&>@SubgC`DMGk>X7?k<>B
z^4b+$q!MmFayanMJCbk0X04c8b|}!h?08>UJ*2!Px#L8+P7sialiOjVMyS^KCB2MD
z0~@fUPwQh>dQa``yz(~(Kj=S1%sXoVxC&yv6wdycF?=&JRD{_2$hzJN0pXb>aUSfO
zeW`ZwGV);s<$FS8owZH~CfBfMeTg*?Qe;0)b&W3IOc#uF#4MZ$WgA6Zbk~Q*Z46ab
zHQgddUOIC!)Ot$P)wnG+>~yJS_4myI;!{g;h<u&4`TJmxM>pgh)7Vye!acXy=`)Ns
zRWAlP&AUIM`x_BmJfG)979^D`9W;pGSG;xi)V(#F3n;n!i(}u`#!OBM=NJQNG0?QH
zq9F0XPMyzfW`cjh1&t?$?h7x&Lp@Tz@{)4NZRukbhu!4OIyxmyQ+71q+V-zAwlv_6
z>^d^4vX^LbTV7E35=~~7^rNxQXt6L&?pwit&(d{hQ;*TjTDpT*(*x5ZHctHbtAVec
z<!0Y$Y1qU(eiB#}K9O>)u1okr#0z{;=DBr&LEF5W>#vzH&cgaK<M8TFF>+@cZ=~2B
zB^Ng5N-iHXl*%iwY<^vRSA|NX=G)?(Yj5$;+On*veX;$0zTVP`F};ry^vCk5T$obf
z?mef&yDzP`RFfPSLT}k+iCE{xsz)`p)ts8O$RLQKb&V@?rxBl5@27cJ)s&@5eVKLS
z%d?Kp-;kQnep8S7zw=CsDed@uluy}7WU;w51+Q>UK@xhSyRACCc~{pS=cp)7zfV_v
z=CzTCHJWSxx_zU`5eZjB&9R*P0&nuUpc1#Rh#2oceXDF}@^ux+n%kkdC_~M3Vl1r9
z%uU#2P}Ja5%7bArfB96lx3d30!5t<KL()PS#Ab+HlPSfr(i%QYOX_!A3b;=$`}0al
z`QlW^fqF`K5Q!qiyRI=PeVU3{7xpy4sSF;fI4>ZyJ);6xWXa3Sc%oL&)u2({p_D`_
z!xY$v&@1ywOl5qk==PmeR(0z=UXjWk^U~_^?cR?(C_gHB>-~4Jqh<pWeXB=-sCVr>
z)}Oam>yGDtDYnBRArXbA(kscb-^@Q3PaA%n`4Y;=g5Dfz-W=)Xpf7A_3Vl%630{4*
z-E;C1L&T<Ca}9UmR7NuPhEd9w=PCPxvX~#^#zYf3?T%(gHBBzAxBf;jH<*$(W7d=I
zuP!!J=m=VTi<FtlY1zHKsF#l;^@dt3tM`)3>M>n@cI&M1>DLi@1B5>E3GB0k!uG9U
zy(ll$Gk(>Bgaz9%7f>vIWT$wVeHRrg-EdW}2KI{hHt3^C1fN_T8s5>uhD;JheSh!G
zkc83ZvO)vKbe|p{8m=!nXMjD7%8?3H`>Te@=UGUhl!>6V;WddKJIkvs`hLPwSXAe|
zkv6LjYPVU*ZPEL4ETLp&v))XW1m^I{NS>z(5e`a#h2aV@;v_Uw*(un@@3QBK=+kc0
zFzNO&MpuE0hA0mC)J?-WQ*QjoF5a+qewHOSUg_i#eeG%wIl5s}1cT-mc&pe&kmm;g
z<6{8uAL$hU1oou&SE2oFPiR9(EPnwNen_=aNZ>d<S7ZRW_T**9#$GSu%>R11y3Fkj
zBFG4GcmaUJqKmrl@M{}s=^AP3(AV~#<k2=cN|%Mf=x7*%SKn4gpXCda0PX2Jiy|@1
z$3@pew14rdd?Ytc_gB#6LaBlY7bX>s33Ffg$(xQ;RFmO`{+|w)@J|EL35sxoUx@9I
z6Zl!Mx6={@0D?EklRHRY&>%1jfbCUqzk>c;@eo)=f}SaXQ2RA=S*IiNq1#110Pt1=
q0O&9G@zUj#q_~VvC>;W4%hQkt4`9%cy;1-W+*=Z001#K;p8f%!+W`>(

diff --git a/doc/stats.php b/doc/stats.php
index cc7a599189..7916726ec1 100644
--- a/doc/stats.php
+++ b/doc/stats.php
@@ -4,8 +4,88 @@ require_once("docutil.php");
 
 page_head("Statistics data");
 echo "
-Stati
+<b>Statistics data</b> is the number of
+<a href=credit.php>Cobblestones</a> (credit units)
+granted to hosts, participants and teams by the
+various BOINC projects.
+This data can be used for various purposes, such as:
+<ul>
+<li> Producing
+web sites that show statistics and leaderboards
+for one or more BOINC projects.
+Examples are listed at <a href=stats_sites.php>here</a>.
+
+<li> Producing dynamically-generated images
+(typically used as message-board signatures)
+that show user and/or team credit, possible across projects.
+Examples are listed at <a href=stats_sites.php>here</a>.
+
+<li> Producing displays of current credit on
+cell phones and PDAs.
+</ul>
+
+<p>
+BOINC provides a flexible architecture for distributing
+statistics data, with the intent of enabling new uses of this data.
+<p>
 <img src=stats.png>
+<p>
+<center><b>The BOINC statistics data architecture</b></center>
+
+<h2>Project data</h2>
+<p>
+Each BOINC project provides data in two forms:
+<ul>
+<li> As
+<a href=db_dump.php>a set of downloadable files</a>
+(in a compressed XML format)
+that contain the project's complete current statistics.
+These files are typically updated once every 24 hours.
+<li> As
+<a href=rpc.php>a set of Web RPCs</a>
+that return an XML-format description of a given
+participant's credit,
+based on that participant's database ID.
+</ul>
+
+<p>
+Applications should access these data sources
+as infrequently as possible,
+to avoid imposing unnecessary load on project servers.
+For example, a Web RPCs to get a particular participant's data
+should made at most once per hour.
+
+
+<h2>Aggregate data</h2>
+<p>
+A <b>data aggregator</b> is a service that collects XML files
+from several projects,
+and computes the totals for participants and hosts
+(based on <a href=foo>cross-project IDs</a>)
+across these projects.
+This aggregate data is then exported in two ways:
+<ul>
+<li> As
+<a href=stats_xml.php>a set of downloadable files</a>
+(in a compressed XML format).
+<li> As
+<a href=stats_xml.php#rpc>a set of Web RPCs</a>
+that return an XML-format description of a given participant
+or host's credit,
+based on the cross-project ID.
+</ul>
+<p>
+Examples are here:
+<a href=http://www.boinc.dk/index.php?page=download_stats_xml>
+http://www.boinc.dk/index.php?page=download_stats_xml</a> and
+<a href=http://www.boincstats.com/xml/xml_user_example.php>http://www.boincstats.com/xml/xml_user_example.php</a>.
+
+<p>
+Application developers are encouraged to concentrate
+on aggregate rather than per-project data.
+This will encourage participants to join multiple projects,
+and will make it possible for new projects to quickly get
+many participants.
 ";
 
 page_tail();