Rooba
/
boinc
mirror of https://github.com/BOINC/boinc.git
1
0
Fork 0
Code Issues 1 Packages Projects Releases Wiki Activity

Update ProjectSkin.md file 

Signed-off-by: Vitalii Koshura <lestat.de.lionkur@gmail.com>
Vitalii Koshura 2023-04-06 23:43:58 +02:00
parent c80baefcfd
commit a6081debbb
No known key found for this signature in database
GPG Key ID: CE0DB1726070A5A3
2 changed files with 101 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

203
ProjectSkin.md

@ -1,34 +1,36 @@
The BOINC Manager [view](simple)(http://boinc.berkeley.edu/wiki/Simple_view) uses graphical representations of projects and applications:
# Project graphics in the BOINC Manager simple view
The BOINC Manager [simple view](https://boinc.berkeley.edu/wiki/Simple_view) uses graphical representations of projects and applications:
* 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.
* The project is represented by a 40x40 pixel icon.
For example, in the following image of the simple view, three of the slides are shown that represent the World Community Grid Help Conquer Cancer application that is currently running and the icons at the bottom represent projects that the client is attached to.
[[nolink)](Image(bsg.gif,)]
![nolink](bsg.gif)
# Specifying project files
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).
## Specifying project files
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).
The format of 'project_files.xml' is:
#!xml
<file_info>
<name>X</name>
<url>X</url>
<md5_cksum>X</md5_cksum>
</file_info>
...
<project_files>
<file_ref>
<file_name>X</file_name>
<open_name>X</open_name>
</file_ref>
...
</project_files>
```xml
<file_info>
<name>X</name>
<url>X</url>
<md5_cksum>X</md5_cksum>
</file_info>
...
<project_files>
<file_ref>
<file_name>X</file_name>
<open_name>X</open_name>
</file_ref>
...
</project_files>
```
For each file, this specifies:
@ -39,32 +41,31 @@ For each file, this specifies:
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.
# Project Icon
## Project Icon
A project icon is a 40x40 image, PNG, GIF, or BMP format. Transparency is not supported in GIF and PNG images.
An example would look like this:
#!xml
<file_info>
<name>stat_icon_01.png</name>
<url>http://www.example.com/download/stat_icon_01.png</url>
<md5_cksum>186c5385c8f2a48ccc7e4f64251fcda1</md5_cksum>
</file_info>
<project_files>
<file_ref>
<file_name>stat_icon_01.png</file_name>
<open_name>stat_icon</open_name>
</file_ref>
</project_files>
```xml
<file_info>
<name>stat_icon_01.png</name>
<url>http://www.example.com/download/stat_icon_01.png</url>
<md5_cksum>186c5385c8f2a48ccc7e4f64251fcda1</md5_cksum>
</file_info>
<project_files>
<file_ref>
<file_name>stat_icon_01.png</file_name>
<open_name>stat_icon</open_name>
</file_ref>
</project_files>
```
Two things to note here:
* The '01' in stat_icon_01.png is used for versioning.
* 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.
# Application Slideshow
## Application 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, GIF, and BMP.
@ -78,75 +79,73 @@ The physical names can be anything you want.
An example:
#!xml
<file_info>
<name>image0.png</name>
<url>http://www.example.com/download/image0.png</url>
<md5_cksum>186c5385c8f2a48ccc7e4f64251fcda1</md5_cksum>
</file_info>
<file_info>
<name>image1.png</name>
<url>http://www.example.com/download/image1.png</url>
<md5_cksum>3b262da3d69d6b9eb55add88b66cdab4</md5_cksum>
</file_info>
<project_files>
<file_ref>
<file_name>image0.png</file_name>
<open_name>slideshow_exampleapp_00</open_name>
</file_ref>
<file_ref>
<file_name>image1.png</file_name>
<open_name>slideshow_exampleapp_01</open_name>
</file_ref>
</project_files>
```xml
<file_info>
<name>image0.png</name>
<url>http://www.example.com/download/image0.png</url>
<md5_cksum>186c5385c8f2a48ccc7e4f64251fcda1</md5_cksum>
</file_info>
<file_info>
<name>image1.png</name>
<url>http://www.example.com/download/image1.png</url>
<md5_cksum>3b262da3d69d6b9eb55add88b66cdab4</md5_cksum>
</file_info>
<project_files>
<file_ref>
<file_name>image0.png</file_name>
<open_name>slideshow_exampleapp_00</open_name>
</file_ref>
<file_ref>
<file_name>image1.png</file_name>
<open_name>slideshow_exampleapp_01</open_name>
</file_ref>
</project_files>
```
In the logical name _slideshow_exampleapp_01_,
In the logical name *slideshow_exampleapp_01*,
'slideshow_' labels it as a slideshow file, 'exampleapp' is the application short name, and '01' is the index of the slide within the slideshow.
# Example
## Example
Here is the 'project_files.xml' file SETI@home is using:
#!xml
<file_info>
<name>arecibo_181.png</name>
<url>http://setiathome.berkeley.edu/sg_images/arecibo_181.png</url>
<md5_cksum>f9b65230a594098d183d2266511bc648</md5_cksum>
</file_info>
<file_info>
<name>sah_40.png</name>
<url>http://setiathome.berkeley.edu/sg_images/sah_40.png</url>
<md5_cksum>5791ba1be2d33eaa5f90ecf5de89a53d</md5_cksum>
</file_info>
<file_info>
<name>sah_banner_290.png</name>
<url>http://setiathome.berkeley.edu/sg_images/sah_banner_290.png</url>
<md5_cksum>39839286db7f580bef5377322d15ed35</md5_cksum>
</file_info>
<file_info>
<name>sah_ss_290.png</name>
<url>http://setiathome.berkeley.edu/sg_images/sah_ss_290.png</url>
<md5_cksum>caf95504208aedd6ac6d82201e2fd8b1</md5_cksum>
</file_info>
<project_files>
<file_ref>
<file_name>sah_40.png</file_name>
<open_name>stat_icon</open_name>
</file_ref>
<file_ref>
<file_name>sah_ss_290.png</file_name>
<open_name>slideshow_setiathome_enhanced_00</open_name>
</file_ref>
<file_ref>
<file_name>arecibo_181.png</file_name>
<open_name>slideshow_setiathome_enhanced_01</open_name>
</file_ref>
<file_ref>
<file_name>sah_banner_290.png</file_name>
<open_name>slideshow_setiathome_enhanced_02</open_name>
</file_ref>
</project_files>
```xml
<file_info>
<name>arecibo_181.png</name>
<url>http://setiathome.berkeley.edu/sg_images/arecibo_181.png</url>
<md5_cksum>f9b65230a594098d183d2266511bc648</md5_cksum>
</file_info>
<file_info>
<name>sah_40.png</name>
<url>http://setiathome.berkeley.edu/sg_images/sah_40.png</url>
<md5_cksum>5791ba1be2d33eaa5f90ecf5de89a53d</md5_cksum>
</file_info>
<file_info>
<name>sah_banner_290.png</name>
<url>http://setiathome.berkeley.edu/sg_images/sah_banner_290.png</url>
<md5_cksum>39839286db7f580bef5377322d15ed35</md5_cksum>
</file_info>
<file_info>
<name>sah_ss_290.png</name>
<url>http://setiathome.berkeley.edu/sg_images/sah_ss_290.png</url>
<md5_cksum>caf95504208aedd6ac6d82201e2fd8b1</md5_cksum>
</file_info>
<project_files>
<file_ref>
<file_name>sah_40.png</file_name>
<open_name>stat_icon</open_name>
</file_ref>
<file_ref>
<file_name>sah_ss_290.png</file_name>
<open_name>slideshow_setiathome_enhanced_00</open_name>
</file_ref>
<file_ref>
<file_name>arecibo_181.png</file_name>
<open_name>slideshow_setiathome_enhanced_01</open_name>
</file_ref>
<file_ref>
<file_name>sah_banner_290.png</file_name>
<open_name>slideshow_setiathome_enhanced_02</open_name>
</file_ref>
</project_files>
```

BIN
bsg.gif Normal file

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 182 KiB