5,838
edits
Customised templates: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Cumulus Web Templates: Updated re MX
SaratogaWX (talk | contribs) m (changed sandaysoft.com references) |
m (→Cumulus Web Templates: Updated re MX) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 54: | Line 54: | ||
Page updated <#update><br /> | Page updated <#update><br /> | ||
powered by | powered by | ||
<a href="https://cumuluswiki. | <a href="https://cumuluswiki.org/a/Downloads" target="_blank">Cumulus</a> | ||
v<#version> (<#build>) | v<#version> (<#build>) | ||
</p> | </p> | ||
| Line 71: | Line 71: | ||
#** In version 1.9.4 (from build 1061) - Don't try to process a standard template file if it's been deleted. | #** In version 1.9.4 (from build 1061) - Don't try to process a standard template file if it's been deleted. | ||
#*If ''Include Standard Files'' is not selected, then only the files explicitly listed with ''Process?'' selected are processed. | #*If ''Include Standard Files'' is not selected, then only the files explicitly listed with ''Process?'' selected are processed. | ||
#*Regardless of that setting, the Cumulus component will process those listed in [[Cumulus. | #*Regardless of that setting, the Cumulus component will process those listed in [[Cumulus.ini_(Cumulus_1)#Section:_FTP_Site]] as local files that also have ''Process?'' selected (set to 1 in Cumulus.ini_(Cumulus_1)#Section:_FTP_Site). [[File:Cumulus FTP Process.png |right]] | ||
[[File:badge v1.png]] In Cumulus 1, only the first 10 of a possible maximum of 100 files appear on 'Files' tab in internet settings screen reached from configuration menu. The others can only be edited (with Cumulus stopped) by editing the Cumulus. | [[File:badge v1.png]] In Cumulus 1, only the first 10 of a possible maximum of 100 files appear on 'Files' tab in internet settings screen reached from configuration menu. The others can only be edited (with Cumulus stopped) by editing the Cumulus.ini_(Cumulus_1) file (see the information later in this article) | ||
[[File:Badge vMx.png]] In Cumulus MX, the configuration screen for the internet files will step through all the possible 100 slots (what you select or input there is covered later in this article). | [[File:Badge vMx.png]] In Cumulus MX, the configuration screen for the internet files will step through all the possible 100 slots (what you select or input there is covered later in this article). | ||
| Line 94: | Line 94: | ||
#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: | #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 template name without the letter T; | #*for templates being processed by ''Include Standard Files'', final file name is as template name without the letter T; | ||
#*for customised templates (what the chart labels as ''Extra files''), final file name is the name stored for the remote file name in [[Cumulus. | #*for customised templates (what the chart labels as ''Extra files''), final file name is the name stored for the remote file name in [[Cumulus.ini_(Cumulus_1)#Section:_FTP_Site]]). | ||
= Default Web Pages for Cumulus MX = | |||
[[File:Badge vMx.png]] Please note MX does not use templates to generate web pages, it only uses templates for data files. For further information related to MX see [[New Default Web Site Information]]. | |||
=Cumulus Web Templates= | =Cumulus Web Templates= | ||
The standard website set up, with several other files, is fully described in [[Simple_Website_setup]], look there for details of all the different files needed on your web site. | [[Category:WebTips]] | ||
[[File:badge v1.png]](Please remember this section does not apply to Cumulus MX). | |||
The Cumulus '''template files''' are stored in the 'web' subfolder within your Cumulus installation on your PC. They all have a 'T' (for 'template') in their file names. | |||
The standard website set up, with several other files, is fully described in [[Simple_Website_setup|Simple web site set up]], look there for details of all the different files needed on your web site. | |||
==The Standard Templates for Cumulus 1== | ==The Standard Templates for Cumulus 1== | ||
The Cumulus 1 installer provides a number of example template files, listed below. | |||
[[File: | |||
When upgrading to a new Cumulus 1 release, as you run the installer, untick the selection on [[File:Components_screen.JPG]] if you wish to keep your existing templates. The default on an upgrade is to overwrite the example templates, or any customised ones using same file names, with a fresh set of standard templates (see list in table below). | |||
<br> | |||
These standard example template files are used if you select to 'Include standard files' within Internet Configuration: | |||
[[File:SimpleInternet-StandardTicks.png]] | [[File:SimpleInternet-StandardTicks.png]] | ||
Cumulus 1 generates some graphics used for the moon image on index.htm web page, for some of the images on the gauges.htm web page, and all the graphs that appear on the trends.htm web page | |||
If you select 'Include Standard Images', then Cumulus 1 generates some graphics used for the moon image on index.htm web page, for some of the images on the gauges.htm web page, and all the graphs that appear on the trends.htm web page. | |||
{| border="1" class="wikitable" | {| border="1" class="wikitable" | ||
| Line 152: | Line 170: | ||
|} | |} | ||
| Line 159: | Line 175: | ||
=== Changing the appearance === | === Changing the appearance === | ||
If all you want to do is change the look of the web pages, then it is the CSS that needs to be changed, just changing the background picture is explained in [[FAQ#How_do_I_replace_the_.27bird.27_image_on_my_website.3F|this FAQ]], . If you don't like your text being converted to lower case see [[FAQ#I.27m_using_the_supplied_web_pages.2C_and_get_lower_case_in_places_where_I_want_upper_case|this FAQ]]. If you want a more extensive change to the look, you might want to consider a third-party template, see downloads page or the support forum, as a starting point. If those don't suit you, you will need to learn about coding CSS (basically you specify selectors and for each selector you can specify a list of property names and their values), as the selectors available in CSS are really very clever now there is an awful lot you can do just using CSS, but it is too complicated to cover here. | If all you want to do is change the look of the web pages, then it is the [[Stylesheets|CSS]] that needs to be changed, just changing the background picture is explained in [[FAQ#How_do_I_replace_the_.27bird.27_image_on_my_website.3F|this FAQ]], . If you don't like your text being converted to lower case see [[FAQ#I.27m_using_the_supplied_web_pages.2C_and_get_lower_case_in_places_where_I_want_upper_case|this FAQ]]. If you want a more extensive change to the look, you might want to consider a third-party template, see downloads page or the support forum, as a starting point. If those don't suit you, you will need to learn about coding CSS (basically you specify selectors and for each selector you can specify a list of property names and their values), as the selectors available in CSS are really very clever now there is an awful lot you can do just using CSS, but it is too complicated to cover here. | ||
One contributor on [https://cumulus.hosiene.co.uk/viewtopic.php?f=14&t=15136 the forum] has produced a very impressive looking summary page, that is totally different to the standard Cumulus provision as it takes the numbers from realtime.txt not cumulus web tags, but he has achieved much of the look using CSS. | One contributor on [https://cumulus.hosiene.co.uk/viewtopic.php?f=14&t=15136 the forum] has produced a very impressive looking summary page, that is totally different to the standard Cumulus provision as it takes the numbers from realtime.txt not cumulus web tags, but he has achieved much of the look using CSS. | ||
| Line 226: | Line 242: | ||
*You can select your own local folder path. | *You can select your own local folder path. | ||
*You do need to tell Cumulus the local and remote file names you require - as described in [[#Creating or Editing Templates in a Separate Folder ]] | *You do need to tell Cumulus the local and remote file names you require - as described in [[#Creating or Editing Templates in a Separate Folder ]] | ||
= Some specific customisation examples = | = Some specific customisation examples = | ||
| Line 436: | Line 451: | ||
#*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]]. 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''. | #*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]]. 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 | #''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. | #*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_(Cumulus_1)#Section:_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. | #*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_(Cumulus_1)#Section:_FTP_site]]. | ||
#''UTF-8?'' column | #''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. | ##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. | ##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_(Cumulus_1)#Section:_FTP_site]]. | ||
#*If it is not a template file, the setting here is irelevent as Cumulus will not be processing it into a web page. | #*If it is not a template file, the setting here is irelevent as Cumulus will not be processing it into a web page. | ||
#''Binary?'' column | #''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. | #*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_(Cumulus_1)#Section:_FTP_site]]. | ||
=== 'Remote filenames' and 'FTP?' columns for remote servers === | === 'Remote filenames' and 'FTP?' columns for remote servers === | ||
| Line 451: | Line 466: | ||
**The host, username, password and initial directory are specified here. | **The host, username, password and initial directory are specified here. | ||
*Files tab of the '''Internet''' screen within the 'Configuration' menu. | *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. | *#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_(Cumulus_1)#Section:_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. | *#Finally, select 'FTP?' column for 0 to 9 or for NN values of 10 upto 99 add ''ExtraFTPNN=1'' in [[Cumulus.ini_(Cumulus_1)#Section:_FTP_site]]. | ||
=== 'Remote filenames' and 'FTP?' columns for local servers === | === 'Remote filenames' and 'FTP?' columns for local servers === | ||
| Line 461: | Line 476: | ||
*Files tab of the '''Internet''' screen within the 'Configuration' menu. | *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 file-name after the equals sign in the existing '''[FTP site]''' section of cumulus.ini. | #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 file-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. | #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_(Cumulus_1)#Section:_FTP_site]]. | ||
*If a particular web-page on a local web server includes (or calls) JavaScript requiring loading another file like 'dayfile.txt', then just for that web-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). | *If a particular web-page on a local web server includes (or calls) JavaScript requiring loading another file like 'dayfile.txt', then just for that web-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). | ||
