RubyGems - j1-template - Versions diffs - 2022.0.9 → 2022.0.13 - Mend

j1-template 2022.0.9 → 2022.0.13

Files changed (218) hide show

data/lib/starter_web/_data/layouts/home.no-ads.yml ADDED Viewed

@@ -0,0 +1,262 @@
+# ------------------------------------------------------------------------------
+# ~/_data/layouts/home.yml
+# Configuration data to specify the (HTML) Layout of all content
+# pages of type HOME placed by the content loader
+#
+# 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:
+#   By J1 template, "Liquid Procedures" are being used intensively. To load
+#   HTML data for a layout, the loader procedure places the data based this
+#   YAML data file into the REGION specified with a LANE.
+# ------------------------------------------------------------------------------
+# ------------------------------------------------------------------------------
+# Layout configuration settings
+#
+#   lanes|lane
+#   ----------------------------------------------------------------------------
+#   Set LANE specific configuration parameters for a page LAYOUT. The
+#   LANES array contains multiple (lane) hashes that describes the type
+#   of the component that is loaded into a lane and their specific
+#   (placement) parameters.
+#
+#   region
+#   ----------------------------------------------------------------------------
+#   J1 templates defines, based on the general structure of a HTML page
+#   (head|body), more specific REGIONS based on HTML5 semantic elements
+#   to place HTML data:
+#
+#   head              <head> section. Contains (site-wide) meta data and
+#                     all CSS and JS files are to be loaded for a page.
+#   body-navigation   <body> NAV section. Contains the main navigation bar.
+#                     Placed a the BEGINNING of the <body> section.
+#   body-header       <body> HEADER section. Contains the page banner (header).
+#                     Placed AFTER the page navigation but BEFORE the main
+#                     content (body-main) of a page.
+#   body-main         <body> MAIN section. J1 template puts a <main> container
+#                     element in the <body> section to place the (main) content.
+#                     All content related elements are loaded into the region
+#                     'body-main'. Content may components like boxes, panels,
+#                     quotes etc. and the document content like sections and
+#                     articles.
+#   body-footer       <body> FOOTER section. J1 template puts a <footer> element
+#                     at the end of the <BODY> section. The body-footer region
+#                     contains all elements that should be loaded at the end
+#                     of a page; typically the page footer.
+#
+#   values:           head|body-navigation|body-header|body-main|body-footer
+#   default:          no defaults
+#
+#   type
+#   ----------------------------------------------------------------------------
+#   The (HTML) content of a lane can be included (from an include file) or
+#   loaded asychronously from a HTML data file by AJAX (get|load) calls.
+#   J1 template is using jQuery as an interface to AJAX calls.
+#
+#   values:           include|load
+#   default:          no defaults
+#
+#   source
+#   ----------------------------------------------------------------------------
+#   The parameter source defines a (site root relativ) path to the data
+#   source to be included or loaded.
+#
+#   values:           string (path)
+#   default:          no defaults
+#
+#   file
+#   ----------------------------------------------------------------------------
+#   Defines the data file to be included or loaded.
+#
+#   values:           string
+#   default:          no defaults
+#
+#   id
+#   ----------------------------------------------------------------------------
+#   Used for AJAX load calls (see parameter type). The id is used twice. First,
+#   id references a HTML fragment as part of the (HTML) data file (see parameter
+#   data below). Second, the id is used to identify the placeholder (div)
+#   element where the AJAX call puts the data on.
+#
+#   values:           string
+#   default:          no defaults
+#
+#   class
+#   ----------------------------------------------------------------------------
+#   Additional CSS classes that are put on the placeholder (div) element.
+#   Can be used for type 'load', only.
+#
+#   values:           string (CSS class name)
+#   default:          no defaults
+#
+# ------------------------------------------------------------------------------
+# ------------------------------------------------------------------------------
+# Layout configuration settings
+#
+lanes:
+  # ----------------------------------------------------------------------------
+  # MASTER header
+  #
+  - lane:
+      enabled:                          true
+      region:                           body-header
+      type:                             sync
+      base:                             _includes/themes/j1
+      path:                             modules/attics
+      file:                             generator.html
+  # ----------------------------------------------------------------------------
+  # MASTER slider
+  #
+  - lane:
+      enabled:                          false
+      id:                               master_slider
+      region:                           body-header
+      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)
+  #
+  #   NOTE:
+  #     The CONTENT of a post or page may already rendered (page contains HTML
+  #     data) or unrendered (page contains MARKUP data). In both cases, rendered
+  #     or unrendered content, a valid FRONTMATTER is needed to pass the data.
+  #
+  #     The CONTENT generation for posts and pages depends on the data type,
+  #     the MARKUP language (Markdown, Asciidoc) the page is using. The data
+  #     type is specified by the file EXTENSION (e.g. ".md" for Markdown or
+  #     ".adoc" for Asciidoc formatted content).
+  #
+  #     To enable Jekyll running the render phase, the respective processor
+  #     (e.g.kramdown for MARKDOWN or asciidoctor for ASCIIDOC) needs to be
+  #     loaded and configured (Gemfile and the side-wide configuration file
+  #     _config.yml).
+  #
+  #   NOTE:
+  #     The CONTENT of a PAGE is passed trough a (Liquid) wrapper procedure
+  #     (page_content.html) to add or inject specific ADDITIONAL data like
+  #     a TOC etc. that influences the resulting page.
+  #
+  #     To modify the wrapper, DO NOT CHANGE the template files. See with
+  #     ***URL*** how to create your own wrapper (and OVERLOAD the J1 template
+  #     system with the data you provided).
+  #
+  # ----------------------------------------------------------------------------
+  # ----------------------------------------------------------------------------
+  # TEASER banner
+  #
+  - lane:
+      enabled:                          true
+      id:                               home_teaser_banner
+      region:                           body-main
+      type:                             async
+      properties:                       g-2 elevated-z0
+  # ----------------------------------------------------------------------------
+  # SERVICE panel
+  #
+  - lane:
+      enabled:                          false
+      id:                               home_service_panel
+      region:                           body-main
+      type:                             async
+      properties:                       g-2 elevated-z0
+  # ----------------------------------------------------------------------------
+  # DIVIDER banner
+  #
+  - lane:
+      enabled:                          false
+      id:                               divider-1
+      region:                           body-main
+      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
+  #
+  - lane:
+      enabled:                          true
+      id:                               home_intro_panel
+      region:                           body-main
+      type:                             async
+      properties:                       g-2 elevated-z2
+  # ----------------------------------------------------------------------------
+  # PARALLAX banner
+  #
+  - lane:
+      enabled:                          true
+      id:                               home_parallax_banner
+      region:                           body-main
+      type:                             async
+      properties:                       elevated-z0
+  # ----------------------------------------------------------------------------
+  # IMAGE banner
+  #
+  - lane:
+      enabled:                          false
+      id:                               home_image_banner
+      region:                           body-main
+      type:                             async
+      properties:                       mb-3
+  # ----------------------------------------------------------------------------
+  # NEWS panel
+  #
+  - lane:
+      enabled:                          true
+      id:                               home_news_panel
+      region:                           body-main
+      type:                             async
+      properties:                       g-2 elevated-z2
+  # ----------------------------------------------------------------------------
+  # FAB
+  #
+  - lane:
+      enabled:                          true
+      id:                               fab-container
+      region:                           body-main
+      type:                             async
+      properties:                       elevated-z0
+# ------------------------------------------------------------------------------
+# END config

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

