Strings.ini - Revision history

Sfws: /* Modifying the phrases */ add to category

2021-05-09T10:14:30Z

Modifying the phrases: add to category

← Older revision		Revision as of 10:14, 9 May 2021
Line 33:		Line 33:
	=Modifying the phrases=		=Modifying the phrases=

			[[Category:Cumulus Files]]
	In the folder where you installed Cumulus, you will find a file called <tt>samplestrings.ini</tt>. Take a copy of this, leave it in the Cumulus installation folder, and rename it <tt>strings.ini</tt>. Note that your 'strings.ini' only needs to contain the rows with phrases you want to modify.		In the folder where you installed Cumulus, you will find a file called <tt>samplestrings.ini</tt>. Take a copy of this, leave it in the Cumulus installation folder, and rename it <tt>strings.ini</tt>. Note that your 'strings.ini' only needs to contain the rows with phrases you want to modify.

	You can edit anything that follows the equals sign. By default, there is always a particular phrase already there, but you can replace the right hand text with the equivalent in another language, or with a similar but more descriptive phase that is easier for you to understand. If you do not want to change the right hand text, then the entire line can be deleted, and the default will be used by Cumulus.		You can edit anything that follows the equals sign. By default, there is always a particular phrase already there, but you can replace the right hand text with the equivalent in another language, or with a similar but more descriptive phase that is easier for you to understand. If you do not want to change the right hand text, then the entire line can be deleted, and the default will be used by Cumulus.

	'''You must restart Cumulus if you make changes to the strings.ini file while Cumulus is running'''. Cumulus only reads the file when it starts to run.		'''You must restart Cumulus if you make changes to the strings.ini file while Cumulus is running'''. Cumulus (any flavour) only reads the file when it starts to run.

	=Forecast phrases=		=Forecast phrases=

Sfws: /* Solar */

2021-02-25T11:32:22Z

Solar

← Older revision		Revision as of 11:32, 25 February 2021
Line 90:		Line 90:


	Legacy Cumulus 1: Remember that these minutes and seconds are calculated only at midnight based on times for '''last Dawn''' and ''next Dusk'' that will be on different dates (except between dusk and midnight), so they are approximate as they never relate to your current daytime period.		Legacy Cumulus 1: Remember that these minutes and seconds are calculated only at midnight based on times for '''last Dawn''' and ''next Dusk'' that will be on different dates (except between dusk and midnight), so they are approximate as they never relate to your current daytime period. However, this modification is only available in Cumulus 2 and 3 (MX).

	MX: Recalculated during the day, so you may see the figures change depending on local time.		MX: Recalculated during the day, so you may see the figures change depending on local time. Please remember, the dawn and dusk used may still be on different days.

	=Example file=		=Example file=

Sfws: /* Solar */

2021-02-25T11:29:20Z

Solar

← Older revision		Revision as of 11:29, 25 February 2021
Line 78:		Line 78:

	=Solar=		=Solar=

			Please note, the calculations used are approximate, this is a "fun" feature, not a "serious" feature.

	[Solar]		[Solar]

	MoreDaylightTomorrow=There will be {0}min {1}s more daylight tomorrow		MoreDaylightTomorrow=There will be {0}min {1}s more daylight tomorrow

	LessDaylightTomorrow=There will be {0}min {1}s less daylight tomorrow		LessDaylightTomorrow=There will be {0}min {1}s less daylight tomorrow

	The {0} and {1} strings are placeholders for where you want the minutes and seconds to appear.		The {0} and {1} strings are placeholders for where you want the minutes and seconds to appear. Note by default, there is no space between figure and units.


		⚫	Legacy Cumulus 1: Remember that these minutes and seconds are calculated only at midnight based on times for '''last Dawn''' and ''next Dusk'' that will be on different dates (except between dusk and midnight), so they are approximate as they never relate to your current daytime period.

			MX: Recalculated during the day, so you may see the figures change depending on local time.
⚫	Remember that these minutes and seconds are calculated based on times for last Dawn and next Dusk that ~~may~~ be on different ~~days~~, so they are approximate in ~~terms~~ of ~~the~~ current ~~local~~ ~~time~~.

	=Example file=		=Example file=

Sfws: /* Extra Temperature Captions, Extra Humidity Captions, Extra Dew Point Captions, Soil Temperature Captions, Soil Moisture Captions, Leaf Temperature Captions, and leaf Wetness Captions */

2021-02-25T11:20:53Z

Extra Temperature Captions, Extra Humidity Captions, Extra Dew Point Captions, Soil Temperature Captions, Soil Moisture Captions, Leaf Temperature Captions, and leaf Wetness Captions

