j1-template 2022.0.9 → 2022.0.10

data/assets/themes/j1/modules/advertising/js/google/adInitializer.js

@@ -0,0 +1,117 @@
+---
+regenerate:                             true
+---
+
+{% capture cache %}
+
+{% comment %}
+ # -----------------------------------------------------------------------------
+ # ~/assets/themes/j1/modules/advertising/js/google/adInitializer.js
+ # Liquid template for Google Adsense to initialze all units in a page
+ #
+ # Product/Info:
+ # https://jekyll.one
+ # Copyright (C) 2021 Juergen Adams
+ #
+ # J1 Template is licensed under the MIT License.
+ # For details, see https://jekyll.one
+ # -----------------------------------------------------------------------------
+ # Test data:
+ #  {{ liquid_var | debug }}
+ # -----------------------------------------------------------------------------
+{% endcomment %}
+
+{% comment %} Liquid procedures
+-------------------------------------------------------------------------------- {% endcomment %}
+
+{% comment %} Set global settings
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign environment       = site.environment %}
+{% assign asset_path        = "/assets/themes/j1" %}
+
+{% comment %} Process YML config data
+================================================================================ {% endcomment %}
+
+{% comment %} Set config files
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign template_config       = site.data.j1_config %}
+{% assign blocks                = site.data.blocks %}
+{% assign modules               = site.data.modules %}
+
+{% comment %} Set config data (settings only)
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign cookie_defaults       = modules.defaults.cookies.defaults %}
+{% assign cookie_settings       = modules.cookies.settings %}
+
+{% assign advertising_options   = modules.defaults.advertising.defaults %}
+{% assign advertising_settings  = modules.advertising.settings %}
+
+{% comment %} Set config options (settings only)
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign cookie_options        = cookie_defaults | merge: cookie_settings %}
+{% assign advertising_options   = advertising_options | merge: advertising_settings %}
+
+{% comment %} Variables
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign advertising           = advertising_options.enabled %}
+{% assign advertising_provider  = advertising_options.provider %}
+
+{% assign production = false %}
+{% if environment == 'prod' or environment == 'production' %}
+  {% assign production = true %}
+{% endif %}
+
+/*
+ # -----------------------------------------------------------------------------
+ # ~/assets/themes/j1/modules/advertising/js/google/adInitializer.js
+ # JS helper for Google Adsense to initialze all units in a page
+ #
+ #  Product/Info:
+ #  http://jekyll.one
+ #
+ #  Copyright (C) 2021 Juergen Adams
+ #
+ #  J1 Template is licensed under MIT License.
+ #  See: https://github.com/jekyll-one/J1 Template/blob/master/LICENSE
+ # -----------------------------------------------------------------------------
+*/
+
+$(document).ready(function() {
+  // [INFO   ] [j1.adapter.advertising                  ] [ detected advertising provider: {{advertising_provider}}} ]
+  // [INFO   ] [j1.adapter.advertising                  ] [ advertising detected as: {{advertising}} ]
+  {% if advertising %}
+  var logger        = log4javascript.getLogger('j1.core.advertising.google');
+  var ads_found     = document.getElementsByClassName('adsbygoogle').length;
+  var cookie_names  = j1.getCookieNames();
+  var user_consent  = j1.readCookie(cookie_names.user_consent);
+
+  var dependencies_met_page_ready = setInterval (function (options) {
+    if (j1.getState() === 'finished') {
+      if (user_consent.personalization) {
+        if (ads_found) {
+          logger.info('\n' + 'initialize all ads in page: #' + ads_found);
+          [].forEach.call(document.querySelectorAll('.adsbygoogle'), function() {
+            (adsbygoogle = window.adsbygoogle || []).push({});
+          });
+        } else {
+          logger.warn('\n' + 'no ads found in page');
+        }
+      } else {
+        logger.warn('\n' + 'initializing ads skipped');
+        logger.warn('\n' + 'consent on cookies disabled for personalization');
+      }
+      clearInterval(dependencies_met_page_ready);
+    }
+  }, 25);
+  {% else %}
+  // [WARN   ] [j1.core.advertising                     ] [ no init code placed ]
+  {% endif %}
+});
+
+{% endcapture %}
+{% if production %}
+  {{ cache | minifyJS }}
+{% else %}
+  {{ cache | strip_empty_lines }}
+{% endif %}
+{% assign cache = nil %}

data/assets/themes/j1/modules/deeplAPI/js/deeplAPI.2.js

