User Defined Menu and Default Website Development: Difference between pages

From Cumulus Wiki
(Difference between pages)
Jump to navigationJump to search
mNo edit summary
 
 
Line 1: Line 1:
==The default CMX website Development==
== Introduction ==
{|align=right
|__TOC__
|}
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.


These section of the Wiki will enable you to get the latest information and resources for the alternative to the default CumulusMX public website.
The system in use is for historical reasons still called ''System 2''.


===Alternative public website===
== Operation ==
Please note. This is NOT part of the CumulusMX Distribution package and is provided only for those interested in having a public site that uses similar structures to the Alternative Interface.
=== 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. System 1 has been deprecated and is removed from use in version 8.0.1


Although it should function at the date of release, no guarantees are given that it will continue to do so with subsequent releases of CumulusMX. Users should take time to investigate how it reacts and uses the library and data files uploaded by CumulusMX so that you are able to do some troubleshooting for yourself.
=== 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 contents of this file as delivered in the distribution is shown at the end of this page.


Full details of the alternative public website, including screenshots can be fond on [https://oaktreewebs.co.uk/wiki/ my wiki] together with comprehensive instructions on how to install, use and modify.
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.


This site also comes with new themes (unfortunately not compatible with the AI or previous versions) that should be easier to modify for your own needs.
==== 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:


====Amendments since last revision====
Item <name> <type> <destination> EndItem
This is a full rebuild of the site that corrects the issue with High Charts X-Axis dates/ times. Latest upload dated 10th Sept 2025 and available from [https://oaktreewebs.co.uk/wiki/doku.php?id=wiki:aw:altwebsite My Wiki]


==Installing==
This Item definition line has space separated words.
Download the current zip file to you local machine and upload it to your web server.
*Unzip it in the same location as your existing site - it will not overwrite the existing pages
*:The new site uses .html pages whereas the existing default site uses .htm
*; If you visit your site without specifying a page you will be taken to the new template pages,
*;Specifying a page such as index.htm will display your old template pages.


*: Please clear your browser cache before viewing.
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:


===Your Own Pages===
#<name> starts with <code>'./' OR '../'</code>
'''As with previous releases, the public website template also includes a template page'''.
#<name> starts with <code>'http' OR 'https'</code>


The template.html page is provided to make it easier for you to add your own pages while retaining the look and feel of the website. The template page is called '''template.html'''.
In which cases the <name> is interpreted as an URL.


<big>Editing</big>
The Type can be of :
The template page shows all the different column layouts that are available. These are:
ax-column1, ax-column2, ax-column3, ax-column4, ax-column5 and ax-column6


: These will always try to display the indicated number of columns but as the screen becomes small will automatically collapse into fewer columns as appropriate.
#'''External''': The URL given as destination will be opened in a new window or new tab besides CUtils
:; If there are more panels than columns they will gracefully split onto additional rows while retaining their column settings.
#'''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
:; Rows with fewer panels than columns will either stretch the remaining panels across the full width or distribute them centrally - this can be controlled by you.
#'''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
#'''Separator''': No further arguments. Creates a thin horizontal line below the last item


For full details visit [https://oaktreewebs.co.uk/wiki/ my wiki].
<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).


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


Please refer to my [https://oaktreewebs.co.uk/wiki/ wiki] for full details of the menu and how to edit it.
Files for System 2 are available in the distribution.


==Changing the Theme and Other Settings==
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.


Please refer to my [https://oaktreewebs.co.uk/wiki/ wiki] for full information on configuring and setting up the alternative website.
== Output ==
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 ==
There are no inifile parameters involved

== Inner working ==
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) ==

The lines below are examples
Lines starting with a semicolon (;) are treated as comment

;
; CumulusUtils Menu definitions for Website- Part of CumulusUtils
;

Home
Reports
Graphs
Item Extra Report extrasensorscharts.txt EndItem
Records
Extra
Misc
Maps
User
Item ./wu.png External https://www.wunderground.com/dashboard/pws/IWAGEN6?cm_ven=localwx_pwsdash EndItem
NL
Item Waterstanden External https://waterinfo.rws.nl/#!/kaart/waterhoogte/ EndItem
Item TopoNL External https://topotijdreis.nl EndItem
Item Hoogtekaart External https://ahn.arcgisonline.nl/ahnviewer/ EndItem
Item CropMap External https://www.esa.int/ESA_Multimedia/Images/2018/05/Crop_map EndItem
Item Separator EndItem
Item Waterstanden (Int) Internal https://waterinfo.rws.nl/#!/kaart/waterhoogte/ EndItem
Item TopoNL (Int) Internal https://topotijdreis.nl EndItem
ToggleDashboard
About


[[Category:CumulusUtils]]

Revision as of 07:28, 10 September 2025

The default CMX website Development

These section of the Wiki will enable you to get the latest information and resources for the alternative to the default CumulusMX public website.

Alternative public website

 Please note.  This is NOT part of the CumulusMX Distribution package and is provided only for those interested in having a public site that uses similar structures to the Alternative Interface.

Although it should function at the date of release, no guarantees are given that it will continue to do so with subsequent releases of CumulusMX. Users should take time to investigate how it reacts and uses the library and data files uploaded by CumulusMX so that you are able to do some troubleshooting for yourself.

Full details of the alternative public website, including screenshots can be fond on my wiki together with comprehensive instructions on how to install, use and modify.

This site also comes with new themes (unfortunately not compatible with the AI or previous versions) that should be easier to modify for your own needs.

Amendments since last revision

This is a full rebuild of the site that corrects the issue with High Charts X-Axis dates/ times. Latest upload dated 10th Sept 2025 and available from My Wiki

Installing

Download the current zip file to you local machine and upload it to your web server.

  • Unzip it in the same location as your existing site - it will not overwrite the existing pages
    The new site uses .html pages whereas the existing default site uses .htm
    If you visit your site without specifying a page you will be taken to the new template pages,
    Specifying a page such as index.htm will display your old template pages.
  • Please clear your browser cache before viewing.

Your Own Pages

As with previous releases, the public website template also includes a template page.

The template.html page is provided to make it easier for you to add your own pages while retaining the look and feel of the website. The template page is called template.html.

Editing The template page shows all the different column layouts that are available. These are: 

ax-column1, ax-column2, ax-column3, ax-column4, ax-column5 and ax-column6
These will always try to display the indicated number of columns but as the screen becomes small will automatically collapse into fewer columns as appropriate.
If there are more panels than columns they will gracefully split onto additional rows while retaining their column settings.
Rows with fewer panels than columns will either stretch the remaining panels across the full width or distribute them centrally - this can be controlled by you.

For full details visit my wiki.

Editing the website menu

Please refer to my wiki for full details of the menu and how to edit it.

Changing the Theme and Other Settings

Please refer to my wiki for full information on configuring and setting up the alternative website.

Retrieved from "https://www.cumuluswiki.org/index.php?title=User_Defined_Menu&oldid=12171"