5,838
edits
Webtags (preserving history): Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→What this article covers
m (→GENERAL TIP) |
|||
| Line 29: | Line 29: | ||
=What this article covers = | =What this article covers = | ||
At the last count MX produces nine and a half million '''web tags'''! But the file mentioned in previous section contains just 717 items. How come this discrepancy? | At the last count, a 3.5.x version of MX produces nine and a half million '''web tags'''! But the file mentioned in previous section contains just 717 items (later versions of MX raise this count by another forty tags or so). How come this discrepancy? | ||
Well each web tag has the general format <tt><#tag_name optional_input_parameter optional_output_parameter></tt> and it is adding these optional parameters that allow 717 tag names to define 9½ million values! | Well each web tag has the general format <tt><#tag_name optional_input_parameter optional_output_parameter></tt> and it is adding these optional parameters that allow 717 tag names to define 9½ million values! | ||
Consequently, this article describes: | |||
*Over 7 hundred web tags | |||
*A score of input parameters that modify some of those tags | |||
*The components that make up output parameters that modify almost all web tags that report a time and/or date | |||
*The way that some of those date modifiers are used for naming NOAA reports | |||
The tables below are not able to indicate which of the billions of combinations possible are valid or invalid for you. | |||
==Applicability by version and build== | |||
The tip at the start of this article tells you how to check which tags are available in whatever build of Cumulus you are actually using. Given how often a new release alters either what web tags are available or what parameters can be used with particular web tags, it is not possible for the tables below to tell you precisely how you use web tags at any version. | |||
Because Cumulus 2 is no longer available, it has been ignored in the tables below. | |||
[[File:Badge v1.png]]This badge is used to highlight text that applies to Cumulus 1. | |||
*Use of this badge does NOT mean that all builds of Cumulus 1 are able to use the web tag. | |||
*There are gaps in the Cumulus 1 documentation, and so it is not usual for the table entry to indicate when a particular web tags started to be available | |||
*If you are using the final version of Cumulus 1, then the text highlighted by that badge does apply to you. | |||
*In general, Cumulus 1 will silently ignore any web tag it does not recognise. This means that you might see the raw | |||
web tag remaining after processing, or you might see nothing where the web tag was prior to processing. It also means that if you try to do a numeric calculation on a web tag that Cumulus 1 does not recognise, the calculation will fail, but you might not see an error message. | |||
[[File:Badge vMx.png]]This badge is used to highlight text that applies to Cumulus 3 (MX) only. | |||
*In many cases, it highlights web tags that are not available in Cumulus 1 | |||
*Use of this badge does not mean that all builds of MX are able to use this web tag | |||
*Some attempt has been made to indicate '''either''' which MX build introduced individual tags, '''or''' from which build the web tag started giving the correct response (where earlier builds reported incorrect values for that web tag in some cases). | |||
*MX will raise an error: | |||
**for any web tag it does not recognise at the version you are running | |||
**for any input parameter that the token parser is unable to recognise | |||
*MX treats output parameters differently: | |||
**any output parameter that it does not recognise at all, is ignored | |||
**an incorrectly formatted output parameter may be treated as an error by the token parser | |||
**if you use the wrong output formatting parameters, you are likely to be confused by the output (the most common cases result in seeing minutes where a month is wanted, or there is a misunderstanding of the concept where the same character has different meanings when on its own and when with other characters). | |||
= NOAA style Report Naming = | = NOAA style Report Naming = | ||
