| 1 | = Project notices = |
| 2 | |
| 3 | Version 6.12+ of the BOINC client software adds a mechanism called |
| 4 | [Notifications notices] for conveying information to volunteers. |
| 5 | |
| 6 | Notices are displayed as HTML in the Manager's Notices tab. |
| 7 | When there is a new notice, the volunteer is alerted via a balloon |
| 8 | or a bouncing BOINC icon. |
| 9 | |
| 10 | Notices are intended to be used for events that either require volunteer action, |
| 11 | or are likely to be of interest to the volunteer. |
| 12 | |
| 13 | Projects are strongly encouraged to use notices to communicate |
| 14 | with their volunteers. |
| 15 | For example, a new scientific accomplishment or publication could be |
| 16 | communicated as a notice. |
| 17 | This will be seen even by volunteers who never visit the project web site. |
| 18 | |
| 19 | To use this mechanism, put the following in your '''gui_urls.xml''' file: |
| 20 | |
| 21 | {{{ |
| 22 | <rss_feeds> |
| 23 | <rss_feed> |
| 24 | <url>PROJECT_URL/notices.php?userid=<userid/>&auth=<rss_auth/></url> |
| 25 | <poll_interval>86400</poll_interval> |
| 26 | </rss_feed> |
| 27 | </rss_feeds> |
| 28 | }}} |
| 29 | |
| 30 | This will cause the following items to be delivered as notices: |
| 31 | |
| 32 | * Your project's news items (threads on the News message board). |
| 33 | * Private messages |
| 34 | * Friend requests |
| 35 | * Posts to subscribed threads |
| 36 | |
| 37 | Notes: |
| 38 | |
| 39 | * Replace PROJECT_URL with your project's URL |
| 40 | * '''<poll_interval>''' specifies how often (in seconds) clients should poll for notices. |
| 41 | |
| 42 | Notices are delivered as RSS feeds. |
| 43 | You can include additional RSS feeds in the list. |
| 44 | The server software will replace '''<userid/>''' with the user's ID, |
| 45 | and '''<rss_auth/>''' with an authenticator that can be used by server software |
| 46 | to authenticate the user. |