j1-template 2022.0.10 → 2022.0.14

data/lib/starter_web/_data/modules/defaults/cookies.yml

@@ -28,9 +28,81 @@ description:
 # Default settings
 #
 defaults:
+  enabled:                              true
 
   # ----------------------------------------------------------------------------
-  # Settings/Attributes
+  # Switches
+  #
+  #   checkCookies
+  #   --------------------------------------------------------------------------
+  #   Check if cookies are created and available to the browser. If the
+  #   cookie attributes does NOT allow to create and|or access on cookies,
+  #   setting-up a page will fail.
+  #   For testing sites deplayed on the Internet, it is recommended to enable
+  #   checks on cookies to issue an error page (HTML 445) if access on cookies
+  #   has failed for some reason. This will prevent severe failures and|or
+  #   endless loops accessing a page on missing cookies or invalid cookie
+  #   settings.
+  #
+  #   values:                           [false|true]
+  #   default:                          false
+  #
+  #   encryptCookiesOnHttp (currently NOT supported)
+  #   --------------------------------------------------------------------------
+  #   If a website does not use encryption over the HTTPS protocol, the
+  #   content written by J1 to cookies can be (AES) encrypted to prevent
+  #   unwanted manipulation.
+  #
+  #   NOTE: For sites deployed on the Internet, it is highly recommended
+  #         to use encryption (HTTPS protocol) for all sites to prevent
+  #         (man-in-the-middle) attacks. If this is NOT possible, at least
+  #         cookies should be encrypted to prevent attacks based on manipulated
+  #         contents.
+  #
+  #   NOTE: Encrpytion on cookies is only enabled, if an unsecure connection
+  #         over the HTTP protocol is detected. This is for performance reasons
+  #         to not do time consuming calculations if a site is already
+  #         encrypted.
+  #
+  #   values:                           [false|true]
+  #   default:                          false
+  #
+  #   expireCookiesOnRequiredOnly
+  #   --------------------------------------------------------------------------
+  #   J1 uses permanent cookies to store user-related data and process stored
+  #   data on subsequent visits. permanent cookies require consent, which is
+  #   automatically displayed as a cookie banner on the first visit.
+  #
+  #   If the switch 'expireCookiesOnRequiredOnly' is set to 'true', all
+  #   permanent cookies created by J1 are rewritten to session cookies if
+  #   the consent for advanced cookies (type personalization or analysis) has
+  #   been denied.
+  #   The browser automatically deletes all session cookies when all browser
+  #   sessions (windows/tabs) are closed. Since all session cookies are deleted
+  #   automatically, this will result in a cookie consent dialog being
+  #   displayed again on visitors next visit.
+  #
+  #   NOTE: It is recommended that permanent J1 cookies be rewritten to
+  #         session cookies for visitors who reject advanced cookies. In
+  #         addition, session cookies improve privacy policy compliance and
+  #         increase the chance all cookies are accepted on return.
+  #
+  #   NOTE: Make sure that your website complies with applicable privacy
+  #         regulations, such as the GDPR (DSGVO) or California California
+  #         Consumer Privacy Act (CCPA) by using the cookie banner provided
+  #         by J1 Template.
+  #
+  #   values:                           [false|true]
+  #   default:                          true
+  #
+  # ----------------------------------------------------------------------------
+  #
+  checkCookies:                         false
+  encryptCookiesOnHttp:                 false
+  expireCookiesOnRequiredOnly:          true
+
+  # ----------------------------------------------------------------------------
+  # Attributes
   #
   #   path
   #   --------------------------------------------------------------------------
@@ -43,19 +115,19 @@ defaults:
   #   domain
   #   --------------------------------------------------------------------------
   #   Switch 'domain' controls if the value for the attribute 'domain' is
