j1-template 2022.0.10 → 2022.0.14

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

@@ -0,0 +1,99 @@
+# ------------------------------------------------------------------------------
+#  ~/_data/modules/analytics.yml
+#  User configuration settings for J1 Analytics module
+#
+#  Product/Info:
+#  https://jekyll.one
+#
+#  Copyright (C) 2021 Juergen Adams
+#
+#  J1 Template is licensed under the MIT License.
+#  See: https://github.com/jekyll-one/J1 Template/blob/master/LICENSE
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+# Description (used for J1 CC only)
+#
+description:
+
+  title:                                J1 Analytics
+  scope:                                User settings
+  location:                             _data/modules/analytics.yml
+
+# ------------------------------------------------------------------------------
+# User configuration settings
+#
+settings:
+
+  # ----------------------------------------------------------------------------
+  # Settings
+  #
+  #   enabled
+  #   --------------------------------------------------------------------------
+  #   Enables or disables the Analytics services. If disabled, the services
+  #   won't be enabled on any page.
+  #
+  #   values:                           [true|false]
+  #   default:                          false
+  #
+  #   provider
+  #   --------------------------------------------------------------------------
+  #   Currently, only Google Analytics (google) is available as an provider
+  #   for Analytics services.
+  #
+  #   values:                           [google]
+  #   default:                          google
+  #
+  # ----------------------------------------------------------------------------
+  #
+  enabled:                              true
+
+  provider:                             google
+  google:
+    # --------------------------------------------------------------------------
+    # Provider settings
+    #
+    #   trackingID
+    #   ------------------------------------------------------------------------
+    #   Your tracking id (G-XXX..XX) connected with your Analytices
+    #   Account the for the domain registered.
+    #
+    #   values:                         string
+    #   default:                        none
+    #
+    #   optInOut
+    #   ------------------------------------------------------------------------
+    #   Google Analytics Opt In. GA will be enabled by default and at a
+    #   later point it can be disabled based on the visitor's privacy
+    #   settings (Analytics) with the cookie consent dialog.
+    #
+    #   values:                         [true|false]
+    #   default:                        true
+    #
+    #   anonymizeIP
+    #   ------------------------------------------------------------------------
+    #   For the use of Google Analytics to comply with the GDPR, the processed
+    #   IP address at GA can be anonymized (set option 'anonymizeIp' to 'true').
+    #   The IP anonymization function at Google GA holds the data "in memeory"
+    #   and sets the last octet for the user's IPv4 addresses and the last
+    #   80 bits for IPv6 addresses to zero.
+    #   That happens at GA shortly after they are sent to Google Analytics.
+    #   This way, the full IP address is NEVER written to disk or stored
+    #   permanenty anyway. Geographically dimensions are later derived from
+    #   the anonymized IP address NOT affected by anonymization.
+    #
+    #   See:
+    #     https://support.google.com/analytics/answer/2763052
+    #     https://developers.google.com/analytics/devguides/collection/analyticsjs/ip-anonymization?hl=en
+    #
+    #   values:                         [true|false]
+    #   default:                        true
+    #
+    # --------------------------------------------------------------------------
+    #
+    trackingID:                         G-299QGW5RJH                            # '<your-tracking-id>'
+    optInOut:                           true
+    anonymizeIP:                        true
+
+# ------------------------------------------------------------------------------
+# END config

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

@@ -22,9 +22,8 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
+# Description (used for J1 CC only)
 #
-about_config:
 
   title:                                Attics
   scope:                                User settings
@@ -34,6 +33,8 @@ about_config:
 # SETTINGS
 #
 settings:
+  enabled:                              true
+
   # ----------------------------------------------------------------------------
   # Global settings for text- and image-based header
   #

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

@@ -0,0 +1,55 @@
+# ------------------------------------------------------------------------------
+#  ~/_data/modules/comments.yml
+#  User configuration settings for J1 Comments Module
+#
+#  Product/Info:
+#  https://jekyll.one
+#
+#  Copyright (C) 2021 Juergen Adams
+#
+#  J1 Template is licensed under the MIT License.
+#  See: https://github.com/jekyll-one/J1 Template/blob/master/LICENSE
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+# Description (used for J1 CC only)
+#
+description:
+
+  title:                                J1 Comments
+  scope:                                User settings
+  location:                             _data/modules/comments.yml
+
+# ------------------------------------------------------------------------------
+# User configuration settings
+#
+settings:
+  # ----------------------------------------------------------------------------
+  # Base settings
+  #
+  #   enabled
+  #   --------------------------------------------------------------------------
+  #   Enables or disable comments services. If disabled, the service
+  #   won't be enabled on any page.
+  #
+  #   values:                           [true|false]
+  #   default:                          false
+  #
+  #   provider
+  #   --------------------------------------------------------------------------
+  #   Specifies the provider to be used for commenting
+  #
+  #   values:                           [disqus|hyvor|commento|just-comments]
+  #   default:                          disqus
+  #
+  # ----------------------------------------------------------------------------
+
+  # ----------------------------------------------------------------------------
+  # Base settings (required)
+  # ----------------------------------------------------------------------------
+  enabled:                              false
+
+  provider:                             hyvor
+
+# ------------------------------------------------------------------------------
+# END config

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

