5,838
edits
Strings.ini: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Modifying the phrases: add to category
m (→Modifying the phrases: Add note that strings.ini does not need to contain all lines in samplestings.ini) |
m (→Modifying the phrases: add to category) |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
The file strings.ini allows the customisation of a number of phrases, | 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. | ||
=Introduction= | |||
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. | |||
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: | |||
'''Legacy Cumulus 1.9.x''' | |||
*Forecasting | *Forecasting | ||
* | *Moon phases | ||
*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 (under development)''' | |||
*Solar (not applicable to legacy Cumulus) | |||
*Forecasting | |||
*Moon phases | |||
*Beaufort Scale | |||
*Trend descriptions | |||
*Compass points | |||
*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). | |||
=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 | '''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= | ||
| Line 46: | Line 65: | ||
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 | =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] | ||
| Line 55: | Line 77: | ||
* [LeafTempCaptions] | * [LeafTempCaptions] | ||
* [LeafWetnesscaptions] | * [LeafWetnesscaptions] | ||
=Solar= | |||
Please note, the calculations used are approximate, this is a "fun" feature, not a "serious" feature. | |||
[Solar] | |||
MoreDaylightTomorrow=There will be {0}min {1}s more 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. 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. 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. Please remember, the dawn and dusk used may still be on different days. | |||
=Example file= | =Example file= | ||
As an example, a poor attempt at a French translation: | |||
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. | 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] | <pre>[Forecast] | ||
| Line 249: | Line 290: | ||
Sensor2=Sensor 2 | Sensor2=Sensor 2 | ||
* = value/section added v1.9.3 beta | |||
^[Solar] | |||
MoreDaylightTomorrow=Il y aura {0} minutes {1} secondes plus la lumière du jour demain | |||
LessDaylightTomorrow=Il y aura {0} minutes {1} secondes moins la lumière du jour demain | |||
* = value/section added v1.9.3 beta (Cumulus 1) | |||
^ = value/section added v3 beta build 3023 (Cumulus MX) | |||
</pre> | </pre> | ||
A variety of translated files are coming soon in the other [[Languages]] section | A variety of translated files are coming soon in the other [[Languages]] section | ||
[[Category: Configuration Files]] | [[Category: Configuration Files]] | ||