@@ -100,7 +100,7 @@
             logger.info('\n' + 'translation: in progress');
             clearInterval(dependencies_met_page_ready);
           }
-        });
+        }, 25);
       },
 
       encryptData: function (message = '', key = '') {

data/assets/themes/j1/modules/deeplAPI/js/deeplAPI.js

@@ -99,7 +99,7 @@
           logger.info('\n' + 'translate: started');
           clearInterval(dependencies_met_page_ready);
         }
-      });
+      }, 25);
     },
 
     // decryptData: function (message = '', key = '', iv = '') {

data/assets/themes/j1/modules/scroller/js/scroller.js

@@ -100,7 +100,7 @@
           logger.info('\n' + 'state: finished');
           clearInterval(dependencies_met_page_ready);
         }
-      });
+      }, 25);
     },
 
     // -------------------------------------------------------------------------

data/lib/j1/version.rb

@@ -1,3 +1,3 @@
 module J1
-  VERSION = '2022.0.9'
+  VERSION = '2022.0.10'
 end

data/lib/starter_web/Gemfile

@@ -53,7 +53,7 @@ gem 'jekyll', '~> 4.2'
 
 # Theme Rubies, default: J1 Template (NOT used for the development system)
 #
-gem 'j1-template', '~> 2022.0.9'
+gem 'j1-template', '~> 2022.0.10'
 
 # ------------------------------------------------------------------------------
 # PRODUCTION: Gem needed for the Jekyll and J1 prod environment

data/lib/starter_web/_config.yml

@@ -53,7 +53,7 @@ environment:                            development
 # ------------------------------------------------------------------------------
 #   Sets the build version of J1 Template Gem
 #
-version:                                2022.0.9
+version:                                2022.0.10
 
 # version
 # ------------------------------------------------------------------------------
@@ -600,7 +600,6 @@ defaults:
 
       analytics:                        true
       comments:                         true
-      advertising:                      false
       youtube:                          true
       vimeo:                            true
 
@@ -645,7 +644,6 @@ defaults:
 
       analytics:                        true
       comments:                         true
-      advertising:                      false
       youtube:                          true
       vimeo:                            true
 
@@ -694,7 +692,6 @@ defaults:
 
       analytics:                        true
       comments:                         true
-      advertising:                      false
       youtube:                          true
       vimeo:                            true
 
@@ -733,7 +730,6 @@ defaults:
 
       analytics:                        false
       comments:                         false
-      advertising:                      false
       youtube:                          false
       vimeo:                            false
 

data/lib/starter_web/_data/layouts/default.yml

@@ -139,13 +139,13 @@ lanes:
   # ----------------------------------------------------------------------------
   # CONNECTORS (advertising)
   #
-  - lane:
-      enabled:                          true
-      region:                           head
-      type:                             sync
-      base:                             _includes/themes/j1
-      path:                             modules/connectors
-      file:                             ads
+  # - lane:
+  #     enabled:                          true
+  #     region:                           head
+  #     type:                             sync
+  #     base:                             _includes/themes/j1
+  #     path:                             modules/connectors
+  #     file:                             ads
 
   # ----------------------------------------------------------------------------
   # RESOURCE loader

data/lib/starter_web/_data/layouts/home.yml

@@ -125,6 +125,18 @@ lanes:
       type:                             async
       properties:                       mb-0
 
+  # ----------------------------------------------------------------------------
+  # Top Advertisment
+  #
+  - lane:
+      enabled:                          false
+      region:                           body-header
+      id:                               google_ad_top_home
+      type:                             sync
+      base:                             _includes/themes/j1
+      path:                             modules/ads
+      file:                             google_ad_top_home.html
+
   # ----------------------------------------------------------------------------
   #   PAGE CONTENT (region body-main)
   #
@@ -184,6 +196,18 @@ lanes:
       type:                             async
       properties:                       mt-4 mr-5 mb-4 ml-5
 
+  # ----------------------------------------------------------------------------
+  # Page Advertisment
+  #
+  - lane:
+      enabled:                          false
+      region:                           body-main
+      id:                               google_ad_content_home
+      type:                             sync
+      base:                             _includes/themes/j1
+      path:                             modules/ads
+      file:                             google_ad_content_home.html
+
   # ----------------------------------------------------------------------------
   # INTRO panel
   #

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

@@ -29,19 +29,146 @@ about_config:
 settings:
 
   # ----------------------------------------------------------------------------
-  # AD elements
+  # Settings
   #
