Webtags (preserving history): Difference between revisions

Webtags (preserving history) (view source)

Revision as of 09:08, 3 July 2020

1,095 bytes added , 09:08, 3 July 2020

m

no edit summary

Sfws

5,838

edits

@@ Line 1: / Line 1: @@
 [[Category:Terminology]]
-This Wiki page covers more than just web tags, it lists the way that you can specify the naming format for the NOAA style reports that Cumulus produces.
+=What is a web tag or token?=
+Put simply, what Cumulus 1 calls a web tag, and MX calls a web token, is included in a Cumulus template file to indicate where Cumulus should insert values when it produces an output file. The concept of [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|processing templates]] is explained in another article.  The output file can be a [[Customised_templates#HTML_5_-_a_very_quick_guide_to_structure|web page]], a [[Feels_Like#HTML_code_to_translate_web_tags_to_JavaScript_variables_.28as_modified_for_additional_parameters.29|JavaScript file]], a PHP script, or a [[Xml_webtags|eXtensible Mark-up Language (XML)]] file.
-However, the main purpose of this page is to explain web tags (tokens that Cumulus uses to indicate where when processing a file it should insert values) that apply to all flavours of Cumulus (Cumulus 1, 2, and 3 aka MX), any differences are highlighted as necessary. Remember as Cumulus is developed more and more web tags are made available, if you are not using the latest release, then some of those listed in this article may not be available. In general, Cumulus 1 will silently ignore any web tags it does not recognise, but MX will raise an error for any web tag it does not understand how to process.
-Please note some items on this page apply to specifying the report name format (NOAA style), but all items refer to what are called '''template files''', those are files that Cumulus (1 or MX) is asked to [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|process]] (do look up that cross-reference if you are not sure what process means, as it will explain how files may gain  a "tmp" extension during the processing) and that processing involves Cumulus recognising special markers (also known in MX as tokens) placed in the template file.
 {{TOCright}}
@@ Line 23: / Line 20: @@
 {{Version badge 1}}If you are using Cumulus 1, each build of that contains a build specific version of Cumulus Help, and within that help is a list of web tags with basic information on what each tag_name returns.
+=What this article covers =
+At the last count MX produces nine and a half million Web tags/tokens! But the file mentioned in previous section contains just 717 items. How come this discrepancy?
+Well each web tag has the general format <tt><#tag_name input_parameter output_parameter></tt> and it is these parameters that allow 717 items to produce 9½ milllion values!
+Because this article describes the parameters available, it covers more than just web tags, it lists the way that you can specify the naming format for the NOAA style reports that Cumulus produces as those names use a sub-set of the output parameters.
+Although web tags apply to all flavours of Cumulus (Cumulus 1, 2, and 3 aka MX), as mentioned above, the range available depends on the exact version/build of Cumulus you are using. Because Cumulus 2 is no longer available, it has been ignored in the tables below. However, in the tables of web tags below, some sections are marked Cumulus 1 only or MX only and some individual tags have markings indicating aspects that apply only to a particular flavour.  It is important to stress that these "C1" markings are for the final version of Cumulus 1 (and so if you are running an earlier version, some may not be available to you). Similarly the "MX" markings apply to the latest version of MX (and if you are using an earlier build, some may not be available to you). In general, Cumulus 1 will silently ignore any web tags it does not recognise, but MX will raise an error for any web token it does not understand how to process. Both flavours may either ignore, give wrong values, or refuse to accept, incorrect input or incorrect output parameters, this varies by tag/token and has not been indicated in the tables below.
 = NOAA style Report Naming =