5,838
edits
Webtags/Parameters (preserving history): Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
Webtags/Parameters (preserving history) (view source)
Revision as of 09:12, 12 April 2021
, 09:12, 12 April 2021add category
m (Sfws moved page Webtag/Parameters to Webtags/Parameters without leaving a redirect: Try again) |
m (add category) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 26: | Line 26: | ||
== What is a web tag parameter?== | == What is a web tag parameter?== | ||
{{TOCright}} | |||
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. | ||
| Line 47: | Line 48: | ||
There are currently only two groups of tags where an input parameter is mandatory: | There are currently only two groups of tags where an input parameter is mandatory: | ||
#The '''recent history tags''' where a separate value exists for potentially every individual minute in last week. | #The [[Webtags#Recent_History|'''recent history tags''']] where a separate value exists for potentially every individual minute in last week. | ||
#* These tags need between one and three input parameters as explained below. | #* These tags need between one and three input parameters as explained below. | ||
#The [[Webtags#Monthly_All_Time_Records]] where a separate value exists for each particular month (of any year). | #The [[Webtags#Monthly_All_Time_Records|'''monthly all-time records''']] where a separate value exists for each particular month (of any year). | ||
#*These tags need an input parameter specifying which month. | #*These tags need an input parameter specifying which month. | ||
#*To save you looking up the linked section, a single input parameter is needed (which is 1 for January to 12 for December, or 0 for current month). | #*To save you looking up the linked section, a single input parameter is needed (which is 1 for January to 12 for December, or 0 for current month). | ||
==Input Modification Parameters for Recent History tags == | |||
You specify which value you want from the array by using parameters on the web tags for number of days ago, hours ago, and minutes ago. The same d, h, and m, parameters are used by Cumulus 1 and MX. | You specify which value you want from the array by using parameters on the web tags for number of days ago, hours ago, and minutes ago. The same d, h, and m, parameters are used by Cumulus 1 and MX. | ||
| Line 82: | Line 83: | ||
The list of tags available has not changed between last Cumulus 1 release and any MX release. Any new derivatives reported elsewhere have not resulted in equivalent new recent history tags. | The list of tags available has not changed between last Cumulus 1 release and any MX release. Any new derivatives reported elsewhere have not resulted in equivalent new recent history tags. | ||
==Input Modification Parameters for Monthly all-time tags== | |||
Each Monthly All Time Records web tag has an optional input parameter "mon=N" where N is the index of the month of the year that you want the value for (January=1 and so on). | |||
If you don't supply an input parameter (or supply an invalid value like zero) the current month will be used. This is useful if you want to write a template that will always supply values for the current month and don't want to use a script to enter the correct input parameter by processing with that script before Cumulus processes the template. | |||
The corresponding date/time web tags are formatted just like the all time records. You can customise the date and time formats by adding the output 'format' modification parameters (shown later on this page) to the web tag. | |||
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. | |||
= Output modification parameters = | = Output modification parameters = | ||
| Line 231: | Line 242: | ||
There are differences between the original (legacy) Cumulus and MX. The characters used for specifying the required output modification vary, so all tables showing details of time and date modifiers have separate columns showing what is used in each flavour. | There are differences between the original (legacy) Cumulus and MX. The characters used for specifying the required output modification vary, so all tables showing details of time and date modifiers have separate columns showing what is used in each flavour. | ||
[[Category:Cumulus MX]] | |||
====For the legacy software==== | ====For the legacy software==== | ||