← Older revision		Revision as of 11:20, 25 February 2021
Line 64:		Line 64:
	This section [ExtraSensorCaptions] allows you to assign meaningful names to any addtional sensors you may have added to your WMR100/200 weather station.		This section [ExtraSensorCaptions] allows you to assign meaningful names to any addtional sensors you may have added to your WMR100/200 weather station.

	=Extra Temperature Captions, Extra Humidity Captions, Extra Dew Point Captions, Soil Temperature Captions, Soil Moisture Captions, Leaf Temperature Captions, and ~~leaf~~ Wetness Captions=		=Extra Temperature Captions, Extra Humidity Captions, Extra Dew Point Captions, Soil Temperature Captions, Soil Moisture Captions, Leaf Temperature Captions, and Leaf Wetness Captions=

			Check which of these are available for the release you are running. There may be more than those listed here.

	Meaningful descriptive labels can be assigned to each extra Davis or Oregon Scientific sensor by editing the lines in the following sections and placing a more appropriate descriptive name to the right of the equals sign:		Meaningful descriptive labels can be assigned to each extra Davis or Oregon Scientific sensor by editing the lines in the following sections and placing a more appropriate descriptive name to the right of the equals sign:
	* [ExtraTempCaptions]		* [ExtraTempCaptions]

Sfws: /* Introduction */

2021-02-25T11:18:36Z

Introduction

← Older revision		Revision as of 11:18, 25 February 2021
Line 2:		Line 2:

	=Introduction=		=Introduction=
⚫	~~Esentially~~ ''strings.ini'' is constructed by including parameters from ''[[samplestring.ini]]''. Each parameter is made up of an "attribute=value" pair, with the left hand side indicating what Cumulus is trying to output and the right hand side indicating the phrase you want Cumulus to use instead.

			No Cumulus release includes a '''strings.ini''' file (note that unless you are running Cumulus in a Windows operating system, all characters in this file name must be lower case). It is a file that a Cumulus user can add to customise some of the output that comes from Cumulus software.
⚫	Note that you can only change the display of items that are already present in the samplestrings.ini file ~~(and~~ ~~hence~~ in ~~your~~ ~~strings.ini~~ ~~file)~~. You can't just add other items to the file and expect them to work.

		⚫	Essentially, ''strings.ini'' is constructed by including one or more parameters taken from ''[[samplestring.ini]]'' (that file is in the distribution). Each parameter is made up of an "attribute=value" pair, with the left hand side indicating what Cumulus is trying to output, and the right hand side indicating the phrase you want Cumulus to use instead. Please note, that for MX only, there are some exceptions where the LHS does not indicate the default output, the default is as per RHS in '''samplestrings.ini''', and these exceptions use embedded parameters on the RHS, for these exceptions you can modify the text surrounding certain output figures represented by imbedded {0} and {1}.

		⚫	Note that you can only change the display of items that are already present in the samplestrings.ini file that is part of the distribution for whatever release of Cumulus you are running. You can't just add other items to the file and expect them to work.

	Currently you can modify phrases associated with the following:		Currently you can modify phrases associated with the following:

	'''Cumulus 1.9.x'''		'''Legacy Cumulus 1.9.x'''
	*Forecasting		*Forecasting
			*Moon phases
	*Moonphases
	*Beaufort Scale		*Beaufort Scale
	*Trend descriptions		*Trend descriptions
	*Compass points		*Compass points
	*Graph titles		*Graph titles (not applicable to MX)
	*Additional sensor names		*Additional sensor names

	'''Cumulus MX'''		'''Cumulus MX (under development)'''
			*Solar (not applicable to legacy Cumulus)
	*Solar
	*Forecasting		*Forecasting
			*Moon phases
	*Moonphases
	*Beaufort Scale		*Beaufort Scale
	*Trend descriptions		*Trend descriptions
	*Compass points		*Compass points
	*Extra sensor names		*Extra sensor names (more extensive than legacy Cumulus)

	(Please see [[Samplestring.ini]] page for full list of group names appearing in square brackets []) for MX.		(Please see [[Samplestring.ini]] page for full list of group names, appearing in square brackets [], for MX).

	=Modifying the phrases=		=Modifying the phrases=

Sfws: /* Introduction */ added cross-ref

2021-02-25T11:07:47Z

Introduction: added cross-ref

← Older revision		Revision as of 11:07, 25 February 2021
Line 25:		Line 25:
	*Compass points		*Compass points
	*Extra sensor names		*Extra sensor names

			(Please see [[Samplestring.ini]] page for full list of group names appearing in square brackets []) for MX.

	=Modifying the phrases=		=Modifying the phrases=

Sfws: /* Introduction */ update for MX

2021-01-23T19:13:33Z

Introduction: update for MX