-  #   used (= auto|domain) or NOT used (false). If 'auto' is given, the domain
-  #   is calculated from the hostname. Otherwise domain is treates as domain
-  #   to be used.
-  #   If the switch 'domain' is to 'false', the attribute 'domain' is
-  #   automatically set to the (fully qualified) hostname and all subdomains
-  #   are EXCLUDED from accessing the cookies.
+  #   used (= auto|domain_string) or NOT used (false). If 'auto' is given,
+  #   the domain is calculated from the hostname found in URL of the current
+  #   page. Otherwise 'domain_string' is treates as domain to be used.
+  #   If the switch 'domain' is set to 'false', the attribute 'domain' is
+  #   not set, but automatically set by the browser to the (fully qualified)
+  #   hostname and all subdomains are excluded from accessing the cookies.
   #
   #   NOTE: Be carefull setting switch 'domain' to auto. For sites deployed
   #         to hosts of public domain providers like Netlify (netlify.app),
   #         this will open the access on cookies to ALL hosts (subdomains)!
   #         See 'same_site'.
   #
-  #   values:                           [false|auto|domain]
+  #   values:                           [false|auto|domain_string]
   #   default:                          false
   #
   #   expires
@@ -69,44 +141,53 @@ defaults:
   #
   #   same_site
   #   --------------------------------------------------------------------------
-  #   Lax: sent for all requests (including subdomains).
-  #   Strict: the cookie is only sent to the site where it originated
-  #   (excluding subdomains)
-  #
-  #   values:                           [Strict|Lax]
+  #   Lax:      Sent cookie for all requests, including subdomains, but
+  #             not in cross-site requests.
+  #   Strict:   The cookie is only sent to the site where it originated,
+  #             excluding subdomains, but not in cross-site requests.
+  #   None:     Send cookies in cross-site requests if the attribute
+  #             'secure' is enabled. Note, the value 'None' can be only
+  #             used for HTTPS requests.
+  #
+  #   values:                           [Strict|Lax|None]
   #   default:                          Strict
   #
   #   http_only
   #   --------------------------------------------------------------------------
-  #   prevent access to cookie values via JavaScript
+  #   Prevent access on cookies via JavaScript (client-side). Note, for
+  #   client-side processing of cookies, like J1 Modules, never change
+  #   the attribute to 'true'.
+  #
+  #   NOTE: The attribute 'http_only' is only used for web applications to
+  #         store sensitive private user data (like passwords, account data) to
+  #         to cookies. Only 'server-sided' web applications will be able to
+  #         read cookies secured by 'http_only'.
   #
   #   values:                           [false|true]
   #   default:                          false
   #
   #   secure
   #   --------------------------------------------------------------------------
-  #   Cookies are only sent to the server with an encrypted request over
-  #   the HTTPS protocol
+  #   If set to 'true', cookies are only sent to the server with an encrypted
+  #   request over the HTTPS protocol. If set to 'auto', the attribute is
+  #   ENABLED (set to 'true') automatically, if a secure connection (HTTPS)
+  #   is detected.
   #
-  #   values:                           [false|true]
-  #   default:                          false
+  #   NOTE: For sites deployed on the Internet, it is highly recommended
+  #         to use encryption (HTTPS protocol) for all sites to prevent
+  #         (man-in-the-middle) attacks (and manipulation on cookies).
   #
-  #   check_cookies
-  #   --------------------------------------------------------------------------
-  #   Check if cookies created/available
-  #
-  #   values:                           [false|true]
-  #   default:                          true
+  #   values:                           [auto|false|true]
+  #   default:                          auto
   #
   # ----------------------------------------------------------------------------
   #
-  check_cookies:                        false
   path:                                 /
   domain:                               false
   expires:                              365
   same_site:                            Strict
+  secure:                               auto
   http_only:                            false
-  secure:                               false
 
 # ------------------------------------------------------------------------------
 # END config

data/lib/starter_web/_data/modules/defaults/fab.yml

@@ -16,9 +16,10 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
+# Description (used for J1 CC only)
 #
-about_config:
+description:
+
   title:                                Floating Action Button
   scope:                                Default settings
   location:                             _data/modules/defaults/fab.yml
@@ -28,6 +29,7 @@ about_config:
 #
 defaults:
   enabled:                              false
+
   mode:                                 icon
 
   xhr_container_id:                     fab-container