@@ -24,9 +24,10 @@ description:
 # User configuration settings
 #
 settings:
-
   enabled:                            true
+
   show_cookie_icon:                   true
+  expire_cookies_on_required_only:    true
 
 # ------------------------------------------------------------------------------
 # END config

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

@@ -24,7 +24,12 @@ description:
 # User configuration settings
 #
 settings:
-  check_cookies:                        false
+  enabled:                              true
 
+  # ----------------------------------------------------------------------------
+  # Switches
+  # ----------------------------------------------------------------------------
+  checkCookies:                         true
+  
 # ------------------------------------------------------------------------------
 # END config

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

@@ -16,9 +16,10 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
+# Description (used for J1 CC only)
 #
-about_config:
+description:
+
   title:                                Advertising
   scope:                                Default settings
   location:                             _data/modules/default/advertising.yml
@@ -33,11 +34,12 @@ defaults:
   #
   #   enabled
   #   --------------------------------------------------------------------------
-  #   Enables or disables the Ad services. If disabled, no ads services are
-  #   enabled and no unit container get initialized on any page.
+  #   Enables or disables the Ad services. If disabled, ad services is NOT
+  #   initialized and no unit container get initialized on any page even the
+  #   module is loaded.
   #
   #   values:                           [true|false]
-  #   default:                          false
+  #   default:                          true
   #
   #   provider
   #   --------------------------------------------------------------------------
@@ -49,13 +51,12 @@ defaults:
   #
   # ----------------------------------------------------------------------------
   #
-  enabled:                              false
+  enabled:                              true
   provider:                             google
 
   google:
-
     # --------------------------------------------------------------------------
-    # Provider settings
+    # Provider settings (Google)
     #
     #   publisherID
     #   ------------------------------------------------------------------------
@@ -99,7 +100,6 @@ defaults:
     addBorderOnUnfilled:                true
     checkTrackingProtection:            false
     showErrorPageOnBlocked:             false
-    addBorderOnUnfilled:                true
 
 # ------------------------------------------------------------------------------
 # END config

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

@@ -0,0 +1,93 @@
+# ------------------------------------------------------------------------------
+# ~/_data/modules/default/analytics.yml
+# Default configuration settings of the Analytics Module (GAD)
+#
+# Product/Info:
+# https://jekyll.one
+#
+# Copyright (C) 2021 Juergen Adams
+#
+# J1 Template is licensed under the MIT License.
+# See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
+#
+# ------------------------------------------------------------------------------
+# NOTE:
+#
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+# Description (used for J1 CC only)
+#
+description:
+
+  title:                                Analytics
+  scope:                                Default settings
+  location:                             _data/modules/default/analytics.yml
+
+# ------------------------------------------------------------------------------
+# Default settings
+#
+defaults:
+
+  # ----------------------------------------------------------------------------
+  # Settings
+  #
+  #   enabled
+  #   --------------------------------------------------------------------------
+  #   Enables or disables the Ad services. If disabled, no ads services are
+  #   enabled and no unit container get initialized on any page.
+  #
+  #   values:                           [true|false]
+  #   default:                          false
+  #
+  #   provider
+  #   --------------------------------------------------------------------------
+  #   Currently, only Google adsense (google) is available as an provider
+  #   for advertising.
+  #
+  #   values:                           [google]
+  #   default:                          google
+  #
+  # ----------------------------------------------------------------------------
+  #
+  enabled:                              false
+
+  provider:                             google
+  google:
+
+    # --------------------------------------------------------------------------
+    # Provider settings
+    #
+    #   optInOut
+    #   ------------------------------------------------------------------------
+    #   Google Analytics Opt In. GA will be enabled by default and at a
+    #   later point it can be disabled based on the visitor's privacy
+    #   settings (Analytics) with the cookie consent dialog.
+    #
+    #   values:                         [true|false]
+    #   default:                        true
+    #
+    #   anonymizeIP
+    #   ------------------------------------------------------------------------
+    #   For the use of Google Analytics to comply with the GDPR, the processed
+    #   IP address at GA can be anonymized. The IP anonymization function in
+    #   analytics sets the last octet for user's IPv4 addresses and the last
+    #   80 bits for IPv6 addresses to zero. That happens at GA shortly after
+    #   they are sent to Google Analytics.
+    #   This way, the full IP address is never written. Geographically
+    #   Dimensions are later derived from anonymized IP addresses.
+    #
+    #   See:
+    #     https://support.google.com/analytics/answer/2763052
+    #     https://developers.google.com/analytics/devguides/collection/analyticsjs/ip-anonymization?hl=en
+    #
+    #   values:                         [true|false]
+    #   default:                        true
+    #
+    # --------------------------------------------------------------------------
+    #
+    optInOut:                           true
+    anonymizeIP:                        true
+
+# ------------------------------------------------------------------------------
+# END config

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

