From 3fe5f3f475fcbebf8648b95e04a3dd4de685bd2b Mon Sep 17 00:00:00 2001 From: Tom Keffer Date: Wed, 5 Dec 2018 05:40:07 -0800 Subject: [PATCH] Include [Defaults] in User's Guide --- TODO.md | 9 ++++----- docs/customizing.htm | 24 ++++++++++++++---------- docs/usersguide.htm | 44 +++++++++++++++++++++++++++----------------- 3 files changed, 45 insertions(+), 32 deletions(-) diff --git a/TODO.md b/TODO.md index 27a9f2a6..6f08af3b 100644 --- a/TODO.md +++ b/TODO.md @@ -1,9 +1,8 @@ #TO DO for V3.9 -User's Guide updates: - - Change references to Standard skin to Seasons. - - Mention the Mobile and Smartphone skins. +Customizing Guide updates: - Document how new skin defaults work -Root level `log_success` and `log_failure` are now documented. They should work for reports, -but how about other things, in particular the uploaders? +`log_success` and `log_failure` + - Check documentation + - They should work for reports, but how about other things, in particular the uploaders? diff --git a/docs/customizing.htm b/docs/customizing.htm index d67b33e5..20a16169 100644 --- a/docs/customizing.htm +++ b/docs/customizing.htm @@ -30,8 +30,8 @@
- -
+
Version: 3.9
@@ -665,7 +665,7 @@ db_manager.getSql("SELECT SUM(rain) FROM %s "\ distribution.

- General options are covered in the next section, while look-and-feel options + General options are covered in the next section, while look-and-feel options are covered under Reference to skin.conf options.

@@ -679,15 +679,19 @@ db_manager.getSql("SELECT SUM(rain) FROM %s "\ interval.

-

General options

+

General options

Overview of general options

- This section covers a suite of "general options," which control things like what unit system to use, how an - observation type should be labelled and formatted, etc. They can be changed in one of two different - sections in weewx.conf, depending on the "scope" over which you want the change to - apply. The table below summarizes: + This section covers a suite of "general options," which control things such as what unit system to use for + reports, how an observation type should be labelled and formatted, etc. A detailed reference guide to + all the options can be found below in section Reference guide to general options. +

+

+ General options can be changed in one of two different sections in weewx.conf, + depending on the "scope" over which you want the change to apply. The table below summarizes:

@@ -897,7 +901,7 @@ db_manager.getSql("SELECT SUM(rain) FROM %s "\

This section is a reference for all the general options, normally found in [Defaults] in weewx.conf

-

Reference guide to general options

+

Reference guide to general options

[Units]

@@ -4162,7 +4166,7 @@ class MyStats(SearchList): # 1

Modify the general options

- Next, you will need to go through the general options in the section general options in the section [Defaults] in weewx.conf, translating labels and modifying formats to follow local conventions.

diff --git a/docs/usersguide.htm b/docs/usersguide.htm index 482d9338..a1983c45 100644 --- a/docs/usersguide.htm +++ b/docs/usersguide.htm @@ -2055,22 +2055,23 @@ longitude = -77.0366

[[SeasonsReport]]
[[SmartphoneReport]]
[[MobileReport]]
[[StandardReport]]

-

These are the four reports that actually generate HTML files and plots. They all ship in the standard WeeWX - distribution. They all use US Customer units by default, but this can be changed by either editing their - respective skin.conf configuration files, or by overriding from the main configuration file, weewx.conf. +

+ These are the four reports that actually generate HTML files and plots. They all ship in the standard WeeWX + distribution. They all use US Customary units by default, but this can be changed by editing section [Defaults].

They all have the following options in common.

skin

-

Where to find the specifications for the skin. This should include any templates and the skin configuration - file, skin.conf. This should be a subdirectory under SKIN_ROOT. +

+ Where to find the skin. This should be a subdirectory under SKIN_ROOT. Inside + the directory should be any templates used by the skin and a skin configuration file, skin.conf.

enable

-

Set to true (the default) to enable the processing of this skin. Set to false to disable. +

+ Set to true to enable the processing of this skin. Set to false to disable. If this option is missing, True is assumed.

HTML_ROOT

@@ -2194,7 +2195,8 @@ longitude = -77.0366 databases. You must chose a unit system and then stick with it. This means that users coming from wview (which uses US Customary) should not change the default setting. Having said this, there is a way of reconfiguring the database to use another unit system. See the section Changing the unit system in the Customization Guide. + href="customizing.htm#Changing_the_unit_system">Changing the unit system in the Customization Guide.

Note!
This service only affects the units used in the databases. @@ -2220,8 +2222,8 @@ longitude = -77.0366 class="code">METRIC is that the former uses mm instead of cm for rain, and m/s instead of km/hr for wind speed. See the Appendix Units in the - Customization Guide for the exact differences beween these three choices. Default is US. + Customization Guide for the exact differences beween these three choices. + Default is US.

[StdCalibrate]

@@ -2341,7 +2343,7 @@ longitude = -77.0366 each derived quantity.

-

ignore_zero_wind

+

ignore_zero_wind

Indicates whether the wind direction should be undefined when the wind speed is zero. The default value is @@ -2651,6 +2653,14 @@ longitude = -77.0366 Default is INNODB.

+

[Defaults]

+

+ This section covers a suite of "general options," which control things such as which unit system should be + used in reports, what label to be used for an observation type, and how it should be formatted. Details can + be found in General options in the Customization Guide. +

+

[Engine]

@@ -3545,10 +3555,10 @@ May 14 13:35:23 web weewx[5633]: **** Generator terminated...

There is no wind direction when wind speed is zero

- This is by design - if there is no wind, then the wind direction is undefined. An undefined value is - represented by a NULL in the database or a None in Python. This policy is enforced by the StdWXCalculate service. If necessary, it can be overridden. See the StdWXCalculate section for instructions. + This is by design — if there is no wind, then the wind direction is undefined, represented by NULL + in the database or None in Python. This policy is enforced by the StdWXCalculate + service. If necessary, it can be overridden. See option ignore_zero_wind + in the [StdWXCalculate] section.

WeeWX distinguishes between a value of zero and no value (NULL or None). However, some services do not make