| | 1 | = GUI URLs = |
| | 2 | |
| | 3 | '''GUI URLs''' is a mechanism that projects to pass URLs to the client, for display as hyperlinks in the GUI. These links will be shown when the project is selected in the '''Projects''' tab. To use this feature, include a file 'gui_urls.xml' in the project root directory, with the following form: |
| | 4 | |
| | 5 | |
| | 6 | {{{ |
| | 7 | <gui_urls> |
| | 8 | <gui_url> |
| | 9 | <name>Your account</name> |
| | 10 | <description>View your account information and credit totals</description> |
| | 11 | <url>http://foo.project.com/show_user.php?userid=<userid/></url> |
| | 12 | </gui_url> |
| | 13 | <gui_url> |
| | 14 | <name>Help</name> |
| | 15 | <description>Get help about SETI@home</description> |
| | 16 | <url>http://foo.project.com/help.php</url> |
| | 17 | </gui_url> |
| | 18 | <ifteam> |
| | 19 | <gui_url> |
| | 20 | <name>Team</name> |
| | 21 | <description>Info about <team_name/></description> |
| | 22 | <url>http://foo.project.com/team_display.php?teamid=<teamid/></url> |
| | 23 | </gui_url> |
| | 24 | </ifteam> |
| | 25 | ... |
| | 26 | </gui_urls> |
| | 27 | }}} |
| | 28 | Each entry describes a GUI URL. These URLs (macro-substituted as described below) will be sent to client hosts in the reply to scheduler RPCs. Team-specific entries should be enclosed in <ifteam>; they will be sent only if the user belongs to a team. |
| | 29 | |
| | 30 | The components of a <gui_url> element are: |
| | 31 | |
| | 32 | |
| | 33 | |
| | 34 | '''name''':: |
| | 35 | A short name, used e.g. as a button name or menu item |
| | 36 | '''description''':: |
| | 37 | An explanation, used e.g. as a rollover popup |
| | 38 | '''url''':: |
| | 39 | The URL |
| | 40 | All items are macro-substituted as follows: |
| | 41 | |
| | 42 | |
| | 43 | |
| | 44 | '''<userid/>''':: |
| | 45 | The user ID |
| | 46 | '''<user_name/>''':: |
| | 47 | The user name |
| | 48 | '''<teamid/>''':: |
| | 49 | The team ID |
| | 50 | '''<team_name/>''':: |
| | 51 | The team name |
| | 52 | '''<hostid/>''':: |
| | 53 | The host ID |
| | 54 | '''<authenticator/>''':: |
| | 55 | The user's account key |
| | 56 | |
| | 57 | |
