AlternativePublicWebsite: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m
=== Configuration ===
 
This version of the Alternative Public Website comes with a remodelled version of cmxConfig. This is currentlynow in theits own file page-control config.js file. You will need to edit this file to make it point to your data.
 
==== Heading text ====
{| style="margin-right: 50px;"
|-
| style="width: 20em60em;"|
 
<nowiki>cmxConfig = {
Charts: {
// Edit this to set your required configuration
Trends: "",
Historic"Custom": "",{
"StandardMenu": false, // Set to true or false
"Dropdown": true, // set to true or false
"Theme": "", // Set to the name of an existing theme WITHOUT 'css'
"Logo": "", // Set to the absolute or relative path and name of the image to use OR 'None'
"BannerImage": "", // As above or leave blank
"BannerPosition":"center center", // Use allowable css values including units
},
"DataPath": "", // Set to the absolute or relative path of your data
Custom: {
StandardMenu"Geometry": false,{
Dropdown "StaticHead": true, // true or false accepted
"StaticFoot": true, // true or false accepted
Theme: "",
"PaddingTop": 2, // Numeric value only (real numbers accepted but ignored if using px as unit)
Logo: "",
"PaddingBottom": 1, // Numeric value only ( ditto )
BannerImage: "",
"Units": "em", // Accepts any valid css unit
StaticHead: true,
StaticFoot: true,
PaddingTop: '2',
PaddingBottom: '1',
PaddingUnits: 'em',
},
Data: "Gull",: {
"Animation": "", // Blank, Expand, 'Enter left', 'Enter right' or Drop only
Menu: 'js/ows-menu.js',
"Speed": 5, // Positive numeric values only (can be real)
NOAAReportPath: 'Reports/',
"OnTop": true, // true or false
Gull: {
Animation: "",
Speed: 5,
OnTop: false,
},
Records"Panels": {
"Shadows": "", // Blank, Basic or Enhanced only
All: "",
"VariableHeights": false,// true or false
Monthly: "",
};,
"Menu": "json/ows-menu.js", // Relative path and name of menu script.
"NOAAPath": "Reports", // Absolute or relative path to your NOAA Reports
}
// You are advised to leave these blank.
cmxSession = {
Charts"Records": {
"Monthly": "", // Numeric integer representing to month to show - zero based
"All": "" // As above and 'ThisYear', 'ThisMonth' or 'Alltime'
},
"Charts": { // ONLY CHOOSE CHARTS FOR WHICH YOU HAVE DATA OR LEAVE BLANK.
"Trends": "", // One of: temp, press, wind, windDir, rain, dailyrain, humidity, solar, sunhours, and sensor dependant
"Historic":"" // One of: Temp. Press, Wind, WindDir, Rain, Humidity, Solar, DegDays, TempSum, ChillHrs, Snow
}
}</nowiki>
};
 
|style="padding-left: 1em;"|
===== Explanation =====
The object is organised alphabetically as this is how it is stored. There are nowboth 4root level entries and sections, The sections are:- '''ChartsCustom''', '''CustomGeometry''', '''Gull''' and '''RecordsPanels'''. as well as three primary settings:- '''Data''', '''Menu''' and '''NOAAReportPath'''.
 
The root level entries are:- '''DataPath''', '''Menu''' and '''NOAAPath'''.
Of these you will need to check, and probably edit, '''Data''' and '''NOAAReportPath''' as these two provide the path to your data, wherever you have uploaded it.
 
Of these you will need to check, and probably edit, just the root level entries - '''DataDataPath''' and '''NOAAReportPathNOAAPath''' as these two provide the path to your data, wherever you have uploaded it.
* '''Data''': This must be set to point to the folder to which you upload your data. By default CumulusMX uploads its data to the same location as the html pages but you may have changed this.
 
** If you upload your data to the same folder as the pages, this option should be empty.
* '''DataDataPath''': This must be set to point to the folder to which you upload your data. By default CumulusMX uploads its data to the same location as the html pages but you may have changed this.
** If you upload your data to a folder below the pages folder, i.e., to a folder inside the folder containing your pages e.g., '''data''', then this entry can contain a '''relative''' path; i.e. 'data/', './data/'. It could also be an absolute path from the root of your website; i.e. '/<pages>/data/' where <pages> is the folder name containing your website.
** If you upload toyour adata folder,to forthe examplesame calledfolder '''data''', aboveas the pages folder, then '''this entryoption canshould be a relative path such as empty''../data/'. You can also use an absolute path if you prefer.
** If you upload your data to another location, then this entry can be an absolute or relative path to that location. Absolute paths always start with a '/' character; any other character implies relative path.
* '''NOAAReportPathNOAAPath''': This must point to your NOAA Reports. The default installation of CumulusMX places these in a sub-folder of the html pages location. If you have changed this then you will also need to edit this entry.
** The same formats are accepted; relative or absolute paths.
===== The Menu entry =====
Please refer to [https://www.oaktreewebs.co.uk/wiki/doku.php?id=start my Wiki] for a detailed explanation and details on how to create your own menu.
 
===== Other entries =====
The other entries in the cmxConfig structure allow you to customise the various options available in this template with the '''Custom''' section being the primary area for such customisation. '''''Charts and Records''''' These two option areas are probably best left as is. They record the last chart (Trends and Summary) and records sets (Monthly and All), viewed in the current browsing session and are changed dynamically.
===== Custom: {=====
This section focuses on colours, the logo and banner images and the menu.
===== Geometry =====
Allows you to adjust the spacing around the page content and whether or not the banner and/or footer are fixed in position. The Gull now positions correctly based on the fixed status of the footer.
===== Gull =====
Primarily concerned with the animation of the gull at the bottom of the page and whether or not it is above or below page content.
===== Panels =====
A new feature that allows you to add one of two variations of shadow to the panels displayed on each page. Some panels will not display shadows regardless of these settings.
==== the cmxSession Object ====
This is used dynamically by visitors to your site. It records the last chart / record set viewed so that when re-visiting the page (in the correct session), the same chart/record set is displayed.
 
|}
 
==== Change Log ====
 
'''Version 5.01''' ''dated: 16/02/2026''
 
This is a complete re-write of the '''Alternative Public Website''' BUT that re-write only affects the header and footer areas and the top and tail of the main content area.
 
It should be possible to copy any personal additional page content into the template.htm file provided.
 
==== To do this ====
* Locate the '''<nowiki><div id="siteContent_Inner"></nowiki>''' in the current version of your page.
* Select ALL code '''inside''' this div and copy it to your clipboard.
* Locate the '''<nowiki><div id="subContent"></nowiki>''' in the template file provided with this update.
* Paste your old code inside this area, overwriting anything that is in the template down to its corresponding '''<nowiki></div></nowiki>'''
* Do make sure that you don't add any extra '''<nowiki><div></nowiki>'''s or remove any that close of the '''<nowiki><div id="subContent></nowiki>''' area
* Rename the template.html page appropriately.
 
'''Update: 11/10/2025 Version 5.0.1'''
450

edits

Navigation menu