Cumulus Wiki

Customised templates: Difference between revisions

Page Discussion

Customised templates (view source)

Revision as of 09:39, 24 May 2015

192 bytes added ,  24 May 2015
→‎What to select on the 'Files' tab of the Internet Settings screen within the 'Configuration' menu: Change all references to [FTP Site] into [FTP site] and clarify realtime setting requirements
m (→‎Standard Finish: Replace specific </div> with general comment)
(→‎What to select on the 'Files' tab of the Internet Settings screen within the 'Configuration' menu: Change all references to [FTP Site] into [FTP site] and clarify realtime setting requirements)
[[File:Files tab settings.jpg|right]]
#''Include Standard Files'' (see top left in this image).
#*Remember if you are not using ''any'' of the standard template names in cumulus\web to unselectun-select this setting (as shown in the nearby image).
#*If one or more of the standard templates is still in cumulus\web, then you want this setting set as per the image at the top of this article.
#''Include Standard Images'', ''Solar'', ''UV'' and ''Sunshine''
#* These settings are selected as applicable. The images are needed for the moon, trend graphs and gauges to appear on your web site. The last 3 are set according to customisation described above in [[#Slightly less simple customisation of trendsT.htm]].
#''Local file names'': List here the new or edited template files (text including Cumulus webtagsweb-tags) you have created.
#*Also list here any non-template files that you want Cumulus to upload (or copy across) at either the normal website updating interval or the realtime updating interval.
#*0 to 9 can be stored in [[cumulus.ini#Section:_FTP_Site_FTP_site]] by placing the path and filenamefile-name in left hand column on the ''Files'' tab of the '''Internet''' screen within the 'Configuration' menu. An easy way to achieve this is by using the appropriate '''Browse...''' button as that will ensure the parts of the path have the correct separator.
#*Local files 10 upto (from version 1.9.3) 99 have to be manually inserted (or amended) by editing [[cumulus.ini#Section:_FTP_Site_FTP_site]], using a ''ExtraLocalNN='' line (note NN is any 1 or 2 digit number) and placing the path (remember for Windows local files the parts of the path are separated by '\') and filename after the equals sign. An easy way to achieve this is by copying one of the lines with NN set to between '0' and '9', next replacing the numerical digit with the required 2 digit number and then changing the filename as needed.
#''Realtime?'' column
#*Leave the column unselected for template (or other) files 0 to 9 to be processed at the upload 'Interval' specified in the middle of the ''Web settings'' frame on the Sites/Options tab of the '''Internet''' screen within the 'Configuration' menu. For NN values '10' upto '99', normal interval processing is achieved by including a ''ExtraRealtimeNN=0'' line.
#*Select the relevant box for processing a file at the 'Realtime interval' (determined by each of the settings marked by blue arrows at the bottom of the web settings frame shown earlier in the article). For NN values '10' upto '99', realtime interval processing is achieved by including a ''ExtraRealtimeNN=1'' line, in [[cumulus.ini#Section:_FTP_Site_FTP_site]]. If you select 'realtime' interval for any files, you will also need to select the ''Enable Realtime'' and ''Enable Realtime FTP''options in '''Web Settings block''' of ''Sites/Options tab''.
#''Process?'' column
#*If the local file you have specifed is a template file (i.e. text including Cumulus webtags) these need to be [[#What is meant by 'Cumulus processes templates' |processed by Cumulus]] to create web pages; select 'Process?' column for 0 to 9 on the ''Files'' tab of the '''Internet''' screen within the 'Configuration' menu; or for 10 upto 99 add ''ExtraProcessNN=1'' in [[Cumulus.ini#Section:_FTP_Site_FTP_site]].
#*If the local file you have specifed is any other type of file, then leave box in this column clear or for 10 upto 99 add ''ExtraProcessNN=0'' in [[Cumulus.ini#Section:_FTP_Site_FTP_site]].
#''UTF-8?'' column
##If the local file you have specifed is a template file (i.e. text including Cumulus webtags) these need to be [[#What is meant by 'Cumulus processes templates' |processed by Cumulus]] to create web pages and Cumulus therefore needs to be told what encoding you used for the customised template.
##From build 1093 (27 April 2014), you need to select the 'UTF-8?' column for 0 to 9 on the ''Files'' tab of the '''Internet''' screen within the 'Configuration' menu; or for NN equals 10 upto 99 add ''ExtraUTFNN=1'' in [[Cumulus.ini#Section:_FTP_Site_FTP_site]].
#*If it is not a template file, the setting here is irreleventirelevent as Cumulus will not be processing it into a web page.
#''Binary?'' column
#*For web pages 0 to 9, select this [it is mandatory for image files, but optional on most other files; however its use will ensure accurate transfer if any extended (non-ASCII) character set letters (like accented ones) or symbols (like temperature degree symbol) are used on your customised pages] on the ''Files'' tab of the '''Internet''' screen within the 'Configuration' menu; this is achieved by including ''ExtraBinaryNN=1'' for NN values '10' upto '99' in [[Cumulus.ini#Section:_FTP_Site_FTP_site]].
 