data/lib/starter_web/_data/modules/defaults/framer.yml

@@ -12,9 +12,9 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
+# Description (used for J1 CC only)
 #
-about_config:
+description:
 
   title:                                Framer
   scope:                                Default settings
@@ -245,7 +245,6 @@ about_config:
 # DEFAULTS
 #
 defaults:
-
   enabled:                            true
 
   load:                               sync

data/lib/starter_web/_data/modules/defaults/log4javascript.yml

@@ -13,9 +13,9 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
+# Description (used for J1 CC only)
 #
-about_config:
+description:
 
   title:                                Logger
   scope:                                Default settings
@@ -25,6 +25,7 @@ about_config:
 # User configuration settings
 #
 defaults:
+  enabled:                              true
 
   # ----------------------------------------------------------------------------
   # APPENDER configurations

data/lib/starter_web/_data/modules/defaults/log4r.yml

@@ -12,9 +12,9 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
+# Description (used for J1 CC only)
 #
-about_config:
+description:
 
   title:                                Ruby Logger
   scope:                                Default settings

data/lib/starter_web/_data/modules/defaults/navigator.yml

@@ -17,9 +17,10 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
+# Description (used for J1 CC only)
 #
-about_config:
+description:
+
   title:                                Navigator
   scope:                                Default settings
   location:                             _data/modules/defaults/navigator.yml
@@ -28,6 +29,7 @@ about_config:
 # Default settings
 #
 defaults:
+  enabled:                              true
 
   # ------------------------------------------------------------------------------
   # Font icon settings

data/lib/starter_web/_data/modules/defaults/quicksearch.yml

@@ -12,9 +12,10 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
+# Description (used for J1 CC only)
 #
-about_config:
+description:
+
   title:                                J1 QuickSearch
   scope:                                Default settings
   location:                             _data/modules/defaults/quicksearch.yml
@@ -23,8 +24,8 @@ about_config:
 # Default settings
 #
 defaults:
-
   enabled:                              false
+
   placement:                            navbar
   target:                               _blank
   rebuild:                              false

data/lib/starter_web/_data/modules/defaults/rtable.yml

@@ -16,9 +16,10 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
+# Description (used for J1 CC only)
 #
-about_config:
+description:
+
   title:                                rTable Module
   scope:                                Default settings
   location:                             _data/modules/defaults/rtable.yml

data/lib/starter_web/_data/modules/defaults/scoller.yml

@@ -16,9 +16,10 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
+# Description (used for J1 CC only)
 #
-about_config:
+description:
+
   title:                                Scroller API
   scope:                                Default settings
   location:                             _data/modules/defaults/rtable.yml

data/lib/starter_web/_data/modules/defaults/themer.yml

@@ -13,125 +13,9 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# Themer settings
+# Description (used for J1 CC only)
 #
