Strings.ini: Difference between revisions

m
m (→‎Modifying the phrases: add to category)
 
(14 intermediate revisions by 2 users not shown)
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, includingand where included (all Cumulus versions) in the associatedweb webtagstags.
 
=Introduction=
Currently you can modified phrases associated with the following:
 
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 (andthat henceis inpart yourof strings.inithe file)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 modifiedmodify phrases associated with the following:
 
'''Legacy Cumulus 1.9.x'''
*Forecasting
*Moon phases
*Moonphases
*Beaufort Scale
*Trend descriptions
*Compass points
*Graph titles (not applicable to MX)
*Additional sensor names
 
'''Cumulus MX (under development)'''
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.
*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=
 
[[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 namerename 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, the textthere is thealways samea asparticular appearsphrase on the left handalready sidethere, but you can replace thisthe 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 Stringsstrings.ini file while Cumulus is running'''. Cumulus (any flavour) only reads the file when it starts to run.
 
=Forecast phrases=
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 leafLeaf 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:
* [ExtraTempCaptions]
* [LeafTempCaptions]
* [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=
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.
<pre>[Forecast]
Forecast=Forecastprévisions
notavailable=Notpas availabledisponibles
exceptional=Exceptionaltemps Weatherexceptionnel
forecast1=Settledbeau finetemps établi
forecast2=Finebeau weathertemps
forecast3=Becomingtendance fineau beau temps
forecast4=Finebeau temps, becomingtendance à lessse settleddégrader
forecast5=Finebeau, possibleaverses showerspossibles
forecast6=Fairlyplutôt finebeau, improvingen amélioration
forecast7=Fairlyplutôt fine,beau possibleaverses showerspossibles earlyen matinée
forecast8=Fairlyassez finebeau, showerydes lateraverses en soirée
forecast9=Showery earlyaverses, improvingen amélioration
forecast10=Changeablevariable, mendingen amélioration
forecast11=Fairlyplutôt finebeau, showersaverses likelyprobables
forecast12=Ratherplutôt unsettledperturbé, clearing laters'améliorant
forecast13=Unsettledperturbé, probablys'améliorant improvingprobablement
forecast14=Showerypluies éparses, brightbelles intervalséclaircies
forecast15=Showeryaverses, becomingtemps lessse settleddécouvrant
forecast16=Changeablevariable, somequelques precipitationprécipitations
forecast17=Unsettledperturbé, shortde finerares éclairces intervals
forecast18=Unsettledvariable, precipitationquelques précipitations tardives later
forecast19=Unsettledvariable, somequelques precipitationprécipitations
forecast20=Mostlytrès very unsettledperturbé
forecast21=Occasionalprécipitations precipitationoccasionnelles, worseningse dégradant
forecast22=Precipitationquelques at timesprécipitations, verytrès unsettledperturbé
forecast23=PrecipitationPrecipitations atà frequentintervalles intervalsfréquents
forecast24=PrecipitationPluie, verytrès unsettledperturbé
forecast25=Stormytempête, maypourrait improves'améliorer
forecast26=Stormytempête, muchfortes precipitationpluies
 
[MoonPhases]
Newmoon=Newnouvelle moonLune
WaxingCrescent=Waxingpremier Crescentcroissant
FirstQuarter=Firstpremier Quarterquartier
WaxingGibbous=WaxingLune Gibbousgibbeuse croissante
Fullmoon=FullPleine moonLune
WaningGibbous=WaningLune Gibbousgibbeuse décroissante
LastQuarter=Lastdernier Quarterquartier
WaningCrescent=Waningdernier Crescentcroissant
 
[Beaufort]
Calm=CalmCalme
Lightair=Lighttrès airlégère brise
Lightbreeze=Lightbrise breezelégère
Gentlebreeze=GentlePetite breezebrise
Moderatebreeze=Moderatejolie breezebrise
Freshbreeze=Freshbonne breezebrise
Strongbreeze=Strongvent breezefrais
Neargale=Neargrand galefrais
Gale=Galecoup de vent
Stronggale=Strongfort galecoup de vent
Storm=StormTempête
Violentstorm=ViolentViolente stormtempête
Hurricane=HurricaneOuragan
 
[Trends]
Risingveryrapidly=Risinghausse verytrès rapidlyrapide
Risingquickly=Risinghausse quicklyrapide
Rising=Risinghausse
Risingslowly=Risinghausse slowlylentement
Steady=Steadystable
Fallingslowly=Fallingchute slowlylente
Falling=Fallingchute
Fallingquickly=Fallingchute quicklyrapide
Fallingveryrapidly=Fallingchute verytrès rapidlyrapide
 
[Compass]
[Graphs]
SmallGraphWindSpeedTitle=Wind Speed
SmallGraphOutsideTemperatureTitle=OutsideAir Temperature
SmallGraphInsideTemperatureTitle=Inside Temperature
SmallGraphPressureTitle=Atmospheric Pressure
SmallGraphRainfallRateTitle=Rainfall Rate
SmallGraphWindDirectionTitle=Wind Direction
LargeGraphWindSpeedTitle=Wind Speed
LargeGraphWindGustTitle=Wind Gust
LargeGraphOutsideTempTitle=Air Temperature
LargeGraphHeatIndexTitle=Heat Index
LargeGraphDewPointTitle=Dew Point
LargeGraphRainfallRateTitle=Rainfall Rate
LargeGraphWindDirectionTitle=Wind Direction
LargeGraphWindAvgDirectionTitle=AverageAve. Direction
LargeGraphMinTempTitle=MinLowest Temp
LargeGraphMaxTempTitle=MaxHighest Temp
LargeGraphAvgTempTitle=AvgAverage Temp
LargeGraphInsideHumidityTitle=Inside Humidity
LargeGraphOutsideHumidityTitle=Outside Humidity
[ExtraSensorCaptions]
Solar=Solar
ExtraChannel2=ExtraMy Channel 2
ExtraChannel3=ExtraMy Channel 3
ExtraChannel4=ExtraMy Channel 4
ExtraChannel5=Extraunused Channel 5
ExtraChannel6=Extraunused Channel 6
ExtraChannel7=Extraunused Channel 7
ExtraChannel8=Extraunused Channel 8
ExtraChannel9=Extraspare Channel 9
ExtraChannel10=Extraspare Channel 10
 
*[ExtraTempCaptions]
Sensor1=Sensorshed 1
Sensor2=Sensorgreenhouse 2
Sensor3=SensorSpare 3
Sensor4=Sensor 4
Sensor5=Sensor 5
Sensor7=Sensor 7
Sensor8=Sensor 8
Sensor9=SensorSpare 9
Sensor10=SensorSpare 10
 
*[ExtraHumCaptions]
Sensor1=Sensor 1
Sensor2=Sensorgreenhouse 2
Sensor3=Sensor 3
Sensor4=Sensor 4
Sensor7=Sensor 7
Sensor8=Sensor 8
Sensor9=SensorSpare 9
Sensor10=SensorSpare 10
 
*[ExtraDPCaptions]
Sensor1=Sensor 1
Sensor2=Sensorgreenhouse 2
Sensor3=Sensor 3
Sensor4=Sensor 4
 
*[SoilTempCaptions]
Sensor1=SensorSoil 1
Sensor2=Sensor 2
Sensor3=Sensor 3
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>
A variety of translated files are coming soon in the other [[Languages]] section
5,838

edits