doc: A bit more explanation of params in local_settings [vipsutv-305]

VIPSWeb/local_settings_sample.py

@@ -58,7 +58,7 @@ LANGUAGE_CODE = 'en'
 # List of available translations
 AVAILABLE_LANGUAGES = ["en", "nb", "bg"]
 
-# Preferred language in VIPSLogic
+# Preferred language in VIPSLogic (The backend for VIPSWeb)
 VIPSLOGIC_LANGUAGE_CODE = "en"
 
 # Local time zone for this installation. Choices can be found here:
@@ -68,12 +68,15 @@ VIPSLOGIC_LANGUAGE_CODE = "en"
 TIME_ZONE = 'Europe/Oslo'
 
 # This can be used for testing purposes. Is valid locally for 
-# this web page, not the VIPSLogic application.
+# this web page, not the VIPSLogic application. To simulate one year
+# ago, set it to -12. Values > 0 make no sense, by the way.
 SYSTEM_TIME_OFFSET_MONTHS = 0
 
 # This is for testing purposes. It overrides SYSTEM_TIME_OFFSET_MONTHS
 # It's valid locally for this web page, not the VIPSLogic application
-# Ideally, they should be synchronized
+# Ideally, they should be synchronized.  
+# Valid values are None, "" or "%Y-%m-%d" 
+# Example: SYSTEM_TIME_EXACT = "2019-06-15"
 SYSTEM_TIME_EXACT = None
 
 DATABASES = {
@@ -97,7 +100,7 @@ DATABASES = {
 #    }
 #}
 
-# Site name - appears in header of all pages
+# Site name - appears in header of all pages. HTML is allowed
 SITE_NAME = "Example site title"
 
 # Insert Google Analytics Script?
@@ -115,9 +118,9 @@ GOOGLE_ANALYTICS_SCRIPT = """
 </script>
 """
 
-# The server name used for VIPSLogic
+# The server hostname used for VIPSLogic
 VIPSLOGIC_SERVER_NAME = "vipslogic"
-# VIPSLogic protocol
+# VIPSLogic protocol (http or https)
 VIPSLOGIC_PROTOCOL = "http"
 # This organization's ID in VIPSLogic/CoreManager
 VIPS_ORGANIZATION_ID = 1
@@ -125,7 +128,7 @@ VIPS_ORGANIZATION_ID = 1
 INCLUDE_ORGANIZATION_IDS =[1,2,3,4,5]
 # Use this if you want to override and show icons for stations belonging to several organizations
 #FORECAST_MAP_ORGANIZATION_IDS =[1,6]
-# The server name used for VIPSCoreManager
+# The server hostname used for VIPSCoreManager
 VIPSCOREMANAGER_SERVER_NAME = "vipscoremanager"
 # Local path to self signed certificate of VIPSCoreManager. 
 # Set to none if using certificate signed by a CA
@@ -138,7 +141,7 @@ VIPSLOGIC_DATE_FORMAT = "%Y-%m-%d"
 SITE_OWNER_NAME = {"en":"FooBar Inc","nb":"ACME industrier"}
 SITE_OWNER_URL = "http://www.example.com/"
 
-# OpenLayers Map initial configuration
+# OpenLayers Map (map on front page) initial configuration
 # Longitude and latitude in WGS84 format
 # See http://en.wikipedia.org/wiki/World_Geodetic_System#A_new_World_Geodetic_System:_WGS_84
 MAP_CENTER_LONGITUDE = 14.1