Webtags (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
Line 13: Line 13:


{{TOCright}}
{{TOCright}}
== Webtags available in Cumulus ==
== Web tags available in Cumulus ==
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]] and that processing involves Cumulus recognising special markers placed in the template file.


These are special markers placed in a file which Cumulus can then process and replace with the actual values.  Typically you would use this to build your own website by having an HTML template file with your layout, static text and graphics.  In the position on the page you wish Cumulus to insert the relevant data place a webtag in the form:
Those special markers in the file are called web tags, during processing Cumulus will replace them with the actual values.  Typically you would use this to build your own website by having an HTML template file with your layout, static text and graphics.  In the position on the page you wish Cumulus to insert the relevant data place a web tag in the form:


  <pre><#tag_name [optional input parameters][optional output parameters]></pre>
  <pre><#tag_name [optional input parameters][optional output parameters]></pre>


''Note: When you put a tag into your template, be careful that whatever program you are using to develop your web pages doesn't change the angle brackets to slightly different symbols -- this is a common cause of failure!''
''Note: When you put a tag into your template, be careful that whatever program you are using to develop your web pages doesn't change the angle brackets to slightly different symbols -- this is a common cause of failure!'' There are a number of editing tools that are designed for those programming code and you should use one of those (e.g. Notepad++), rather than a tool designed for web page design editing (eg. Dreamweaver).


Web tags are case sensitive, so please type the tag name exactly as shown in the web tag columns on this page. These web tag markers can return values for both readings from your weather station and the what can be derived from those readings. A small number of web tags require lower case input parameters to select which value is shown (e.g. value for one hour ago). Although some web tags will not accept output parameters, others allow you to vary the number of decimal places that are output, or to vary the way that times and dates are output. Some output parameters are case sensitive for Cumulus 1 (all are case sensitive for MX), so do check them carefully.
Web tags are case sensitive, so please type the tag name exactly as shown in the web tag columns on this page. These web tag markers can return values for both readings from your weather station and the what can be derived from those readings. A small number of web tags require lower case input parameters to select which value is shown (e.g. value for one hour ago). Although some web tags will not accept output parameters, others allow you to vary the number of decimal places that are output, or to vary the way that times and dates are output. Some output parameters are case sensitive for Cumulus 1 (all are case sensitive for MX), so do check them carefully.