Changes between Version 2 and Version 3 of BadgeDoc

Timestamp:

Dec 24, 2013, 7:47:07 PM (11 years ago)

Author:

davea

Comment:

--

BadgeDoc

@@ -2 +2 @@
 
 '''Badges''' are symbols of accomplishment by volunteers or teams -
-for example, how much computing they're contributed.
+for example, how much computing they've contributed.
 Badges are shown as icons on project web sites.
 In the future, they may also be shown in client GUIs and statistics sites.
@@ -12 +12 @@
 
 The data associated with a badge includes:
- * A name (used to identify the badge internally; not shown to users)
+ * A name (used to identify the badge internally; not visible to users)
  * The URL of an image file.
-   The image will be sized on display (currently 48 pixels high).
-   Make it somewhat larger than this, e.g. 300x300 pixels.
+   Images are sized on display (currently 48 pixels high).
+   Make them somewhat larger than this, e.g. 300x300 pixels.
    For flexibility, use a PNG with transparent background.
- * A title - a short phrase that explains the accomplishment
+ * A title - a phrase that explains the accomplishment
    for which the badge is granted.
 
@@ -25 +25 @@
 == The default badges ==
 
-By default (for new projects) there are badges
+The BOINC server code supports badges
 for the top 1%, 5%, and 25% of recent average credit (RAC).
 They are represented by gold, silver, and bronze medal images, respectively,
 and are assigned to both users and teams.
 
+The script that assigns these badges is here:
+http://boinc.berkeley.edu/gitweb/?p=boinc-v2.git;a=blob;f=html/ops/badge_assign.php
+
+To enable these badges on your project's site,
+add the following to your config.xml file:
+{{{
+    <task>
+      <cmd>run_in_ops ./badge_assign.php</cmd>
+      <period>24 hours</period>
+      <output>badge_assign.out</output>
+    </task>
+}}}
+
 == Writing a badge-assignment script ==
 
-The script that assigns the default badges is here:
-http://boinc.berkeley.edu/gitweb/?p=boinc-v2.git;a=blob;f=html/ops/badge_assign.php
-
-You can use this script as a template for writing your own.
-
+You can use the default badge-assignment script as a template for writing your own.
 The script uses the following utility functions, defined in '''html/inc/util_ops.inc''':
 {{{
@@ -75 +84 @@
 Use the admin web interface (see below) to clean up badge records as needed.
 When you're done, arrange to run the script periodically
-by adding something like this to your project config file:
-{{{
-    <task>
-      <cmd>run_in_ops ./badge_assign.php</cmd>
-      <period>24 hours</period>
-      <output>badge_assign.out</output>
-    </task>
-}}}
+by adding it as a task in config.xml (see above).
 
 == Managing badges ==