5,838
edits
(4 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Template:Version badge Mx}}{{Version badge 1}}This Wiki page applies to both flavours of Cumulus currently available. | |||
=Introduction= | =Introduction= | ||
This page is about parameters used for modifying Cumulus web tags. To | This page is about parameters used for modifying Cumulus web tags. | ||
A [[Cumulus template file|'''Cumulus Template File''']] is the name given by Steve Loft to any files that contain web tags. Each of those files need to be processed before they actually include values: | |||
* MX avoids using these template files, the code itself internally generates most of the data files that are sent externally. | |||
* The legacy Cumulus 1 software, and MX releases up to release 3.9.7 - build 3107, used lots of template files (see [[Customised templates]]. | |||
For Cumulus MX, there is still one Cumulus template file, the web tags that supply values to the various tables in the [[New Default Web Site Information|Default Web Site]] are stored in [[websitedataT.json]] file. Most of those web tags use the default output format, but a few use some of the [[#Output modification parameters]] listed below. To customise the default web site, you might want to edit '''websitedataT.json''', by using information found on this page. | |||
To set context, let us learn the terminology with cross-references to where those features are explained further. | |||
==What is a web tag? == | ==What is a web tag? == | ||
Put simply, a [[Webtags|web tag]] is included in a [[Cumulus template file]] to indicate where Cumulus should insert values when it [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|processes that template]] and produces an output file. | Put simply, a [[Webtags|web tag]] is included in a [[Cumulus template file]] to indicate where Cumulus should insert values when it [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|processes that template]] and produces an output file. | ||
The output file can be: | The output file can be: | ||
Line 12: | Line 22: | ||
* a [[Feels_Like#HTML_code_to_translate_web_tags_to_JavaScript_variables_.28as_modified_for_additional_parameters.29|JavaScript file]], | * a [[Feels_Like#HTML_code_to_translate_web_tags_to_JavaScript_variables_.28as_modified_for_additional_parameters.29|JavaScript file]], | ||
* a [[PHP]] script file, or | * a [[PHP]] script file, or | ||
*a [[Xml_webtags|eXtensible Mark-up Language (XML)]] file. | * a [[Xml_webtags|eXtensible Mark-up Language (XML)]] file. | ||
==General Format for Web Tags== | ==General Format for Web Tags== | ||
In the position in the file where Cumulus is to insert the relevant data, place a web tag in the '''general format''' specified here: | In the position in the template file where Cumulus is to insert the relevant data, place a web tag in the '''general format''' specified here: | ||
< | <code><#tag_name [optional input selection parameters] [optional output modification parameters]></code> | ||
==== Case sensitivity for tag names ==== | ==== Case sensitivity for tag names ==== | ||
The tag_name in the general format above is case sensitive, so please type the tag name exactly as shown in the | The tag_name in the general format above is case sensitive, so please type the tag name exactly as shown in the tag name columns in the tables on the [[Webtags|tag names page]]. | ||
== What is a web tag parameter?== | == What is a web tag parameter?== | ||
Now we get to the terminology for what this Wiki page will document. | Now we get to the terminology for what this Wiki page will document. | ||
The parameters shown in the general format above are of two kinds: | The parameters shown in the general format above are of two kinds: | ||
# Input modifying | |||
# Output modifying | |||
You can include both optional input modification, and optional output modification parameters | |||
* As the general format above shows, you separate them with spaces, e.g. <#ByMonthTempHT mon=7 format=hh:nn>. | |||
** In that example, the time only is returned for the highest ever temperature in July, after processing by Cumulus of the time-stamp web tag. | |||
=== Case sensitivity for parameters === | === Case sensitivity for parameters === | ||
The optional input parameters always use lower case, so please type them exactly as shown in the | The optional input modification parameters always use lower case, so please type them exactly as shown in the [[#Input modification Parameters|section below]]. | ||
The content of optional output parameters are only case insensitive when used in Cumulus 1. | |||
For Cumulus 2 and later, so this includes MX, the output parameters are case sensitive and also dependent on what other output formatters are being used if any, so please read the sections on output parameters and study the examples in the tables carefully. | |||
= Input modification Parameters = | = Input modification Parameters = | ||
'''Most web tags do not require any input parameters'''. | '''Most web tags do not require any input parameters'''. Luckily, where they are needed, it is quite simple to use them, see table below. | ||
* An input parameter is used where the same web tag can represent a value for a number of different past time instants. | * An input parameter is used where the same web tag can represent a value for a number of different past time instants. | ||
Line 49: | Line 62: | ||
* So a combination of web tag name and input modification parameter lets Cumulus select the value you want to see. | * So a combination of web tag name and input modification parameter lets Cumulus select the value you want to see. | ||
* The web tags that can use input modification parameters will depend on which Cumulus release you are using | * The web tags that can use input modification parameters will depend on which Cumulus release you are using | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 62: | Line 74: | ||
! scope="row"| Tag names listed at [[Webtags#Table of Recent History tag names available|'''Table of Recent History tag names available''']] (see [[Recent history]] page for explanation) | ! scope="row"| Tag names listed at [[Webtags#Table of Recent History tag names available|'''Table of Recent History tag names available''']] (see [[Recent history]] page for explanation) | ||
| One value for each minute in last 7 days | | One value for each minute in last 7 days | ||
| | | '''d''' specifies number of days ago, | ||
'''h''' specifies number of hours ago, | |||
and '''m''' specifies number of minutes ago. | |||
* You can use any combination of the three parameters. | * You can use any combination of the three parameters. | ||
* The same d, h, and m, parameters are used by Cumulus 1 and MX. | * The same d, h, and m, parameters are used by Cumulus 1 and MX. | ||
| Cumulus 1.9.3 beta build 1033 | | Cumulus 1.9.3 beta build 1033 (remain available in MX) | ||
| Examples for outside temperature: | | Examples for outside temperature: | ||
* <#RecentOutsideTemp m=1> will give the temperature one minute ago, <#RecentOutsideTemp h=1> will give the temperature one hour ago (as will <#RecentOutsideTemp m=60>). | * <#RecentOutsideTemp m=1> will give the temperature one minute ago, <#RecentOutsideTemp h=1> will give the temperature one hour ago (as will <#RecentOutsideTemp m=60>). | ||
* <#RecentOutsideTemp d=1> will give the temperature one day ago | * <#RecentOutsideTemp d=1> will give the temperature one day ago. | ||
* <#RecentOutsideTemp d=1 h=1 m=1> will give the temperature one day, one hour and one minute ago. | * <#RecentOutsideTemp d=1 h=1 m=1> will give the temperature one day, one hour and one minute ago. | ||
|All values supplied for parameters must be whole numbers. | |All values supplied for parameters must be whole numbers. | ||
* If you don't supply any parameters, the result is undefined for Cumulus 1, and an illegal web tag for MX. | * If you don't supply any parameters, the result is undefined for Cumulus 1, and an illegal web tag for MX. | ||
* | * '''Beware: If you use <code><#RecentRainToday d=2></code> remember that rainfall can accumulate during a day, so "d=2" returns an estimate of the rain between rollover 2 days ago and the same time as now 48 hours ago, it does not return the total rainfall 2 days ago! | ||
* ''''''Please note:''' Some Cumulus users say that using <#RecentOutsideTemp d=1 m=1> is more reliable at getting the temperature at a similar time the day before, the extra minute apparently gives better results when you might not be using Cumulus all the time, or your weather station might have some drift on when it supplies readings. See which works best for you. | |||
'''Beware: If you use <code><#RecentRainToday d=2></code> remember that rainfall can accumulate during a day, so "d=2" returns an estimate of the rain between rollover 2 days ago and the same time as now 48 hours ago, it does not return the total rainfall 2 days ago!''' | |||
|- | |- | ||
! scope="row"| [[Webtags#Monthly_All_Time_Records|'''monthly all-time extreme records''']] | ! scope="row"| [[Webtags#Monthly_All_Time_Records|'''monthly all-time extreme records''']] | ||
| These exist for all occurrences of the current month, and for all occurrences of each month | | These exist for all occurrences of the current month, and for all occurrences of each month | ||
| '''mon=N''' where N is the index of the month of the year that you want the value for (1 =January, and so on, to 12 =December) | | '''mon=N''' | ||
| Cumulus 1.9.3 beta build 1033 | |||
| | where N is the index of the month of the year that you want the value for (1 =January, and so on, to 12 =December) | ||
| Cumulus 1.9.3 beta build 1033 (remain available in MX) | |||
| <#ByMonthDewPointH mon=3> is highest monthly dew point for any March and <#ByMonthDewPointHT mon=3> is the related time and date. | |||
<#ByMonthTempH mon=3> gives highest temperature in any March, <#ByMonthTempHT mon=3> gives the date and time for that highest temperature | <#ByMonthTempH mon=3> gives highest temperature in any March, <#ByMonthTempHT mon=3> gives the date and time for that highest temperature | ||
| Only one input parameter applies: | | Only one input parameter applies: | ||
* The value of "N" supplied should be an integer between 1 and 12 | * The value of "N" supplied should be an integer between 1 and 12 | ||
* If you don't supply an input parameter (or supply an invalid value like zero) the current month will be used. | * If you don't supply an input parameter (or supply an invalid value like zero) the current month will be used. | ||
Use without an input parameter applies if you want to write a template that will always supply values for the current month and don't want to process a script, to calculate the correct input parameter, before Cumulus processes the template. | |||
|- | |- | ||
! scope="row"| [[Webtags#Monthly|Only <#SunshineHoursMonth>]] and [[webtags#Yearly|Only <#SunshineHoursYear>]] | ! scope="row"| [[Webtags#Monthly|Only <#SunshineHoursMonth>]] and [[webtags#Yearly|Only <#SunshineHoursYear>]] | ||
| Values available for current month/year, and for past month/year | | Values available for current month/year, and for past month/year | ||
| Listed web tags take '''r=-ww''' | | Listed web tags take: '''r=-ww''' (note minus sign and up to 2 digits) | ||
* Monthly tags also take: '''m=N y=nnnn''' | * Monthly tags also take: '''m=N y=nnnn''' ('''N''' can be 1 to 12, ''nnnn'' is 4 digit year) | ||
* Yearly tags also take: '''y=nnnn''' | * Yearly tags also take: '''y=nnnn''' | ||
Omit input modification parameter to get value for current month/year | Omit input modification parameter to get value for current month/year | ||
Line 101: | Line 116: | ||
* <#SunshineHoursMonth> gives total sunshine hours since 1 minute past midnight at start of current month | * <#SunshineHoursMonth> gives total sunshine hours since 1 minute past midnight at start of current month | ||
* <#SunshineHoursMonth y=2021 m=1> for the January 2021 total | * <#SunshineHoursMonth y=2021 m=1> for the January 2021 total | ||
* <#SunshineHoursMonth r=-1> for last | * <#SunshineHoursMonth r=-1> for last month's total | ||
* <#SunshineHoursMonth r=-12> for same month as current month, but one year ago | * <#SunshineHoursMonth r=-12> for same month as current month, but one year ago | ||
Yearly examples: | |||
* <#SunshineHoursYear> gives total sunshine hours since 1 minute past midnight on New Year's Day | * <#SunshineHoursYear> gives total sunshine hours since 1 minute past midnight on New Year's Day | ||
* <#SunshineHoursYear y=2019> for the total for 2019 | * <#SunshineHoursYear y=2019> for the total for 2019 | ||
* <#SunshineHoursYear r=-2> total for the year before last (if current year is 2021, that | * <#SunshineHoursYear r=-2> total for the year before last (if current year is 2021, that returns total for 2019 as previous example) | ||
| Returns the sunshine hours total in selected period | | Returns the sunshine hours total in selected period | ||
(You need a sensor to be monitoring this throughout selected period) | |||
|} | |} | ||
= Output modification parameters = | = Output modification parameters = | ||
*A few web tags always need an output format specifier | This page does not tell you which web tags fall into each of these 3 types: | ||
*Some web tags | * A few web tags always need an output format specifier | ||
*The majority of web tags | * Some web tags ignore any output format specifier as they have a fixed output format | ||
* The majority of web tags have a default output if there is no output format modifier, but accept an output format parameter, so you can change what they output. | |||
To make life more complicated, the availability of output format parameters for particular web tags is dependent on which Cumulus release you are running. There is a general [[Webtag_Applicability|discussion about applicability]], but that does not | To make life more complicated, the availability of output format parameters for particular web tags is dependent on which Cumulus release you are running. There is a general [[Webtag_Applicability|discussion about applicability]], but that needs updating as it does not specify dependencies for individual [[Webtags|web tags]]. | ||
If you are using MX: | |||
* if your locale specifies that integer and decimal parts of real numbers are separated by a comma, there is an | * if your locale specifies that integer and decimal parts of real numbers are separated by a comma, there is an output parameter to replace that decimal comma by a decimal point for any script that does not recognise decimal commas | ||
* there are two output modifiers for changing number of decimal places | * there are two output modifiers for changing number of decimal places | ||
* there are multiple output modifiers for changing date and/or time format | * there are multiple output modifiers for changing date and/or time format | ||
If you are using the legacy Cumulus (or a very early MX release), please skip to [[#Two Output (format modifier) parameters for decimal places]] as the changing decimal comma into decimal point parameter is not available to you. | |||
Each of these will be explained in turn. | Each of these will be explained in turn. | ||
Line 137: | Line 155: | ||
**From release 3.6.6 onwards (1 June 2020), it was extended to other web tags that output real numbers. | **From release 3.6.6 onwards (1 June 2020), it was extended to other web tags that output real numbers. | ||
**From release 3.10.5 onwards (29 March 2021), the use of <tt><#tag_name rc=n></tt> became also possible, to ensure decimal comma shown when locale specifies it | **From release 3.10.5 onwards (29 March 2021), the use of <tt><#tag_name rc=n></tt> became also possible, to ensure decimal comma shown when locale specifies it | ||
This output modification format parameter can be used to replace all commas in the output by a full stop (don't worry, MX does not use a comma for separating off thousands, so it is the decimal comma that becomes a decimal full stop like character when this remove comma specifier is used). | This output modification format parameter can be used to replace all commas in the output by a full stop (don't worry, MX does not use a comma for separating off thousands, so it is the decimal comma that becomes a decimal full stop like character when this remove comma specifier is used). | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
Line 153: | Line 165: | ||
|rc=n | |rc=n | ||
|This is the default, so does not need to be specified. The output from the web tag will use either decimal comma or decimal point as specified by the locale in which MX is running | |This is the default, so does not need to be specified. The output from the web tag will use either decimal comma or decimal point as specified by the locale in which MX is running | ||
For more information about how the computer determines whether decimal commas is your default, see [[#Locale]] section later. | |||
| Both <#tempYH> and <#tempYH rc=n> will return yesterday's highest temperature using what is specified by locale to separate integer and decimal parts | | Both <#tempYH> and <#tempYH rc=n> will return yesterday's highest temperature using what is specified by locale to separate integer and decimal parts | ||
|- | |- | ||
Line 163: | Line 177: | ||
'''Why would you want to remove decimal commas?''' Well because the JavaScript language cannot understand decimal commas, and MX has several scripts written in this language, equally some third party alternative web pages rely on ajax to update them (and Ajax uses JavaScript). | '''Why would you want to remove decimal commas?''' Well because the JavaScript language cannot understand decimal commas, and MX has several scripts written in this language, equally some third party alternative web pages rely on ajax to update them (and Ajax uses JavaScript). | ||
== | ==Controlling the number of decimal places== | ||
Internally, Cumulus stores numbers in binary. You cannot represent base 10 decimal places exactly in base 2. | |||
From release 3.10.5 (which did a big rewrite of web tag handling), you can modify | Therefore, Cumulus stores to a precision that would generally give about 24 significant figures when expressed in base 10. | ||
Cumulus is written to assign particular numbers of decimal places to any outputs it makes, and in any logging of current, or extreme values (for day or longer periods). It determines these precisions, by reference to the units chosen for outputs. | |||
From release 3.12.0, you can set the default number of decimal places to output for all derivatives of temperature, pressure, etc. by [[Cumulus.ini#Units.2C_Derivative_Options.2C_and_Decimal_Places|advanced settings]]. Those settings can force output as integers, stopping these modification parameters from working. | |||
As handling of each web tag is coded individually, the number of decimal places output by default in any web tag might vary slightly from the above default. As Cumulus has been developed, people have commented that these defaults do not reflect the precision of their instrumentation (weather stations used with Cumulus tend not to have the accuracy of those used by meteorologists, or are not recalibrated as often). | |||
This section (and its subsections) only applies to tag names that output real numbers (with integer and decimal parts). You can't change anything that is output as an integer, or is text with these parameters, nor can you change the decimal places for any time element. | |||
Consequently, gradually Cumulus has allowed more and more of its output to take an output format modifier that allows people to control number of decimal places shown. | |||
===Two Output (format modifier) parameters for decimal places=== | |||
From release 3.10.5 (which did a big rewrite of web tag handling), you can modify real number output for individual tag names, using output modification parameters in either of the following formats: | |||
* <tt><#tag_name dp=i></tt> and | * <tt><#tag_name dp=i></tt> and | ||
*<tt><#tag_name tc=y></tt> | * <tt><#tag_name tc=y></tt> | ||
These can be applied to any tag names that represent real numbers (with integer and decimal parts). | These can be applied to any tag names that represent real numbers (with integer and decimal parts). | ||
====Rounding to a specific number of decimal places==== | |||
<tt>dp=i</tt> is used for both Cumulus 1 and MX. | |||
*The value '''i''' following the attribute '''dp''' is an integer, it represents how many decimal places you want for the output you see. | |||
This functionality was trialled in the original Cumulus, but has been properly implemented in MX. | |||
If you are using the legacy Cumulus (1.9.4), only <tt><#latitude dp=i></tt> and <tt><#longitude dp=i></tt> were able to be output with "i" denoting number of decimal places, e.g. <#latitude dp=5> gives "59.24250". | |||
If you are not using latest MX release, you may find this is not available for particular web tag names | |||
# From beta releases (3.0.0) onwards, <tt><#latitude dp=i></tt> and <tt><#longitude dp=i></tt> were able to be output with "i" decimal places | |||
#* But this output modification parameter could not be applied to any other tags in the MX beta. | |||
# MX when it came out of beta, added this output modification parameter usage in the moon tags <#MoonPercent> and <#MoonPercentAbs>). | |||
#* Specifically, <#MoonAge> gives "11" but <#MoonAge dp=3> gives "11.234" | |||
====Truncation of unwanted decimal places==== | |||
This output format modifier is only available in MX. | |||
<tt>tc=y</tt> is the truncation parameter, the attribute '''tc''' takes the value 'y' to remove decimal places by truncation. e.g. <#MoonAge tc=y>. | |||
Whilst many people want Cumulus to round output as done by the previous parameters, there are circumstances when rounding down (or truncation) gives the result desired. | |||
* If you are using an early release of MX, you will need to research whether this is available for particular tag names | |||
* Later releases of MX implement this for any tag that by default outputs decimal places. | |||
Note, truncation by MX converts real numbers to integers. There is no option to truncate to one decimal place, Airports are expected to report air field level (QFE), and sea level (QNH), pressures truncated to one decimal place rather than rounded. | |||
== Multiple Output Format Modifier parameters for times and dates == | == Multiple Output Format Modifier parameters for times and dates == | ||
Line 205: | Line 233: | ||
To start with a simple example, suppose you want date/time in ISO 8601 format: | To start with a simple example, suppose you want date/time in ISO 8601 format: | ||
# This means, something like ''2019-02-28 06:59:05''. | |||
# Take the tag name (from tables on [[Webtags]] page) | # Take the tag name (from tables on [[Webtags]] page) | ||
# Next check in [[#Which tag names take date/time output formatting modifiers]] to see if that tag accepts both time and date modifiers | # Next check in [[#Which tag names take date/time output formatting modifiers]] to see if that tag accepts both time and date modifiers | ||
# | # If our tag name does accept both date and time modifiers, simply modify the web tag as shown here <code><#tag_name format="yyyy-MM-dd HH:mm:ss"></code> where tag_name is set from step 1, but all the rest is typed as shown. | ||
# To explain each element in that format value, look in [[#Year formats]], [[#Month formats]], [[#Day formats]], [[#Use of spaces]], [[#Time formats]]. | # To explain each element in that format value, look in [[#Year formats]], [[#Month formats]], [[#Day formats]], [[#Use of spaces]], [[#Time formats]]. | ||
Should you want a different date/time format, then the sub-sections just referenced should help you to select a different arrangement, although there are some more options in [[#Date formats]]. | |||
===Which tag names take date/time output formatting modifiers=== | ===Which tag names take date/time output formatting modifiers=== | ||
Line 300: | Line 329: | ||
If Cumulus obtained archive data, as part of the catch-up process it can do when it restarts, any time-stamps for that period can only be the time of a particular archive record, so that might be every half an hour, but not aligned precisely with hour changes. | If Cumulus obtained archive data, as part of the catch-up process it can do when it restarts, any time-stamps for that period can only be the time of a particular archive record, so that might be every half an hour, but not aligned precisely with hour changes. | ||
===Dependency on Cumulus flavour=== | ===Dependency on Cumulus flavour=== | ||
Line 319: | Line 349: | ||
====The complications with MX==== | ====The complications with MX==== | ||
Cumulus MX works '''internally''' with dates specified in either a day before month before year format, or ISO 8601 date format where year comes first (yyyy-MM-dd) depending on context. Compatibility with the legacy software has so far meant while the [[:Category:Ini Files|*.ini Files]] have adopted the year first approach, the [[:Category:MX txt Files|*.txt Files]] have stuck to date formats as used in the legacy definitions. | Cumulus MX works '''internally''' with dates specified in either a day before month before year format, or ISO 8601 date format where year comes first (yyyy-MM-dd) depending on context. Compatibility with the legacy software has so far meant while the [[:Category:Ini Files|*.ini Files]] have adopted the year first approach, the [[:Category:MX txt Files|*.txt Files]] have stuck to date formats as used in the legacy definitions. | ||
Line 353: | Line 382: | ||
Literals are discussed fully in the [[#Including literals in format parameters]] sub-section later. If we want to include other characters not to be interpreted by the date time parameter parser, and spaces, then both double and single quotes must be used, and the spaces must be within the single quotes. An example, that shows all the options that MX allows, with literals is <code> <#TpressH format="\a't 'h:mm' ' tt' <nowiki><small>on 'd/M/yyyy' </small></nowiki>'"> </code>. | Literals are discussed fully in the [[#Including literals in format parameters]] sub-section later. If we want to include other characters not to be interpreted by the date time parameter parser, and spaces, then both double and single quotes must be used, and the spaces must be within the single quotes. An example, that shows all the options that MX allows, with literals is <code> <#TpressH format="\a't 'h:mm' ' tt' <nowiki><small>on 'd/M/yyyy' </small></nowiki>'"> </code>. | ||
Finally, the use of literals can cause you ''a problem if you want to use a date/time specification in a script'' because the script wants literal delimiters outside any web tags, so that delimiters remain when the web tag itself has been processed into a string by Cumulus. This means the type of quotes (single or double) used outside the web tag, cannot be used within the web tag. The complicated sounding (but actually simple solution) is to avoid placing literals, and/or spaces, within any output format specifier, instead put single quotes round the whole content. What you thought of putting as literals within any web tag is instead typed outside with separate web tags for the part of the specification before and after each literal. An example to make this clearer is <code>$MXDateTime | Finally, the use of literals can cause you ''a problem if you want to use a date/time specification in a script'' because the script wants literal delimiters outside any web tags, so that delimiters remain when the web tag itself has been processed into a string by Cumulus. This means the type of quotes (single or double) used outside the web tag, cannot be used within the web tag. The complicated sounding (but actually simple solution) is to avoid placing literals, and/or spaces, within any output format specifier, instead put single quotes round the whole content. What you thought of putting as literals within any web tag is instead typed outside with separate web tags for the part of the specification before and after each literal. An example to make this clearer is <code>$MXDateTime = '<#date format=yyyy-MM-dd>' . 'T' . '<#time format=hh:mm:ss>';</code>, which is written in PHP Hypertext preprocessor format, the literal 'T' has been inserted between two separate web tags. | ||
===Year formats=== | ===Year formats=== | ||
Line 804: | Line 833: | ||
== Forum reference == | == Forum reference == | ||
Steve Loft published a table showing comparison between output date modifiers for Cumulus 1 and MX at [https://cumulus.hosiene.co.uk/viewtopic.php?f=39&t=17888 Cumulus MX forum]. The table there was based on the table that | Steve Loft published a table showing comparison between output date modifiers for Cumulus 1 and MX at [https://cumulus.hosiene.co.uk/viewtopic.php?f=39&t=17888 Cumulus MX forum]. The table there was based on the table that appeared in this Wiki when only the original Cumulus existed, so it was designed to help people migrate to his MX beta, it was not intended as a definitive list of what modifiers were available for MX (Steve instructed people to look them up on some Microsoft sites). | ||
The subsequent comments in the forum suggested his layout got people confused. Most of that confusion came in two circumstances: | The subsequent comments in the forum suggested his layout got people confused. Most of that confusion came in two circumstances: | ||
*When someone wanted to use one date or time modifier on its own | *When someone wanted to use one date or time modifier on its own | ||
*When someone who had been using Cumulus 1 swapped to MX and wanted to replace a combination of output modifier characters | *When someone who had been using Cumulus 1 swapped to MX and wanted to replace a combination of output modifier characters that was not explicitly shown in his table. | ||
That all comes from the fact that when a MX modifier consists of a single character it can mean something different to when it appears with other characters. | |||
In Cumulus 1, "m" or "M" had two meanings depending whether it was combined with "H" or "h" (when it represented minutes), or on its own or with any other code (when it represented month). But for Cumulus 1, there is no other case where it matters what context a modifier is put in by the use of other modifiers, and no other modifier takes more than one meaning. | |||
In MX it is much more complicated, to take a few examples "D", "H", "M" represent different items on their own to what they represent when combined with other characters. That other character can be as simple as using a space or a "%" to modify the meaning of the character. | |||
Looking at the tables, now included above, you can see "G" is used on its own because it represents a full date-time specifier. "D" is similarly used on its own represents the long date format. If we only want the day of month number we must use "%d" to avoid the meaning of short date format that "d" on its own represents. | |||
If we want the typical Cumulus date-stamp of day of month number and month, then we have two choices, because both "d M" and "M" will work. This illustrates how "M" has a different meaning on its own and with another modifier. | |||
Hopefully, the way that information is now presented on this page makes any use of parameters for web tags much easier now. | Hopefully, the way that information is now presented on this page makes any use of parameters for web tags much easier now. |
edits