Webtags (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Webtags (preserving history) (view source)

Revision as of 20:10, 24 July 2021

1,787 bytes added ,  20:10, 24 July 2021
m
→‎Monthly All Time Records: more typos
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:Terminology]]
[[Category:Terminology]]
Please be aware some content originally on this page has been moved to other pages.  Old posts on the support forum that used to link directly to the specific material, will instead bring you to this start of the page. Please see [[#Input Modification Parameters and Output Modification Parameters]] and  [[#The tag name]] for the new links to those items.
Please be aware some content originally on this page has been moved to other pages.  Old posts on the support forum that used to link directly to the specific material, will instead bring you to this start of the page.  
 
The new links to material that has been moved off this page can be found approximately where the material used to be within two sections on this page: [#Input Modification Parameters and Output Modification Parameters]] and  [[#The tag name]].


=Essential Background Reading=
=Essential Background Reading=
Line 8: Line 10:
<div style="background: LemonChiffon;padding:5px; margin:2px;">
<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]]
[[File:Crystal Clear info.png|40px]]
<big>From release 3.10.1,
From release 3.10.1,


:if you use the [[New_Default_Web_Site_Information|default web site]], then web tags are provided to your web server using the [[WebsitedataT.json]] file, so see those 2 linked pages if you are interested in the default web pages.</big>
:if you use the <big>[[New_Default_Web_Site_Information|default web site]]</big>, then web tags are provided to your web server using the <big>[[WebsitedataT.json]]</big> file, so see those 2 linked pages if you are interested in the default web pages.


<br>
<br>
Line 19: Line 21:
==What is a web tag? ==
==What is a web tag? ==


Weather values are always changing, so Cumulus needs a way for you to tell Cumuluss to enter the current value for a particular derivative, when it is [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|processing templates]].
Weather values are always changing, so Cumulus needs a way for you to tell Cumulus to enter the current value for a particular derivative, when it is [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|processing templates]].


==General Format for Web Tags==
==General Format for Web Tags==
Line 31: Line 33:
The tables of tag names that appear later on this page will seldom give any information about which parameters are mandatory or optional.  There are tables on the other page referenced above that help you to understand what parameters the various tag names accept, explain each of the parameters available, and give examples.
The tables of tag names that appear later on this page will seldom give any information about which parameters are mandatory or optional.  There are tables on the other page referenced above that help you to understand what parameters the various tag names accept, explain each of the parameters available, and give examples.