-#   enabled
-#   ----------------------------------------------------------------------------
-#   Enables|Disables the use of J1 Themer
-#
-#     values:                           boolean (true|false)
-#     default:                          false
-#
-#   debug
-#   ----------------------------------------------------------------------------
-#   Enables|Disables the console log
-#
-#     values:                           boolean (true|false)
-#     default:                          false
-#
-#   cssThemeLink
-#   ----------------------------------------------------------------------------
-#   The ID used for the bootstrap theme css file
-#
-#     values:                           string
-#     default:                          bootstrapTheme
-#
-#   saveToCookie
-#   ----------------------------------------------------------------------------
-#   If true, a cookie will be saved with the currently selected theme
-#
-#     values:                           boolean (true|false)
-#     default:                          true
-#
-# cookieThemeName
-#   The name of the cookie to be used to store the theme name
-#
-#   values:                             string
-#   default:                            bootstrapTheme.name
-#
-#   cookieDefaultThemeName
-#   ----------------------------------------------------------------------------
-#   The name of the cookie to be used to store the default theme name
-#
-#     values:                           string
-#     default:                          bootstrapDefaultTheme.name
-#
-#   cookieThemeCss
-#   ----------------------------------------------------------------------------
-#   The name of the cookie to be used to store the css file name
-#   used for the theme
-#
-#     values:                           string
-#     default:                          bootstrapTheme.css
-#
-#   cookieExpiration
-#   ----------------------------------------------------------------------------
-#   The number of days the cookies should expire
-#
-#     values:                           integer
-#     default:                          7
-#
-#   cookiePath
-#   ----------------------------------------------------------------------------
-#   The path the cookie should be stored
-#
-#     values:                           string (path)
-#     default:                          /
-#
-#   defaultCssFile
-#   ----------------------------------------------------------------------------
-#   The default css file the plugin should use if it can not load
-#   the themes from Bootswatch
-#
-#     values:                           string (URI)
-#     default:                          https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css
-#
-#   bootswatchApiUrl
-#   ----------------------------------------------------------------------------
-#   The url for the bootswatch api
-#
-#     values:                           string (URI)
-#     default:                          http://api.bootswatch.com
-#
-#   bootswatchApiVersion
-#   ----------------------------------------------------------------------------
-#   The version of the bootswatch api to use
-#
-#     values:                           integer
-#     default:                          3
-#
-#   localFeed
-#   ----------------------------------------------------------------------------
-#   The path to a JSON file that contains the themes you want to use.
-#   If this parameter is used, the control will be loaded the themes
-#   from here and not go to the bootswatchApiUrl. A sample of the json
-#   file can be found at themes.json
-#
-#     values:                           string
-#     default:                          empty string
-#
-#   excludeBootswatch
-#   ----------------------------------------------------------------------------
-#   Comma separated list of BootSwatch names (e.g. Slate,Yeti) that
-#   should be excluded from the rendered <ul> or <select>
-#
-#     values:                           string
-#     default:                          empty string
-#
-#   hideOnReload
-#   ----------------------------------------------------------------------------
-#   Number of milliseconds (msec) the current page is hidden (display: none)
-#   to prevent "DOM flicker" aka "FOUC" (Flash of unstyled content)  while
-#   the css file is loaded|activated
-#
-#     values:                           integer
-#     default:                          150
-# ------------------------------------------------------------------------------
-
-# ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
-#
-about_config:
+description:
 
   title:                                Themer
   scope:                                Default settings
@@ -142,6 +26,123 @@ about_config:
 #
 defaults:
 
