Cumulus.ini (preserving history): Difference between revisions

Cumulus.ini (preserving history) (view source)

Revision as of 03:55, 21 June 2013

977 bytes added , 03:55, 21 June 2013

m

→‎Editing the file: introducing sub-headings and turning notes into bullet points

Sfws

5,838

edits

@@ Line 2: / Line 2: @@
 == Editing the file ==
-Many configuration parameters are changed from the various application configuration pages, you should never edit these directly in the file while Cumulus is running, as Cumulus will replace these parameters with the contents of the relevant application Edit/View/Configuration screens to the file when it shuts down.  You can edit them in the file with Cumulus stopped, it will read the new values when it restarts, but beware of selecting invalid values for these parameters, generally it is safer to use the application to edit them (unless you are importing values from another setup).
+=== Settings controlled by application ===
+Many configuration parameters are changed from the various application configuration pages, and those screens should ensure your replacement values are acceptable. You should never edit these directly in the file while Cumulus is running, as Cumulus will replace these parameters with the contents of the relevant application Edit/View/Configuration screens to the file when it shuts down.  You can edit them in the file with Cumulus stopped, but beware of selecting invalid values for these parameters, generally it is safer to use the application to edit them (unless you are importing values from another setup), and Cumulus will read the new values when it restarts.
-Note that some configuration settings can only be applied by editing this file to insert them; they do not appear anywhere in the configuration screens. Cumulus does not write these values back out to the file on shut down, so they do not appear with default values - in other words, you need to ''add'' them if you want to set them. Make sure you place these additional parameters in the correct section as listed below.
+=== Settings independent of application ===
+Some configuration settings can only be applied by editing this file to insert them; they do not appear anywhere in the configuration screens. Cumulus does not write these values back out to the file on shut down, so they do not appear with default values - in other words, you need to ''add'' them if you want to set them. Make sure you place these additional parameters in the correct section as listed below.
-'''Note''' also that if your system is configured to use a comma for a decimal separator, then you should use a comma in any decimal values that you set in this file.
+=== General notes ===
+*It is best to take a copy of the existing cumulus.ini file before you make any changes (either by using application screens or by editing the file), so you can return to the original if necessary.
+*If your system is configured to use a comma for a decimal separator, then you should use a comma in any decimal values that you set in this file.
+*You should use a text editor (not a rich text editor nor word processor) to edit this file as only letters, numerical digits, decimal separators and the equals symbol are allowed in any parameter. If you use a spreadsheet program to make use of the manipulation it offers, ensure it is set to output in pure text.
+*The parameters (attribute=value) can be in any order, but must be in the correct section. You might find it helpful to sort the attributes within a section into alphabetical order, to ensure you have no duplicates and to make it easier to find the particular parameter you may wish to edit in the future.
 == File Contents ==