There is a basic guide to what these parameters can do, and another link to the new page at [[#Input Modification Parameters and Output Modification Parameter]] later on this page.
There is a basic guide to what these parameters can do, and another link to the new page at [[#Input Modification Parameters and Output Modification Parameters]] later on this page.


{{TOCright}} [[Category:Cumulus 1]]
{{TOCright}} [[Category:Cumulus 1]]
Line 37: Line 39:
===The tag names===
===The tag names===


<div style="background: LemonChiffon;padding:5px; margin:2px;">All the "tag_names" that are available for legacy 1.9.4, and for MX up to release '''3.12.0'''</div>  are listed in [[#The Web Tags for Cumulus]] later on this page.
<div style="background: LemonChiffon;padding:5px; margin:2px;">All the "tag_names" that are available for legacy 1.9.4, and for MX up to release '''3.12.0'''</div>  are in [[#Full List of Tag Names]] later on this page.


As Cumulus has developed, more tag names have been introduced, the tables showing tag names available, attempt to give an indication of which release introduced them. The information that used to appear on this page for differences between MX and the legacy Cumulus has been moved to a new [[Webtag Applicability|Web tag Applicability page]].
As Cumulus has developed, more tag names have been introduced, the tables showing tag names available, attempt to give an indication of which release introduced them. The information that used to appear on this page for differences between MX and the legacy Cumulus has been moved to a new [[Webtag Applicability|Web tag Applicability page]].
Line 99: Line 101:
==Input Modification Parameters and Output Modification Parameters==
==Input Modification Parameters and Output Modification Parameters==


MX has introduced many more of these, so they are no longer listed on this page.
In [[#Scary_statistics]] section of this page, it is explained how less than a thousand [[#Full List of Tag Names|tag names]] as they are only part of the [[#General Format for Web Tags]] become billions of web tags, simply by adding modifiers.
 
The modifiers available used to be listed on this page (so if you select the history tab for this page, you will find references to their introduction and growth).  There are some advantages in moving them to the new [[Webtags/Parameters|web tag parameters]] page:
* This page is very long, even without the parameters
* There would be a lot of repetition if you attempted to say beside each tag name which modification parameters were available.
* Having them on separate pages means you can have two tabs (or two separate browsers) open so you can see both the tag name and the modifier parameter by flicking between tabs,instead of lots of scrolling.
* MX has introduced many more input and output modification parameters, it is easier to maintain a separate page (and easier for reference if you just want to refresh your mind on new modification parameters).


Now to find out what is allowed for the '''input selection parameters''' and '''output modification parameters''', refer to [[Webtags/Parameters|web tag parameters]] page.


For just a taste, there you can discover:
For just a taste, there you can discover:
* A score of input parameters that modify some of those tags (for example, by using one input parameter attribute with a value between 1 and 12, the same web tag names can give values for 12 different months)
* A score of [[Webtags/Parameters#Input_modification_Parameters|input modification parameters
* The components that make up output parameters (a guide to how you modify the output format)
** For  example, find which attribute is used with a value between 1 and 12, so the same tag name can give values for 12 different months)
** how to control number of decimal places
* If your locale normally (in real numbers) uses an integer part, then a comma, and then the decimal part, you should be aware that some computer scripts, and some external servers where you might want to send data, insist on a decimal point, instead of a decimal comma:
** how to control whether decimal comma (if used) is replaced by decimal point (useful for some script languages)
** If you have installed a recent MX release, then [[Webtags/Parameters#Output_Modification_Parameter_for_changing_any_decimal_comma_into_a_decimal_point|change decimal comma to decimal point]] with a simple "y" value to another attribute
** the majority modify the output from almost all web tags that report a time and/or date (there are so many ways to represent times and dates this multiples up the available output considerably)
** If you have the legacy Cumulus 1 installed, stay on this page and look at [[#No_Commas]], as you have to use the restricted alternative set of tag names.
* How to [[Webtags/Parameters#Two_Output_.28format_modifier.29_parameters_for_decimal_places|control number of decimal places]] in any real number output
* All about the complex subject of modifying the way a '''duration''', a ''date'', or a '''clock time''' is output by looking [[Webtags/Parameters#Multiple_Output_Format_Modifier_parameters_for_times_and_dates|here]]


== Why does MX talk about tokens? ==
== Why does MX talk about tokens? ==
Line 158: Line 167:


You may have used GET as an attribute when defining the action of a HTML form.  Equally you might in a script language access the query-string part of a Universal Resource Locator to get parameters for what the script is to supply to the web page.  Even if you don't understand the meaning of those technical terms, you probably have seen when using a browser (in the box where a URL is entered) that sometimes the URL seen there has a query-string. You will have seen a question mark (?) followed by one or [separated by ampersand (&)] more '''name=value''' parameters.
You may have used GET as an attribute when defining the action of a HTML form.  Equally you might in a script language access the query-string part of a Universal Resource Locator to get parameters for what the script is to supply to the web page.  Even if you don't understand the meaning of those technical terms, you probably have seen when using a browser (in the box where a URL is entered) that sometimes the URL seen there has a query-string. You will have seen a question mark (?) followed by one or [separated by ampersand (&)] more '''name=value''' parameters.
 
Full List of Tag Names
The GET approach to using the Cumulus general api works in this way indicating the start of a query-string with a question mark and using ampersands to separate names. The difference is that a tag name (or list of tag names) is used instead of a name=value parameter (or list of name=value parameters).  However, when the Cumulus api returns the values they will be in attribute=value format.  Therefore if (like example below) you are coding in JavaScript, what is returned is a JavaScript Object and you extract the values by specifying the Object name and the Attribute name. If that technical terminology confuses you, look at the example.
The GET approach to using the Cumulus general api works in this way indicating the start of a query-string with a question mark and using ampersands to separate names. The difference is that a tag name (or list of tag names) is used instead of a name=value parameter (or list of name=value parameters).  However, when the Cumulus api returns the values they will be in attribute=value format.  Therefore if (like example below) you are coding in JavaScript, what is returned is a JavaScript Object and you extract the values by specifying the Object name and the Attribute name. If that technical terminology confuses you, look at the example.


Line 233: Line 242:
<br>
<br>


=<big>The Web Tags for Cumulus</big> =
=<big>Full List of Tag Names</big> =
{{Template:WorkInProgressBanner}}
{{Template:WorkInProgressBanner}}


Line 1,814: Line 1,823:
|}
|}


==Monthly==
==Yearly==
 
This table shows most of the web tags used on the "thisyearT.htm" web template.
 
The web tags in the date column output dates in the format "dd MMMM" (for once this is same for Cumulus 1 and Cumulus MX). Should you require a different output format, this can be changed using the [[#Time.2FDate_.27format.27_Parameter|format parameters]] described above. For web tags that represent daily values, there are (obviously) no corresponding time web tags, but for high and low spot values the default 'h:mm' format of the time output can be changed using output parameters. Do make sure that you get the web tag names right and the output form at parameters right.


This table shows the web tags used on the '''thismonthT.htm''' web template.
As another example of inconsistency in how web tags added in different versions are coded, there are two web tags (highest minimum/lowest maximum temperatures) where a standard web tag is not provided by Cumulus (1 or MX) for the associated time-stamp. Consequently, for these 2 (and their corresponding tags in the this month group), there are mandatory output parameters required as shown in the table. Obviously Cumulus 1 lets you use "NN", "nn", "MM", or "mm" for the minutes, but minutes can only be represented in one way in Cumulus MX.


Because the rainfall this month does not appear on '''thismonthT.htm''' web page, it is shown in [[#Current_Conditions|indexT.htm]] table earlier in this article which is for the web page where it does appear.
Remember that the Year-to-date runs from roll-over time on 1 January for all web tags listed here.  


The web tags in the date column output dates in the format "dd MMMM" (for once this is same for Cumulus 1 and Cumulus MX). Should you require a different output format, this can be changed using the [[#Time.2FDate_.27format.27_Parameter|format parameters]] described above. For web tags that represent daily values, there are (obviously) no corresponding time web tags, but for high and low spot values the default 'h:mm' format of the time output can be changed using output parameters. Do make sure that you get the web tag names right and the output form at parameters right.
The list below does NOT include any web tags that represent seasonal derivatives, i.e. where you define the month from which they start counting. (Cumulative seasonal Chill Hours <#chillhours> and Total seasonal rainfall <#ryear> can both be found in [[Webtags#Current_Conditions|Current Conditions]]). Note, that does not imply both are included in '''indexT.htm'''.


As another example of inconsistency in how web tags added in different versions are coded, there are two web tags (highest minimum/lowest maximum temperatures) where a standard web tag is not provided by Cumulus (1 or MX) for the associated time-stamp. Consequently, for these 2 (and their corresponding tags in the this year group), there are mandatory output parameters required as shown in the table. Obviously Cumulus 1 lets you use "NN", "nn", "MM", or "mm" for the minutes, but minutes can only be represented in one way in Cumulus MX.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 1,828: Line 1,840:
!style="width:150px"|Web tag_name
!style="width:150px"|Web tag_name
!style="width:300px"|Function
!style="width:300px"|Function
!style="width:150px"|Time
!style="width:350px"|Time
!style="width:150px"|Date
!style="width:150px"|Date
|-
|-
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#MonthTempH>
|<#YearTempH>
|This months high temperature
|This year's highest temperature
|<#MonthTempHT>
|<#YearTempHT>
|<#MonthTempHD>
|<#YearTempHD>
|-
|-
|<#MonthTempL>
|<#YearTempL>
|This months low temperature
|This year's lowest temperature
|<#MonthTempLT>
|<#YearTempLT>
|<#MonthTempLD>
|<#YearTempLD>
|-
|-
|<#MonthMinTempH>
|<#YearHighDailyTempRange>
|This months highest daily minimum temperature
|This year's highest Daily Temp Range
|[[File:badge v1.png]]<#MonthMinTempHD format=hh:nn> or <#MonthMinTempHD format=HH:mm> for Cumulus 1, 
[[File:Badge vMx.png]] <#MonthMinTempHD format=HH:mm> for Cumulus MX
|<#MonthMinTempHD>
|-
|<#MonthMaxTempL>
|This months lowest daily maximum temperature
|[[File:badge v1.png]]<#MonthMaxTempLD format=HH:mm> or <#MonthMaxTempLD format=hh:nn> for Cumulus 1,
[[File:Badge vMx.png]]<#MonthMaxTempLD format=HH:mm> for Cumulus MX
|<#MonthMaxTempLD>
|-
|<#MonthHighDailyTempRange>
|High Daily Temp Range
|n/a
|n/a
|<#MonthHighDailyTempRangeD>
|<#YearHighDailyTempRangeD>
|-
|-
|<#MonthLowDailyTempRange>
|<#YearLowDailyTempRange>
|Low Daily Temp Range
|This year's lowest Daily Temp Range
|n/a
|n/a
|<#MonthLowDailyTempRangeD>
|<#YearLowDailyTempRangeD>
|-
|-
|<#MonthHeatIndexH>
|<#YearHeatIndexH>
|This months high USA heat index
|This year's highest USA heat index
|<#MonthHeatIndexHT>
|<#YearHeatIndexHT>
|<#MonthHeatIndexHD>
|<#YearHeatIndexHD>
|-
|-
|<#MonthWChillL>
|<#YearWChillL>
|This months greatest wind chill (i.e. lowest temperature)
|This year's greatest wind chill (i.e. lowest temperature)
|<#MonthWChillLT>
|<#YearWChillLT>
|<#MonthWChillLD>
|<#YearWChillLD>
|-
|-
|<#MonthAppTempH>
|<#YearAppTempH>
|This month's high apparent temperature
|This year's highest apparent temperature
|<#MonthAppTempHT>
|<#YearAppTempHT>
|<#MonthAppTempHD>
|<#YearAppTempHD>
|-
|-
|<#MonthAppTempL>
|<#YearAppTempL>
|This month's low apparent temperature
|This year's lowest apparent temperature
|<#MonthAppTempLT>
|<#YearAppTempLT>
|<#MonthAppTempLD>
|<#YearAppTempLD>
|-
|-
|<#MonthFeelsLikeH>
|<#YearFeelsLikeH>
|This month's highest feels like temperature (available from [[File:Badge vMx.png]] 3.6.0)  (NOT AVAILABLE IN CUMULUS 1)
|[[File:Badge vMx.png]]This year's highest feels like temperature (available from 3.6.0)  (NOT AVAILABLE IN CUMULUS 1)
|<#MonthFeelsLikeHT>
|<#YearFeelsLikeHT>
|<#MonthFeelsLikeHD>
|<#YearFeelsLikeHD>
|-
|-
|<#MonthFeelsLikeL>
|<#YearFeelsLikeL>
|This months lowest feels like temperature (available from [[File:Badge vMx.png]] 3.6.0)  (NOT AVAILABLE IN CUMULUS 1)
|[[File:Badge vMx.png]]This year's lowest feels like temperature (available from 3.6.0)  (NOT AVAILABLE IN CUMULUS 1)
|<#MonthFeelsLikeLT>
|<#YearFeelsLikeLT>
|<#MonthFeelsLikeLD>
|<#YearFeelsLikeLD>
|-
|-
|<#MonthHumidexH>
|<#YearHumidexH>
|[[File:Badge vMx.png]] (Available from version 3.7.0)    (NOT AVAILABLE IN CUMULUS 1)
|[[File:Badge vMx.png]] (Available from version 3.7.0)    (NOT AVAILABLE IN CUMULUS 1)


This month's highest Canadian Humidity Index
This year's highest Canadian Humidity Index
|<#MonthHumidexHT>
|<#YearHumidexHT>
|<#MonthHumidexHD>
|<#YearHumidexHD>
|-
|-
|<#MonthDewPointH>
|<#YearDewPointH>
|This month's high dew point
|This year's highest dew point
|<#MonthDewPointHT>
|<#YearDewPointHT>
|<#MonthDewPointHD>
|<#YearDewPointHD>
|-
|-
|<#MonthDewPointL>
|<#YearDewPointL>
|This month's low dew point
|This year's lowest dew point
|<#MonthDewPointLT>
|<#YearDewPointLT>
|<#MonthDewPointLD>
|<#YearDewPointLD>
|-
|-
|<#MonthHumH>
|<#YearMinTempH>
|This month's highest humidity
|This year's highest daily minimum temperature
|<#MonthHumHT>
|Flavour specific mandatory output parameters:
|<#MonthHumHD>
* <#YearMinTempHD format=HH:nn> ''for Cumulus 1'',
* <#YearMinTempHD format=HH:mm> ''for Cumulus MX''
|<#YearMinTempHD>
|-
|-
|<#MonthHumL>
|<#YearMaxTempL>
|This month's lowest humidity
|This year's lowest daily maximum temperature
|<#MonthHumLT>
|Flavour specific mandatory output parameters:
|<#MonthHumLD>
* <#YearMaxTempHD format=HH:nn> ''for Cumulus 1'',
* <#YearMaxTempHD format=HH:mm> ''for Cumulus MX''
 
|<#YearMaxTempLD>
|-
|-
|colspan="4" style="background:lightgray;"|Pressure
|<#YearHumH>
|This year's high humidity
|<#YearHumHT>
|<#YearHumHD>
|-
|-
|<#MonthPressH>
|<#YearHumL>
|This month's highest pressure
|This year's low humidity
|<#MonthPressHT>
|<#YearHumLT>
|<#MonthPressHD>
|<#YearHumLD>
|-
|colspan="4" style="background:lightgray;"|Pressure
|-
|<#YearPressH>
|This year's high pressure
|<#YearPressHT>
|<#YearPressHD>
|-
|-
|<#MonthPressL>
|<#YearPressL>
|This month's lowest pressure
|This year's low pressure
|<#MonthPressLT>
|<#YearPressLT>
|<#MonthPressLD>
|<#YearPressLD>
|-
|-
|colspan="4" style="background:lightgray;"|Wind
|colspan="4" style="background:lightgray;"|Wind
|-
|-
|<#MonthGustH>
|<#YearGustH>
|This month's highest wind gust
|This year's high wind gust
|<#MonthGustHT>
|<#YearGustHT>
|<#MonthGustHD>
|<#YearGustHD>
|-
|<#MonthWindH>
|This month's highest wind speed
|<#MonthWindHT>
|<#MonthWindHD>
|-
|-
|<#MonthWindRunH>
|<#YearWindH>
|This month's high Daily Wind Run
|This year's high wind speed
|<#YearWindHT>
|<#YearWindHD>
|-
|<#YearWindRunH>
This year's highest Daily Wind Run
|n/a
|n/a
|<#MonthWindRunHD>  
|<#YearWindRunHD>  
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|colspan="4" style="background:lightgray;"|Rainfall
|-
|-
|<#MonthRainRateH>
|<#YearRainRateH>
|This month's highest rainfall rate
|This year's highest rainfall rate
|<#MonthRainRateHT>
|<#YearRainRateHT>
|<#MonthRainRateHD>
|<#YearRainRateHD>
|-
|-
|<#MonthHourlyRainH>
|<#YearHourlyRainH>
|This month's highest hourly rain
|This year's highest hourly rain
|<#MonthHourlyRainHT>
|<#YearHourlyRainHT>
|<#MonthHourlyRainHD>
|<#YearHourlyRainHD>
|-
|-
|<#MonthDailyRainH>
|<#YearDailyRainH>
|This month's wettest day (greatest daily rain)
|This year's high daily rain
|n/a
|n/a
|<#MonthDailyRainHD>
|<#YearDailyRainHD>
|-
|<#YearMonthlyRainH>
|This year's high monthly rain
|n/a
|<#YearMonthlyRainHD>
|-
|-
|<#MonthLongestDryPeriod>
|<#YearLongestDryPeriod>
|Longest dry period ending this month (days)
|Longest period without rain ending this year (days)
|n/a
|n/a
|<#MonthLongestDryPeriodD>
|<#YearLongestDryPeriodD>
|-
|-
|<#MonthLongestWetPeriod>
|<#YearLongestWetPeriod>
|Longest period of rain every day, ending this month (days)
|Longest period of rain every day ending this year (days)
|n/a
|n/a
|<#MonthLongestWetPeriodD>
|<#YearLongestWetPeriodD>
|-
|-
|colspan="4" style="background:lightgray;"|Solar
|colspan="4" style="background:lightgray;"|Solar
Line 1,982: Line 2,002:
[[File:Badge vMx.png]] (Available from release 3.12.0 onwards)
[[File:Badge vMx.png]] (Available from release 3.12.0 onwards)
|-
|-
| <#SunshineHoursMonth>
| <#SunshineHoursYear>
| the total sunshine hours in month-to-date, or with [[Webtags/Parameters#Input_modification_Parameters|input modification parameters using either '''y''' and '''m''' or '''r''']] for a past month
| the total sunshine hours in year-to-date, or with [[Webtags/Parameters#Input_modification_Parameters|input modification parameters using either '''y''' or '''r''']] for a past year
| n/a
| n/a
| n/a
| n/a
|}
|}


==Yearly==
==All Time==


This table shows most of the web tags used on the "thisyearT.htm" web template.
This table lists the web tags that appear in the '''recordsT.htm''' example template that is included in each release since version 1.5.1 10th January 2006.  Additional tags correctly populated from 3.6.10 (build 3086) or 3.7.0 (build 3089) are marked with a "MX" icon as they are not available in Cumulus 1. Please note the 3.6.10 release was available from 24 June 2020, if the date shown for those MX only tags is before when you installed that (or a later release), the output may show incorrect values.


The web tags in the date column output dates in the format "dd MMMM" (for once this is same for Cumulus 1 and Cumulus MX). Should you require a different output format, this can be changed using the [[#Time.2FDate_.27format.27_Parameter|format parameters]] described above. For web tags that represent daily values, there are (obviously) no corresponding time web tags, but for high and low spot values the default 'h:mm' format of the time output can be changed using output parameters. Do make sure that you get the web tag names right and the output form at parameters right.
The output from the web tags shown in the date/time column have the default format that is seen on "records.htm" in the standard web pages:
*The default format for an extreme month is to show the month name in full i.e. format 'MMMM' followed by the year in full.
*For an extreme day it shows the day of the month and the month name in full i.e. format "dd MMMM" (same for Cumulus 1 and Cumulus MX), prefixed with the word 'on' again ending with the year.  
*For the highest/lowest within a day in the year it shows both time and date adding the word "at" before the time, and the word 'on' before the date (i.e. on the standard web page the time comes first, not as seen in admin interface).


As another example of inconsistency in how web tags added in different versions are coded, there are two web tags (highest minimum/lowest maximum temperatures) where a standard web tag is not provided by Cumulus (1 or MX) for the associated time-stamp. Consequently, for these 2 (and their corresponding tags in the this month group), there are mandatory output parameters required as shown in the table. Obviously Cumulus 1 lets you use "NN", "nn", "MM", or "mm" for the minutes, but minutes can only be represented in one way in Cumulus MX.
You can change the default output on either the standard web template, or in your own file, by using the [[#Time.2FDate_.27format.27_Parameter|formats]] features described above, but this can involve complicated use of single and double quotes and there are differences between Cumulus 1 and Cumulus MX. Please see examples section above for advice.
 
Remember that the Year-to-date runs from roll-over time on 1 January for all web tags listed here.
 
The list below does NOT include any web tags that represent seasonal derivatives, i.e. where you define the month from which they start counting. (Cumulative seasonal Chill Hours <#chillhours> and Total seasonal rainfall <#ryear> can both be found in [[Webtags#Current_Conditions|Current Conditions]]). Note, that does not imply both are included in '''indexT.htm'''.


Note that unlike the this month and this year web tags, the time and the date are both included in the default format of the standard time-stamp web tags for the 'highest minimum' and 'lowest maximum' temperatures, yet another inconsistency!


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px"|Web tag_name
!style="width:150px" | Web tag_name
!style="width:300px"|Function
!style="width:400px" | Function
!style="width:350px"|Time
!style="width:150px" | Date/Time
!style="width:150px"|Date
|-
|-
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#YearTempH>
|<#tempH>
|This year's highest temperature
|All time high temperature
|<#YearTempHT>
|<#TtempH>
|<#YearTempHD>
|-
|-
|<#YearTempL>
|<#tempL>
|This year's lowest temperature
|All time low temperature  
|<#YearTempLT>
|<#TtempL>
|<#YearTempLD>
|-
|-
|<#YearHighDailyTempRange>
|<#mintempH>
|This year's highest Daily Temp Range
|All time high minimum temperature
|n/a
|<#TmintempH>
|<#YearHighDailyTempRangeD>
|-
|-
|<#YearLowDailyTempRange>
|<#maxtempL>
|This year's lowest Daily Temp Range
|All time low maximum temperature
|n/a
|<#TmaxtempL>
|<#YearLowDailyTempRangeD>
|-
|-
|<#YearHeatIndexH>
|<#LowDailyTempRange>
|This year's highest USA heat index
|All time low daily temperature range
|<#YearHeatIndexHT>
|<#TLowDailyTempRange>
|<#YearHeatIndexHD>
|-
|-
|<#YearWChillL>
|<#HighDailyTempRange>
|This year's greatest wind chill (i.e. lowest temperature)
|All time high daily temperature range
|<#YearWChillLT>
|<#THighDailyTempRange>
|<#YearWChillLD>
|-
|-
|<#YearAppTempH>
|<#apptempH>
|This year's highest apparent temperature
|All time high apparent temperature
|<#YearAppTempHT>
|<#TapptempH>
|<#YearAppTempHD>
|-
|-
|<#YearAppTempL>
|<#apptempL>
|This year's lowest apparent temperature
|All time low apparent temperature
|<#YearAppTempLT>
|<#TapptempL>
|<#YearAppTempLD>
|-
|-
|<#YearFeelsLikeH>
|<#feelslikeH>
|[[File:Badge vMx.png]]This year's highest feels like temperature (available from 3.6.0)   (NOT AVAILABLE IN CUMULUS 1)
|[[File:Badge vMx.png]]All time high feels like temperature (available from 3.6.0)
|<#YearFeelsLikeHT>
|<#TfeelslikeH>
|<#YearFeelsLikeHD>
|-
|-
|<#YearFeelsLikeL>
|<#feelslikeL>
|[[File:Badge vMx.png]]This year's lowest feels like temperature (available from 3.6.0)   (NOT AVAILABLE IN CUMULUS 1)
|[[File:Badge vMx.png]]All time low feels like temperature (available from 3.6.0)
|<#YearFeelsLikeLT>
|<#TfeelslikeL>
|<#YearFeelsLikeLD>
|-
|-
|<#YearHumidexH>
|<#humidexH>
|[[File:Badge vMx.png]] (Available from version 3.7.0)   (NOT AVAILABLE IN CUMULUS 1)
|[[File:Badge vMx.png]]All time high Canadian Humidity Index (available from 3.7.0)
 
|<#ThumidexH>
This year's highest Canadian Humidity Index
|<#YearHumidexHT>
|<#YearHumidexHD>
|-
|-
|<#YearDewPointH>
|<#heatindexH>
|This year's highest dew point
|All time high USA heat index
|<#YearDewPointHT>
|<#TheatindexH>
|<#YearDewPointHD>
|-
|-
|<#YearDewPointL>
|<#dewpointH>
|This year's lowest dew point
|All time high dew point
|<#YearDewPointLT>
|<#TdewpointH>
|<#YearDewPointLD>
|-
|-
|<#YearMinTempH>
|<#dewpointL>
|This year's highest daily minimum temperature
|All time low dew point
|Flavour specific mandatory output parameters:
|<#TdewpointL>
* <#YearMinTempHD format=HH:nn> ''for Cumulus 1'',
* <#YearMinTempHD format=HH:mm> ''for Cumulus MX''
|<#YearMinTempHD>
|-
|-
|<#YearMaxTempL>
|<#humH>
|This year's lowest daily maximum temperature
|All time high humidity
|Flavour specific mandatory output parameters:
|<#ThumH>
* <#YearMaxTempHD format=HH:nn> ''for Cumulus 1'',
* <#YearMaxTempHD format=HH:mm> ''for Cumulus MX''
 
|<#YearMaxTempLD>
|-
|-
|<#YearHumH>
|<#humL>
|This year's high humidity
|All time low humidity
|<#YearHumHT>
|<#ThumL>
|<#YearHumHD>
|-
|-
|<#YearHumL>
|<#wchillH>
|This year's low humidity
|All time greatest wind chill (i.e. lowest temperature, but highest wind speed)
|<#YearHumLT>
|<#TwchillH>
|<#YearHumLD>
|-
|-
|colspan="4" style="background:lightgray;"|Pressure
|colspan="3" style="background:lightgray;"|Rainfall
|-
|-
|<#YearPressH>
|<#rrateM>
|This year's high pressure
|All time high rain rate
|<#YearPressHT>
|<#TrrateM>
|<#YearPressHD>
|-
|-
|<#YearPressL>
|<#rfallH>
|This year's low pressure
|All time high daily rain
|<#YearPressLT>
|<#TrfallH>
|<#YearPressLD>
|-
|-
|colspan="4" style="background:lightgray;"|Wind
|<#rfallhH>
|All time high hourly rain
|<#TrfallhH>
|-
|-
|<#YearGustH>
|<#rfallmH>
|This year's high wind gust
|All time high monthly rain
|<#YearGustHT>
|<#TrfallmH>
|<#YearGustHD>
|-
|-
|<#YearWindH>
|<#LongestDryPeriod>
|This year's high wind speed
|All time longest dry period (days)
|<#YearWindHT>
|<#TLongestDryPeriod>
|<#YearWindHD>
|-
|-
|<#YearWindRunH>
|<#LongestWetPeriod>
This year's highest Daily Wind Run
|All time longest wet period (days)
|n/a
|<#TLongestWetPeriod>
|<#YearWindRunHD>  
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|colspan="3" style="background:lightgray;"|Pressure
|-
|-
|<#YearRainRateH>
|<#pressH>
|This year's highest rainfall rate
|All time high pressure
|<#YearRainRateHT>
|<#TpressH>
|<#YearRainRateHD>
|-
|-
|<#YearHourlyRainH>
|<#pressL>
|This year's highest hourly rain
|All time low pressure
|<#YearHourlyRainHT>
|<#TpressL>
|<#YearHourlyRainHD>
|-
|-
|<#YearDailyRainH>
|colspan="3" style="background:lightgray;"|Wind
|This year's high daily rain
|n/a
|<#YearDailyRainHD>
|-
|-
|<#YearMonthlyRainH>
|<#gustM>
|This year's high monthly rain
|All time high wind gust
|n/a
|<#TgustM>
|<#YearMonthlyRainHD>
|-
|-
|<#YearLongestDryPeriod>
|<#wspeedH>
|Longest period without rain ending this year (days)
|All time high average wind speed
|n/a
|<#TwspeedH>
|<#YearLongestDryPeriodD>
|-
|-
|<#YearLongestWetPeriod>
|<#windrunH>
|Longest period of rain every day ending this year (days)
|All time high daily wind run
|n/a
|<#TwindrunH>
|<#YearLongestWetPeriodD>
|}
|-
|colspan="4" style="background:lightgray;"|Solar


[[File:Badge vMx.png]] (Available from release 3.12.0 onwards)
==Monthly==
|-
| <#SunshineHoursYear>
| the total sunshine hours in year-to-date, or with [[Webtags/Parameters#Input_modification_Parameters|input modification parameters using either '''y''' or '''r''']] for a past year
| n/a
| n/a
|}


==All Time==
This table shows the web tags used on the '''thismonthT.htm''' web template.


This table lists the web tags that appear in the '''recordsT.htm''' example template that is included in each release since version 1.5.1 10th January 2006.  Additional tags correctly populated from 3.6.10 (build 3086) or 3.7.0 (build 3089) are marked with a "MX" icon as they are not available in Cumulus 1. Please note the 3.6.10 release was available from 24 June 2020, if the date shown for those MX only tags is before when you installed that (or a later release), the output may show incorrect values.
Because the rainfall this month does not appear on '''thismonthT.htm''' web page, it is shown in [[#Current_Conditions|indexT.htm]] table earlier in this article which is for the web page where it does appear.


The output from the web tags shown in the date/time column have the default format that is seen on "records.htm" in the standard web pages:
The web tags in the date column output dates in the format "dd MMMM" (for once this is same for Cumulus 1 and Cumulus MX). Should you require a different output format, this can be changed using the [[#Time.2FDate_.27format.27_Parameter|format parameters]] described above. For web tags that represent daily values, there are (obviously) no corresponding time web tags, but for high and low spot values the default 'h:mm' format of the time output can be changed using output parameters. Do make sure that you get the web tag names right and the output form at parameters right.
*The default format for an extreme month is to show the month name in full i.e. format 'MMMM' followed by the year in full.
*For an extreme day it shows the day of the month and the month name in full i.e. format "dd MMMM" (same for Cumulus 1 and Cumulus MX), prefixed with the word 'on' again ending with the year.  
*For the highest/lowest within a day in the year it shows both time and date adding the word "at" before the time, and the word 'on' before the date (i.e. on the standard web page the time comes first, not as seen in admin interface).


You can change the default output on either the standard web template, or in your own file, by using the [[#Time.2FDate_.27format.27_Parameter|formats]] features described above, but this can involve complicated use of single and double quotes and there are differences between Cumulus 1 and Cumulus MX. Please see examples section above for advice.
As another example of inconsistency in how web tags added in different versions are coded, there are two web tags (highest minimum/lowest maximum temperatures) where a standard web tag is not provided by Cumulus (1 or MX) for the associated time-stamp. Consequently, for these 2 (and their corresponding tags in the this year group), there are mandatory output parameters required as shown in the table. Obviously Cumulus 1 lets you use "NN", "nn", "MM", or "mm" for the minutes, but minutes can only be represented in one way in Cumulus MX.
 
Note that unlike the this month and this year web tags, the time and the date are both included in the default format of the standard time-stamp web tags for the 'highest minimum' and 'lowest maximum' temperatures, yet another inconsistency!


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Web tag_name
!style="width:150px"|Web tag_name
!style="width:400px" | Function
!style="width:300px"|Function
!style="width:150px" | Date/Time
!style="width:150px"|Time
!style="width:150px"|Date
|-
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#tempH>
|<#MonthTempH>
|All time high temperature
|This months high temperature
|<#TtempH>
|<#MonthTempHT>
|<#MonthTempHD>
|-
|-
|<#tempL>
|<#MonthTempL>
|All time low temperature  
|This months low temperature
|<#TtempL>
|<#MonthTempLT>
|<#MonthTempLD>
|-
|-
|<#mintempH>
|<#MonthMinTempH>
|All time high minimum temperature  
|This months highest daily minimum temperature
|<#TmintempH>
|[[File:badge v1.png]]<#MonthMinTempHD format=hh:nn> or <#MonthMinTempHD format=HH:mm> for Cumulus 1, 
[[File:Badge vMx.png]] <#MonthMinTempHD format=HH:mm> for Cumulus MX
|<#MonthMinTempHD>
|-
|-
|<#maxtempL>
|<#MonthMaxTempL>
|All time low maximum temperature  
|This months lowest daily maximum temperature
|<#TmaxtempL>
|[[File:badge v1.png]]<#MonthMaxTempLD format=HH:mm> or <#MonthMaxTempLD format=hh:nn> for Cumulus 1,
[[File:Badge vMx.png]]<#MonthMaxTempLD format=HH:mm> for Cumulus MX
|<#MonthMaxTempLD>
|-
|-
|<#LowDailyTempRange>
|<#MonthHighDailyTempRange>
|All time low daily temperature range
|High Daily Temp Range
|<#TLowDailyTempRange>
|n/a
|<#MonthHighDailyTempRangeD>
|-
|-
|<#HighDailyTempRange>
|<#MonthLowDailyTempRange>
|All time high daily temperature range
|Low Daily Temp Range
|<#THighDailyTempRange>
|n/a
|<#MonthLowDailyTempRangeD>
|-
|-
|<#apptempH>
|<#MonthHeatIndexH>
|All time high apparent temperature
|This months high USA heat index
|<#TapptempH>
|<#MonthHeatIndexHT>
|<#MonthHeatIndexHD>
|-
|-
|<#apptempL>
|<#MonthWChillL>
|All time low apparent temperature
|This months greatest wind chill (i.e. lowest temperature)
|<#TapptempL>
|<#MonthWChillLT>
|<#MonthWChillLD>
|-
|-
|<#feelslikeH>
|<#MonthAppTempH>
|[[File:Badge vMx.png]]All time high feels like temperature (available from 3.6.0)
|This month's high apparent temperature
|<#TfeelslikeH>
|<#MonthAppTempHT>
|<#MonthAppTempHD>
|-
|-
|<#feelslikeL>
|<#MonthAppTempL>
|[[File:Badge vMx.png]]All time low feels like temperature (available from 3.6.0)
|This month's low apparent temperature
|<#TfeelslikeL>
|<#MonthAppTempLT>
|<#MonthAppTempLD>
|-
|-
|<#humidexH>
|<#MonthFeelsLikeH>
|[[File:Badge vMx.png]]All time high Canadian Humidity Index (available from 3.7.0)
|This month's highest feels like temperature (available from [[File:Badge vMx.png]] 3.6.0)   (NOT AVAILABLE IN CUMULUS 1)
|<#ThumidexH>
|<#MonthFeelsLikeHT>
|<#MonthFeelsLikeHD>
|-
|-
|<#heatindexH>
|<#MonthFeelsLikeL>
|All time high USA heat index
|This months lowest feels like temperature (available from [[File:Badge vMx.png]] 3.6.0)  (NOT AVAILABLE IN CUMULUS 1)
|<#TheatindexH>
|<#MonthFeelsLikeLT>
|<#MonthFeelsLikeLD>
|-
|-
|<#dewpointH>
|<#MonthHumidexH>
|All time high dew point
|[[File:Badge vMx.png]] (Available from version 3.7.0)    (NOT AVAILABLE IN CUMULUS 1)
|<#TdewpointH>
 
This month's highest Canadian Humidity Index
|<#MonthHumidexHT>
|<#MonthHumidexHD>
|-
|-
|<#dewpointL>
|<#MonthDewPointH>
|All time low dew point
|This month's high dew point
|<#TdewpointL>
|<#MonthDewPointHT>
|<#MonthDewPointHD>
|-
|-
|<#humH>
|<#MonthDewPointL>
|All time high humidity
|This month's low dew point
|<#ThumH>
|<#MonthDewPointLT>
|<#MonthDewPointLD>
|-
|-
|<#humL>
|<#MonthHumH>
|All time low humidity
|This month's highest humidity
|<#ThumL>
|<#MonthHumHT>
|<#MonthHumHD>
|-
|-
|<#wchillH>
|<#MonthHumL>
|All time greatest wind chill (i.e. lowest temperature, but highest wind speed)
|This month's lowest humidity
|<#TwchillH>
|<#MonthHumLT>
|<#MonthHumLD>
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|colspan="4" style="background:lightgray;"|Pressure
|-
|-
|<#rrateM>
|<#MonthPressH>
|All time high rain rate
|This month's highest pressure
|<#TrrateM>
|<#MonthPressHT>
|<#MonthPressHD>
|-
|-
|<#rfallH>
|<#MonthPressL>
|All time high daily rain
|This month's lowest pressure
|<#TrfallH>
|<#MonthPressLT>
|<#MonthPressLD>
|-
|-
|<#rfallhH>
|colspan="4" style="background:lightgray;"|Wind
|All time high hourly rain
|<#TrfallhH>
|-
|-
|<#rfallmH>
|<#MonthGustH>
|All time high monthly rain
|This month's highest wind gust
|<#TrfallmH>
|<#MonthGustHT>
|<#MonthGustHD>
|-
|-
|<#LongestDryPeriod>
|<#MonthWindH>
|All time longest dry period (days)
|This month's highest wind speed
|<#TLongestDryPeriod>
|<#MonthWindHT>
|<#MonthWindHD>
|-
|-
|<#LongestWetPeriod>
|<#MonthWindRunH>
|All time longest wet period (days)
|This month's high Daily Wind Run
|<#TLongestWetPeriod>
|n/a
|<#MonthWindRunHD>  
|-
|colspan="4" style="background:lightgray;"|Rainfall
|-
|-
|colspan="3" style="background:lightgray;"|Pressure
|<#MonthRainRateH>
|This month's highest rainfall rate
|<#MonthRainRateHT>
|<#MonthRainRateHD>
|-
|-
|<#pressH>
|<#MonthHourlyRainH>
|All time high pressure
|This month's highest hourly rain
|<#TpressH>
|<#MonthHourlyRainHT>
|<#MonthHourlyRainHD>
|-
|-
|<#pressL>
|<#MonthDailyRainH>
|All time low pressure
|This month's wettest day (greatest daily rain)
|<#TpressL>
|n/a
|<#MonthDailyRainHD>
|-
|-
|colspan="3" style="background:lightgray;"|Wind
|<#MonthLongestDryPeriod>
|Longest dry period ending this month (days)
|n/a
|<#MonthLongestDryPeriodD>
|-
|-
|<#gustM>
|<#MonthLongestWetPeriod>
|All time high wind gust
|Longest period of rain every day, ending this month (days)
|<#TgustM>
|n/a
|<#MonthLongestWetPeriodD>
|-
|-
|<#wspeedH>
|colspan="4" style="background:lightgray;"|Solar
|All time high average wind speed
 
|<#TwspeedH>
[[File:Badge vMx.png]] (Available from release 3.12.0 onwards)
|-
|-
|<#windrunH>
| <#SunshineHoursMonth>
|All time high daily wind run
| the total sunshine hours in month-to-date, or with [[Webtags/Parameters#Input_modification_Parameters|input modification parameters using either '''y''' and '''m''' or '''r''']] for a past month
|<#TwindrunH>
| n/a
| n/a
|}
|}


==Monthly All Time Records==
==Monthly All Time Records==
Line 2,317: Line 2,327:
This table includes web tags that show the values in [[Monthlyalltime.ini]] log file, which was introduced in version 1.9.3 (build 1033, 10 Apr 2012).
This table includes web tags that show the values in [[Monthlyalltime.ini]] log file, which was introduced in version 1.9.3 (build 1033, 10 Apr 2012).


These are a set of tags for monthly all-time highs and lows, in other words the highest and lowest values for a particular month of the year.  To supply both optional input modification, and optional output modification parameters, separate them with spaces, e.g. <#ByMonthTempHT mon=7 format=hh:nn>. In that example, the highest ever temperature in July is returned in the value after processing by Cumulus.
These are a set of tags for monthly all-time highs and lows, in other words the highest and lowest values for a particular month of the year.   
 
# The tag names listed here require a [[Webtags/Parameters#Input_modification_Parameters|input modification parameter]].
For full details of the input modification parameters, see [[Webtags/Parameters#Input_modification_Parameters|Parameters]] page.
# The tag names here can optionally take any [[Webtags/Parameters#Output_modification_parameters|output modification parameters]].
# To supply both optional input modification, and optional output modification parameters, separate them with spaces, e.g. <#ByMonthTempHT mon=7 format=hh:nn>. In that example, the time (not date) of highest ever temperature in July is returned after processing by Cumulus.


Additional tags correctly populated from 3.6.10 (build 3086) or 3.7.0 (build 3089) are marked with a "MX" icon as they are not available in Cumulus 1. Please note the 3.6.10 release was available from 24 June 2020, if the date/time shown for those MX only tags is before when you installed that (or a later release), the feels like output may show incorrect values.
At release 3.6.10 (build 3086), and at release 3.7.0 (build 3089); additional tag names were introduced:
* They are marked with a "MX" icon as they are not available in legacy Cumulus 1.  
* If you have any "feels like temperatures" that appear with a date/time parameter with a date before 24 June 2020, or before you installed the 3.6.10 release (or a later release), then the value web tag may show incorrect values.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/9544...9582"

Navigation menu