User Defined Menu - Revision history

HansR: /* System 1 */

2025-09-19T02:48:19Z

System 1

← Older revision		Revision as of 02:48, 19 September 2025
Line 10:		Line 10:
	=== System 1 ===		=== System 1 ===
	System 1 has been deprecated and is removed from use in version 8.0.1		System 1 has been deprecated and is removed from use in version 8.0.1

	In the website root there must exist a file ''CUsermenu.txt'' which contains the user defined menu. When the ''index.html'' is requested by a visitor the file ''CUsermenu.txt'' is read and the items in there form the ''User Defined Menu'' which is explained below. This menu is dynamically used by the website and NOT generated by CumulusUtils.

	=== System 2 ===		=== System 2 ===

HansR: /* Operation */

2025-09-18T19:46:53Z

Operation

← Older revision		Revision as of 19:46, 18 September 2025
Line 9:		Line 9:
	== Operation ==		== Operation ==
	=== System 1 ===		=== System 1 ===
			System 1 has been deprecated and is removed from use in version 8.0.1
⚫	In the website root there must exist a file ''CUsermenu.txt'' which contains the user defined menu. When the ''index.html'' is requested by a visitor the file ''CUsermenu.txt'' is read and the items in there form the ''User Defined Menu'' which is explained below. This menu is dynamically used by the website and NOT generated by CumulusUtils. ~~System 1 has been deprecated and is removed from use in version 8.0.1~~

		⚫	In the website root there must exist a file ''CUsermenu.txt'' which contains the user defined menu. When the ''index.html'' is requested by a visitor the file ''CUsermenu.txt'' is read and the items in there form the ''User Defined Menu'' which is explained below. This menu is dynamically used by the website and NOT generated by CumulusUtils.

	=== System 2 ===		=== System 2 ===

HansR: /* Items */

2025-09-18T19:46:13Z

Items

← Older revision		Revision as of 19:46, 18 September 2025
Line 19:		Line 19:
	Any menu topic, named other than the standard items, will create a new user defined, top level menu dropdown. If the top level name contains an underscore, that underscore will be replaced by a space.		Any menu topic, named other than the standard items, will create a new user defined, top level menu dropdown. If the top level name contains an underscore, that underscore will be replaced by a space.

			The following holds:
⚫	For all drop downs ''items'' can be defined as follows:
			#Tab is a valid separator of fields within ''CutilsMenu.def''
			#Requires ''About'' as last item and ''Home'' as first
			#Requires the following Top Level items in the CutilsMenu.def (Note that Print is optional): <code>Home, ToggleDashboard, Reports, Graphs, Records, Extra, Misc, About</code>
			#The order of items between Home and About is arbitrary

		⚫	<br/>For all drop downs ''items'' can be defined as follows:

	Item <name> <type> <destination> EndItem		Item <name> <type> <destination> EndItem
Line 46:		Line 52:
	Example lines are shown at the bottom of this page and in the distribution file ''CutilsMenu-example-for-use.def''		Example lines are shown at the bottom of this page and in the distribution file ''CutilsMenu-example-for-use.def''

		⚫	Errors are shown in the logfile. 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.
	Files for System 2 are available in the distribution.

⚫	~~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.		Garbage in is garbage out.

HansR: /* Items */

2025-09-10T02:41:35Z

Items

← Older revision		Revision as of 02:41, 10 September 2025
Line 17:		Line 17:

	==== Items ====		==== Items ====
	Any menu topic named other than the standard ~~item~~ will create a new, user defined, ~~main~~ menu dropdown. ~~For~~ ~~all~~ ~~drop~~ ~~downs~~ ~~''items''~~ ~~can~~ be ~~defined~~ as ~~follows:~~		Any menu topic, named other than the standard items, will create a new user defined, top level menu dropdown. If the top level name contains an underscore, that underscore will be replaced by a space.

			For all drop downs ''items'' can be defined as follows:

	Item <name> <type> <destination> EndItem		Item <name> <type> <destination> EndItem
Line 23:		Line 25:
	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. 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 images to be displayed~~ in the ~~menu. It is the users responsibility~~ to ~~have~~ a ~~correct filespec or URL~~. ~~No validation is done other than:~~		The <name> is what you will see in the menu and may consist of one or more words (no need to use an underscore in the name to create a space).

			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 images to be displayed in the menu. It is the users responsibility to have a correct filespec or URL. No validation is done other than:

	#<name> starts with <code>'./' OR '../'</code>		#<name> starts with <code>'./' OR '../'</code>
Line 44:		Line 48:
	Files for System 2 are available in the distribution.		Files for System 2 are available in the distribution.

	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.~~		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 ==

HansR at 12:28, 7 September 2025

2025-09-07T12:28:26Z

@@ Line 5: / Line 5: @@
 When using the [[Website Generator]] the website comes with a standard menu. It is possible to expand this menu by adding items to it. It is not possible to modify the standard menu items or sub-items, it is possible though to remove some items from the main manu by using the parameters, some items cannot be removed. The About menu item cannot be removed nor changed.
 == Operation ==
@@ Line 16: / Line 14: @@
 In the utils directory there must be a file ''CutilsMenu.def''. If this file is not present you get the default menu. The contents of this file as delivered in the distribution is shown at the end of this page.