+  # ----------------------------------------------------------------------------
+  # Themer settings
+  #
+  #   enabled
+  #   --------------------------------------------------------------------------
+  #   Enables|Disables the use of J1 Themer
+  #
+  #     values:                         boolean (true|false)
+  #     default:                        false
+  #
+  #   debug
+  #   --------------------------------------------------------------------------
+  #   Enables|Disables the console log
+  #
+  #     values:                         boolean (true|false)
+  #     default:                        false
+  #
+  #   cssThemeLink
+  #   --------------------------------------------------------------------------
+  #   The ID used for the bootstrap theme css file
+  #
+  #     values:                         string
+  #     default:                        bootstrapTheme
+  #
+  #   saveToCookie
+  #   --------------------------------------------------------------------------
+  #   If true, a cookie will be saved with the currently selected theme
+  #
+  #     values:                         boolean (true|false)
+  #     default:                        true
+  #
+  # cookieThemeName
+  #   The name of the cookie to be used to store the theme name
+  #
+  #   values:                           string
+  #   default:                          bootstrapTheme.name
+  #
+  #   cookieDefaultThemeName
+  #   --------------------------------------------------------------------------
+  #   The name of the cookie to be used to store the default theme name
+  #
+  #     values:                         string
+  #     default:                        bootstrapDefaultTheme.name
+  #
+  #   cookieThemeCss
+  #   --------------------------------------------------------------------------
+  #   The name of the cookie to be used to store the css file name
+  #   used for the theme
+  #
+  #     values:                         string
+  #     default:                        bootstrapTheme.css
+  #
+  #   cookieExpiration
+  #   --------------------------------------------------------------------------
+  #   The number of days the cookies should expire
+  #
+  #     values:                         integer
+  #     default:                        7
+  #
+  #   cookiePath
+  #   --------------------------------------------------------------------------
+  #   The path the cookie should be stored
+  #
+  #     values:                         string (path)
+  #     default:                        /
+  #
+  #   defaultCssFile
+  #   --------------------------------------------------------------------------
+  #   The default css file the plugin should use if it can not load
+  #   the themes from Bootswatch
+  #
+  #     values:                         string (URI)
+  #     default:                        https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css
+  #
+  #   bootswatchApiUrl
+  #   --------------------------------------------------------------------------
+  #   The url for the bootswatch api
+  #
+  #     values:                         string (URI)
+  #     default:                        http://api.bootswatch.com
+  #
+  #   bootswatchApiVersion
+  #   --------------------------------------------------------------------------
+  #   The version of the bootswatch api to use
+  #
+  #     values:                         integer
+  #     default:                        3
+  #
+  #   localFeed
+  #   --------------------------------------------------------------------------
+  #   The path to a JSON file that contains the themes you want to use.
+  #   If this parameter is used, the control will be loaded the themes
+  #   from here and not go to the bootswatchApiUrl. A sample of the json
+  #   file can be found at themes.json
+  #
+  #     values:                         string
+  #     default:                        empty string
+  #
+  #   excludeBootswatch
+  #   --------------------------------------------------------------------------
+  #   Comma separated list of BootSwatch names (e.g. Slate,Yeti) that
+  #   should be excluded from the rendered <ul> or <select>
+  #
+  #     values:                         string
+  #     default:                        empty string
+  #
+  #   hideOnReload
+  #   --------------------------------------------------------------------------
+  #   Number of milliseconds (msec) the current page is hidden (display: none)
+  #   to prevent "DOM flicker" aka "FOUC" (Flash of unstyled content)  while
+  #   the css file is loaded|activated
+  #
+  #     values:                         integer
+  #     default:                        150
+  #
+  # ----------------------------------------------------------------------------
+  #
   enabled:                              false
 
   reloadPageOnChange:                   false                                   # reload current page, if theme has been changed

data/lib/starter_web/_data/modules/defaults/toccer.yml

@@ -44,7 +44,6 @@ defaults:
   #     default:                        false
   # ----------------------------------------------------------------------------
   enabled:                              true
-  log:                                  false
 
   # ----------------------------------------------------------------------------
   # MODULE settings
@@ -153,6 +152,7 @@ defaults:
   #       default:                      true
   #
   # ----------------------------------------------------------------------------
+  log:                                  false
   tocSelector:                          .js-toc
   contentSelector:                      .js-toc-content
   headingSelector:                      "h2, h3, h4, h5, h6"

data/lib/starter_web/_data/modules/defaults/translator.yml

@@ -15,6 +15,7 @@
 # About this configuration (used for J1 CC only)
 #
 about_config:
+
   title:                                J1 Translator
   scope:                                Default settings
   location:                             _data/modules/defaults/translator.yml
@@ -23,7 +24,6 @@ about_config:
 # Default translator settings (general)
 #
 defaults:
-
   enabled:                              false
 
   translationEnabled:                   false

data/lib/starter_web/_data/modules/fab.yml

@@ -16,9 +16,10 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
+# Description (used for J1 CC only)
 #
-about_config:
+description:
+
   title:                                Floating Action Button
   scope:                                User settings
   location:                             _data/modules/fab.yml

data/lib/starter_web/_data/modules/framer.yml

@@ -12,9 +12,9 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
+# Description (used for J1 CC only)
 #
-about_config:
+description:
 
   title:                                Framer
   scope:                                User settings
@@ -24,8 +24,7 @@ about_config:
 # SETTINGS
 #
 settings:
-
-  enabled:                            true
+  enabled:                            false
 
   load:                               sync
   log:                                false

data/lib/starter_web/_data/modules/log4r.yml

@@ -12,9 +12,9 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
+# Description (used for J1 CC only)
 #
-about_config:
+description:
 
   title:                                Ruby Logger
   scope:                                User settings