← Older revision		Revision as of 19:13, 23 January 2021
Line 2:		Line 2:

	=Introduction=		=Introduction=
	Esentially ''strings.ini'' is constructed by including parameters from ''samplestring.ini''. Each parameter is made up of an "attribute=value" pair, with the left hand side indicating what Cumulus is trying to output and the right hand side indicating the phrase you want Cumulus to use instead.		Esentially ''strings.ini'' is constructed by including parameters from ''[[samplestring.ini]]''. Each parameter is made up of an "attribute=value" pair, with the left hand side indicating what Cumulus is trying to output and the right hand side indicating the phrase you want Cumulus to use instead.

	Note that you can only change the display of items that are already present in the samplestrings.ini file (and hence in your strings.ini file). You can't just add other items to the file and expect them to work.		Note that you can only change the display of items that are already present in the samplestrings.ini file (and hence in your strings.ini file). You can't just add other items to the file and expect them to work.
Line 19:		Line 19:
	'''Cumulus MX'''		'''Cumulus MX'''
	*Solar		*Solar
			*Forecasting
			*Moonphases
			*Beaufort Scale
			*Trend descriptions
			*Compass points
			*Extra sensor names

	=Modifying the phrases=		=Modifying the phrases=

Steve at 11:48, 2 January 2016

2016-01-02T11:48:31Z

← Older revision		Revision as of 11:48, 2 January 2016
Line 26:		Line 26:
	You can edit anything that follows the equals sign. By default, there is always a particular phrase already there, but you can replace the right hand text with the equivalent in another language, or with a similar but more descriptive phase that is easier for you to understand. If you do not want to change the right hand text, then the entire line can be deleted, and the default will be used by Cumulus.		You can edit anything that follows the equals sign. By default, there is always a particular phrase already there, but you can replace the right hand text with the equivalent in another language, or with a similar but more descriptive phase that is easier for you to understand. If you do not want to change the right hand text, then the entire line can be deleted, and the default will be used by Cumulus.

	'''You must restart Cumulus if you make changes to the ~~Strings~~.ini file while Cumulus is running'''. Cumulus only reads the file when it starts to run.		'''You must restart Cumulus if you make changes to the strings.ini file while Cumulus is running'''. Cumulus only reads the file when it starts to run.

	=Forecast phrases=		=Forecast phrases=

Sfws: Mention Solar for MX and some minor grammatical improvements

2015-06-15T10:24:34Z

Mention Solar for MX and some minor grammatical improvements

@@ Line 1: / Line 1: @@
-The file strings.ini allows the customisation of a number of phrases, including the associated webtags.
+The '''optional''' file ''strings.ini'' allows the customisation of a number of phrases that are output by Cumulus.  It affects the output where shown (Cumulus 1.x.x) on the main screen, and where included (all Cumulus versions) in the web tags.
 *Forecasting
 *Moonphases
@@ Line 11: / Line 17: @@
 *Additional sensor names
 =Modifying the phrases=
@@ Line 55: / Line 62: @@
 * [LeafTempCaptions]
 * [LeafWetnesscaptions]
 =Example file=
 This example  of '''strings.ini''' has had some English phrases (see ''samplestrings.ini'') replaced by their French equivalents, and a few other terms have been changed to different English phrases just to give an example of what can be done.
 <pre>[Forecast]
@@ Line 249: / Line 270: @@
 Sensor2=Sensor 2
 </pre>
 A variety of translated files are coming soon in the other [[Languages]] section

Sfws: /* Modifying the phrases */ Add note that strings.ini does not need to contain all lines in samplestings.ini

2013-12-17T07:54:02Z

Modifying the phrases: Add note that strings.ini does not need to contain all lines in samplestings.ini

← Older revision		Revision as of 07:54, 17 December 2013
Line 15:		Line 15:
	=Modifying the phrases=		=Modifying the phrases=

	In the folder where you installed Cumulus, you will find a file called <tt>samplestrings.ini</tt>. Take a copy of this, leave it in the Cumulus installation folder, and ~~name~~ it <tt>strings.ini</tt>		In the folder where you installed Cumulus, you will find a file called <tt>samplestrings.ini</tt>. Take a copy of this, leave it in the Cumulus installation folder, and rename it <tt>strings.ini</tt>. Note that your 'strings.ini' only needs to contain the rows with phrases you want to modify.

	You can edit anything that follows the equals sign. By default, there is always a particular phrase already there, but you can replace the right hand text with the equivalent in another language, or with a similar but more descriptive phase that is easier for you to understand.		You can edit anything that follows the equals sign. By default, there is always a particular phrase already there, but you can replace the right hand text with the equivalent in another language, or with a similar but more descriptive phase that is easier for you to understand. If you do not want to change the right hand text, then the entire line can be deleted, and the default will be used by Cumulus.

	'''You must restart Cumulus if you make changes to the Strings.ini file while Cumulus is running'''. Cumulus only reads the file when it starts to run.		'''You must restart Cumulus if you make changes to the Strings.ini file while Cumulus is running'''. Cumulus only reads the file when it starts to run.