Changes between Initial Version and Version 1 of ProjectSkin


Ignore:
Timestamp:
Apr 25, 2007, 9:13:23 AM (19 years ago)
Author:
Nicolas
Comment:

Converted by an automatic script

Legend:

Unmodified
Added
Removed
Modified

  • ProjectSkin

    v1 v1  
     1= Project graphics in the BOINC simple GUI =
     2
     3The 'simple GUI' available in versions 5.8+ of the BOINC Manager uses graphical representations of projects and applications:
     4
     5
     6 * The project is represented by a 40x40 pixel icon.
     7 * Each application is represented by a sequence of images, each up to 290x126 pixels. These are shown as a slideshow, changing once every few seconds.
     8
     9 For example, in the following screenshot of the simple GUI, the two icons at the bottom represent CPDN and SETI@home, and the earth-map image in the middle represents the particular CPDN application that is currently running.  [[Image(images/newboinc.jpg)]]
     10== Specifying project files ==
     11 Project graphics files are specified in a configuration file '''project_files.xml''' that you put in your project's root directory. This file specifies a set of 'project files' that will be automatically downloaded to clients (this can be used for purposes other than graphics).
     12
     13The format of 'project_files.xml' is:
     14
     15
     16{{{
     17<file_info>
     18    <name>X</name>
     19    <url>X</url>
     20    <md5_cksum>X</md5_cksum>
     21</file_info>
     22...
     23<project_files>
     24    <file_ref>
     25        <file_name>X</file_name>
     26        <open_name>X</open_name>
     27    </file_ref>
     28    ...
     29</project_files>
     30}}}
     31      For each file, this specifies:
     32
     33
     34 * its URL (where to download it from)
     35 * its physical name; it will be stored in the project directory on the client under this name.
     36 * its MD5 checksum (use 'openssl dgst' to get this).
     37 * its logical name; a 'soft link' file will be created with this name, linking to the physical name.
     38
     39 All file_info records must appear before the project_files record. As with all BOINC files, project files are immutable. If you want to change the contents of a file, you must use a new physical name.
     40
     41
     42
     43Project Icon A project icon is a 40x40 image, PNG, JPG, GIF, or BMP format.
     44
     45An example would look like this:
     46
     47
     48{{{
     49<file_info>
     50    <name>stat_icon_01.png</name>
     51    <url>http://www.example.com/download/stat_icon_01.png</url>
     52    <md5_cksum>186c5385c8f2a48ccc7e4f64251fcda1</md5_cksum>
     53</file_info>
     54<project_files>
     55    <file_ref>
     56      <file_name>stat_icon_01.png</file_name>
     57      <open_name>stat_icon</open_name>
     58    </file_ref>
     59</project_files>
     60}}}
     61      Two things to note here:
     62
     63
     64 * The '01' in stat_icon_01.png is used for versioning.
     65 * The physical name for the project icon is 'stat_icon_01.png'   while the logical name for the project icon is 'stat_icon'.   The manager looks for 'stat_icon' and resolves   it to a physical name.
     66
     67Application Slideshow You can have one or more images displayed in the Simple GUI when BOINC is running one of your apps. Each image can have a height up to 126px and a width up to 290px, and can be any of the following image types: PNG, JPG, GIF, and BMP.
     68
     69An example would look like this:
     70
     71
     72{{{
     73<file_info>
     74    <name>slideshow_exampleapp_01_01.png</name>
     75    <url>http://www.example.com/download/slideshow_exampleapp_01_01.png</url>
     76    <md5_cksum>186c5385c8f2a48ccc7e4f64251fcda1</md5_cksum>
     77</file_info>
     78<file_info>
     79    <name>slideshow_exampleapp_02_01.png</name>
     80    <url>http://www.example.com/download/slideshow_exampleapp_02_01.png</url>
     81    <md5_cksum>3b262da3d69d6b9eb55add88b66cdab4</md5_cksum>
     82</file_info>
     83</file_info>
     84<project_files>
     85    <file_ref>
     86      <file_name>slideshow_exampleapp_01_01.png</file_name>
     87      <open_name>slideshow_exampleapp_01</open_name>
     88    </file_ref>
     89    <file_ref>
     90      <file_name>slideshow_exampleapp_02_01.png</file_name>
     91      <open_name>slideshow_exampleapp_02</open_name>
     92    </file_ref>
     93</project_files>
     94}}}
     95      In this example:
     96
     97
     98{{{
     99slideshow_exampleapp_02_01.png
     100}}}
     101 'slideshow_' labels it as a slideshow file, 'exampleapp' is the  application short name, '02' is the index of the slide within the slideshow, and 01 is the version of the file.
     102
     103
     104
     105
     106== Example ==
     107 Here is the 'project_files.xml' file SETI@home is using:
     108
     109
     110{{{
     111<file_info>
     112    <name>arecibo_181.png</name>
     113    <url>http://setiathome.berkeley.edu/sg_images/arecibo_181.png</url>
     114    <md5_cksum>f9b65230a594098d183d2266511bc648</md5_cksum>
     115</file_info>
     116<file_info>
     117    <name>sah_40.png</name>
     118    <url>http://setiathome.berkeley.edu/sg_images/sah_40.png</url>
     119    <md5_cksum>5791ba1be2d33eaa5f90ecf5de89a53d</md5_cksum>
     120</file_info>
     121<file_info>
     122    <name>sah_banner_290.png</name>
     123    <url>http://setiathome.berkeley.edu/sg_images/sah_banner_290.png</url>
     124    <md5_cksum>39839286db7f580bef5377322d15ed35</md5_cksum>
     125</file_info>
     126<file_info>
     127    <name>sah_ss_290.png</name>
     128    <url>http://setiathome.berkeley.edu/sg_images/sah_ss_290.png</url>
     129    <md5_cksum>caf95504208aedd6ac6d82201e2fd8b1</md5_cksum>
     130</file_info>
     131<project_files>
     132    <file_ref>
     133      <file_name>sah_40.png</file_name>
     134      <open_name>stat_icon</open_name>
     135    </file_ref>
     136    <file_ref>
     137      <file_name>sah_ss_290.png</file_name>
     138      <open_name>slideshow_setiathome_enhanced_00</open_name>
     139    </file_ref>
     140    <file_ref>
     141      <file_name>arecibo_181.png</file_name>
     142      <open_name>slideshow_setiathome_enhanced_01</open_name>
     143    </file_ref>
     144    <file_ref>
     145      <file_name>sah_banner_290.png</file_name>
     146      <open_name>slideshow_setiathome_enhanced_02</open_name>
     147    </file_ref>
     148</project_files>
     149}}}