Customised templates: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
171 bytes added ,  23:32, 10 February 2015
m
Line 54: Line 54:
#*If ''Include Standard Files'' is selected it processes all the standard files (those listed in table above). The (built in, third party) component which handles the processing of the template file copes with a missing input file by creating an empty output file.
#*If ''Include Standard Files'' is selected it processes all the standard files (those listed in table above). The (built in, third party) component which handles the processing of the template file copes with a missing input file by creating an empty output file.
#*If ''Include Standard Files'' is not selected, then only the files explicitly listed as local files for processing are processed.
#*If ''Include Standard Files'' is not selected, then only the files explicitly listed as local files for processing are processed.
#*Regardless of that setting, the Cumulus component will process those listed in [[Cumulus.ini#Section:_FTP_Site]] as local files (the first 10 appear on 'Files' tab in internet settings screen reached from configuration menu) that also have ''Process?'' selected (set to 1 in Cumulus.ini#Section:_FTP_Site).
#*Regardless of that setting, the Cumulus component will process those listed in [[Cumulus.ini#Section:_FTP_Site]] as local files (the first 10 appear on 'Files' tab in internet settings screen reached from configuration menu) that also have ''Process?'' selected (set to 1 in Cumulus.ini#Section:_FTP_Site). [[File:Cumulus FTP Process.png |right]]
#The result of that process is the creation of local web pages (until build 1092 the created pages were in XHTML 1.0 Transitional using charset=iso-8859-1; from build 1093 the created pages are by default - see below for how to change this - in HTML 5 using charset="UTF-8")
#Processing means:
#*By inserting Hyper Text Mark-up Language structure and text as defined by the template.
#*Where it finds a [[Webtags|web tag]] it will -
#*Where it finds a [[Webtags|web tag]] it will
#**either insert the relevant observations from the weather station,
#**either insert the relevant observations from the weather station,
#**or insert derived values calculated by Cumulus,  
#**or insert derived values calculated by Cumulus,  
#** or insert time-stamps (formatted by default or [[Webtags#Time.2FDate_.27format.27_Parameter|how you specify]]),
#**or insert time-stamps (formatted by default or [[Webtags#Time.2FDate_.27format.27_Parameter|how you specify]]),
#** or [[Webtags#Miscellaneous|miscellaneous]] values.
#**or [[Webtags#Miscellaneous|miscellaneous]] values.
#*The file name that Cumulus uses for the created local web page depends on whether the original template is being processed by ''Include Standard Files'' (in which case the created web page is the same name without a T) or being processed as an ''Extra file'' because it is listed on the ''Files'' tab (or in cumulus.ini FTP section) as a local file (in which case the created web page is the same as the original filename with its extension but with 'tmp' suffixed to the extension)The latter copes with customised templates that do not use the 'T' convention.[[File:Cumulus FTP Process.png]]
#*Otherwise text and code as defined by the template is copied into the output file. <br/><br/>
#Cumulus will FTP these up to your web space on the internet. If you have asked it to use ''Rename'' on the remote file, a temporary name is created with the suffix 'tmp' added to the final file name as shown in diagram above. The final file names on your web site will be as in table above, without the letter T for templates being processed by ''Include Standard Files'', or the name you specify for the remote file name on the ''Files' tab (or in [[Cumulus.ini#Section:_FTP_Site]]) for customised templates (what the chart labels as ''Extra files'').
#The result of that process is the creation of local output pages:
#*Typically the output is a HTML web page, but it is also possible to process scripts with cumulus web tags and then produce an output file in JavaScript or PHP Hypertext pre-processor.
#*(until build 1092 any created web pages were in XHTML 1.0 Transitional using charset=iso-8859-1; from build 1093 normal created web pages are by default - see below for how to change this - in HTML 5 using charset="UTF-8")
#*The file name that Cumulus uses for the created local output page depends on the original template:
#**If template is being processed by "Include Standard Files", the created output page is the same name without a T,
#**If template is listed on the ''Files'' tab (or in cumulus.ini FTP section) as a local file then the created web page has 'tmp' suffixed to the extension.  This copes with customised templates that do not use the 'T' convention. <br/><br/>
#Cumulus will FTP these up to your web space on the internet. If you have asked it to use ''Rename'' on the remote file, a temporary name is created with the suffix 'tmp' added to the final file name as shown in diagram here. The final file names on your web site will be:
#*for templates being processed by ''Include Standard Files'', final file name is as in table above without the letter T;
#*for customised templates (what the chart labels as ''Extra files''), final file name is the name you specify for the remote file name on the ''Files' tab (or in [[Cumulus.ini#Section:_FTP_Site]]).


The standard website set up, with several other files, is fully described in [[Simple_Website_setup]].
The standard website set up, with several other files, is fully described in [[Simple_Website_setup]].
5,838

edits

Navigation menu