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

Update GuiUrls.md file 

Signed-off-by: Vitalii Koshura <lestat.de.lionkur@gmail.com>
Vitalii Koshura 2023-04-09 17:44:10 +02:00
parent 666ce4889a
commit 863032de26
No known key found for this signature in database
GPG Key ID: CE0DB1726070A5A3
1 changed files with 62 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

119
GuiUrls.md

@ -1,71 +1,76 @@
*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:
# GUI URLs
<gui_urls>
<gui_url>
<name>Your account</name>
<description>View your account information and credit totals</description>
<url>http://foo.project.com/home.php</url>
</gui_url>
<gui_url>
<name>Help</name>
<description>Get help about SETI@home</description>
<url>http://foo.project.com/help.php</url>
</gui_url>
<ifteam>
<gui_url>
<name>Team</name>
<description>Info about <team_name/></description>
<url>http://foo.project.com/team_display.php?teamid=<teamid/></url>
</gui_url>
</ifteam>
...
</gui_urls>
**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:
```
<gui_urls>
<gui_url>
<name>Your account</name>
<description>View your account information and credit totals</description>
<url>http://foo.project.com/home.php</url>
</gui_url>
<gui_url>
<name>Help</name>
<description>Get help about SETI@home</description>
<url>http://foo.project.com/help.php</url>
</gui_url>
<ifteam>
<gui_url>
<name>Team</name>
<description>Info about <team_name/></description>
<url>http://foo.project.com/team_display.php?teamid=<teamid/></url>
</gui_url>
</ifteam>
...
</gui_urls>
```
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.
Team-specific entries should be enclosed in \<ifteam>; they will be sent only if the user belongs to a team.
Like with any XML file, all text (including URLs) must be entity-escaped:
|| || Character || Escape Code ||
|| Ampersand || & || &amp; ||
|| Single Quote || ' || &apos; ||
|| Double Quote || " || &quot;
|| Greater Than || > || &gt;
|| Less Than || < || &lt;
| <!-- --> | <!-- --> | <!-- --> |
| --- | --- | --- |
| | Character | Escape Code |
| Ampersand | & | &amp; |
| Single Quote | ' | &apos; |
| Double Quote | " | &quot;
| Greater Than | > | &gt;
| Less Than | < | &lt;
The components of a <gui_url> element are:
The components of a \<gui_url> element are:
*name*::
A short name, used e.g. as a button name or menu item
*description*::
An explanation, used e.g. as a rollover popup
*url*::
The URL
### **name**
A short name, used e.g. as a button name or menu item
### **description**
An explanation, used e.g. as a rollover popup
### **url**
The URL
All items are macro-substituted as follows:
*<authenticator/>*::
The user's account key
*<hostid/>*::
The host ID
*<master_url/>*::
The project's master URL
*<project_name/>*::
The project name (from config.xml)
*<rss_auth/>*:"
An authenticator used by notices.php
*<teamid/>*::
The team ID
*<team_name/>*::
The team name
*<userid/>*::
The user ID
*<user_name/>*::
The user name
### **\<authenticator/>**
The user's account key
### **\<hostid/>**
The host ID
### **\<master_url/>**
The project's master URL
### **\<project_name/>**
The project name (from config.xml)
**\<rss_auth/>**:"
An authenticator used by notices.php
### **\<teamid/>**
The team ID
### **\<team_name/>**
The team name
### **\<userid/>**
The user ID
### **\<user_name/>**
The user name
*<ifteam> ... </ifteam>*::
The enclosed items are included only if the user belongs to a team.
### **\<ifteam> ... \</ifteam>**
The enclosed items are included only if the user belongs to a team.