Customised templates: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
Line 32: Line 32:


=Notes of caution=
=Notes of caution=
*Remember to edit the xxxT.htm files, (not the xxx.htm files) and to have 'Include Standard Files' ticked (as shown above).


*Try to use a simple text editor to change the files.  Many HTML editors will insert additional code, or break the standard Cumulus '[[webtags]]' by replacing the < or > symbols with character codes.  Avoid using Word processors, like Word, to edit these files.
*Try to use a simple text editor to change the files.  Many HTML editors will insert additional code, or break the standard Cumulus '[[webtags]]' by replacing the < or > symbols with character codes.  Avoid using Word processors, like Word, to edit these files.


*Keep copies of any xxxT.htm files you modify.  If you update Cumulus or re-install, your changes will be lost as Cumulus will replace with the standard templates. From version 1.8.9 onwards, the installer offers you the option of not replacing the templates in the 'web' folder, and also installs them in a folder called 'originals' so you can refer to 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.
 
*From version 1.8.9 onwards, the Cumulus installer installs the standard templates in a Cumulus subfolder called 'web/originals' so you can refer to them.  The installer offers you the option of either replacing all templates in the 'web' folder, or not replacing them, if you update Cumulus or re-install the current version.  If you select to install the templates, your changes will be lost as Cumulus will replace those in the 'web' folder with the standard ones.


*If you are making anything but minor changes to the template, consider creating your own files and have Cumulus process these instead.
*If you are making anything but minor changes to the template, consider creating your own files with different names (in a separate folder), and list them for Cumulus to process these instead of the standard ones (untick).

Revision as of 23:15, 28 November 2012

It is possible to take the standard Cumulus web templates and customise these to your own requirements. A basic understanding of HTML is useful.

How Cumulus uses its templates

Cumulus has a number of template files which it uses if you select to upload the standard files within Internet Configuration


SimpleInternet-StandardTicks.png


The template files are stored in the 'web' folder under your Cumulus installation on your PC. They are named:

  • indexT.htm
  • todayT.htm
  • yesterdayT.htm
  • recordT.htm
  • gaugesT.htm
  • trendsT.htm

... and any others that may get added. They all have a 'T' (for 'template') in their names.

When Cumulus is ready to perform a web site update, it will process each of these files, insert the relevant data from the weather station and create temporary filenames for each. Once completed Cumulus will FTP these up to your web space on the internet. The filenames on your web site will be as above, without the letter T at the end.

Changing the templates

You can modify any of the template files mentioned above. For example, you may wish to add a link; remove some information; add a page counter; etc

It is best to close down Cumulus while updating the template files. Use windows Notepad or Notepad++ or another text editor to modify the HTML as necessary.

Typically the templates are modified to include additional weather data, or remove it. This is done with Cumulus webtags


Notes of caution

  • Remember to edit the xxxT.htm files, (not the xxx.htm files) and to have 'Include Standard Files' ticked (as shown above).
  • Try to use a simple text editor to change the files. Many HTML editors will insert additional code, or break the standard Cumulus 'webtags' by replacing the < or > symbols with character codes. Avoid using Word processors, like Word, to edit these files.
  • 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.
  • From version 1.8.9 onwards, the Cumulus installer installs the standard templates in a Cumulus subfolder called 'web/originals' so you can refer to them. The installer offers you the option of either replacing all templates in the 'web' folder, or not replacing them, if you update Cumulus or re-install the current version. If you select to install the templates, your changes will be lost as Cumulus will replace those in the 'web' folder with the standard ones.
  • If you are making anything but minor changes to the template, consider creating your own files with different names (in a separate folder), and list them for Cumulus to process these instead of the standard ones (untick).