Configuring the site

Like all previous versions of the alternative website, all settings are now held in one place - the cmxConfig object held in the config.js file.

This object holds the location of the menu to use, the location of your data, the path and name of your menu, the location of your NOAA Reports and other features that the website uses. This object is loaded into each page negating the need to use 'SessionStorage'. However, a small fragment is stored when visiting records or charts pages. This enables the page to 'remember' which chart or set of records your last viewed. The sessionStorage is not retained if the browser / window is closed.

Initial Configuration

All pages load the config.js file meaning that every page has access to its settings. As it is now not stored locally, any user will immediately see any changes you make to it. This file also includes a js object to remember which chart and record set the visitor last viewed. This is stored in sessionStorage. This script is comprehensively documented in-line and is shown below.

Custom

This section enables you to configure the menu, theme, your own logo, banner image and its position. You can use relative or absolute paths for the Logo and Banner Image. This is covered in detail in the wiki:aw:cmxConfig

More information

DataPath

This points to the location of your *.json data files¹⁾ uploaded by CumulusMX.

Geometry

This section configures spacing between the header, page content and footer. You can also make the banner and/or footer static.

Flying Gull

Enables you to set the animation for the flying gull at the bottom of the screen and its speed. It can no longer be placed behind page content but it does move downwards on smaller screens.

NOAA Path

Unlike general data CumulusMX allows you to specify your own location for any NOAA reports that you choose to publish. The default location is 'Reports/'. This is a relative path and so a sub-folder of your site. If you choose an alternative location then you can use this entry to provide the required access.More The same options apply as for the Data entry.

This should be used to point to the javascript menu file used to drive all the menus on the site. Unless you use your own modified menu, there should be little need to edit this. Its default value is js/menu.js. More details about creating your own menu can be found on the page Creating your own menu.

The cmxConfig object

cmxConfig = {
    //  Edit this to set your required configuration
    "Custom": {
        "SideMenu": true,   // Set to true or false
        "BannerStyle": "thin",  // set to 'thin' or leave empty
        "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
    "Geometry": {
        "StaticHead": true,     // true or false accepted
        "StaticFoot": true,     // true or false accepted
        "PaddingTop": 2,        // Numeric value only (Real numbers accepted but ignored if units = px)
        "PaddingBottom": 1,     // Numeric value only ( Ditto )
        "Units": "em",          // Accepts any valid css unit 
    },
    "Gull": {
        "Animation": "",        // Blank, Expand, 'Enter left', 'Enter right' or Drop only
        "Speed": 5,             // Positive numeric real values only
        "OnTop": true,          // No longer used
    },
    "Panels": {
        "Shadows": "",          // Blank, Basic or Enhanced only
        "VariableHeights": false,// true or false
    },
    "Menu": "json/ows-menu.js", // Relative path and name of menu script.
    "NOAAPath": "Reports/",     // Absolute or relative path to your NOAA Reports
}

Dashboard Information Panel

The contents of this panel can only be changed by editing the index.html page.

¹⁾

and the realtimegauges.txt file

Oaktree Weather Systems

Table of Contents