Webtags (preserving history): Difference between revisions

m
Line 66: Line 66:
The tables below are not able to indicate which of the billions of combinations possible are valid or invalid for particular tag names nor for particular release versions..
The tables below are not able to indicate which of the billions of combinations possible are valid or invalid for particular tag names nor for particular release versions..


==Applicability by version and build==
==Applicability by flavour, and by release 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 possible the tables below do not list all web tags at any version, and the tables can't say which modifiers are available at your version.
Full support is available via the support forum at https://cumulus.hosiene.co.uk/viewforum.php?f=40 for the latest MX release. Given that some users may still be running an older MX release, where possible any web tag listed below for MX indicates at which release it first became available.


Because Cumulus 2 is no longer available, it has been ignored in the tables below.  It never really worked for web page generation, so if you happen to have installed Cumulus 2 from when it was available, you probably don't care which web tags it supports.
There is limited support available for Cumulus 1.9.4, but on this page every attempt is made to indicate which version of the legacy software introduced any web tag listed below as being available in the legacy software.  


[[File:Badge v1.png]]This badge is used to highlight text that applies to Cumulus 1.
Various approaches are trialled in the list for indicating which flavours a web tag exists for.  The [[Webtags#Davis|Davis]] section has a column that indicates the applicability. Other sections with more web tags use pink section headings to identify their applicability to the flavours. Finally, there are some individual entries where '''C1''' and '''MX''' symbols are used to indicate applicability.
*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]]<big>This badge is used to highlight text that applies to Cumulus 3 (MX) for any release with version numbers 3.0.0 to 3.9.7 ONLY.</big>
There is some more information on [[Webtag Applicability|Web tag Applicability page]].
*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
** Web tags can only be used with template files (Steve Loft names these files in format "xxxxxxT.htm") and none are provided in MX release 3.10.1 or later.
**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).
*You can, even with latest MX release, create a template file using web tags, as mentioned elsewhere on this page, and fully described on the [[Customised templates]] page.
*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
**any output parameter in a web tag that '''does not''' accept output parameters is also ignored
**any output parameter in a web tag that does accept output parameters, where the supplied parameter is inconsistent with the content of the web tag, is reported as an error by the token parser
**an output parameter that specifies only part of the standard output may be reported as an error because of single character rules (for example a tag that reports a time cannot understand '''format=H''', amongst the acceptable formats are ''format=%H'' for just hour and '''format=H:mm''' for hour and minutes but not seconds.
**any output parameter that contains incorrectly formatted characters in that output parameter will be treated as an error by the token parser (a common mistake is forgetting spaces are expected to be included with other literal characters by the MX token parser)
**if you use valid parameters but the wrong 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).


= Template Files =
= Template Files =
5,838

edits