WebsitedataT.json - Revision history

NeilThomas: /* Current Conditions */

2023-09-25T10:26:45Z

Current Conditions

← Older revision		Revision as of 10:26, 25 September 2023
Line 201:		Line 201:
	\|<#moonphase>		\|<#moonphase>
	\|"moonphase"		\|"moonphase"
	\| <nowiki><span data-cmxdata=moonphase"></nowiki>		\| <nowiki><span data-cmxdata="moonphase"></nowiki>
	\|Current [[Lunar phase\|phase of the moon]] in words, eg "New Moon" etc. The names used can be altered in [[Strings.ini#Moon_Phases\|strings.ini]].		\|Current [[Lunar phase\|phase of the moon]] in words, eg "New Moon" etc. The names used can be altered in [[Strings.ini#Moon_Phases\|strings.ini]].
	\|-		\|-
	\|<#longlocation>		\|<#longlocation>
	\|"longlocation"		\|"longlocation"
	\| <nowiki><span data-cmxdata=longlocation"></nowiki>		\| <nowiki><span data-cmxdata="longlocation"></nowiki>
	\|(Static information) Longer description of your location as entered in Settings		\|(Static information) Longer description of your location as entered in Settings
	\|-		\|-

Sfws at 12:17, 29 October 2021

2021-10-29T12:17:06Z

Show changes

Sfws: Tried to correct all typos

2021-10-22T08:40:00Z

Tried to correct all typos

← Older revision		Revision as of 08:40, 22 October 2021
Line 2:		Line 2:
	[[Category:JSON Files]]		[[Category:JSON Files]]

	This [[Cumulus template file]] is found in the [[Web folder\|'''web''']] sub-folder of the MX distribution from release 3.10.1 onwards.		This [[Cumulus template file]] is found in the [[Web folder\|'''web''']] sub-folder of the MX distribution from release 3.10.1 onwards. '''The content of this page is based on the template file included in release 3.10.1 of MX; hopefully anybody updating this Wiki page, for a later release with an updated file, will also update this paragraph.'''

	It supplies the variable information that can be included in a web page by using Cumulus web tags to create a [[Php_webtags#Option_3:_JavaScript_Object_Notation\|JavaScript Object Notation (.json) data file]].		It supplies the variable information that can be included in a web page by using Cumulus web tags to create a [[Php_webtags#Option_3:_JavaScript_Object_Notation\|JavaScript Object Notation (.json) data file]].
Line 8:		Line 8:
	=Explanatory Introduction=		=Explanatory Introduction=

	JSON files are written in JavaScript, and that script language supports defining objects. Thus this template file defines a number of objects, each has a variable name that is assigned to a [[Webtags\|Cumulus web tag]], when MX [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27\|processes]] the template file the values replace the tags and you end up with a data file. In the supplied file, some of these web tags employ [[Webtags/Parameters\|input and/or output modification Parameters]]. Let me take one line, and explain it in detail:		JSON files are written in JavaScript, and that script language supports defining objects. Thus this template file defines a number of JavaScript objects, each has a variable name that is assigned to a [[Webtags\|Cumulus web tag]], when MX [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27\|processes]] the template file the values replace the tags and you end up with a data file. In the supplied file, some of these web tags employ [[Webtags/Parameters\|input and/or output modification Parameters]]. Let me take one line from the file, and explain that line in detail in the hope you can then understand other lines:
	"recordsbegandateISO":"<#recordsbegandate format=yyyy-MM-dd>",		"recordsbegandateISO":"<#recordsbegandate format=yyyy-MM-dd>",
	# The first string <code>"recordsbegandateISO"</code> defines the name for this variable in the object.		# The first string <code>"recordsbegandateISO"</code> defines the name for this variable in the object.
Line 25:		Line 25:
	Later on this Wiki page in [[#Tailoring the file]], it is explained that you can edit a copy of this template file. I say a copy, as if you edit the original file you risk your edit being lost whenever you upgrade to a new MX release as the release distribution includes a file with this name. In [[#How the file is used]], it is explained how a JavaScript file "setpagedata.js" loads this data file, and transfers values from the data file into HTML pages.		Later on this Wiki page in [[#Tailoring the file]], it is explained that you can edit a copy of this template file. I say a copy, as if you edit the original file you risk your edit being lost whenever you upgrade to a new MX release as the release distribution includes a file with this name. In [[#How the file is used]], it is explained how a JavaScript file "setpagedata.js" loads this data file, and transfers values from the data file into HTML pages.

	If you do edit this template file, then remember it is JavaScript, there are rules for using arithmetic in this script language, but we won't go technical and list such rules here, instead we will use an example to explain. Let us suppose you wanted to include the temperature difference between now and 24 hours ago in your HTML page. How you edit HTML is covered elsewhere in this Wiki and in many tutorials available online. To get the value to our web server, we must ask MX ~~tocalculate~~ it, therefore that value has to be calculated in this template, and you would add a new line like this:		If you do edit this template file, then remember it is JavaScript, there are rules for using arithmetic in this script language, but we won't go technical and list such rules here, instead we will use an example to explain. Let us suppose you wanted to include the temperature difference between now and 24 hours ago in your HTML page. How you edit HTML is covered elsewhere in this Wiki and in many tutorials available online. To get the value to our web server, we must ask MX to calculate it, therefore that value has to be calculated in this template, and you would add a new line like this:
	"temperatureChange24hours":"<#temp rc=y> - <#RecentOutsideTemp d=1 rc=y>",		"temperatureChange24hours":(<#temp rc=y> - <#RecentOutsideTemp d=1 rc=y>),
	Here, we still define a single variable name before the colon, but after the colon we subtract one web tag value from another remembering that we need to specify that decimal points not decimal commas are needed for JavaScript to understand the values as being numerical in order for the subtraction to work.		Here, we still define a single variable name before the colon, but after the colon we subtract one web tag value from another remembering that we need to specify that decimal points not decimal commas are needed for JavaScript to understand the values as being numerical in order for the subtraction to work. Note that brackets surround the calculation to ensure the expression within those brackets is evaluated, and the lack of quotation marks ensure the expression is treated as numerical rather than a string.

	(By the way, if we were doing an adding operation, we have to be very cautious as "+" is normally understood in this script language as indicating concatenation of strings. Please see [[Feels_Like#Script_for_setting_values\|here for an example of how addition is used]], essentially '+' can be used for adding by always using a numerical constant before the plus sign and always having any variable after the plus sign).		(By the way, if we were doing an adding operation, we have to be very cautious as "+" is normally understood in this script language as indicating concatenation of strings (see [[#Tailoring the file]] for example of plus sign being used for concatenation). Please see [[Feels_Like#Script_for_setting_values\|here for an example of how addition is used]], essentially '+' can be used for adding by always using a numerical constant before the plus sign and always having any variable after the plus sign).

	=How the file is used=		=How the file is used=
Line 35:		Line 35:
	This wiki page is about a [[Cumulus template file]]. [[Cumulus.ini#Optional_Web_Server\|Settings for Optional_Web_Server]] describes how choosing the default web pages enables the processing of this file into a data file with values, and how that can be uploaded onto your web server. If we decide to tailor this template file, as described later, then we might use [[Cumulus.ini#Extra_Web_Files\|Extra web files]] settings within the [[MX Administrative Interface\|settings interface]] to process and upload our tailored file(s).		This wiki page is about a [[Cumulus template file]]. [[Cumulus.ini#Optional_Web_Server\|Settings for Optional_Web_Server]] describes how choosing the default web pages enables the processing of this file into a data file with values, and how that can be uploaded onto your web server. If we decide to tailor this template file, as described later, then we might use [[Cumulus.ini#Extra_Web_Files\|Extra web files]] settings within the [[MX Administrative Interface\|settings interface]] to process and upload our tailored file(s).

	MX has to be told to convert that to a data file. There is a full explanation of what is meant by 'Cumulus processing any template' [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27\|here]]. In this case, MX will generate a file that is stored as "CumulusMX/web/websitedata.json". This data file is still coded as JavaScript file, but now the tags have gone as they have been replaced by values.		MX has to be told to convert that to a data file. There is a full explanation of what is meant by 'Cumulus processing any template' [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27\|here]]. In this case, MX will, while processing the template, generate a data file that is stored as "CumulusMX/web/websitedata.json". This data file is still coded as JavaScript file, but now the tags have gone as they have been replaced by values.

	The data file is used with the [[New Default Web Site Information\|Web Pages]] supplied in the [[Webfiles folder\|'''webfiles''']] sub-folder of the MX distribution from release 3.10.1 onwards. On your web server, each HTML page will call another JavaScript file "/CumulusMX/webfiles/js/setpagedata.js" (after uploading this file once to web site), it is that script that will both read the uploaded data file, and insert the relevant value into HTML pages in a span which has the "cmxdata" attribute, with a value for that attribute set to the appropriate variable name for the relevant JSON object.		The data file is used with the [[New Default Web Site Information\|Web Pages]] supplied in the [[Webfiles folder\|'''webfiles''']] sub-folder of the MX distribution from release 3.10.1 onwards. On your web server, each HTML page will call another JavaScript file "/CumulusMX/webfiles/js/setpagedata.js" (after uploading this file once to web site), it is that script that will both read the uploaded data file, and insert the relevant value into HTML pages in a span which has the "cmxdata" attribute, with a value for that attribute set to the appropriate variable name for the relevant JSON object.
Line 69:		Line 69:
	*# You might chose to upload some information in a third file that is uploaded at the defined standard interval		*# You might chose to upload some information in a third file that is uploaded at the defined standard interval

	You will need to modify your JavaScript file "/CumulusMX/webfiles/js/setpagedata.js" (and don't forget to upload this file after editing once to web site), because it includes the loading of the data file: <code>$.getJSON('websitedata.json?_=' + Date.now(),</code>, the query-string (bit prefixed by question mark) just ensures a fresh copy is loaded each time, preventing your browser thinking because you have loaded the file before it can reuse the copy it cached. In the tailored copy of this script, it will need to load each of the tailored data files.		You will need to modify your JavaScript file "/CumulusMX/webfiles/js/setpagedata.js" (and don't forget to upload this file after editing once to web site), because it includes the loading of the data file: <code>$.getJSON('websitedata.json?_=' + Date.now(),</code>, here the plus sign is used to indicate concatenation within the query-string (bit prefixed by question mark), adding the current time to make the request unique just ensures a fresh copy is loaded each time, preventing your browser thinking because you have loaded the file before it can reuse the copy it cached. In the tailored copy of this script, it will need to load each of the tailored data files.

	==Options==		==Options==
Line 251:		Line 251:
	\|(Fairly static information as only changes at start of rollover) The date of the meteorological day that has most recently finished. Using the date formatting element of '''ISO 8601 Data elements and interchange formats'''		\|(Fairly static information as only changes at start of rollover) The date of the meteorological day that has most recently finished. Using the date formatting element of '''ISO 8601 Data elements and interchange formats'''

	Note: The JSON name chosen indicates this is in ISO 8601 format, not your locale format.		Note: The JSON object variable name is different to the tag name, the variable name chosen indicates this is in ISO 8601 format, not your locale format.
	\|-		\|-
	\|<#date>		\|<#date>
Line 268:		Line 268:
	\|(Only changes when calendar month changes) The current '''calendar month''' using words defined for your locale. Example format: July		\|(Only changes when calendar month changes) The current '''calendar month''' using words defined for your locale. Example format: July

	Note: If you use 9 am or 10 am rollover, on the first day of a month this will (before rollover) display wrong meteorological month		Note: If you use 9 am or 10 am rollover, on the first day of a month this variable will (before rollover) display wrong meteorological month
	\|-		\|-
	\|<#temp>		\|<#temp>
Line 370:		Line 370:
	\|"rmonth"		\|"rmonth"
	\| <nowiki><span data-cmxdata="rmonth"></nowiki>		\| <nowiki><span data-cmxdata="rmonth"></nowiki>
	\|The total rainfall (derived from ~~count~~ ~~now~~ ~~minus~~ ~~count at start of meteorological month~~) for the month so far		\|The total rainfall (derived from summing daily rainfall amounts) for the month so far
	\|-		\|-
	\|<#ryear>		\|<#ryear>
	\|"ryear"		\|"ryear"
	\| <nowiki><span data-cmxdata="ryear"></nowiki>		\| <nowiki><span data-cmxdata="ryear"></nowiki>
	\|The total rainfall (derived from ~~count~~ ~~now~~ ~~minus~~ ~~count at start of meteorological season~~, plus any adjustment defined in Settings for this calendar year) for the rain ~~year~~ (starting month defined in Settings)		\|The total rainfall, (derived from summing daily rainfall amount, plus any adjustment defined in Settings for this calendar year) for the rain season (starting month defined in Settings, so does not have to align with calendar year)
	\|-		\|-
	\|<#rhour>		\|<#rhour>
	\|"rhour"		\|"rhour"
	\| <nowiki><span data-cmxdata="rhour"></nowiki>		\| <nowiki><span data-cmxdata="rhour"></nowiki>
	\|The total rainfall in last hour (derived from count now minus count one hour ago). Equivalent to <#rfall> - <#RecentRainToday h=1> (unless rollover happened within last hour)		\|The total rainfall in last hour (derived from count now, minus count one hour ago). Equivalent to (<#rfall> - <#RecentRainToday h=1>) (unless rollover happened within last hour)
	\|-		\|-
	\|<#LastRainTip format="d MMM">		\|<#LastRainTip format="d MMM">
Line 502:		Line 502:
	\|Highest USA Heat Index, derived by MX for this meteorological day, and time, taken from '''today.ini'''		\|Highest USA Heat Index, derived by MX for this meteorological day, and time, taken from '''today.ini'''

	Note: ~~The~~ Canadian Humidity Index (Humidex) ~~could be used~~ instead by replacing <#heatindexTH> and <#TheatindexTH> with <#humidexTH> and <#ThumidexTH>		Note: You could tailor the template to use Canadian Humidity Index (Humidex) instead by replacing <#heatindexTH> and <#TheatindexTH> with <#humidexTH> and <#ThumidexTH>
	\|-		\|-
	\|<#humTH> and <#ThumTH>		\|<#humTH> and <#ThumTH>

Sfws: Further readability improvements

2021-10-21T15:27:21Z

Further readability improvements

← Older revision		Revision as of 15:27, 21 October 2021
Line 4:		Line 4:
	This [[Cumulus template file]] is found in the [[Web folder\|'''web''']] sub-folder of the MX distribution from release 3.10.1 onwards.		This [[Cumulus template file]] is found in the [[Web folder\|'''web''']] sub-folder of the MX distribution from release 3.10.1 onwards.

	It supplies the variable information that can be included in a web page by using Cumulus web tags to create a [[Php_webtags#Option_3:_JavaScript_Object_Notation\|JavaScript Object Notation (.json) file]].		It supplies the variable information that can be included in a web page by using Cumulus web tags to create a [[Php_webtags#Option_3:_JavaScript_Object_Notation\|JavaScript Object Notation (.json) data file]].

			=Explanatory Introduction=
⚫	JSON files are written in JavaScript, and that script language supports defining objects. Thus this template file defines a number of objects, each is assigned to a [[Webtags\|Cumulus web tag]]. In the supplied file, some of these web tags employ [[Webtags/Parameters\|input and/or output modification Parameters]]. Let me take one line, and explain it in detail:

		⚫	JSON files are written in JavaScript, and that script language supports defining objects. Thus this template file defines a number of objects, each has a variable name that is assigned to a [[Webtags\|Cumulus web tag]], when MX [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27\|processes]] the template file the values replace the tags and you end up with a data file. In the supplied file, some of these web tags employ [[Webtags/Parameters\|input and/or output modification Parameters]]. Let me take one line, and explain it in detail:
	"recordsbegandateISO":"<#recordsbegandate format=yyyy-MM-dd>",		"recordsbegandateISO":"<#recordsbegandate format=yyyy-MM-dd>",
	# The first string <code>"recordsbegandateISO"</code> defines the ~~object~~ name.		# The first string <code>"recordsbegandateISO"</code> defines the name for this variable in the object.
	# The colon separates that object name from the value, think of it like an equals sign in ordinary arithmetic.		# The colon separates that object variable name from the value, think of it like an equals sign in ordinary arithmetic.
	# The <code><#</code> prefix defines the start of a Cumulus web tag.		# The <code><#</code> prefix defines the start of a Cumulus web tag.
	# The <code>recordsbegandate</code> is the tag name, the definition of this particular one can be found near the end of the table in [[Webtags#Date_.26_Time\|'Date & Time' section on webtags page]].		# The <code>recordsbegandate</code> is the Cumulus tag name, the definition of this particular one can be found near the end of the table in [[Webtags#Date_.26_Time\|'Date & Time' section on webtags page]].
	# The <code>format=</code> is an output format modifier attribute defined in [[Webtags/Parameters#Multiple_Output_Format_Modifier_parameters_for_times_and_dates\|Multiple_Output_Format_Modifier_parameters_for_times_and_dates section on the parameters sub-page]].		# The <code>format=</code> is an output format modifier attribute defined in [[Webtags/Parameters#Multiple_Output_Format_Modifier_parameters_for_times_and_dates\|'Multiple_Output_Format_Modifier_parameters_for_times_and_dates' section on the parameters sub-page]].
	# The <code>yyyy-MM-dd</code> defines the output format required, as explained in the last cross-reference, this represents a four digit year, then a hyphen,then a two digit month code, then another hyphen, and finally a two digit day of month.		# The <code>yyyy-MM-dd</code> defines the output format required, as explained in the tables on the Wiki page in the last cross-reference, this represents a four digit year, then a hyphen, then a two digit month code, then another hyphen, and finally a two digit day of month.
	# The > symbol ends the Cumulus web tag definition.		# The > symbol ends the Cumulus web tag definition.
	# The double quotation marks round the Cumulus web tag ensure the output is treated as a string		# The double quotation marks round the Cumulus web tag ensure the output is treated as a string
	# The comma at the end of the line I have used as an example is there because another parameter is defined on the next line.		# The comma at the end of the line I have used as an example is there because another parameter is defined on the next line.
	# The whole object definition is enclosed in brackets "{" to "}"		# The whole object definition, of all the variables in the file, (not seen in single line extract above) is enclosed in brackets "{" to "}"

			==Example of using arithmetic with two Cumulus web tags in value==
⚫	Later on this Wiki page, it is explained that you can edit this template file, ~~but~~ if you ~~keep~~ the ~~current~~ ~~name~~ you risk your edit being lost ~~when~~ you upgrade to a new release as the release distribution includes a file with this name. If ~~you~~ do ~~edit~~ ~~this~~ ~~file~~, ~~then remember~~ it is ~~JavaScript, so you could~~ ~~define~~ a ~~parameter~~ ~~using~~ ~~arithmetic e.g~~. ~~Suppose~~ ~~you~~ ~~wanted~~ to ~~include~~ ~~the~~ ~~temperature~~ ~~difference~~ ~~between~~ ~~now~~ ~~and~~ 24 ~~hours~~ ~~ago,~~ ~~add~~ ~~a new line like this:~~

⚫	"temperatureChange24hours":"<#~~RCtemp~~> - <#~~RCRecentOutsideTemp~~ d=1>",
		⚫	Later on this Wiki page in [[#Tailoring the file]], it is explained that you can edit a copy of this template file. I say a copy, as if you edit the original file you risk your edit being lost whenever you upgrade to a new MX release as the release distribution includes a file with this name. In [[#How the file is used]], it is explained how a JavaScript file "setpagedata.js" loads this data file, and transfers values from the data file into HTML pages.

			If you do edit this template file, then remember it is JavaScript, there are rules for using arithmetic in this script language, but we won't go technical and list such rules here, instead we will use an example to explain. Let us suppose you wanted to include the temperature difference between now and 24 hours ago in your HTML page. How you edit HTML is covered elsewhere in this Wiki and in many tutorials available online. To get the value to our web server, we must ask MX tocalculate it, therefore that value has to be calculated in this template, and you would add a new line like this:
		⚫	"temperatureChange24hours":"<#temp rc=y> - <#RecentOutsideTemp d=1 rc=y>",
			Here, we still define a single variable name before the colon, but after the colon we subtract one web tag value from another remembering that we need to specify that decimal points not decimal commas are needed for JavaScript to understand the values as being numerical in order for the subtraction to work.

			(By the way, if we were doing an adding operation, we have to be very cautious as "+" is normally understood in this script language as indicating concatenation of strings. Please see [[Feels_Like#Script_for_setting_values\|here for an example of how addition is used]], essentially '+' can be used for adding by always using a numerical constant before the plus sign and always having any variable after the plus sign).

	=How the file is used=		=How the file is used=

			This wiki page is about a [[Cumulus template file]]. [[Cumulus.ini#Optional_Web_Server\|Settings for Optional_Web_Server]] describes how choosing the default web pages enables the processing of this file into a data file with values, and how that can be uploaded onto your web server. If we decide to tailor this template file, as described later, then we might use [[Cumulus.ini#Extra_Web_Files\|Extra web files]] settings within the [[MX Administrative Interface\|settings interface]] to process and upload our tailored file(s).
	Like any other [[Cumulus template file]], MX has to be told to [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27\|process]] the template in order to generate "CumulusMX/web/websitedata.json" which is a JavaScript file where the tags have been replaced by values. [[Cumulus.ini#Optional_Web_Server\|Settings for Optional_Web_Server]] describes how choosing the default web pages enables the processing and uploading of this file with values onto your web server.

			MX has to be told to convert that to a data file. There is a full explanation of what is meant by 'Cumulus processing any template' [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27\|here]]. In this case, MX will generate a file that is stored as "CumulusMX/web/websitedata.json". This data file is still coded as JavaScript file, but now the tags have gone as they have been replaced by values.

		⚫	The data file is used with the [[New Default Web Site Information\|Web Pages]] supplied in the [[Webfiles folder\|'''webfiles''']] sub-folder of the MX distribution from release 3.10.1 onwards. On your web server, each HTML page will call another JavaScript file "/CumulusMX/webfiles/js/setpagedata.js" (after uploading this file once to web site), it is that script that will both read the uploaded data file, and insert the relevant value into HTML pages in a span which has the "cmxdata" attribute, with a value for that attribute set to the appropriate variable name for the relevant JSON object.

			For example <code><span data-cmxdata="recordsbegandateISO"></span></code> would be processed in the "setpagedata.js" script and result in an insert of the date in the JSON line that we examined in detail at the start of this Wiki page.
⚫	The data file is used with the [[New Default Web Site Information\|Web Pages]] supplied in the [[Webfiles folder\|'''webfiles''']] sub-folder of the MX distribution from release 3.10.1 onwards. On your web server, each HTML page will call ~~the~~ JavaScript file "/CumulusMX/webfiles/js/setpagedata.js" (after uploading this file once to web site), it is that script that will read the uploaded data file, and insert the relevant value into HTML pages in a span which has the "cmxdata" attribute, with a value for that attribute set to the ~~JSON~~ ~~object~~ name.

	For example <code><span data-cmxdata="recordsbegandateISO"></span></code> would instruct the "setpagedata.js" script to insert the date in the JSON line that we examined in detail at the start of this Wiki page, ~~and~~ <code><span data-cmxdata="temperatureChange24hours"></span></code> would make it insert the temperature difference we ~~used~~ to show how arithmetic can be used in ~~what we presented earlier as an example of~~ what can be added as a modification to the JSON template.		Similarly, <code><span data-cmxdata="temperatureChange24hours"></span></code> would make that script insert the temperature difference we defined earlier, to show how arithmetic can be used in what can be added as a modification to the JSON template.

	In the tables below, that explain the data represented by various lines in the template file, there are multiple columns:		In the tables below, that explain the data represented by various lines in the template file, there are multiple columns:

Sfws: /* How the file is used */

2021-10-21T14:36:28Z

How the file is used

← Older revision		Revision as of 14:36, 21 October 2021
Line 30:		Line 30:
	For example <code><span data-cmxdata="recordsbegandateISO"></span></code> would instruct the "setpagedata.js" script to insert the date in the JSON line that we examined in detail at the start of this Wiki page, and <code><span data-cmxdata="temperatureChange24hours"></span></code> would make it insert the temperature difference we used to show how arithmetic can be used in what we presented earlier as an example of what can be added as a modification to the JSON template.		For example <code><span data-cmxdata="recordsbegandateISO"></span></code> would instruct the "setpagedata.js" script to insert the date in the JSON line that we examined in detail at the start of this Wiki page, and <code><span data-cmxdata="temperatureChange24hours"></span></code> would make it insert the temperature difference we used to show how arithmetic can be used in what we presented earlier as an example of what can be added as a modification to the JSON template.

			In the tables below, that explain the data represented by various lines in the template file, there are multiple columns:
⚫	In ~~the~~ ~~tables~~ ~~below,~~ that ~~explain~~ the ~~data~~ ~~represented~~ by ~~various~~ ~~lines~~ in the ~~template~~ file, the ~~Cumulus~~ ~~[[webtags\|tag~~ ~~name]]~~ ~~and~~ ~~its~~ ~~meaning~~ ~~are~~ ~~explained,~~ it is ~~made~~ ~~clear~~ whether any [[Webtags/Parameters\|input/output modification parameter]] appears, ~~and~~ the ~~table~~ ~~clearly~~ ~~identifies~~ ~~what JSON object name is used for the span attribute value. It might seem there is some repetition, but the~~ tag name ~~and~~ ~~JSON object name do not always match~~. Please note for simplicity, not every line in the file is explained, sometimes just one example is given representing multiple lines, this is enough to show you the format (with or without parameters), and whether the tag name and JSON object name do match.
			* Cumulus tag name (including whether any input/output modification parameters)
			* JSON object variable name
			* The span sequence used in HTML file to relate to the
		⚫	The reason for showing all three columns is that sometimes the tag name and the variable name do not match in the JSON file, and that if you look in the HTML file you need to find what data will be inserted there, including whether any [[Webtags/Parameters\|input/output modification parameter]] appears, or the default output from that tag name will appear. Please note for simplicity, not every line in the file is explained, sometimes just one example is given representing multiple lines, this is enough to show you the format (with or without parameters), and whether the tag name and JSON object variable name do match.

	=File details=		=File details=

Sfws: /* How the file is used */ Made clearer

2021-10-21T14:29:04Z

How the file is used: Made clearer

← Older revision		Revision as of 14:29, 21 October 2021
Line 26:		Line 26:
	Like any other [[Cumulus template file]], MX has to be told to [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27\|process]] the template in order to generate "CumulusMX/web/websitedata.json" which is a JavaScript file where the tags have been replaced by values. [[Cumulus.ini#Optional_Web_Server\|Settings for Optional_Web_Server]] describes how choosing the default web pages enables the processing and uploading of this file with values onto your web server.		Like any other [[Cumulus template file]], MX has to be told to [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27\|process]] the template in order to generate "CumulusMX/web/websitedata.json" which is a JavaScript file where the tags have been replaced by values. [[Cumulus.ini#Optional_Web_Server\|Settings for Optional_Web_Server]] describes how choosing the default web pages enables the processing and uploading of this file with values onto your web server.

	The data file is used with the [[New Default Web Site Information\|Web Pages]] supplied in the [[Webfiles folder\|'''webfiles''']] sub-folder of the MX distribution from release 3.10.1 onwards. On your web server, each HTML page will call the JavaScript file "/CumulusMX/webfiles/js/setpagedata.js" (after uploading this file once to web site), it is that script that will read the uploaded data file, and insert the relevant value into HTML pages in a span which has the "cmxdata" attribute, with a value for that attribute set to the JSON object name. For example <code><span data-cmxdata="recordsbegandateISO"></span></code> would instruct the "setpagedata.js" script to insert the object we examined in detail earlier and <code><span data-cmxdata="temperatureChange24hours"></span></code> would make it insert the temperature difference we added as a modification earlier.		The data file is used with the [[New Default Web Site Information\|Web Pages]] supplied in the [[Webfiles folder\|'''webfiles''']] sub-folder of the MX distribution from release 3.10.1 onwards. On your web server, each HTML page will call the JavaScript file "/CumulusMX/webfiles/js/setpagedata.js" (after uploading this file once to web site), it is that script that will read the uploaded data file, and insert the relevant value into HTML pages in a span which has the "cmxdata" attribute, with a value for that attribute set to the JSON object name.

			For example <code><span data-cmxdata="recordsbegandateISO"></span></code> would instruct the "setpagedata.js" script to insert the date in the JSON line that we examined in detail at the start of this Wiki page, and <code><span data-cmxdata="temperatureChange24hours"></span></code> would make it insert the temperature difference we used to show how arithmetic can be used in what we presented earlier as an example of what can be added as a modification to the JSON template.
	In the tables below, the [[webtags\|tag name]] together with any [[Webtags/Parameters\|input/output modification parameter]], and the span attribute value of a JSON object is also shown because they do not always match. Please note that in the tables below, for simplicity, not every element is shown, often just an example, this is enough to show you the format, again the JSON attribute and the ID do not always match.

			In the tables below, that explain the data represented by various lines in the template file, the Cumulus [[webtags\|tag name]] and its meaning are explained, it is made clear whether any [[Webtags/Parameters\|input/output modification parameter]] appears, and the table clearly identifies what JSON object name is used for the span attribute value. It might seem there is some repetition, but the tag name and JSON object name do not always match. Please note for simplicity, not every line in the file is explained, sometimes just one example is given representing multiple lines, this is enough to show you the format (with or without parameters), and whether the tag name and JSON object name do match.

	=File details=		=File details=

Sfws: /* How the file is used */ correct where code not showing

2021-10-21T14:14:41Z

How the file is used: correct where code not showing

← Older revision		Revision as of 14:14, 21 October 2021
Line 26:		Line 26:
	Like any other [[Cumulus template file]], MX has to be told to [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27\|process]] the template in order to generate "CumulusMX/web/websitedata.json" which is a JavaScript file where the tags have been replaced by values. [[Cumulus.ini#Optional_Web_Server\|Settings for Optional_Web_Server]] describes how choosing the default web pages enables the processing and uploading of this file with values onto your web server.		Like any other [[Cumulus template file]], MX has to be told to [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27\|process]] the template in order to generate "CumulusMX/web/websitedata.json" which is a JavaScript file where the tags have been replaced by values. [[Cumulus.ini#Optional_Web_Server\|Settings for Optional_Web_Server]] describes how choosing the default web pages enables the processing and uploading of this file with values onto your web server.

	The data file is used with the [[New Default Web Site Information\|Web Pages]] supplied in the [[Webfiles folder\|'''webfiles''']] sub-folder of the MX distribution from release 3.10.1 onwards. On your web server, each HTML page will call the JavaScript file "/CumulusMX/webfiles/js/setpagedata.js" (after uploading this file once to web site), it is that script that will read the uploaded data file, and insert the relevant value into HTML pages in a span which has the "cmxdata" attribute, with a value for that attribute set to the JSON object name. For example <code><span data-cmxdata="recordsbegandateISO"></span></code> would instruct the "setpagedata.js" script to insert the object we examined in detail earlier and <code><span data-cmxdata="temperatureChange24hours"></span></code> would make it insert the temperature difference we added as a modification earlier.		The data file is used with the [[New Default Web Site Information\|Web Pages]] supplied in the [[Webfiles folder\|'''webfiles''']] sub-folder of the MX distribution from release 3.10.1 onwards. On your web server, each HTML page will call the JavaScript file "/CumulusMX/webfiles/js/setpagedata.js" (after uploading this file once to web site), it is that script that will read the uploaded data file, and insert the relevant value into HTML pages in a span which has the "cmxdata" attribute, with a value for that attribute set to the JSON object name. For example <code><span data-cmxdata="recordsbegandateISO"></span></code> would instruct the "setpagedata.js" script to insert the object we examined in detail earlier and <code><span data-cmxdata="temperatureChange24hours"></span></code> would make it insert the temperature difference we added as a modification earlier.

	In the tables below, the [[webtags\|tag name]] together with any [[Webtags/Parameters\|input/output modification parameter]], and the span attribute value of a JSON object is also shown because they do not always match. Please note that in the tables below, for simplicity, not every element is shown, often just an example, this is enough to show you the format, again the JSON attribute and the ID do not always match.		In the tables below, the [[webtags\|tag name]] together with any [[Webtags/Parameters\|input/output modification parameter]], and the span attribute value of a JSON object is also shown because they do not always match. Please note that in the tables below, for simplicity, not every element is shown, often just an example, this is enough to show you the format, again the JSON attribute and the ID do not always match.


	=File details=		=File details=

Sfws: Improved the initial explanation about this file, in response to feedback

2021-10-21T10:34:33Z

Improved the initial explanation about this file, in response to feedback

← Older revision		Revision as of 10:34, 21 October 2021
Line 4:		Line 4:
	This [[Cumulus template file]] is found in the [[Web folder\|'''web''']] sub-folder of the MX distribution from release 3.10.1 onwards.		This [[Cumulus template file]] is found in the [[Web folder\|'''web''']] sub-folder of the MX distribution from release 3.10.1 onwards.

	It supplies the variable information that can be included in a web page by using Cumulus web tags to create a [[Php_webtags#Option_3:_JavaScript_Object_Notation\|JavaScript Object Notation (.json) file]]. ~~In the tables below, the [[webtags\|tag name]] together with any [[Webtags/Parameters\|input/output modification parameter]], and the JSON attribute is also shown because they do not always match.~~		It supplies the variable information that can be included in a web page by using Cumulus web tags to create a [[Php_webtags#Option_3:_JavaScript_Object_Notation\|JavaScript Object Notation (.json) file]].

			JSON files are written in JavaScript, and that script language supports defining objects. Thus this template file defines a number of objects, each is assigned to a [[Webtags\|Cumulus web tag]]. In the supplied file, some of these web tags employ [[Webtags/Parameters\|input and/or output modification Parameters]]. Let me take one line, and explain it in detail:
	On the [[New Default Web Site Information\|Web Pages]] supplied in the [[Webfiles folder\|'''webfiles''']] sub-folder of the MX distribution from release 3.10.1 onwards, table cells that take value, time, and date, information from this file, include a (span) element with an ''id'' that identifies which JSON variable is to be inserted by the relevant script. In the tables below, for simplicity, not every element is shown, often just an example to show you the format, again the JSON attribute and the ID do not always match.
			"recordsbegandateISO":"<#recordsbegandate format=yyyy-MM-dd>",
			# The first string <code>"recordsbegandateISO"</code> defines the object name.
			# The colon separates that object name from the value, think of it like an equals sign in ordinary arithmetic.
			# The <code><#</code> prefix defines the start of a Cumulus web tag.
			# The <code>recordsbegandate</code> is the tag name, the definition of this particular one can be found near the end of the table in [[Webtags#Date_.26_Time\|'Date & Time' section on webtags page]].
			# The <code>format=</code> is an output format modifier attribute defined in [[Webtags/Parameters#Multiple_Output_Format_Modifier_parameters_for_times_and_dates\|Multiple_Output_Format_Modifier_parameters_for_times_and_dates section on the parameters sub-page]].
			# The <code>yyyy-MM-dd</code> defines the output format required, as explained in the last cross-reference, this represents a four digit year, then a hyphen,then a two digit month code, then another hyphen, and finally a two digit day of month.
			# The > symbol ends the Cumulus web tag definition.
			# The double quotation marks round the Cumulus web tag ensure the output is treated as a string
			# The comma at the end of the line I have used as an example is there because another parameter is defined on the next line.
			# The whole object definition is enclosed in brackets "{" to "}"

			Later on this Wiki page, it is explained that you can edit this template file, but if you keep the current name you risk your edit being lost when you upgrade to a new release as the release distribution includes a file with this name. If you do edit this file, then remember it is JavaScript, so you could define a parameter using arithmetic e.g. Suppose you wanted to include the temperature difference between now and 24 hours ago, add a new line like this:
			"temperatureChange24hours":"<#RCtemp> - <#RCRecentOutsideTemp d=1>",

			=How the file is used=

			Like any other [[Cumulus template file]], MX has to be told to [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27\|process]] the template in order to generate "CumulusMX/web/websitedata.json" which is a JavaScript file where the tags have been replaced by values. [[Cumulus.ini#Optional_Web_Server\|Settings for Optional_Web_Server]] describes how choosing the default web pages enables the processing and uploading of this file with values onto your web server.

			The data file is used with the [[New Default Web Site Information\|Web Pages]] supplied in the [[Webfiles folder\|'''webfiles''']] sub-folder of the MX distribution from release 3.10.1 onwards. On your web server, each HTML page will call the JavaScript file "/CumulusMX/webfiles/js/setpagedata.js" (after uploading this file once to web site), it is that script that will read the uploaded data file, and insert the relevant value into HTML pages in a span which has the "cmxdata" attribute, with a value for that attribute set to the JSON object name. For example <code><span data-cmxdata="recordsbegandateISO"></span></code> would instruct the "setpagedata.js" script to insert the object we examined in detail earlier and <code><span data-cmxdata="temperatureChange24hours"></span></code> would make it insert the temperature difference we added as a modification earlier.

			In the tables below, the [[webtags\|tag name]] together with any [[Webtags/Parameters\|input/output modification parameter]], and the span attribute value of a JSON object is also shown because they do not always match. Please note that in the tables below, for simplicity, not every element is shown, often just an example, this is enough to show you the format, again the JSON attribute and the ID do not always match.


Line 19:		Line 41:
	The default web pages, even if you customise them, can only display JSON variables that are defined in this file (as per tables below) and formats for content are fixed.		The default web pages, even if you customise them, can only display JSON variables that are defined in this file (as per tables below) and formats for content are fixed.

			==Tailoring the file==

	If you want to use this file as the basis of your own JSON based file uploads (either because you want to change the fixed formats in provided file, or because you are not using the default web site):		If you want to use this file as the basis of your own JSON based file uploads (either because you want to change the fixed formats in provided file, or because you are not using the default web site):
	* Should you wish to tailor it, the best practice is to take a copy into a new folder, edit that copy, possibly into 3 separate files, and use the '''Extra Web Files''' settings to get it [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27\|processed]] and uploaded at your preferred interval.		* Should you wish to tailor it, the best practice is to take a copy into a new folder, edit that copy, possibly into 3 separate files, and use the '''Extra Web Files''' settings to get your tailored template [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27\|processed]] and uploaded at your preferred interval. The suggestion for multiple separate files, is purely because the content of the file does not all change at same interval:
	*# First file, upload using the '''EOD''' selection		*# First file, upload using the '''EOD''' selection
	# ~~All~~ the '''Static information''' (marked as such in lists below) rarely changes		# Include in this file, all the '''Static information''' (marked as such in lists below), as this information rarely changes
	# Equally, the '''Yesterday group''' only ~~changes~~ at rollover		# Equally include in this first file the '''Yesterday group''' as those values only change at rollover
	*# Most of the rest of the information can change during a day, and is best uploaded in a second file at your real-time interval (if that is enabled)		*# Most of the rest of the information can change during a day, and is best uploaded in a second file at your real-time interval (if that is enabled)
	*# You might chose to upload some information in a third file that is uploaded at the defined standard interval		*# You might chose to upload some information in a third file that is uploaded at the defined standard interval

			You will need to modify your JavaScript file "/CumulusMX/webfiles/js/setpagedata.js" (and don't forget to upload this file after editing once to web site), because it includes the loading of the data file: <code>$.getJSON('websitedata.json?_=' + Date.now(),</code>, the query-string (bit prefixed by question mark) just ensures a fresh copy is loaded each time, preventing your browser thinking because you have loaded the file before it can reuse the copy it cached. In the tailored copy of this script, it will need to load each of the tailored data files.

	==Options==		==Options==

	There are 3 fixed pieces of information conveyed by this file defining options:		There are 3 fixed pieces of information conveyed by this file refering to Cumulus web tags for defining options:
	# "useApparent" = whether Apparent Temperature or Feels Like temperature is required		# "useApparent" = whether Apparent Temperature or Feels Like temperature is required
	# "showSolar" = whether a solar sensor is providing solar information or not		# "showSolar" = whether a solar sensor is providing solar information or not
	# "showUV" = whether a UV sensor is providing Ultra Violet information or not		# "showUV" = whether a UV sensor is providing Ultra Violet information or not

	The content for these included in this file depend upon [[Cumulus.ini#Display_Options\|selections]] at '''Station Settings → Display Options'''.		The content values for these JSON object names as included in this file depend upon [[Cumulus.ini#Display_Options\|selections]] at '''Station Settings → Display Options'''.

	==List of variables==		==List of variables==
Line 88:		Line 113:
	\|"recordsbegandate" and "recordsbegandateISO"		\|"recordsbegandate" and "recordsbegandateISO"
	\| e.g. <nowiki><span data-cmxdata="recordsbegandate"></nowiki>		\| e.g. <nowiki><span data-cmxdata="recordsbegandate"></nowiki>
	\|Date when usage of MX began. The default format for first JSON parameter depends on the locale you use to run Cumulus, the second JSON parameter always returns a four digit year, then a hyphen, then a 2 digit month number, then a hyphen, then a 2 digit day of month number; this is using the date formatting element of '''ISO 8601 Data elements and interchange formats'''		\|Date when usage of MX began. The default format for first JSON parameter depends on the locale you use to run Cumulus, the second JSON parameter always returns a four digit year, then a hyphen, then a 2 digit month number, then a hyphen, then a 2 digit day of month number; this is using the date formatting element of '''ISO 8601 Data elements and interchange formats''' and was explained as an example in detail at the start of this Wiki page
	\|-		\|-
	\|<#forum>		\|<#forum>

Mcrossley: /* Daily extremes for yesterday */

2021-07-30T10:46:15Z

Daily extremes for yesterday

← Older revision		Revision as of 10:46, 30 July 2021
Line 608:		Line 608:
	\|Highest Solar Radiation, output should be ignored if your station does not have a solar sensor, and time, taken from last line stored in '''dayfile.txt'''		\|Highest Solar Radiation, output should be ignored if your station does not have a solar sensor, and time, taken from last line stored in '''dayfile.txt'''
	\|-		\|-
	\|<#~~SunshineHoursY~~>		\|<#YSunshineHours>
			\|"YSunshineHours"
	\|"SunshineHoursY"
	\| e.g.<span data-cmxdata="~~SunshineHoursY~~">		\| e.g.<span data-cmxdata="YSunshineHours">
	\|Yesterday's sunshine hours, taken from last line stored in '''dayfile.txt'''		\|Yesterday's sunshine hours, taken from last line stored in '''dayfile.txt'''
	\|-		\|-

Sfws: /* Monthly extremes for month-to-date */ typo

2021-07-27T04:50:36Z

Monthly extremes for month-to-date: typo

← Older revision		Revision as of 04:50, 27 July 2021
Line 736:		Line 736:
	\|<#MonthHumL>, "<#MonthHumLT> and <#MonthHumLD>		\|<#MonthHumL>, "<#MonthHumLT> and <#MonthHumLD>
	\|"MonthHumL", "MonthHumLT" and "MonthHumLD"		\|"MonthHumL", "MonthHumLT" and "MonthHumLD"
			\| e.g.<span data-cmxdata="MonthHumLD">
	\|Lowest relative humidity this meteorological month, time, and date, taken from '''month.ini'''		\|Lowest relative humidity this meteorological month, time, and date, taken from '''month.ini'''
	\|-		\|-