@@ -125,6 +125,18 @@ lanes:
       type:                             async
       properties:                       mb-0
+  # ----------------------------------------------------------------------------
+  # Top Advertisment
+  #
+  - lane:
+      enabled:                          true
+      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/layouts/page.yml CHANGED Viewed

@@ -123,13 +123,13 @@ lanes:
   # ----------------------------------------------------------------------------
   # Ad Block
   #
-  - lane:
-      enabled:                          false
-      region:                           body-header
-      type:                             sync
-      base:                             _includes/themes/j1
-      path:                             blocks/ads
-      file:                             ad.html
+  # - lane:
+  #     enabled:                          false
+  #     region:                           body-header
+  #     type:                             sync
+  #     base:                             _includes/themes/j1
+  #     path:                             blocks/ads
+  #     file:                             ad.html
   # ----------------------------------------------------------------------------
   # PAGE CONTENT (region body-main)
@@ -170,17 +170,6 @@ lanes:
       path:                             layouts
       file:                             content_generator_page.html
-  # ----------------------------------------------------------------------------
-  # COMMENT connector (e.g. for DISQUS as part of the CONTENT section)
-  #
-  - lane:
-      enabled:                          true
-      region:                           body-main
-      type:                             sync
-      base:                             _includes/themes/j1
-      path:                             modules/connectors
-      file:                             comments
   # ----------------------------------------------------------------------------
   # FAM
   #

data/lib/starter_web/_data/layouts/post.yml CHANGED Viewed

@@ -160,17 +160,6 @@ lanes:
       path:                             layouts
       file:                             content_generator_post.html
-  # ----------------------------------------------------------------------------
-  # COMMENT connector
-  #
-  - lane:
-      enabled:                          true
-      region:                           body-main
-      type:                             sync
-      base:                             _includes/themes/j1
-      path:                             modules/connectors
-      file:                             comments
   # ----------------------------------------------------------------------------
   # FAM
   #

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

@@ -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,145 @@ 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:                        '<your-publisher-id>'
+    autoHideOnUnfilled:                 false
+    addBorderOnUnfilled:                true
+    checkTrackingProtection:            true
+    showErrorPageOnBlocked:             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 ADDED Viewed

@@ -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 CHANGED Viewed

@@ -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
   #