Strings.ini: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m
m (→‎Introduction: added cross-ref)
 
=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.
 
EsentiallyEssentially, ''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 modify 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)'''
*Solar (not applicable to legacy Cumulus)
*Solar
*Forecasting
*Moon phases
*Moonphases
*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=
5,838

edits

Navigation menu