@@ -21,9 +21,9 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
+# Description (used for J1 CC only)
 #
-about_config:
+description:
 
   title:                                Attics
   scope:                                Default settings
@@ -33,6 +33,7 @@ about_config:
 # Default configuration settings
 #
 defaults:
+  enabled:                              true
 
   # ----------------------------------------------------------------------------
   # Global settings for text- and image-based header

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

@@ -13,63 +13,66 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# Authentication (j1_auth)
+# Description (used for J1 CC only)
 #
-# If a site is started as an app, this transforms the web into an
-# Web Application based on Rack and Sinatra using the Omniauth
-# software stack for authentication to enable User Management
-# and Authentication services for secured private web sites.
-#
-# enabled
-# ------------------------------------------------------------------------------
-#   Enables or disables the Auth Manager services for the web.
-#   If disabled, all pages are accessible without authentication.
-#
-#   values:                           true|false
-#   default:                          false
-#
-# ssl
-# ------------------------------------------------------------------------------
-#   Enforce SSL communication for the app. If you've got SSL
-#   set up, ensure SSL is enforced.
-#
-#   values:                           true|false
-#   default:                          false
-#
-# provider
-# ------------------------------------------------------------------------------
-#   List of enabled OAuth providers to be used for the auth
-#   service for authentication. The first provider in a list
-#   is used for default.
-#
-#   values:                           [disqus|github|facebook|patreon|twitter]
-#   default:                          none
-#
-# whitelist
-# ------------------------------------------------------------------------------
-#   List of pages (and assets) skipped for authentication.
-#   Values can be given as regular expressions.
-#
-#   values:                           string
-#   default:                          none
-#
-# ------------------------------------------------------------------------------
-
-
-# ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
-#
-about_config:
+description:
 
   title:                                Authentication
   scope:                                Default settings
   location:                             _data/modules/defaults/authentication.yml
 
 # ------------------------------------------------------------------------------
-# Default configuration settings
+# Default settings
 #
 defaults:
+  enabled:                              true
 
+  # ----------------------------------------------------------------------------
+  # Authentication (j1_auth)
+  #
+  # If a site is started as an app, this transforms the web into an
+  # Web Application based on Rack and Sinatra using the Omniauth
+  # software stack for authentication to enable User Management
+  # and Authentication services for secured private web sites.
+  #
+  # enabled
+  # ----------------------------------------------------------------------------
+  #   Enables or disables the Auth Manager services for the web.
+  #   If disabled, all pages are accessible without authentication.
+  #
+  #   values:                           true|false
+  #   default:                          false
+  #
+  # ssl
+  # ----------------------------------------------------------------------------
+  #   Enforce SSL communication for the app. If you've got SSL
+  #   set up, ensure SSL is enforced.
+  #
+  #   values:                           true|false
+  #   default:                          false
+  #
+  # provider
+  # ----------------------------------------------------------------------------
+  #   List of enabled OAuth providers to be used for the auth
+  #   service for authentication. The first provider in a list
+  #   is used for default.
+  #
+  #   values:                           [disqus|github|facebook|patreon|twitter]
+  #   default:                          none
+  #
+  # whitelist
+  # ----------------------------------------------------------------------------
+  #   List of pages (and assets) skipped for authentication.
+  #   Values can be given as regular expressions.
+  #
+  #   values:                           string
+  #   default:                          none
+  #
+  # ----------------------------------------------------------------------------
+
+  # ----------------------------------------------------------------------------
+  # Provider settings
+  #
   j1_auth:
     enabled:                            false
     ssl:                                false
