From 863032de26daea48f0f8f520de8641c901b49ae8 Mon Sep 17 00:00:00 2001 From: Vitalii Koshura Date: Sun, 9 Apr 2023 17:44:10 +0200 Subject: [PATCH] Update GuiUrls.md file Signed-off-by: Vitalii Koshura --- GuiUrls.md | 119 ++++++++++++++++++++++++++++------------------------- 1 file changed, 62 insertions(+), 57 deletions(-) diff --git a/GuiUrls.md b/GuiUrls.md index a681945..2323498 100644 --- a/GuiUrls.md +++ b/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 - - - - Your account - View your account information and credit totals - http://foo.project.com/home.php - - - Help - Get help about SETI@home - http://foo.project.com/help.php - - - - Team - Info about - http://foo.project.com/team_display.php?teamid= - - - ... - - +**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: + +``` + + + Your account + View your account information and credit totals + http://foo.project.com/home.php + + + Help + Get help about SETI@home + http://foo.project.com/help.php + + + + Team + Info about + http://foo.project.com/team_display.php?teamid= + + + ... + +``` 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 ; they will be sent only if the user belongs to a team. +Team-specific entries should be enclosed in \; 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 || & || & || -|| Single Quote || ' || ' || -|| Double Quote || " || " -|| Greater Than || > || > -|| Less Than || < || < + +| | | | +| --- | --- | --- | +| | Character | Escape Code | +| Ampersand | & | & | +| Single Quote | ' | ' | +| Double Quote | " | " +| Greater Than | > | > +| Less Than | < | < -The components of a element are: +The components of a \ 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: -**:: - The user's account key -**:: - The host ID -**:: - The project's master URL -**:: - The project name (from config.xml) -**:" - An authenticator used by notices.php -**:: - The team ID -**:: - The team name -**:: - The user ID -**:: - The user name +### **\** +The user's account key +### **\** +The host ID +### **\** +The project's master URL +### **\** +The project name (from config.xml) +**\**:" +An authenticator used by notices.php +### **\** +The team ID +### **\** +The team name +### **\** +The user ID +### **\** +The user name -* ... *:: - The enclosed items are included only if the user belongs to a team. \ No newline at end of file +### **\ ... \** +The enclosed items are included only if the user belongs to a team.