=== 'Remote filenames' and 'FTP?' columns for remote servers ===
**The host, username, password and initial directory are specified here.
*Files tab of the '''Internet''' screen within the 'Configuration' menu.
*#For files 0 to 9 enter the full path (directory and required file name) in the '''Remote filenames''' column on the ''Files'' tab of the '''Internet''' screen within the 'Configuration' menu; for NN values '10' upto '99' this is achieved by including ''ExtraRemoteNN='' with directory and filename after the equals sign in [[Cumulus.ini#Section:_FTP_Site_FTP_site]]. (IMPORTANT, as the Cumulus '''Help''' screen says the ''Remote filenames'' column "'''does not use the 'ftp directory' setting'''. You should specify the full path for the file, starting from the point you are at when you log in to your site's FTP server" (remember the separator is '/' for server paths).)
*#Finally, select 'FTP?' column for 0 to 9 or for NN values of 10 upto 99 add ''ExtraFTPNN=1'' in [[Cumulus.ini#Section:_FTP_Site_FTP_site]].
 
=== 'Remote filenames' and 'FTP?' columns for local servers ===
If your web server is on the same computer (or local network) as Cumulus, then the instructions for remote files are changed slightly because copying rather than file transfer is used:
*Sites/Options tab of the '''Internet''' screen within the 'Configuration' menu.
**It is rarely needed to specify the host, username, password and initial directory of a local web server on this screen (because you are not using FTP)
**The exception is if your webpage includes a script requiring loading a local file like 'dayfile.txt' because the security design of ''some'' browsers may restrict where files can be loaded from, and if your local server is visible to anyone, you cannot know what browser is being used to view the page.▼
*Files tab of the '''Internet''' screen within the 'Configuration' menu.
#For files 0 to 9 enter the full path (on your computer or network) and required file -name (destination for file copy instruction) in the 'Remote filenames' column on the ''Files'' tab of the '''Internet''' screen within the 'Configuration' menu; for NN values '10' upto '99' this is achieved by including ''ExtraRemoteNN='' with full path and filenamefile-name after the equals sign in the existing '''[FTP site]''' section of cumulus.ini.
#Finally to indicate a 'Copy' instruction is required, '''unselect''' both ''Binary'' and ''FTP?'' columns for 0 to 9; or for 10 upto 99 add ''ExtraBinaryNN=0'' and ''ExtraFTPNN=0'' in the existing [[Cumulus.ini#Section:_FTP_Site_FTP_site]].
 
If a particular webpage on a local web server includes a script requiring loading a local file like 'dayfile.txt', then just for that webpage enter its remote web file name, and select Binary and File Transfer Process, as per the previous set of instructions. (The remaining pages will be copied across locally using the specified full path without FTP as per instructions directly above).▼
 
▲*If a particular webpageweb-page on a local web server includes a(or scriptcalls) JavaScript requiring loading a localanother file like 'dayfile.txt', then just for that webpageweb-page enter its remote web file name, and select Binary and File Transfer Process, as per the previous set of instructions. (The remaining pages will be copied across locally using the specified full path without FTP as per instructions directly above).
▲**The exceptionThis is if your webpage includes a script requiring loading a local file like 'dayfile.txt' because the security design of ''some'' browsers may restrictinsist whereany filesweb-page cancontaining besuch scripts is file transferred onto a loadedweb fromserver, and if your local server is visible to anyone, you cannot know what browser is being used to view the page.
 
= The next article to read …… =
Sfws
5,838

edits

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