@@ -196,7 +199,7 @@ defaults:
       #         blacklist:                []
 
   # ----------------------------------------------------------------------------
-  # Auth CLIENT
+  # Auth CLIENT settings
   #
   auth_client:
     enabled:                            false

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

@@ -0,0 +1,114 @@
+# ------------------------------------------------------------------------------
+#  ~/_data/modules/default/comments.yml
+#  Default configuration settings for the J1 Comments Module
+#
+#  Product/Info:
+#  https://jekyll.one
+#
+#  Copyright (C) 2021 Juergen Adams
+#
+#  J1 Template is licensed under the MIT License.
+#  See: https://github.com/jekyll-one/J1 Template/blob/master/LICENSE
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+# Description (used for J1 CC only)
+#
+description:
+
+  title:                                J1 Comments
+  scope:                                Default settings
+  location:                             _data/modules/default/comments.yml
+
+# ------------------------------------------------------------------------------
+# Default settings
+#
+defaults:
+
+  # ----------------------------------------------------------------------------
+  # Base settings
+  #
+  #   enabled
+  #   --------------------------------------------------------------------------
+  #   Enables or disable comments services. If disabled, the service
+  #   won't be enabled on any page.
+  #
+  #   values:                           [true|false]
+  #   default:                          false
+  #
+  #   comments_headline
+  #   --------------------------------------------------------------------------
+  #   A comment block is prepended by a headline (<h2> HTML element).
+  #   The text for headline is automatically chosen based on the language
+  #   detected for the site.
+  #
+  #   values:                           iso-639 language code
+  #   default:                          en
+  #
+  #   provider
+  #   --------------------------------------------------------------------------
+  #   Specifies the provider to be used for commenting
+  #
+  #   values:                           [disqus|hyvor|commento|just-comments]
+  #   default:                          disqus
+  #
+  # ----------------------------------------------------------------------------
+  #
+  enabled:                              false
+
+  # ----------------------------------------------------------------------------
+  # Base settings
+  # ----------------------------------------------------------------------------
+  provider:                             disqus
+  comments_headline:
+    "en":                               Leave a comment
+    "bg":                               Оставите коментар
+    "de":                               Kommentieren
+    "dk":                               Efterlad en kommentar
+    "nl":                               Laat een reactie achter
+    "fr":                               Laissez un commentaire
+    "gr":                               Αφήστε ένα σχόλιο
+    "hr":                               Ostavite komentar
+    "es":                               Deja un comentario
+    "it":                               Lascia un commento
+    "pt":                               Deixe um comentário
+    "se":                               Lämna en kommentar
+    "si":                               Zanechať komentár
+    "fi":                               Jätä kommentti
+    "no":                               Legg igjen en kommentar
+    "hu":                               Szólj hozzá
+    "cz":                               Zanechat komentář
+    "tr":                               Yorum yap
+    "ee":                               Jäta kommentaar
+    "lv":                               Atstājiet savu komentāru
+    "lt":                               Palikite komentarą
+    "pl":                               Zostaw komentarz
+    "ro":                               Lasa un comentariu
+    "ru":                               Оставить комментарий
+
+  # ----------------------------------------------------------------------------
+  # Provider settings
+  # ----------------------------------------------------------------------------
+  hyvor:
+    site_id:                            '<your-hyvor-site-id>'
+
+  disqus:
+    site_id:                            '<your-site-short-name>'
+
+  # currently NOT supported
+  commento:
+    site_id:                            '<your-commento-site-id>'
+
+  # currently NOT supported
+  just-comments:
+    site_id:                            '<your-just-comments-site-id>'
+
+  # currently NOT supported
+  facebook:
+    site_id:                            '<your-facebook-app-id>'
+    num_posts:                          5
+    width:                              580
+    colorscheme:                        light
+
+# ------------------------------------------------------------------------------
+# END config

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

@@ -12,9 +12,10 @@
 # ------------------------------------------------------------------------------
 
 # ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
+# Description (used for J1 CC only)
 #
-about_config:
+description:
+
   title:                                CookieConsent
   scope:                                Default settings
   location:                             _data/modules/defaults/cookieconsent.yml
@@ -23,7 +24,6 @@ about_config:
 # Default settings
 #
 defaults:
-
   enabled:                              false
 
   reloadPageOnChange:                   true