Php webtags: Difference between revisions

990 bytes added ,  20:19, 7 February 2015
m
→‎Options available: Improve layout
m (→‎Options available: Improve layout)
Line 5: Line 5:
It is more efficient  for those using PHP on their website to have Cumulus process one single file and place all the [[webtags]] values into a file of PHP variables.  You can include this file in all your PHP web files and use the variables as you would in PHP.
It is more efficient  for those using PHP on their website to have Cumulus process one single file and place all the [[webtags]] values into a file of PHP variables.  You can include this file in all your PHP web files and use the variables as you would in PHP.
=Options available=
=Options available=
# One approach is to create an array '''$WX''' and within it have elements for all the Cumulus web tags. A file to do this is called ''CUtags.txt'' and can be downloaded from [http://saratoga-weather.org/wxtemplates/install.php Saratoga-Weather.org]. That approach includes elements for the recent history tags at 5, 10, 15, 20, 30, 45, 60, 75, 90, 105 and 120 minutes. In this case your customised pages would replace any reference to a Cumulus web tag <#xxyyzz> by a PHP array element $WX[xxyyzz] (some elements include the m=10 type selector).
# One approach is to create an array '''$WX'''
# Another approach is to create a PHP variable for each Cumulus web tag. In this case your customised pages would replace any reference to a Cumulus web tag <#xxyyzz> by a PHP variable $xxyyzz. This is done by the file cumuluswebtags.tx, and this PHP file (download [http://sandaysoft.com/forum/viewtopic.php?f=6&t=10424 cumuluswebtags.txt  link]) contains all current [[webtags]] produced by Cumulus v 1.9.4, but as supplied the recent history tags are commented out and if you want to use them you need to put in the necessary time selectors yourself.
#*Within it have elements for all the Cumulus web tags.
#*A file to do this is called ''CUtags.txt'' and can be downloaded from [http://saratoga-weather.org/wxtemplates/install.php Saratoga-Weather.org].
#*That approach includes elements for the recent history tags at 5, 10, 15, 20, 30, 45, 60, 75, 90, 105 and 120 minutes. If you want older values or values at other times, then you will need to add these to the array yourself. #*Using this array your customised pages would replace any reference to a Cumulus web tag <#xxyyzz> by a PHP array element $WX[xxyyzz] (some elements include the m=10 type selector).
# Another approach is to create a PHP variable for each Cumulus web tag.
#*In this case your customised pages would replace any reference to a Cumulus web tag <#xxyyzz> by a PHP variable $xxyyzz.
#*In your customised pages use the instruction '''require cumuluswebtags.php'''.
#*To produce this PHP file, you need a template file (download [[File:Cumuluswebtags.txt]]) that is [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|processed]] by Cumulus.
#*For more information see [http://sandaysoft.com/forum/viewtopic.php?f=6&t=10424 cumulus web tags support forum link].
#*The download file contains all current [[webtags]] produced by Cumulus v 1.9.4.
#*Note that as supplied the recent history tags only occur with a single 3 hours ago parameter but if you use these tags it is likely you will want to include them for several other periods too so if you want to use them you need to put in the necessary time selectors yourself.
# There was another project [[xml webtags|XML webtags]] but that is now obsolete.
# There was another project [[xml webtags|XML webtags]] but that is now obsolete.
# Yet another approach is to use JSON for transferring the variables in a portable way. Cumulus MX has one array per weather variable each element being a sub-array containing a time-stamp and the value at that time.
# An alternative approach is to use JSON for transferring the variables in a portable way.
 
#*Cumulus MX has one array per weather variable; each element being a sub-array containing a time-stamp and the value at that time.  Again you may need to choose the interval between such sub-arrays that suits your use in your web pages.
=Option 2 - implementation details=
The installation, usage, and example sections below apply to option 2, but are similar for the other options.
The installation, usage, and example sections below apply to option 2, but are similar for the other options.
==Installation ==
==Installation ==
For the file you have downloaded at option 2 above, open it in any text editor and look at first and last line.  In each of these find the following sequence of 4 characters "'''&''' '''l''' '''t''' ''';'''" and replace all of those with just one "''<''" and then save the file in the directory where you want Cumulus to read it.
[[File:ScreenShot-PHPWebtags-ConfigSetup.png|right|'Screenshot top and bottom extracts Cumulus v1.9.4']]
[[File:ScreenShot-PHPWebtags-ConfigSetup.png|right|'Screenshot top and bottom extracts Cumulus v1.9.4']]
# Choose a local directory (that Cumulus can read) where you store your customised templates as the destination for this download, or copy the file there after download;
# Choose a local directory (that Cumulus can read) where you store your customised templates as the destination for this download, or copy the file there after download;
5,838

edits