Module tpnote_lib::settings

source ·
Expand description

Configuration data that origins from environment variables. Unlike the configuration data in LIB_CFG which is sourced only once when Tp-Note is launched, the SETTINGS object may be sourced more often in order to follow changes in the related environment variables.

Constants

  • ENV_VAR_TPNOTE_EXTENSION_DEFAULT
    The name of the environment variable which can be optionally set to overwrite the filename.extension_default configuration file setting.
  • ENV_VAR_TPNOTE_LANG
    Name of the environment variable, that can be optionally used to overwrite the user’s default language setting, which is accessible as {{ lang }} template variable and used in various templates.
  • ENV_VAR_TPNOTE_LANG_DETECTION
    Name of the environment variable, that can be optionally used to overwrite the user’s tmpl.filter.get_lang and tmpl.filter.map_lang configuration file setting.
  • ENV_VAR_TPNOTE_SCHEME
    The name of the environment variable which can be optionally set to overwrite the scheme_default configuration file setting.
  • ENV_VAR_TPNOTE_USER
    Name of the environment variable, that can be optionally used to overwrite the user’s login name. The result is accessible as {{ username }} template variable and used in various templates.

Functions

  • set_test_default_settings
    Like Settings::update, with scheme_source = SchemeSource::Force("default") and force_lang = None. This is used in doctests only.