1,953
edits
Website Generator: Difference between revisions
m
→Inifile parameters
| (11 intermediate revisions by the same user not shown) | |||
|
While CumulusUtils started as a collection of modules to be used at will in the creation of a weather website - for the site of the author - after several modules it became clear that generation of a complete website would not be too difficult. It required a HTML framework within which the modules would fit, a menu, a runtime system to handle the realtime data, loading of files, clocks, sun and moon and an adaptation of mcrossley's gauges.
The work set out on a scratch board where the site was drafted and the runtime was coded. The choice was made to split the screen in two in a 5/7 ratio which never changed since. The right pane became the ''ReportView'' where the user chooses the report he wishes to see while the realtime data are always visible in the left pane, the [[Dashboard]]. The contents of the Dashboard can be toggled between two sets of twelve panes
In the example on the image on the right you see Holgers' fully translated site with expanded user menu and even multilingual by his own design to show off the things possible with the CumulusUtils framework.
#CUserAbout.txt => The menu choice About=>This Site uses the contents of a file named CUserAbout.txt to be displayed in a popup window. As you can imagine, the user has to create this file himself. The contents of this file must be text with HTML tags for formatting.
== Inifile parameters ==
[Website]
// The statistics parameters are currently either for Google or Matomo
// If the corresponding ID's and or Url are not filled in, invalid code is generated. If you do not want
// statistics than set ''StatisticsType'' without value
StatisticsType= [Google || Matomo] default is empty
GoogleStatsId= => When not empty, a google stats code fragment will be generated with this code as the user Id, default is empty
MatomoTrackerUrl=
PermitGoogleOptout=true | false => Permits to generate code so the users own access to the site will not be measured, default=false▼
MatomoSiteId=
▲ PermitGoogleOptout=
CumulusRealTimeLocation= => see below, default is empty
CumulusRealTimeInterval=30 => The refresh cycle time of the runtime system to update the values on the dashboard and gauges, default=15
ShowUV=true => Show the UV values (if there is a sensor), default=true
HeaderRightText= => A free plain or HTML formatted text destined at the right side of the header, default is empty
SiteTitleAddition= => A free text addition to the title, default is empty
UseCMXMoonImage=false => When true the CMX generated moon image is used i.s.o. the CUtils native abstracted image
MoonImageLocation= => The full URL for the moon image, used when ''UseCMXMoonImage=true'', ignored otherwise
PwsfwiButtonInHeader=true => When true the direct access pwsFWI button will show in the header, when false it shows in the menu bar
All parameters starting with '''''Panel''''' affect what you actually see in that panel See [[Dashboard]] for more information.<br>
then, when CumulusMX sends the realtime and datafiles to the webroot, you can set the ''CumulusRealTimeLocation'' to '''..\''' and it will automatically find the realtime and datafiles it needs.
=== CuserHead.def ===
If that file (user created) exists in the utils directory, its contents replaces three HTML Meta tags in the generated HTML code. This should facilitate any HTML header tags e.g. <META ...> to be positioned in the HTML header as the user wishes. No checks are made on the contents of the ''CutilsHead.def'' file and its effect on the resulting ''index.html'', it is fully the users responsibility. No support on the contents and its effects will be given. The HTML tags replaced are:
#<meta name="description" content="CumulusMX Website, part of CumulusUtils" />
#<meta name="keywords" content="CumulusMX, weather, data, private weather station, CumulusUtils" />
#<meta name="robots" content="index, noarchive, follow, noimageindex, noimageclick" />
=== Javascript libraries ===
| |||