User Defined Menu: Difference between revisions

846 bytes added ,  12:01, 21 October 2022
m
Line 42: Line 42:
THis Item definition line has space separated words.
THis Item definition line has space separated words.


The <name> is what you will see in the menu and may consist of one or more words.
The <name> is what you will see in the menu and may consist of one or more words. If <name> is a valid filespec on the seerver or a valid URL, it will display the contents of that filespec or URL. It is intended to be used as a specification for a small image to be displayed in the menu. It is the users responsibility to have a correct filespec or URL. No validation is done other than:
 
#Filename starts with <code>'./' OR '../'</code>
#Filename starts with <code>'http' OR 'https'</code>
 
In which case the <name> is interpreted as an URL.


The Type can be of :  
The Type can be of :  
Line 48: Line 53:
#'''External''': The URL given as destination will be opened in a new window or new tab besides CUtils
#'''External''': The URL given as destination will be opened in a new window or new tab besides CUtils
#'''Internal''': The URL given as destination will be opened in the ReportView, the large viewport on the right side of the dashboard. It is implemented as an Iframe which is generated to the standard demands of Cutils
#'''Internal''': The URL given as destination will be opened in the ReportView, the large viewport on the right side of the dashboard. It is implemented as an Iframe which is generated to the standard demands of Cutils
#'''Report''': Any UserReport of Cutils or any other legitimate HTML/Javascript file similar to the standard reports and charts. The destination is a textfile name : ''filename.txt''
#'''Report''': Any UserReport of Cutils or any other legitimate HTML/Javascript file similar to the standard reports and charts. The destination is a fully specified text file name : ''filename.txt'' (so including the extension)
#'''Image''': Not implemented yet
#'''Image''': The URL for the image (e.g. a satellite image) will be shown in the ReportView
#'''Separator''': No further arguments. Creates a thin horizontal line below the last item
#'''Separator''': No further arguments. Creates a thin horizontal line below the last item


<destination> is the URL what you want to see. An URL can be a full specification or just a filename in which case the report must be present on the server in the webroot (as always).
<destination> is the URL of what you want to see. An URL can be a full specification or just a filename in which case the report must be present on the server in the webroot (as always).


The example in the distribution contains three example lines.
Example lines are shown at the bottom of this page and in the distribution file ''CutilsMenu-example-for-use.def''


Both files for System 1 & 2 are available in the distribution.
Both files for System 1 & 2 are available in the distribution.
Both System 1 & 2 can be used concurrently.
Both System 1 & 2 can be used concurrently.
Error recovery in case of errors is present. System 2 however cannot validate against the real world so while developing your menu: be precise or be prepared to rerun if your menu looks garbled. Garbage in is garbage out.


== Output ==
== Output ==