Changes between Version 2 and Version 3 of BadgeDoc


Ignore:
Timestamp:
Dec 24, 2013, 7:47:07 PM (11 years ago)
Author:
davea
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • BadgeDoc

    v2 v3  
    22
    33'''Badges''' are symbols of accomplishment by volunteers or teams -
    4 for example, how much computing they're contributed.
     4for example, how much computing they've contributed.
    55Badges are shown as icons on project web sites.
    66In the future, they may also be shown in client GUIs and statistics sites.
     
    1212
    1313The data associated with a badge includes:
    14  * A name (used to identify the badge internally; not shown to users)
     14 * A name (used to identify the badge internally; not visible to users)
    1515 * The URL of an image file.
    16    The image will be sized on display (currently 48 pixels high).
    17    Make it somewhat larger than this, e.g. 300x300 pixels.
     16   Images are sized on display (currently 48 pixels high).
     17   Make them somewhat larger than this, e.g. 300x300 pixels.
    1818   For flexibility, use a PNG with transparent background.
    19  * A title - a short phrase that explains the accomplishment
     19 * A title - a phrase that explains the accomplishment
    2020   for which the badge is granted.
    2121
     
    2525== The default badges ==
    2626
    27 By default (for new projects) there are badges
     27The BOINC server code supports badges
    2828for the top 1%, 5%, and 25% of recent average credit (RAC).
    2929They are represented by gold, silver, and bronze medal images, respectively,
    3030and are assigned to both users and teams.
    3131
     32The script that assigns these badges is here:
     33http://boinc.berkeley.edu/gitweb/?p=boinc-v2.git;a=blob;f=html/ops/badge_assign.php
     34
     35To enable these badges on your project's site,
     36add the following to your config.xml file:
     37{{{
     38    <task>
     39      <cmd>run_in_ops ./badge_assign.php</cmd>
     40      <period>24 hours</period>
     41      <output>badge_assign.out</output>
     42    </task>
     43}}}
     44
    3245== Writing a badge-assignment script ==
    3346
    34 The script that assigns the default badges is here:
    35 http://boinc.berkeley.edu/gitweb/?p=boinc-v2.git;a=blob;f=html/ops/badge_assign.php
    36 
    37 You can use this script as a template for writing your own.
    38 
     47You can use the default badge-assignment script as a template for writing your own.
    3948The script uses the following utility functions, defined in '''html/inc/util_ops.inc''':
    4049{{{
     
    7584Use the admin web interface (see below) to clean up badge records as needed.
    7685When you're done, arrange to run the script periodically
    77 by adding something like this to your project config file:
    78 {{{
    79     <task>
    80       <cmd>run_in_ops ./badge_assign.php</cmd>
    81       <period>24 hours</period>
    82       <output>badge_assign.out</output>
    83     </task>
    84 }}}
     86by adding it as a task in config.xml (see above).
    8587
    8688== Managing badges ==