-You recognize the standard menu of CumulusUtils. User items can be added  to the standard menu as is indicated above. While generating the website this menu will be incorporated. The System 1 menu will be generated in addition to System 2 (i.e. those items will be on the rightmost side of the menu).
+You recognize the standard menu of CumulusUtils. User items can be added  to the standard menu as is indicated above. While generating the website this menu will be incorporated.
 ==== Items ====
@@ Line 44: / Line 42: @@
 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.
+Files for System 2 are available in the distribution.
 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.
@@ Line 60: / Line 57: @@
 The website is designed on the basis of the [https://getbootstrap.com/ Bootstrap Toolkit]. As a result, the menu is also within this toolkit.
 As the menu is not really very easy if you are not a HTML / Bootstrap programmer, System 2 for the menu is designed to deal with without knowledge of the Bootstrap menu system. On the basis of the  keywords in System 2 CumulusUtils generates the menu for  you.
 == Example of CuserMenu.def (System 2) ==

HansR: /* Operation */

2025-09-07T12:15:45Z

Operation

← Older revision		Revision as of 12:15, 7 September 2025
Line 11:		Line 11:
	== Operation ==		== Operation ==
	=== System 1 ===		=== System 1 ===
	In the website root there must exist a file ''CUsermenu.txt'' which contains the user defined menu. When the ''index.html'' is requested by a visitor the file ''CUsermenu.txt'' is read and the items in there form the ''User Defined Menu'' which is explained below. This menu is dynamically used by the website and NOT generated by CumulusUtils.		In the website root there must exist a file ''CUsermenu.txt'' which contains the user defined menu. When the ''index.html'' is requested by a visitor the file ''CUsermenu.txt'' is read and the items in there form the ''User Defined Menu'' which is explained below. This menu is dynamically used by the website and NOT generated by CumulusUtils. System 1 has been deprecated and is removed from use in version 8.0.1

	=== System 2 ===		=== System 2 ===

HansR: /* System 2 */

2022-10-21T13:33:08Z

System 2

← Older revision		Revision as of 13:33, 21 October 2022
Line 14:		Line 14:

	=== System 2 ===		=== System 2 ===
	In the utils directory there must be a file ''CutilsMenu.def''. If this file is not present you get the default menu. The ~~default~~ contents of this file as delivered in the distribution is :		In the utils directory there must be a file ''CutilsMenu.def''. If this file is not present you get the default menu. The contents of this file as delivered in the distribution is shown at the end of this page.

		⚫	You recognize the standard menu of CumulusUtils. User items can be added to the standard menu as is indicated above. While generating the website this menu will be incorporated. The System 1 menu will be generated in addition to System 2 (i.e. those items will be on the rightmost side of the menu).
	Home

	About
	Item Test1 External <nowiki>https://waterinfo.rws.nl/#!/kaart/waterhoogte-t-o-v-nap/</nowiki> EndItem
	Item Test2 Internal <nowiki>https://embed.windy.com/embed2.html?lat=53.2589&lon=6.9314&detailLat=47.339&detailLon=6.812&width=1000&height=700&zoom=5&level=surface&overlay=temp&product=ecmwf&menu=&message=true&marker=true&calendar=now&pressure=true&type=map&location=coordinates&detail=&metricWind=km%2Fh&metricTemp=%C2%B0C&radarRange=-1</nowiki> EndItem
	Item Test3 Report tagtest EndItem

	Reports
	Graphs
	Records
	Extra
	Misc
	ToggleDashboard

	You recognize the standard menu of CumulusUtils.
	From version 6.12 the menu runs from left to right (as before it went from right to left).

⚫	User items can be added to the standard menu as is indicated above. While generating the website this menu will be incorporated. The System 1 menu will be generated in addition to System 2 (i.e. those items will be on the rightmost side of the menu)

	==== Items ====		==== Items ====
Line 40:		Line 23:
	Item <name> <type> <destination> EndItem		Item <name> <type> <destination> EndItem

	~~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. 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:		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 images 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>		#<name> starts with <code>'./' OR '../'</code>
	#~~Filename~~ starts with <code>'http' OR 'https'</code>		#<name> starts with <code>'http' OR 'https'</code>

	In which ~~case~~ the <name> is interpreted as an URL.		In which cases the <name> is interpreted as an URL.

	The Type can be of :		The Type can be of :
Line 57:		Line 40:
	#'''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 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~~).		<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 (produced by Cutils or by the user).

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

HansR: /* Output */

2022-10-21T12:03:27Z

Output

← Older revision		Revision as of 12:03, 21 October 2022
Line 68:		Line 68:
	== Output ==		== Output ==
	There is no output of the user menu, only a visible appearance on the website.		There is no output of the user menu, only a visible appearance on the website.

			System 2 however may produce menufiles on the server of the form: ''<main menu item><subitem number>.txt''.

	== Inifile parameters ==		== Inifile parameters ==

HansR: /* Items */

2022-10-21T12:01:06Z

Items

← Older revision		Revision as of 12:01, 21 October 2022
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''': The URL for the image (e.g. a satellite image) will be shown in the ReportView
	#'''Image''': Not implemented yet
	#'''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 ==

HansR: /* Example of CuserMenu.def (System 2) */

2022-10-21T09:18:09Z

Example of CuserMenu.def (System 2)

@@ Line 143: / Line 143: @@
 == Example of CuserMenu.def (System 2) ==
 Lines starting with a semicolon (;) are treated as comment
 [[Category:CumulusUtils]]