Cumulus.ini (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Cumulus.ini (preserving history) (view source)

Revision as of 12:11, 20 May 2021

864 bytes added ,  12:11, 20 May 2021
m
no edit summary
mNo edit summary
Line 78: Line 78:


Consequently, the revised tables have to explain which section settings are in the file.
Consequently, the revised tables have to explain which section settings are in the file.
The ‘’’Settings’’’ menu has links to a number of settings pages in its drop down.  On this Wiki page, a separate second level headed section is used for each settings page.
Within that second level section in this Wiki (it covers the whole settings page), there are third level sections on this Wiki page that are named to match the way that settings page has grouped settings into a number of sections that have to be opened individually (by either a button for maximum accessibility, or a '''Click ▶to expand,  click ▼ to collapse''' for alternative styling).
If after opening any settings page sections MX then chooses to display sub-sections, this Wiki page will use fourth-level section headings that correspond with those sub-section names on the settings page.
Finally, individual settings are normally presented as rows in tables for clarity on this Wiki page. The full format for tables shown below is
{| class="wikitable" border="1"
|-
!style="width:30px" | Section
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Shown on Settings page?
!style="width:100px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|}
Where round brackets are used in '''Default''' column, they indicate an explanation. No brackets surround literal text representing default value, which is normally also seen in '''Paraeter Line Entry'''.
Not all columns appear in each table:
*The '''Section''' column does not appear if all parameters in that settings page section appear in the same section in "Cumulus.ini", because it is replaced by a new row (where xxxxxx is the section name):
{| class="wikitable" border="1"
|-
|style="background:lightgray;"|[xxxxxx]
|
|
|style="background:lightgray;"|Section name
|}
*The '''Shown on Settings page?''' column does not appear if all parameters that settings page can show always appear. If some settings appear or disappear depending on an earlier selection, then the relevant condition is shown in this column, otherwise "Always" is shown.
Exceptions to above table styling:
# MQTT parameters are handled slightly differently, as they did not fit that standard layout
#  The mean temperatures, and normal rainfall figures, with one parameter per month, have been presented as text, rather than a table for simplicity
# For the Extra Web Files Settings page, where the settings page uses [[MX_Basic_info#editable_grid|editable grid software]] using a table to enter 800 settings, the table here is split into just 8 rows, each of which applies to 100 parameters in the file.


=The Cumulus.ini file=
=The Cumulus.ini file=
Line 163: Line 201:
Please see [[MX_Administrative_Interface#Changing_Settings]] for basic information, including how to load the admin interface.
Please see [[MX_Administrative_Interface#Changing_Settings]] for basic information, including how to load the admin interface.


The ‘’’Settings’’’ menu has links to a number of settings pages in its drop down.  On this Wiki page, a separate second level headed section is used for each settings page.
Within that second level section in this Wiki (it covers the whole settings page), there are third level sections on this Wiki page that are named to match the way that settings page has grouped settings into a number of sections that have to be opened individually (by either a button for maximum accessibility, or a '''Click ▶to expand,  click ▼ to collapse''' for alternative styling).
If after opening any settings page sections MX then chooses to display sub-sections, this Wiki page will use fourth-level section headings that correspond with those sub-section names on the settings page.
Finally, individual settings are normally presented as rows in tables for clarity on this Wiki page.
There are different formats for these tables:
# Configuration file [Section] name appears in a column, permitting one table to cover parameters that appear in different sections in the file
# Configuration file [Section] name appears at top of table, signifying all parameters in that table are in same section of the configuration file.
# MQTT parameters are handled slightly differently, as they did not fit that standard layout
#  As an exception, the mean temperatures, and normal rainfall figures, with one parameter per month, have been presented as text, rather than a table for simplicity
# As another exception, for the Extra Web Files Settings page, where the settings page uses different software using a table to enter 800 settings, the table here is split into just 8 rows, each of which applies to 100 parameters in the file.


==Do I need to restart MX?==
==Do I need to restart MX?==
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/8966"

Navigation menu