j1-template 2022.0.7 → 2022.0.11

data/lib/starter_web/_data/modules/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:                                User settings
   location:                             _data/modules/advertising.yml
@@ -29,19 +30,146 @@ about_config:
 settings:
 
   # ----------------------------------------------------------------------------
-  # AD elements
+  # 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
+  #
+  # ----------------------------------------------------------------------------
   #
-  ads:
+  enabled:                              false
+
+  google:
 
     # --------------------------------------------------------------------------
-    # Image attic (used for layouts posts|pages, image-based)
-    #
-    - name:                             Full width top
-      ad:
-        enabled:                        true
-        id:                             ad_full_width_top
-        layout:                         [ page, post ]
-        type:                           ad-bla
+    # Provider settings
+    #
+    #   publisherID
+    #   ------------------------------------------------------------------------
+    #   Your publisher id (ca-pub-xxxx..xxx) connected with your Adsense
+    #   Account the for the domain registered.
+    #
+    #   values:                         string
+    #   default:                        none
+    #
+    #   autoHideOnUnfilled
+    #   ------------------------------------------------------------------------
+    #   For several reasons, the placed ad (unit) containers get unfilled (no
+    #   ad placed inside). Unfilled unit containers results in blank areas
+    #   instead. Using the setting autoHideOnUnfilled, unfilled containers
+    #   can be hidden automatically.
+    #
+    #   values:                         [true|false]
+    #   default:                        true
+    #
+    #   checkTrackingProtection (currently NOT supported)
+    #   ------------------------------------------------------------------------
+    #   Modern browsers in their current versions (e.g. FireFox) provide
+    #   Tracking Protection build-in. If Tracking Protection is enabled
+    #   for a browser, showing ads may blocked automatically. All unit
+    #   containers affected by Tracking Protection are hidden automatically.
+    #
+    #   values:                         [true|false]
+    #   default:                        false
+    #
+    #   showErrorPageOnBlocked (currently NOT supported)
+    #   ------------------------------------------------------------------------
+    #   If Tracking Protection is detected for a browser, no content is
+    #   presented to the visitor and an error page is shown (HTML 447).
+    #
+    #   values:                         [true|false]
+    #   default:                        false
+    #
+    # --------------------------------------------------------------------------
+    #
+    publisherID:                        ca-pub-xxxx..xxx
+    autoHideOnUnfilled:                 false
+    addBorderOnUnfilled:                true
+    checkTrackingProtection:            true
+    showErrorPageOnBlocked:             true
+    addBorderOnUnfilled:                true
+
+    ads:
+
+      # ------------------------------------------------------------------------
+      # Attributes
+      #
+      #   enabled
+      #   ----------------------------------------------------------------------
+      #   Enables or disables an ad unit (container). If an container is
+      #   disabled, this unit get NOT initialized for ads on any page.
+      #
+      #   values:                       [true|false]
+      #   default:                      true
+      #
+      #   placement (currently NOT supported)
+      #   ----------------------------------------------------------------------
+      #   Defines the placements of the unit container specified. For default
+      #   (manual), all ad units are placed on (home/content) pages manually
+      #   by adding the <ins>-code.
+      #
+      #   values:                       [manual|auto|content-top|content-bottom]
+      #   default:                      manual
+      #
+      #   adSlot (currently NOT supported)
+      #   ----------------------------------------------------------------------
+      #   Defines the slot-id of the unit container specified.
+      #
+      #   values:                       string
+      #   default:                      none
+      #
+      #   adTest (currently NOT supported)
+      #   ------------------------------------------------------------------------
+      #   For testing only. If adTest is enabled (true), clicks and impressions
+      #   aren't recorded by the ad service and advertisers aren't charged.
+      #
+      #   values:                       [true|false]
+      #   default:                      false
+      #
+      # --------------------------------------------------------------------------
+
+      # ------------------------------------------------------------------------
+      # Google Ad resposive full-width
+      #
+#     - name:                           display-ad-horizontal-1
+#       ad:
+#         enabled:                      true
+#         placement:                    manual
+#         adSlot:                       xxxx..xxx
+#         adTest:                       false
+
+      # ------------------------------------------------------------------------
+      # Google Ad resposive full-width
+      #
+#     - name:                           display-ad-horizontal-2
+#       ad:
+#         enabled:                      false
+#         placement:                    manual
+#         adSlot:                       xxxx..xxx
+#         adTest:                       false
+
+      # ------------------------------------------------------------------------
+      # Google Ad resposive full-width
+      #
+#     - name:                           in-article-ad-1
+#       ad:
+#         enabled:                      false
+#         placement:                    manual
+#         adSlot:                       xxxx..xxx
+#         adTest:                       false
 
 # ------------------------------------------------------------------------------
 # END config

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:                              false
+
+  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,9 @@ description:
 # User configuration settings
 #
 settings:
-  expires:                              365
+  enabled:                              true
+
+  check_cookies:                        false
 
 # ------------------------------------------------------------------------------
 # END config

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

@@ -0,0 +1,106 @@
+# ------------------------------------------------------------------------------
+# ~/_data/modules/default/advertising.yml
+# Default configuration settings of the Ad 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-org/J1 Template/blob/master/LICENSE
+#
+# ------------------------------------------------------------------------------
+# NOTE:
+#
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+# Description (used for J1 CC only)
+#
+description:
+
+  title:                                Advertising
+  scope:                                Default settings
+  location:                             _data/modules/default/advertising.yml
+
+# ------------------------------------------------------------------------------
+# User 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
+    #
+    #   publisherID
+    #   ------------------------------------------------------------------------
+    #   Your publisher id (ca-pub-xxxx..xxx) connected with your Adsense
+    #   Account the for the domain registered.
+    #
+    #   values:                         string
+    #   default:                        none
+    #
+    #   autoHideOnUnfilled
+    #   ------------------------------------------------------------------------
+    #   For several reasons, the placed ad (unit) containers get unfilled (no
+    #   ad placed inside). Unfilled unit containers results in blank areas
+    #   instead. Using the setting autoHideOnUnfilled, unfilled containers
+    #   can be hidden automatically.
+    #
+    #   values:                         [true|false]
+    #   default:                        true
+    #
+    #   checkTrackingProtection (currently NOT supported)
+    #   ------------------------------------------------------------------------
+    #   Modern browsers in their current versions (e.g. FireFox) provide
+    #   Tracking Protection build-in. If Tracking Protection is enabled
+    #   for a browser, showing ads may blocked automatically. All unit
+    #   containers affected by Tracking Protection are hidden automatically.
+    #
+    #   values:                         [true|false]
+    #   default:                        false
+    #
+    #   showErrorPageOnBlocked (currently NOT supported)
+    #   ------------------------------------------------------------------------
+    #   If Tracking Protection is detected for a browser, no content is
+    #   presented to the visitor and an error page is shown (HTML 447).
+    #
+    #   values:                         [true|false]
+    #   default:                        false
+    #
+    # --------------------------------------------------------------------------
+    #
+    autoHideOnUnfilled:                 true
+    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