Customised templates: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Customised templates (view source)

Revision as of 04:00, 4 August 2022

5,122 bytes added ,  04:00, 4 August 2022
m
→‎Cumulus Web Templates: Updated re MX
No edit summary
m (→‎Cumulus Web Templates: Updated re MX)
 
(17 intermediate revisions by 2 users not shown)
Line 20: Line 20:
<html lang="en"><!-- modify this to indicate your language -->
<html lang="en"><!-- modify this to indicate your language -->
<head>
<head>
<meta charset="UTF-8"><!-- assigns the recommended standard encoding -->
<meta charset="UTF-8"><!-- assigns the recommended standard encoding that copes with all international characters -->
         <meta name="description" content="<#location> weather data"><!-- you can choose a different way to explain what the page contains -->
         <meta name="description" content="<#location> weather data"><!-- you can choose a different way to explain what the page contains -->
         <meta name="author" content="<!-- put name of author here or leave this line out totally -->">
         <meta name="author" content="<!-- put name of author here or leave this line out totally -->">
         <meta name="keywords" content="Cumulus, <#location> weather data, weather, data, weather station"><!-- you can choose a different set of key words -->
         <meta name="keywords" content="Cumulus, <#location> weather data, weather, data, weather station"><!-- you can choose a different set of key words -->
         <title><!-- insert here what is to appear in browser tab title --></title>
         <title><!-- insert here what is to appear in browser tab title --></title>
         <link href="weatherstyle.css" rel="stylesheet"> <!-- This line links the standard Cumulus style-sheet
 
to the HTML page (and implies the HTML and CSS files are in the same web site directory) -->
        <!-- The next line is not included in official versions of Cumulus Templates, but was introduced in an alternative version to make the standard pages responsive, they adapt to screen size. -->
<link href="http://www.w3schools.com/lib/w3.css" rel="stylesheet">  <!-- See https://www.w3schools.com/w3css/default.asp for details -->
        <!-- See support forum https://cumulus.hosiene.co.uk/viewtopic.php?f=14&t=16014&p=122788 for more details -->
 
         <link href="weatherstyle.css" rel="stylesheet"> <!-- This line links the standard Cumulus style-sheet to the HTML page (and implies the HTML and CSS files are in the same web site directory) -->
 
         <!-- in some customisations you may need to load code libraries or include script here ...
         <!-- in some customisations you may need to load code libraries or include script here ...
         (The support forum includes code from various authors using various libraries and one of these examples might help you)
         (The support forum includes code from various authors using various libraries and one of these examples might help you)
         What you put here could be PHP code, JavaScript, or calls to libraries like jQuery, HighCharts or many others, anything that can be loaded before the page output starts -->
         What you put here could be PHP code, JavaScript, or calls to libraries like jQuery, HighCharts or many others, anything that can be loaded before the page output starts -->
</head>
</head>
<body> <!-- This defines the start of what the browser is to display in its window -->
<body> <!-- This defines the start of what the browser is to display in its window -->
Line 35: Line 41:
The comments <code>&lt;!--  a comment goes here --&gt;</code> are place holders explaining the above code.
The comments <code>&lt;!--  a comment goes here --&gt;</code> are place holders explaining the above code.
    
    
You will see that the Cascading Style Sheet for Cumulus "weatherstyle.css" is linked to the HTML in the 10th line of the above code example. There is more information about stylesheets in a separate article [[Stylesheets]] in this Wiki.
You will see that the Cascading Style Sheet for Cumulus "weatherstyle.css" is linked to the HTML in the 16th line of the above code example. There is more information about stylesheets in a separate article [[Stylesheets]] in this Wiki.


=== Structure that browser displays ===
=== Structure that browser displays ===
Line 48: Line 54:
Page updated <#update><br />
Page updated <#update><br />
powered by
powered by
<a href="http://sandaysoft.com/products/cumulus" target="_blank">Cumulus</a>  
<a href="https://cumuluswiki.org/a/Downloads" target="_blank">Cumulus</a>  
v<#version> (<#build>)
v<#version> (<#build>)
</p>
</p>
Line 65: 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.ini#Section:_FTP_Site]] as local files that also have ''Process?'' selected (set to 1 in Cumulus.ini#Section:_FTP_Site). [[File:Cumulus FTP Process.png |right]]
#*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.ini file (see the information later in this article)
[[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 88: 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.ini#Section:_FTP_Site]]).
#*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==


[[Category:WebTips]]
The Cumulus 1 installer provides a number of example template files, listed below.
[[File:badge v1.png]] Cumulus 1 has a number of template files that it uses if you select to 'Include standard files' within Internet Configuration:
 
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 the gauges.htm web page, and the graphs that appear on the trends.htm web page.
 
The '''template files''' are stored in the 'web' folder under your Cumulus installation on your PC.  They all have a 'T' (for 'template') in their names:
 
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 146: Line 170:
|}
|}