-  ads:
+  #   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
+
+  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/cookies.yml

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

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

@@ -0,0 +1,105 @@
+# ------------------------------------------------------------------------------
+# ~/_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:
+#
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+# About this configuration (used for J1 CC only)
+#
+about_config:
+  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/resources.yml

@@ -1369,5 +1369,29 @@ resources:
         js:                             [ modules/translator/js/translator ]
         init_function:                  [ j1.adapter.translator.init ]
 
+  # ----------------------------------------------------------------------------
+  #  Advertising, JS API to provide Ads for J1 Template
+  #
+  - name:                               Advertising
+    resource:
+      id:                               advertising
+      enabled:                          true
+      comment:                          module advertising
+      region:                           head
+      layout:                           [ all ]
+      required:                         ondemand
+      preload:                          false
+      script_load:                      sync
+      dependencies:                     false
+      pass_init_data:                   false
+      data:
+        css:                            []
+        files:                          [
+                                          modules/advertising/js/google/adInitializer.js,
+                                          adapter/js/advertising.js
+                                        ]
+        js:                             []
+        init_function:                  [ j1.adapter.advertising.init ]
+
 # ------------------------------------------------------------------------------
 # END config

data/lib/starter_web/_includes/attributes.asciidoc

@@ -437,7 +437,7 @@ end::tables[]
 // -----------------------------------------------------------------------------
 tag::products[]
 :j1--license:                                     MIT License
-:j1--version:                                     2022.0.9
+:j1--version:                                     2022.0.10
 :j1--site-name:                                   Jekyll One
 end::products[]
 

data/lib/starter_web/_includes/themes/j1/modules/ads/google_ad_content_home.html

@@ -0,0 +1,11 @@
+<!-- insert gad container -->
+<div id="xxx..xx" class="mb-5">
+  <!-- display-ad-horizontal-2 -->
+  <ins class="adsbygoogle"
+       style="display:block"
+       data-ad-client="ca-pub-xxxx..xxx"
+       data-ad-slot="xxxx..xx"
+       data-ad-format="auto"
+       data-full-width-responsive="true">
+  </ins>
+</div>

data/lib/starter_web/_includes/themes/j1/modules/ads/google_ad_top_home.html

@@ -0,0 +1,11 @@
+<!-- insert gad container -->
+<div id="xxx..xx" class="mb-5">
+  <!-- display-ad-horizontal-1 -->
+  <ins class="adsbygoogle"
+       style="display:block"
+       data-ad-client="ca-pub-xxxx..xxx"
+       data-ad-slot="xxx..xx"
+       data-ad-format="auto"
+       data-full-width-responsive="true">
+  </ins>
+</div>

data/lib/starter_web/_plugins/lunr_index.rb

@@ -364,6 +364,6 @@ end
 
 module Jekyll
   module J1LunrSearch
-    VERSION = '2022.0.9'
+    VERSION = '2022.0.10'
   end
 end

data/lib/starter_web/index.html

@@ -23,7 +23,6 @@ personalization:                        false
 exclude_from_search:                    false
 
 analytics:                              true
-advertising:                            false
 comments:                               false
 
 fab_menu_id:                            default

data/lib/starter_web/package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "j1_starter",
-  "version": "2022.0.9",
+  "version": "2022.0.10",
   "description": "J1 Template Starter Web",
   "homepage": "https://your.site",
   "author": {

data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/documentation.adoc

@@ -15,7 +15,6 @@ categories:                             [ Knowledge ]
 tags:                                   [ Asciidoc, Skeleton, Documentation, PDF ]
 
 sitemap:                                false
-advertising:                            false
 comments:                               false
 
 robots:

data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/multi.adoc

@@ -13,7 +13,6 @@ categories:                             [ Knowledge ]
 tags:                                   [ Asciidoc, Skeleton, Document ]
 
 sitemap:                                false
-advertising:                            false
 comments:                               false
 
 robots:

data/lib/starter_web/pages/public/asciidoc_skeletons/simple-document/simple.adoc

@@ -12,7 +12,6 @@ categories:                             [ Knowledge ]
 tags:                                   [ Asciidoc, Skeleton, Document ]
 
 sitemap:                                false
-advertising:                            false
 comments:                               false
 
 robots:

data/lib/starter_web/pages/public/blog/navigator/archive/categoryview.html

@@ -17,7 +17,6 @@ pagination:
   permalink:                            /page:num/
 
 analytics:                              true
-advertising:                            false
 comments:                               false
 
 exclude_from_search:                    true