Cumulus Wiki

Help System and Default Website Development: Difference between pages

Page Discussion
(Difference between pages)

Default Website Development (view source)

Revision as of 06:51, 7 September 2025

100 bytes added ,  7 September
→‎Alternative public website
 
 
==The default CMX website Development==
= Introduction =
CumulusUtils has a help system for the Charts (through the ChartsCompiler) and for the Climate Charts (Graphs menu choice).
 
These section of the Wiki will enable you to get the latest information and resources for the alternative to the default CumulusMX public website.
For the website viewer there is no difference: the small word ''info'' appears left of the hamburger menu in the chart and when clicked there is some Help info available through a popup modal window. If it is not available, the word Info won't appear.
 
===Alternative public website===
For the owner of the Website is the task to write some information which makes the charts more clear for the viewer.
Please note. This is NOT part of the CumulusMX Distribution package and is provided only for those interested in having a public site that uses similar structures to the Alternative Interface.
 
Although it should function at the date of release, no guarantees are given that it will continue to do so with subsequent releases of CumulusMX. Users should take time to investigate how it reacts and uses the library and data files uploaded by CumulusMX so that you are able to do some troubleshooting for yourself.
= Operation =
Technically there are currently two systems:
# The charts generated through the [[ChartsCompiler]] have the [[Charts_Definition_Language_(CDL)#Info_specifier|keyword Info in CDL]]
# The charts in the menu ''Graphs'' assemble the Info text from the ''file CUhelptexts.txt'' where the website owner has his help texts.
 
Full details of the alternative public website, including screenshots can be fond on [https://oaktreewebs.co.uk/wiki/ my wiki] together with comprehensive instructions on how to install, use and modify.
The ''CutilsCharts.def'' for the ChartsCompiler is described [[ChartsCompiler|on the ChartsCompiler page]].
 
This site also comes with new themes (unfortunately not compatible with the AI or previous versions) that should be easier to modify for your own needs.
The ''CUhelptexts.txt'' file resides in the utils directory an will be created when it does not exist: run CumulusUtils once without an argument. A default CUhelptexts-default-for-use.txt exists in the distribution you can use that file by renaming it to ''CUhelptexts.txt'' or by using those texts in your own ''CUhelptexts.txt''. This is relevant if you use translations
 
'''Download the [https://www.cumuluswiki.org/images/0/08/PublicWebsite.zip latest version here]''' (Updated: (14:30 29th July 2025) '''W3C Validated code'''.)
It has the following default content:
 
====Amendments since last revision====
HT_DailyRain = " "
This is a full rebuild of the site. Please note that if you switch from HTML formated reports back to plain text reports, (OR VICA VERSA), you MUST regenerate ALL your reports and upload them using the Utilities FTP option.
HT_MonthlyRain = " "
HT_YearlyRainStats = " "
HT_YearlyMonthlyRainStats = " "
HT_MonthlyTemp = " "
HT_YearlyTempStats = " "
HT_YearlyMonthlyTempStats = " "
HT_WarmerDays = " "
HT_HeatMap = " "
HT_WindRose = " "
HT_WindRun = " "
HT_YearlySolarHRSstats = " "
HT_YearlyMonthlySolarHRSstats = " "
HT_YearlyInsolationStats = " "
HT_YearlyMonthlyInsolationStats = " "
HT_TempSum = " "
HT_GrowingDegreeDays = " "
HT_ThermalSeasons = " "
HT_DailyEVT = " "
HT_MonthlyEVT = " "
HT_ClashOfAverages = " "
 
==Installing==
The structure is <code><tag> = " <free text> "</code> ; The spaces are obligatory, the tag names are fixed and must not be changed by the user.
Download the current zip file to you local machine and upload it to your web server.
*Unzip it in the same location as your existing site - it will not overwrite the existing pages
*:The new site uses .html pages whereas the existing default site uses .htm
*; If you visit your site without specifying a page you will be taken to the new template pages,
*;Specifying a page such as index.htm will display your old template pages.
 
*: Please clear your browser cache before viewing.
The spaces are obligatory for the parser to recognize the structure of the file and a space between the double quote and the free text between the quotes is also obligatory. The user can write any HTML formatted text between the quotes, in principle of any length (though some restraint is advisable).
 
===Your Own Pages===
All climate graphs have their own meaningful entry - e.g. HT_DailyRain means '''''H'''elp '''T'''ext for the '''D'''aily '''R'''ain'' chart - and can have their own text. If no text is specified (only white space between the double quotes) the ''Info'' word will not appear in the chart.
'''As with previous releases, the public website template also includes a template page'''.
 
The template.html page is provided to make it easier for you to add your own pages while retaining the look and feel of the website. The template page is called '''template.html'''.
= Output =
The helptexts are assembled in the different charts files (e.g. ''graphsrain.txt'' and ''cumuluscharts.txt'').
 
<big>Editing</big>
= Inifile parameters =
The template page shows all the different column layouts that are available. These are:
There are no inifile parameters related to this helptext information system
ax-column1, ax-column2, ax-column3, ax-column4, ax-column5 and ax-column6
 
: These will always try to display the indicated number of columns but as the screen becomes small will automatically collapse into fewer columns as appropriate.
= Other remarks =
:; If there are more panels than columns they will gracefully split onto additional rows while retaining their column settings.
The ''Info'' keyword in the ChartsCompiler will eventually be unified with the CUhelptexts.txt file system when an unambiguous merge can be constructed.
:; Rows with fewer panels than columns will either stretch the remaining panels across the full width or distribute them centrally - this can be controlled by you.
 
For full details visit [https://oaktreewebs.co.uk/wiki/ my wiki].
When errors have been made or the default tag names have been changed and the system no longer works, just remove the CUhelptexts.txt file and rerun CumulusUtils without argument.
 
==Editing the website menu==
[[Category:CumulusUtils]]
 
Please refer to my [https://oaktreewebs.co.uk/wiki/ wiki] for full details of the menu and how to edit it.
 
==Changing the Theme and Other Settings==
 
Please refer to my [https://oaktreewebs.co.uk/wiki/ wiki] for full information on configuring and setting up the alternative website.
NeilThomas
445

edits

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