==Standard Templates for Cumulus MX==
[[File:Badge vMx.png]] The standard template files are found in CumulusMX\webfiles folder. Although the templates appear to be the same as Cumulus 1, those for gauges and trends are different. In Cumulus MX script files supply the data that will be used to show on the gauges web page and for the web server to draw the trend graphs, Cumulus MX does not generate any new graphics for each upload.




==Changing the Standard Templates==
==Changing the Standard Templates==
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.


This section covers how the templates are modified to include additional weather data, or remove it.  This is generally done by adding or removing Cumulus [[webtags]], but you normally have to vary the HTML structure by adding/editing/removing table cell (<td> to </td>) elements and possibly add/remove a row (<tr class="...">  to </tr>) element.
=== Changing the appearance ===
*You can modify one or more of the template files listed above.  For example, you may wish to
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.
**change the wording that appears on the web page by editing it on the template;
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.
**add a link to another of your pages or externally;
**add/remove some Cumulus derived information;
**add a page counter; etc 
*Remember to edit the xxxT.htm files, (not the xxx.htm files as they are created by the [[#What is meant by 'Cumulus processes templates' |Cumulus 'process']])
*It is best to close down Cumulus while updating the template files.
*You should ideally use a tool designed to help you edit a file written in a 'programming language', although most '''text editor''' tools can be safely used to modify the HTML.
**HTML editors (like [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++], [http://www.htmlkit.com/ HTML kit-292] to cite just two free ones) are just text editors that use colour and other aids to help you identify what you are editing and may make it easier for you as they also preserve the character encoding in the file (Cumulus files are encoded in UTF-8 without BOM - see below).
**Do not use a 'word processor' as that will introduce unwanted characters;
**Avoid most 'web page editors' (like wordpress) as they can change the page structure and remove the Cumulus web tags;


=== Templates in cumulus\web\originals sub-folder ===
=== Templates in cumulus\web\originals sub-folder ===
Line 171: Line 183:


===Editing to create one or more customised templates in the standard web sub-folder===
===Editing to create one or more customised templates in the standard web sub-folder===
A number of people have '''reduced the number of web pages by combining templates'''. At time of writing one example of such customisation (combining ''todayT.htm, yesterdayT.htm, thismonthT.htm, and thisyearT.htm'') is visible at [http://tamworthweather.com/today.htm this site]. Some sites combine fewer templates, just yesterday.htm and today.htm at many sites [http://www.cheadlehulmeweather.co.uk/today.htm including this one], and I have seen recordsT.htm combined with other templates.
Other people customise the standard template just to move certain web tags; for example to '''move the monthly total for rainfall''' from ''indexT.htm'' to ''thismonthT.htm'' or to change some of the text shown on a web page to what suits them.


*Keep copies of any xxxT.htm files you modify.  It is best to back up the whole Cumulus folder onto a different disc on a regular basis.
As the heading says modify the template files in the ''cumulus\web'' sub-folder, NOT those in 'originals' sub-folder:
*Remember to edit the xxxT.htm files, (not the xxx.htm files as they are created by the [[#What is meant by 'Cumulus processes templates' |Cumulus 'process']])
*Keep copies of any xxxT.htm files you modify.  It is best to back up the whole Cumulus folder onto a different disc on a regular basis, to save all the files that Cumulus depends upon, not just those it automatically backs up.
*If you edit one or more of the templates, listed in the table above, in the ''cumulus\web'' sub-folder, keeping their original names, this has the advantage that Cumulus will [[#What is meant by 'Cumulus processes templates' |process ]] the customised template as if it is an unmodified standard one.
*If you edit one or more of the templates, listed in the table above, in the ''cumulus\web'' sub-folder, keeping their original names, this has the advantage that Cumulus will [[#What is meant by 'Cumulus processes templates' |process ]] the customised template as if it is an unmodified standard one.
*You just need to have 'Include Standard Files' ticked (as shown above) on the ''Files'' tab of the '''Internet''' screen within the 'Configuration' menu.
*You just need to have 'Include Standard Files' ticked (as shown above) on the ''Files'' tab of the '''Internet''' screen within the 'Configuration' menu.
   
*You can modify one or more of the template files listed above. For example, you may wish to
**change the wording that appears on the web page by editing it on the template (e.g. change language or replace "Lowest Wind Chill" with "Greatest Wind Chill" or whatever);
**change the class linked with a HTML tag so that you can change the appearance or position
**add a link to another of your pages or externally (e.g. add link to another weather web page);
**add/remove some Cumulus derived information (for example: the monthly rainfall total is on the "index" page, you might want to move it to the "this month" page; and similarly the seasonal rainfall total could be moved from the "index" page to the "this year" page);
**add a page counter; etc
*It is best to close down Cumulus while updating the template files.
*You should ideally use a tool designed to help you edit a file written in a 'programming language', although most '''text editor''' tools can be safely used to modify the HTML.
**HTML editors (like [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++], [http://www.htmlkit.com/ HTML kit-292] to cite just two free ones) are just text editors that use colour and other aids to help you identify what you are editing and may make it easier for you as they also preserve the character encoding in the file (the latest Cumulus files are encoded in UTF-8 without BOM - see below).
**Do not use a 'word processor' as that will introduce unwanted characters;
**Avoid most 'web page editors' (like wordpress) as they can change the page structure and remove the Cumulus web tags;
 
* As well as changing one (or more) HTML templates, you can change the CSS file and give all your pages a new look.
 
=== Coding standard and character encoding for Customised Templates using the same names as Standard Cumulus Templates ===
=== Coding standard and character encoding for Customised Templates using the same names as Standard Cumulus Templates ===


Line 183: Line 212:
=== Using third party user customised templates ===
=== Using third party user customised templates ===


'''If you choose to use [http://sandaysoft.com/downloads designs from other providers]''' and they use the standard names listed in the table at the start of this article you need to check if their web page coding starts like the HTML5 extract (top of this page).   
'''If you choose to use designs from other providers''' and they use the standard names listed in the table at the start of this article you need to check if their web page coding starts like the HTML5 extract (top of this page).   
*If it does mention ''charset="UTF-8"'', and uses the name of a standard template and is stored in cumulus\web, then the '''UTF-8 encode''' should be selected as shown by red arrow in 'Web Settings' frame.
*If it does mention ''charset="UTF-8"'', and uses the name of a standard template and is stored in cumulus\web, then the '''UTF-8 encode''' should be selected as shown by red arrow in 'Web Settings' frame.
*If it uses a standard name and path, but does not mention utf-8, then uncheck the '''UTF-8 encode''' where indicated by red arrow.  
*If it uses a standard name and path, but does not mention utf-8, then uncheck the '''UTF-8 encode''' where indicated by red arrow.  
Line 214: Line 243:
*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 =
A common reason to modify the templates is to include additional weather data, or remove it.  This is generally done by adding or removing Cumulus [[webtags]], but you normally have to vary the HTML structure by adding/editing/removing table cell (<td> to </td>) elements and possibly add/remove a row (<tr class="...">  to </tr>) element.


Your weather station might be a sort that can accept [[Extra_Sensor_Files| Extra Sensors]] and if so you probably want to add web tags for those taking your cue from the various examples below.
Your weather station might be a sort that can accept [[Extra_Sensor_Files| Extra Sensors]] and if so you probably want to add web tags for those taking your cue from the various examples below.
Line 297: Line 327:
# You can change which Cumulus produced graphs are included (the standard version includes indoor temperature but excludes solar related graphs). The necessary edits to do this are described below.
# You can change which Cumulus produced graphs are included (the standard version includes indoor temperature but excludes solar related graphs). The necessary edits to do this are described below.
# The standard template uses JavaScript to action the change of the large graph when a thumbnail graph is clicked. All modern browsers support script, but you might want to eliminate script and just use pure HTML as explained  [[Editing_content_of_a_webpage_using_either_HTML_or_Script| elsewhere in this Wiki]].
# The standard template uses JavaScript to action the change of the large graph when a thumbnail graph is clicked. All modern browsers support script, but you might want to eliminate script and just use pure HTML as explained  [[Editing_content_of_a_webpage_using_either_HTML_or_Script| elsewhere in this Wiki]].
# If you want points plotted at hourly intervals for up to 7 days, the recent history tags and external script libraries can be used to do this as explained [http://sandaysoft.com/forum/viewtopic.php?f=18&t=12321 in this thread on the support forum].
# If you want points plotted at hourly intervals for up to 7 days, the recent history tags and external script libraries can be used to do this as explained [https://cumulus.hosiene.co.uk/viewtopic.php?f=18&t=12321 in this thread on the support forum].
# That same support forum thread includes how to plot histograms (best for daily totals such as rainfall and windrun) made from colour blocks reading the values from the daily summary log. But of course if you use PHP, you might want to read from a database table with similar information.
# That same support forum thread includes how to plot histograms (best for daily totals such as rainfall and windrun) made from colour blocks reading the values from the daily summary log. But of course if you use PHP, you might want to read from a database table with similar information.


Line 361: Line 391:
</pre>
</pre>
In your implementation, you may only use 1 or 2 of the 3 included here.  Also you may want to delete the 'td' elements relating to indoor observations. Just remember to adjust the 'colspan' value and, if you have an odd total number of thumbnails split between an even number of rows, to make all rows the same number of columns by including the null 'td' element shown in the above example.
In your implementation, you may only use 1 or 2 of the 3 included here.  Also you may want to delete the 'td' elements relating to indoor observations. Just remember to adjust the 'colspan' value and, if you have an odd total number of thumbnails split between an even number of rows, to make all rows the same number of columns by including the null 'td' element shown in the above example.
== Changing how an extreme is shown ==
Most Cumulus web pages show extremes with first the label being shown in a tabel cell containing text, then comes a table cell with the value and unit (both of these will normally be Cumulus web tags) and finally a table cell containing a time-stamp (this will have one or two Cumulus web tags) made up of a time and/or date.
*To change the label, simply edit the text. For example, you could change
<pre>
<td>Low&nbsp;Wind&nbsp;Chill</td>
</pre>
to
<pre>
<td>Greatest&nbsp;Wind&nbsp;Chill</td>
</pre>
*To show the value in different units, you would need to add some [[PHP|script]] to do the conversion.  Scripts can be written in a number of languages. One possibility is JavaScript, that is parsed by the browser as it loads the code. For example, suppose your wind speeds are in mph and you wanted to show the equivalent in nautical miles per hour:
<pre>
<td id='wind'><#wgustYM>&nbsp;<#windunit></td>
<script>
var gust=1.150779*parseFloat(<#wgustYM>);
document.getElementById('wind').insertAdjacentHTML('beforeend'," (" + gust + " knots)");
</script>
</pre>
Note: You don't need to have the script code in the HTML immediently after the HTML element the script is updating, that was done here to make the example self-contained.
Another possible script language is PHP Hypertext Preprocessor.  This is parsed by the web server to create HTML code that is forwarded to the browser, so the browser does not see PHP script. As PHP is a powerful language, it has a separate article [[PHP#Using_PHP_Hypertext_Pre-processor|here]].
*To change the way the time and/or date is shown, you add the format clause to each web tag you wish to alter as explained [[Webtags#Time.2FDate_.27format.27_Parameter|here]].  For example, you could change a 24 hour format time into an am/pm time:
<pre>
<td>at&nbsp;<#TwgustYM></td>
</pre>
{{Version badge 1}} to (Cumulus 1 only example)
<pre>
<td>at&nbsp;<#TwgustYM format=hh:nnampm></td>
</pre>


= Creating or Editing Templates in a Separate Folder =
= Creating or Editing Templates in a Separate Folder =
Line 369: Line 433:


In this section, the instruction cover both template files (Cumulus has to be asked to 'process' these) and other files (such as images, web pages without cumulus web tags, log files etc) that are to be file transferred or copied multiple times each day.
In this section, the instruction cover both template files (Cumulus has to be asked to 'process' these) and other files (such as images, web pages without cumulus web tags, log files etc) that are to be file transferred or copied multiple times each day.
[[File:badge v1.png]] The pictures of the settings screen are taken from Cumulus 1, but although the settings screen in Cumulus MX has a different look, it is populated with the same content.
 
[[File:Files tab settings.jpg|right]]
The picture of the settings screen on the left is taken from [[File:badge v1.png]] Cumulus 1, and that on the right is in [[File:Badge vMx.png]] Cumulus MX. Despite the different looks, each is populated with the same content.
#''Include Standard Files'' (see top left in this image).
 
[[File:Files tab settings.jpg|left]]
[[File:Extra web settings.png|right]]
#''Include Standard Files'' (see top left in {{Version badge 1}} left image). (The equivalent MX selection is made in the Web/FTP section of the Internet Settings screen).
#*Remember if you are not using ''any'' of the standard template names in cumulus\web to un-select this setting (as shown in the nearby image).
#*Remember if you are not using ''any'' of the standard template names in cumulus\web to un-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.
#*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''
#''Include Standard Images''{{Version badge 1}}, ''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]].
#* These settings are selected as applicable. The images are needed for the moon, trend graphs and gauges to appear on your {{Version badge 1}} web site.  The last 3 are set according to customisation described above in [[#Slightly less simple customisation of trendsT.htm (Cumulus 1 only)]] and again only apply to Cumulus 1.
#''Local file names'': List here the new or edited template files (text including Cumulus web-tags) you have created.
#''Local file names'': List here the new or edited template files (text including Cumulus web-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.
#*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.
Line 384: 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.ini#Section:_FTP_site]].
#*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.ini#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.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.ini#Section:_FTP_site]].
##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.ini#Section:_FTP_site]].
#*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 399: 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.ini#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).)  
*#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.ini#Section:_FTP_site]].
*#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 409: 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.ini#Section:_FTP_site]].
#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).
Sfws
5,838

edits

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

Navigation menu