Differences

This shows you the differences between two versions of the page.

--- wiki:aw:cmxconfig_page [2025/10/03 15:48] – created Neil
+++ wiki:aw:cmxconfig_page [2025/10/13 09:54] (current) – Neil
@@ Line 1: / Line 1: @@
 ===== The cmxConfig Object =====
-This is used extensively to configure the site.
+==== This page focuses on the Custom Area of cmxConfig ===
 <WRAP group>
 <WRAP twothirds column>
-==== General ====
-This structure is used to tell CumulusMX where to find your data, your NOAA report and the menu.  By default they assume that you upload your data and webpages to the same location and that you have not modified the default settings in CumulusMX.  If this is not the case, you will need to edit these three options.
-<color #80f>**Data**</color><wrap indent>This should contain the **relative path**((This is the path relative to where your pages are located.)) to your data.  It can contain **..** to indicate parent folders if required.</wrap>\\
+<WRAP nicebox teal>
-<color #80f>**Menu**</color><wrap indent>This should be correct unless you create your own menu.  In which case change the name to whatever you have used.</wrap>\\
-<color #80f>**NOAAReportPath**</color><wrap indent>Again this should be correct unless you have specified a differnt location for your NOAA Reports.</wrap>
-==== Charts ====
+=== StandardMenu ===
-This section is dynamically managed when you visit either the Trends or Historic chart pages.  They record which chart you have selected so that when you revisit the page((In the current session.)) you see the same chart you were last looking at.
-**However**, you can dictate which chart should be the first chart displayed in a new browsing session if you wish.  The valid entries are:
+This option controls whether or not you want to use a standard bar-type menu as in the default and previous versions of this site.
+  * Set this to **true** to use a bar-type menu
+  * Set to **false** if you want to use the new hamburger style menu
-<color #80f>**Historic Charts**</color><wrap indent>Temp, Press, Wind, WindDir, Rain, Humidity, Solar, DegDays, TempSum, ChillHrs, Snow((Only if you enable snow charts in CumulusMX)).</wrap>\\
+=== Dropdown ===
-<color #80f>**Trends Charts**</color><wrap indent>temp, dailytemp, press, wind, windDir, rain, dailyRain, humidity, solar, sunhours, airquality, extratemp, extrahum, extradew, solitemp, leafwet, usertemp, and co2.</wrap>
+This is not active in this version - it is provided for future developments.
-Please note that many if these are only available if you have enabled them in CumulusMX and yu generate data to drive them.
+=== Theme ===
+Use this option as in previous versions.  Set it to the theme name as found in the **themes** subfolder but without the **.css** file extension.++ Further information | More information about themes can be found on the [[themes|Themes]] page. ++
-==== Records ====
+=== Logo ===
-This section is also dynamically used when you visit either the monthly or 'All Records' pages.  For a specific month, use the month number minus 1, I.e., 0 to 11, or one of '**Alltime**', '**ThisYear**', or '**ThisMonth**' for the '**All Records**' page.
+If this is left blank, the CumulusMX logo will be used, if it contains **None**((I don't recommend this unless your banner, see next entry, contains the name of your site in some way.)) then no logo will be used, otherwise provide an absolute or relative path to your chosen logo image.  ++ See more | Your image can be as large as you want but will be reduced in proportion to a maximum height of 80 pixels. ++
+=== BannerImage ===
+Leave blank for no image, otherwise provide an absolute or relative path to your chosen image.  ++See more | The image will always be aligned center / bottom and set to cover the available area. For this reason I recommend an image at least 4000 by 600 pixels. ++
+=== Static Head & Static Foot ===
+As in previous versions, both the banner and the footer are static by default.  I.e., they attach to the top and bottom of the screen regardless of the page content.  Setting either of these to false will cause theme to scroll with the page.++ more | If the screen content is not enough to reach the bottom of your browser, the footer will still attach itself to the page bottom but the gull will be on the bottom edge of the screen.++
+=== Padding ===
+Again a standard feature of my templates, you can adjust the gap between the page content and the banner and footer.  Entries cannot be negative and setting them to zero will not mean there is no gap; that is also determined by element padding within the content of the page.
+Units can be any of **//em//**, **//vh//** or **//px//**. The first two provide responsive gaps, either based on font size or screen height.  The latter uses the pixel resolution of your screen.
+</WRAP>
-**Note** If you don't have data for a specific month, it will still display but with '--' for all values and dates.
 </WRAP>
@@ Line 62: / Line 73: @@
 </WRAP>
 </WRAP>
-==== The 'Custom' section ====
-This section covers all the various options you can use to personalise your site.  The first two options control the menu and has been covered elsewhere.
-=== Theme ===
-The Alternative Public Website is supplied with **Fourteen** themes with **grey** being the default.  If this entry is blank or contains the name of a non-existent theme, the default grey theme is used.  Adding the name of a theme here will cause that colour scheme to be applied to your site.  See the [[Themes|playground:aw2:themes]] page for further details.
-=== Logo ===
-With this version of the template, you can easily replace the standard logo with your own.  Simple add the path and name of the required logo to this entry.  **Note** The maximum height of the logo is 80px.  If yours is bigger it will be reduced in height and width proportionately.  I would not recommend a width greater than 350px.
-=== Banner ===
-With this version of the template you can also add your own banner image.  It will cover the full screen width and include the menu area.  You are advised to make the image at least 4000px wide to accommodate wide screens on visitors monitors.  The image will be aligned along its bottom edge and centered.  It will also be scaled to cover the available area.  To ensure that the menu is always leadgible, standard menus will cover the image with a background colour.
-=== Static Head & Static Foot ===
-As in previous templates, both the banner and the footer are static by default.  I.e., they attach to the top and bottom of the screen regardless of the page content.  Setting either of these to false will cause theme to scroll with the page.
-=== Padding ===
-Again a standard feature of my templates, you can adjust the gap between the banner and the footer.  Entries cannot be negative and setting them to zero will not mean there is no gap; that is also determined by element padding within the content of the page.
-=== The Gull ===
-The gull at the bottom left of the screen is animated by default.  Setting the '**Speed**' to zero will stop the animation.  There are a number of animations in the main.css stylesheet that can be used as an alternative.  These are: gull-FadeIn, gull-GrowUp,  gull-SlideIn-from-Left, and gull-SlideIn-from-Right.
-The final option - '**OnTop**' is used to set the gull above or below page content.  It is below by default.