Cumulus Wiki

Webtags (preserving history): Difference between revisions

Webtags (preserving history) (view source)

Revision as of 23:25, 7 April 2021

311 bytes added ,  23:25, 7 April 2021
Finish off
(Finish off)
Line 7: Line 7:
</div>
</div>


=What is a web tag? =
=Introduction=
 
==What is a web tag? ==


Put simply, a web tag 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.  
Put simply, a web tag 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.  
Line 19: Line 21:




== Why does MX talk about tokens? ==
==What this page covers ==
 
MX uses a '''token parser''' to read the web tags and replace them with the correct value, so if diagnostic output refers to tokens, it is saying the attempt to actually work out what content to return to replace the web tag with its tag name and parameters has encountered a problem.
 
=GENERAL TIP=
 
The web tags available in the version/build you are using, can be listed (in Cumulus 1 or Cumulus MX) by adding the following line to [[Cumulus.ini#Section:_Station|Cumulus.ini]] in the [station] section...
 
ListWebTags=1
 
Then start Cumulus and it will create a file called WebTags.txt in the same folder as where the executable is found. That file will list all the tags your build of Cumulus can currently generate. This list only contains the tag_names, it does not indicate what parameters they can take, nor does it include the brackets the tag name is surrounded by when you quote it in a template file for Cumulus to process.
 
An example of the output for an early MX version is at the end of this page (the actual output does not include commas, and has just one item per line, it has been compressed for inclusion in this article).
 
To stop Cumulus continuing to produce new versions of that file change the line to say ...
 
ListWebTags=0
 
{{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.
 
[[File:Badge vMx.png]] MX bug: The inclusion of a web tag in the list produced by this instruction, does not mean that web tag is actually populated with valid information. See https://cumulus.hosiene.co.uk/viewtopic.php?p=153096#p153096 for an example.
 
=What this page covers =


{{TOCright}}
{{TOCright}}
Line 55: Line 35:
*Over 7 hundred web tags -'''THIS ARTICLE MAY NOT CONTAIN ALL WEB TAGS AVAILABLE IN LATEST VERSION - It depends on someone updating this article if the developer does not have time to do so'''
*Over 7 hundred web tags -'''THIS ARTICLE MAY NOT CONTAIN ALL WEB TAGS AVAILABLE IN LATEST VERSION - It depends on someone updating this article if the developer does not have time to do so'''


=What is covered on another page=  
==What is covered on another page==  


The parameters you can use with web tags are explained on the [[Web Tag Parameters|parameters page]], there you can discover:
The parameters you can use with web tags are explained on the [[Web Tag Parameters|parameters page]], there you can discover:
Line 67: Line 47:
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 flavour, and by release version and build=
==Applicability by flavour, and by release version and build==


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.
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.
Line 76: Line 56:


There is some more information on [[Webtag Applicability|Web tag Applicability page]].
There is some more information on [[Webtag Applicability|Web tag Applicability page]].
== Why does MX talk about tokens? ==
MX uses a '''token parser''' to read the web tags and replace them with the correct value, so if diagnostic output refers to tokens, it is saying the attempt to actually work out what content to return to replace the web tag with its tag name and parameters has encountered a problem.
=GENERAL TIP=
The web tags available in the version/build you are using, can be listed (in Cumulus 1 or Cumulus MX) by adding the following line to [[Cumulus.ini#Section:_Station|Cumulus.ini]] in the [station] section...
ListWebTags=1
Then start Cumulus and it will create a file called WebTags.txt in the same folder as where the executable is found. That file will list all the tags your build of Cumulus can currently generate. This list only contains the tag_names, it does not indicate what parameters they can take, nor does it include the brackets the tag name is surrounded by when you quote it in a template file for Cumulus to process.
An example of the output for an early MX version is at the end of this page (the actual output does not include commas, and has just one item per line, it has been compressed for inclusion in this article).
To stop Cumulus continuing to produce new versions of that file change the line to say ...
ListWebTags=0
{{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.
[[File:Badge vMx.png]] MX bug: The inclusion of a web tag in the list produced by this instruction, does not mean that web tag is actually populated with valid information. See https://cumulus.hosiene.co.uk/viewtopic.php?p=153096#p153096 for an example.


=The web tag application programming interface=
=The web tag application programming interface=
Line 170: Line 173:
=The Web Tags for Cumulus =
=The Web Tags for Cumulus =


These are available in both Cumulus 1 and MX unless indicated by a version 1 or MX badge.
Here follow tables indicating what web tags are available to be used, tables group them by the basic purpose of the tags listed.
 
Here follow tables indicating what web tags/tokens can be used, tables group the web tags available by the basic purpose of the tags listed.


== System ==
== System ==
Line 183: Line 184:
|-
|-
!style="width:150px" |Web tag_name
!style="width:150px" |Web tag_name
!style="width:150px" |Applicability
!style="width:600px" |Function
!style="width:600px" |Function
|-
|-
|<#OsVersion>
|<#OsVersion>
|up to 1.9.4, and MX
|OS version, e.g. "Windows 7 x64 build 7600"
|OS version, e.g. "Windows 7 x64 build 7600"
Please note this may not return the information you expect!
|-
|-
|<#OsLanguage>
|<#OsLanguage>
|Both leagacy and MX
|OS language, e.g. "English"
|OS language, e.g. "English"
|-
|-
|<#SystemUpTime>
|<#SystemUpTime>
|{{Version badge 1}}How long the system has been up, e.g. "8 hours 21 minutes" (not available on MX)
|{{Version badge 1}}(not available on MX)
|How long the system has been up, e.g. "8 hours 21 minutes"  
|-
|-
|<#ProgramUpTime>
|<#ProgramUpTime>
|all releases
|How long Cumulus has been running, e.g. "7 hours 55 minutes"
|How long Cumulus has been running, e.g. "7 hours 55 minutes"
|-
|-
|<#CpuName>
|<#CpuName>
|{{Version badge 1}}CPU type, e.g. "Intel(R) Core(TM)2 Quad CPU Q6600 @ 2.40GHz" (not available on MX)
|{{Version badge 1}}(not available on MX)
|CPU type, e.g. "Intel(R) Core(TM)2 Quad CPU Q6600 @ 2.40GHz"
|-
|-
|<#CpuCount>
|<#CpuCount>
|{{Version badge 1}}(not available on MX)
|Number of processors, e.g. "4"
|Number of processors, e.g. "4"
|-
|-
|<#MemoryStatus>
|<#MemoryStatus>
|{{Version badge 1}}Free and total system RAM, e.g. "4619/8191 MB (free/total)" (not available on MX)
|{{Version badge 1}}(not available on MX)
|Free and total system RAM, e.g. "4619/8191 MB (free/total)"
|-
|-
|<#DisplayMode>
|<#DisplayMode>
|{{Version badge 1}}Screen display mode, e.g. "1680x1050, 32 bit" (not available on MX)
|{{Version badge 1}}(not available on MX)
|Screen display mode, e.g. "1680x1050, 32 bit"
|-
|-
|<#AllocatedMemory>
|<#AllocatedMemory>
|{{Version badge 1}}Amount of memory allocated to Cumulus, e.g. "18.76 MB" (not available on MX)
|{{Version badge 1}}(not available on MX)
|Amount of memory allocated to Cumulus, e.g. "18.76 MB"
|-
|-
|<#DiskSize>
|<#DiskSize>
|{{Version badge 1}}Size of disk on which Cumulus is running, e.g. "931.51 GB" (not available on MX)
|{{Version badge 1}}(not available on MX)
|Size of disk on which Cumulus is running, e.g. "931.51 GB"  
|-
|-
|<#DiskFree>
|<#DiskFree>
|{{Version badge 1}}Free space on disk on which Cumulus is running, e.g. "515.36 GB" (not available on MX)
|{{Version badge 1}}(not available on MX)
|Free space on disk on which Cumulus is running, e.g. "515.36 GB"
|}
|}


== Miscellaneous ==
== Miscellaneous ==


All tags are available in all flavours, as far as I know, although their output might vary, and which input/output parameters they permit might vary between Cumulus 1 and MX.
All tags are available in all flavours, as far as I know, although ''their output might vary'', and which input/output parameters they permit might vary between Cumulus 1 and MX.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 261: Line 276:
|-
|-
|<#realtimeinterval>
|<#realtimeinterval>
|The realtime update interval in seconds (integer)
|The real time update interval in seconds (integer)
|-
|-
|<#interval>
|<#interval>
Line 267: Line 282:
|-
|-
|<#rollovertime>
|<#rollovertime>
|The time that the logs rollover to the next day: 'Midnight', '9 am' or '10 am'
|The time that the logs rollover to the next day: will always return one of these: 'Midnight', '9 am' or '10 am'


This is the end of the meteorological day, so if during Daylight Saving Time it is "10 am", then on the day DST ends it will return to "9 am" ensuring every meteorological day is exactly 24 hours long. If the time is "Midnight" or during DST it is "9 am", then days will be 23 or 25 hours long just on day clocks change, 24 hours otherwise.
This is the end of the meteorological day, so if during Daylight Saving Time rolover is at "10 am", then on the day DST ends it will return to "9 am" ensuring every meteorological day is exactly 24 hours long. If the time is "Midnight" (or during DST it is "9 am"), then days will be 23 or 25 hours long just on day clocks change, 24 hours otherwise.
|-
|-
|<#update>
|<#update>
|The date and time of the last web site update
|The date and time of the last web site update. The default format of the output depends on your locale settings.
|-
|-
|<#LastDataReadT>
|<#LastDataReadT>
|The date/time data was last read from the station
|The date/time data was last read from the station. The default format of the output depends on your locale settings.
|-
|-
|<#stationtype>
|<#stationtype>
Line 292: Line 307:
|-
|-
|<#altitude>
|<#altitude>
|The station [http://en.wikipedia.org/wiki/Altitude altitude] value (webtag outputs web encoded format containing figure, '&amp;nbsp;' and units) in either feet or metres just as you entered during setup (so it is more complex to extract number for script arithmetric); e.g. '123&amp;nbsp;m'
|The station [http://en.wikipedia.org/wiki/Altitude altitude] value (web tag outputs web encoded format containing figure, '&amp;nbsp;' and units) in either feet or metres just as you entered during setup (so it is more complex to extract number for script arithmetic); e.g. '123&amp;nbsp;m'
|-
|-
|<#location>
|<#location>
Line 302: Line 317:
|<#forum>
|<#forum>
|URL of the forum (as you entered during setup)
|URL of the forum (as you entered during setup)
For Cumulus 1, this defaults to a Sandaysoft URL that is no longer available, for MX this defaults to the current support forum hosted by "Freddie" web server site
For Cumulus 1, this defaults to a Sandaysoft URL that is no longer available, for MX this defaults to the current support forum (web server site hosted by "Freddie")
|-
|-
|<#webcam>
|<#webcam>
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/8330"