j1-template 2020.0.9 → 2020.0.14

data/_includes/themes/j1/modules/connectors/ad/custom-provider.html

@@ -17,17 +17,14 @@
 {% endcomment %}
 
 {% comment %} Liquid procedures
---------------------------------------------------------------- {% endcomment %}
+-------------------------------------------------------------------------------- {% endcomment %}
 
 {% comment %} Variables
---------------------------------------------------------------- {% endcomment %}
-
+-------------------------------------------------------------------------------- {% endcomment %}
 
 
 {% comment %} Main
---------------------------------------------------------------- {% endcomment %}
-
-<!-- Your code for the custom provider goes here -->
-
-
-
+-------------------------------------------------------------------------------- {% endcomment %}
+<script>
+  /* Your code for the custom provider goes here */
+</script>

data/_includes/themes/j1/modules/connectors/ad/google-adsense.html

@@ -17,15 +17,20 @@
 {% endcomment %}
 
 {% comment %} Liquid procedures
---------------------------------------------------------------- {% endcomment %}
+-------------------------------------------------------------------------------- {% endcomment %}
 
 {% comment %} Variables
---------------------------------------------------------------- {% endcomment %}
+-------------------------------------------------------------------------------- {% endcomment %}
 {% assign publisher_id = site.data.template_settings.advertising.google.publisher_id %}
 
 {% comment %} Main
---------------------------------------------------------------- {% endcomment %}
+-------------------------------------------------------------------------------- {% endcomment %}
 
+<script data-ad-client="{{publisher_id}}"
+    async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js">
+</script>
+
+{% comment %} Old Ads code
 <script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
 <script>
   (adsbygoogle = window.adsbygoogle || []).push({
@@ -33,6 +38,4 @@
     enable_page_level_ads: true
   });
 </script>
-
-
-
+-------------------------------------------------------------------------------- {% endcomment %}

data/_includes/themes/j1/modules/connectors/ads

@@ -36,15 +36,12 @@
 
   {% case advertising_provider %}
     {% when "google" %}
-      <!-- [INFO   ] [j1.modules.connectors.ads             ] [ place Google Adsense ] -->
+      <!-- [INFO   ] [j1.modules.connectors.ads             ] [ place provider: Google Adsense ] -->
       {% include themes/{{site.template.name}}/modules/connectors/ad/google-adsense.html %}
     {% when "custom" %}
-      <!-- [INFO   ] [j1.modules.connectors.ads             ] [ place Custom Provider ] -->
-      {% include themes/{{site.template.name}}/modules/connectors/analytic/custom-analytics.html %}
+      <!-- [INFO   ] [j1.modules.connectors.ads             ] [ place provider: Custom Provider ] -->
+      {% include themes/{{site.template.name}}/modules/connectors/ad/custom-provider.html %}
   {% endcase %}
 
 {% endif %}
 <!-- [INFO   ] [j1.modules.connectors.ads             ] [ end processing ] -->
-          
-
-

data/_includes/themes/j1/modules/navigator/generator.html

@@ -38,7 +38,6 @@
 
 {% comment %} Set config files
 -------------------------------------------------------------------------------- {% endcomment %}
-{% assign site_config                 = site %}
 {% assign template_config             = site.data.template_settings %}
 {% assign blocks                      = site.data.blocks %}
 {% assign modules                     = site.data.modules %}

data/_includes/themes/j1/modules/navigator/procedures/topsearch.proc

@@ -27,7 +27,7 @@
 -------------------------------------------------------------------------------- {% endcomment %}
 {% capture select_color     %}themes/{{site.template.name}}/procedures/global/select_color.proc{% endcapture %}
 {% capture select_icon_size %}themes/{{site.template.name}}/procedures/global/select_icon_size.proc{% endcapture %}
- 
+
 
 {% comment %} Liquid var initialization
 -------------------------------------------------------------------------------- {% endcomment %}
@@ -52,6 +52,7 @@
 {% assign result_heading_lead = topsearch_options.result_heading_lead %}
 {% assign search_icon         = topsearch_options.search_icon %}
 {% assign close_icon          = topsearch_options.close_icon %}
+{% assign clear_icon          = topsearch_options.clear_icon %}
 
 {% assign quick_search   = true %}
 {% assign elastic_search = false %}
@@ -80,7 +81,7 @@
 {% assign icon_size = size %}
 
 
-{% comment %} Main 
+{% comment %} Main
 -------------------------------------------------------------------------------- {% endcomment %}
 {% if topsearch_options.enabled %}
 
@@ -88,21 +89,25 @@
   ------------------------------------------------------------------------------ {% endcomment %}
   {% if quick_search %}
     <!-- [INFO   ] [j1.modules.navigator.topsearch.proc   ] [ start processing: top search ] -->
-    <div id="{{topsearch_id}}" class="top-search">
+    <div id="{{topsearch_id}}" class="top-search" style="display: none;">
       <div class="container-fluid">
         <div class="input-group">
           <span class="input-group-addon"><i class="{{icon_family}} {{icon_family}}-{{search_icon}} {{icon_size}}" {{icon_color}}></i></span>
           <input type="text" id="jss-input" class="form-control" placeholder="{{placeholder}}">
+          {% if clear_icon %}
+          <!-- [INFO   ] [j1.modules.navigator.topsearch.proc   ] [ place clear icon ] -->
+          <span class="form-clear form-clear-searcher d-none"><i class="{{icon_family}} {{icon_family}}-{{clear_icon}} {{icon_size}}" {{icon_color}}"></i></span>
+          {% endif %}
           <span class="input-group-addon close-search"><i class="{{icon_family}} {{icon_family}}-{{close_icon}} {{icon_size}}" {{icon_color}}></i></span>
         </div>
       </div>
       <!-- [INFO   ] [j1.modules.navigator.topsearch.proc   ] [ add search panel (hidden) ] -->
-      <div class="row">
+      <div class="row no-gutters ml-3 mr-5">
         <!-- div class="card card-flat panel-search mr-5 mb-3 ml-5" id="jss-panel" style="display: none" -->
-        <div class="panel-search mr-5 mb-3 ml-5" id="jss-panel" style="display: none">
+        <div class="panel-search mb-3" id="jss-panel" style="display: none">
           {% if search_heading_lead %}<div class="panel-heading lead">{{ search_heading_lead }}</div>{% endif %}
           {% if result_heading_lead %}<div class="panel-body"><p>{{ result_heading_lead }}</p></div>{% endif %}
-          <div class="search-list-group mr-5 ml-2">
+          <div class="search-list-group">
             <ul id="jss-results"></ul>
           </div>
         </div>

data/_includes/themes/j1/procedures/global/create_word_cloud.proc

@@ -57,7 +57,10 @@
 {% comment %} Main
 -------------------------------------------------------------------------------- {% endcomment %}
 <div id="word-cloud" class="row ml-3 mr-3">
-  <div class="card tagbox raised-z0 mt-0 mb-2">
+  <!-- jadams, 2020-07-24: style cart creates a unwanted border, removed card styles -->
+  <!-- jadams, 2020-07-24: style cart is NOT longer overloaded since CSS generation has changed -->
+  <!-- div class="card tagbox raised-z0 mt-0 mb-2" -->
+  <div class="tagbox mt-0 mb-2">
 
     <div class="tag-cloud">
     {% unless word_list %}
@@ -66,7 +69,7 @@
     {% else  %}
       <ul class="content">
         {% if source == 'categories' %}
-          {% for tag in word_array %}            
+          {% for tag in word_array %}
             <li>
               <a href="#{{tag|slugify}}">
                 {{ tag | capitalize }}

data/_includes/themes/j1/procedures/layouts/content_writer.proc

@@ -2,7 +2,7 @@
  # -----------------------------------------------------------------------------
  # ~/_includes/themes/j1/procedures/layouts/content_writer.proc
  # Liquid PROCEDURE to load and place the content portion for J1 layouts
- # 
+ #
  # Product/Info:
  # https://jekyll.one
  #
@@ -12,7 +12,7 @@
  # See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
  # -----------------------------------------------------------------------------
  # Test data:
- #    liquid_var:  {{ liquid_var | debug }}
+ #    liquid_var:  {{liquid_var | debug}}
  # -----------------------------------------------------------------------------
 {% endcomment %}
 
@@ -74,11 +74,11 @@
             {% if placement == 'body-main' %}
               <!-- [INFO   ] [j1.layout.content_writer.proc         ] [ load region 'body-main' for layout: {{page.layout}} ] -->
               {% if type == 'async' %}
-                <!-- div id="{{ id }}" class="{{ class }}"></div -->
-                <section id="{{ id }}" class="{{ class }}"></section>
+                <!-- div id="{{id}}" class="{{class}}"></div -->
+                <section id="{{id}}" class="{{class}}"></section>
               {% elsif type == 'sync' %}
                 {% capture path %}{{base}}/{{path}}/{{file}}{% endcapture %}
-                {% include {{ path }} %}
+                {% include {{path}} %}
               {% endif %}
             {% endif %}  {% comment %} END placement {% endcomment %}
 
@@ -89,10 +89,10 @@
             {% if placement == 'body-footer' %}
               <!-- [INFO   ] [j1.layout.content_writer.proc         ] [ load region body-footer for layout: {{page.layout}} ] -->
               {% if type == 'async' %}
-                <div id="{{ id }}" class="{{ class }}"></div>
+                <div id="{{id}}" class="{{class}}"></div>
               {% elsif type == 'sync' %}
                 {% capture path %}{{base}}/{{path}}/{{file}}{% endcapture %}
-                {% include {{ path }} region='body-footer' %}
+                {% include {{path}} region='body-footer' %}
               {% endif %}
             {% endif %} {% comment %} END if placement {% endcomment %}
 
@@ -103,10 +103,9 @@
   {% endfor %}
 {% endfor %}
 
-{% comment %} END Process all lane items 
+{% comment %} END Process all lane items
 -------------------------------------------------------------------------------- {% endcomment %}
 <!-- [INFO   ] [j1.layout.content_writer.proc         ] [ placement for all lane items finished ] -->
 <!-- [DEBUG  ] [j1.layout.content_writer.proc         ] [ reset all lane items ] -->
 <!-- [INFO   ] [j1.layout.content_writer.proc         ] [ end processing ] -->
 {% assign items = nil %}
-

data/_includes/themes/j1/procedures/layouts/module_writer.1.proc

@@ -0,0 +1,270 @@
+{% comment %}
+ # -----------------------------------------------------------------------------
+ # ~/_includes/themes/j1/procedures/layouts/module_writer.proc
+ # Liquid PROCEDURE to write|place the HTML markup for Javascript init
+ # scripts defined for a layout
+ #
+ # Product/Info:
+ # https://jekyll.one
+ #
+ # Copyright (C) 2020 Juergen Adams
+ #
+ # J1 Template is licensed under the MIT License.
+ # See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
+ # -----------------------------------------------------------------------------
+ # Test data:
+ #    liquid_var:  {{ liquid_var | debug }}
+ # -----------------------------------------------------------------------------
+{% endcomment %}
+
+{% comment %} liquid procedures
+-------------------------------------------------------------------------------- {% endcomment %}
+{% include themes/{{site.template.name}}/procedures/global/set_base_vars_folders.proc %}
+
+{% comment %}
+jadams, 2019-08-23: globals set via layouts/default.html (!!!)
+NO need to load this again
+--------------------------------------------------------------------------------
+{% include themes/{{site.template.name}}/procedures/global/set_base_vars_folders.proc %}
+--------------------------------------------------------------------------------
+{% endcomment %}
+
+{% capture collect_module_defaults %}themes/{{site.template.name}}/procedures/layouts/collect_module_defaults.proc{% endcapture %}
+{% capture collect_frontmatter_options %}themes/{{site.template.name}}/procedures/global/collect_frontmatter_options.proc{% endcapture %}
+{% capture collect_page_options %}themes/{{site.template.name}}/procedures/global/collect_page_options.proc{% endcapture %}
+
+{% comment %} process YML config data
+================================================================================ {% endcomment %}
+
+{% comment %} set config data
+-------------------------------------------------------------------------------- {% endcomment %}
+
+{% comment %} variables
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign placement                   = include.region %}
+{% assign resource_globals            = include.global %}
+{% assign resource_settings           = include.resource %}
+
+{% assign dependency_check_cycle      = resource_globals.dependency_check_cycle %}
+{% assign dependency_check_max_count  = resource_globals.dependency_check_timeout %}
+
+{% assign depends                     = '' %}
+
+{% comment %} helpers
+-------------------------------------------------------------------------------- {% endcomment %}
+{% capture adapter_prefix %}j1.adapter.{% endcapture %}
+{% capture state_condition %}.getState() == 'finished'{% endcapture %}
+
+
+{% comment %} main
+-------------------------------------------------------------------------------- {% endcomment %}
+{% if resource_settings.enabled == false %}
+  <!-- [WARN   ] [j1.layout.module_writer.proc          ] [ {{resource_settings.id}} module detected as: {{ resource_settings.enabled }} ] -->
+{% endif %}
+
+
+{% if resource_settings.enabled and placement == 'body-footer' %}
+
+  {% comment %} collect module dependency conditions (if any)
+  ------------------------------------------------------------------------------ {% endcomment %}
+  {% if resource_settings.dependencies %}
+    <!-- [INFO   ] [j1.layout.module_writer.proc          ] [ dependencies detected: {{resource_settings.dependencies | split:','}} ] -->
+
+    {% comment %} create dependency conditions (depends)
+    ---------------------------------------------------------------------------- {% endcomment %}
+    {% for dependency in resource_settings.dependencies %}
+      {% capture depends %}{{depends|append:{{adapter_prefix}}{{dependency}}{{state_condition}}{% endcapture %}
+      {% if forloop.last %}{% else %}{% capture depends %}{{depends|append:' && '}}{% endcapture %}{% endif %}
+    {% endfor %}
+  {% endif %}
+
+  {% comment %} NOTE:
+  Module default values collected by J1 Adapter
+  ------------------------------------------------------------------------------ {% endcomment %}
+
+  {% comment %} collect frontmatter|page options (page)
+  ------------------------------------------------------------------------------ {% endcomment %}
+  {% include {{collect_frontmatter_options}} module=resource_settings.id %}
+  {% assign frontmatter_options = {{frontmatter_options}} %}
+
+  {% include {{collect_page_options}} %}
+  {% assign page_options = {{page_options}} %}
+
+  {% assign layout_valid = false %}
+  {% for layout in resource_settings.layout %}
+    {% assign layout = layout|downcase %}
+    {% if layout == page.layout or layout == "all" %} {% assign layout_valid = true %} {% endif %}
+  {% endfor %}
+
+  {% assign resource_valid = false %}
+  {% if resource_settings.required == 'always' %}
+    {% assign resource_valid = true %}
+  {% else %}
+    {% for resource in page.resources %}
+      {% if resource == resource_settings.id %} {% assign resource_valid = true %}  {% endif %}
+    {% endfor %}
+  {% endif %}
+
+
+  {% if layout_valid and resource_valid and resource_settings.enabled %}
+
+    {% comment %} process all data keys
+    ---------------------------------------------------------------------------- {% endcomment %}
+    {% for data_var in resource_settings.data %}
+
+      {% assign data_key       = data_var[0] %}
+      {% assign data_value     = data_var[1] %}
+
+      {% comment %}
+      --------------------------------------------------------------------------
+      WORKAROUND: and id != "j1_footer". For unclear reasons
+      a UNKNOWN|NOT EXISTING resource  "j1_footer" is detected causing
+      wrong adapter placements
+      -------------------------------------------------------------------------- {% endcomment %}
+
+      {% if data_key == 'init_function' and resource_settings.id != "j1_footer" %}
+
+        <!-- [INFO   ] [j1.layout.module_writer.proc          ] [ place J1 adapter for resource: {{resource_settings.id}} ] -->
+        <script>
+          $(document).ready(function() {
+            var logger = log4javascript.getLogger("j1.module_loader");
+
+            {% if resource_settings.id == 'log4javascript' %}
+              var start = moment();
+              var finished = '';
+              var elapsed = '';
+              var log_text = '[' +start.format("HH:mm:ss.SSS")+ '] [INFO ] [j1.layout.module_writer.proc          ] [ {{resource_settings.comment|strip}} is being initialized ]';
+              console.info(log_text);
+            {% else %}
+              var log_text = '{{resource_settings.comment|strip}} is being initialized';
+              logger.info(log_text);
+            {% endif %}
+
+
+            {% comment %} place initializer|s
+            -------------------------------------------------------------------- {% endcomment %}
+            {% for init_function in data_value %}
+
+              {% comment %} pass module specific frontmatter options
+              ------------------------------------------------------------------ {% endcomment %}
+              {% if frontmatter_options %}
+                // [INFO   ] [j1.layout.module_writer.proc          ] [ pass module specific frontmatter options for: {{resource_settings.id}} ]
+                {% capture frontmatter_options %}{{frontmatter_options}}, {"layout": "{{page.layout}}", "scrollbar": "{{page.scrollbar}}", "toc": "{{page.toc}}", "comments": "{{page.comments}}"}{% endcapture %}
+                var settings = $.extend({}, {{frontmatter_options}});
+
+                {% comment %} create resource_settings.dependencies (if any)
+                ---------------------------------------------------------------- {% endcomment %}
+                {% if resource_settings.dependencies %}
+                  var interval_count = 0;
+                  var dependencies_met_{{resource_settings.id}} = setInterval(function() {
+                  var max_count      = {{dependency_check_max_count}};
+                    interval_count += 1;
+                    if ( {{depends}} ) {
+                      {{init_function}}( settings );
+                      logger.info('dependencies of module {{resource_settings.id}} met for: {{resource_settings.dependencies}}');
+                      logger.debug('dependencies of module {{resource_settings.id}} met after: ' + interval_count * {{dependency_check_cycle}} + ' ms');
+                      clearInterval(dependencies_met_{{resource_settings.id}});
+                      }
+                    if (interval_count > max_count) {
+                      logger.warn('dependency check failed for module: {{resource_settings.id}}');
+                      clearInterval(dependencies_met_{{resource_settings.id}});
+                      logger.warn('run initializer {{resource_settings.id}} unchecked for: {{resource_settings.dependencies}}');
+                      {{init_function}}(settings);
+                    }
+                  }, {{dependency_check_cycle}});
+                {% else %}
+                  {{init_function}}(settings);
+                {% endif %}
+              {% else %}
+                {% comment %} no module specific frontmatter options
+                ---------------------------------------------------------------- {% endcomment %}
+
+                {% comment %} pass default settings
+                ---------------------------------------------------------------- {% endcomment %}
+                {% if resource_settings.pass_init_data %}
+
+                  // [INFO   ] [j1.layout.module_writer.proc          ] [ pass init data for: {{resource_settings.id}} ]
+                  {% capture settings %}{"layout": "{{page.layout}}", "scrollbar": "{{page.scrollbar}}", "toc": "{{page.toc}}", "comments": "{{page.comments}}"}{% endcapture %}
+                  var settings = $.extend({}, {{settings}});
+
+                  {% comment %} create resource_settings.dependencies (if any)
+                  -------------------------------------------------------------- {% endcomment %}
+                  {% if resource_settings.dependencies %}
+                    // Initialize module if resource_settings.dependencies reached state 'finished'
+                    var interval_count = 0;
+                    var max_count      = {{dependency_check_max_count}};
+                    var dependencies_met_{{resource_settings.id}} = setInterval(function() {
+                      interval_count += 1;
+                      if ( {{depends}} ) {
+                        {{init_function}}(settings);
+                        logger.info('dependencies of module {{resource_settings.id}} met for: {{resource_settings.dependencies}}');
+                        logger.debug('dependencies of module {{resource_settings.id}} met after: ' + interval_count * {{dependency_check_cycle}} + ' ms');
+                        clearInterval(dependencies_met_{{resource_settings.id}});
+                        }
+                      if (interval_count > max_count) {
+                        logger.warn('dependency check failed for module: {{resource_settings.id}}');
+                        clearInterval(dependencies_met_{{resource_settings.id}});
+                        logger.warn('run initializer {{resource_settings.id}} unchecked for: {{resource_settings.dependencies}}');
+                        {{init_function}}(settings);
+                      }
+                    }, {{dependency_check_cycle}});
+                  {% else %}
+                    {{init_function}}(settings);
+                  {% endif %}
+                {% else %}
+                  {% comment %} no default settings
+                  -------------------------------------------------------------- {% endcomment %}
+
+                  {% comment %} create resource_settings.dependencies (if any)
+                  -------------------------------------------------------------- {% endcomment %}
+                  {% if resource_settings.dependencies %}
+                    var interval_count = 0;
+                    var max_count      = {{dependency_check_max_count}};
+                    var dependencies_met_{{resource_settings.id}} = setInterval(function() {
+                      interval_count += 1;
+                      if ( {{depends}} ) {
+                        {{init_function}}();
+                        logger.info('dependencies of module {{resource_settings.id}} met for: {{resource_settings.dependencies}}');
+                        logger.debug('dependencies of module {{resource_settings.id}} met after: ' + interval_count * {{dependency_check_cycle}} + ' ms');
+                        clearInterval(dependencies_met_{{resource_settings.id}});
+                        }
+                      if (interval_count > max_count) {
+                        logger.warn('dependency check failed for module: {{resource_settings.id}}');
+                        clearInterval(dependencies_met_{{resource_settings.id}});
+                        logger.warn('run initializer {{resource_settings.id}} unchecked for: {{resource_settings.dependencies}}');
+                        {{init_function}}();
+                      }
+                    }, {{dependency_check_cycle}});
+                  {% else %}
+                    {{init_function}}();
+                  {% endif %}
+                {% endif %}
+              {% endif %}
+            {% endfor %}
+        });
+        </script>
+      {% endif %}
+
+    {% endfor %}
+
+    {% comment %} END Process all data keys
+    ---------------------------------------------------------------------------- {% endcomment %}
+    <!-- [INFO   ] [j1.layout.module_writer.proc          ] [ placement for all data_keys finished ] -->
+    <!-- [DEBUG  ] [j1.layout.module_writer.proc          ] [ reset all data_keys ] -->
+
+    {% comment %} reset all data keys
+    ----------------------------------------------------------------------------
+    {% assign is_placed       = true %}
+    {% assign name            = nil %}
+    {% assign resource_settings.enabled         = nil %}
+    {% assign resource_settings.id              = nil %}
+    {% assign resource_settings.comment         = nil %}
+    {% assign resource_settings.layout         = nil %}
+    {% assign resource_settings.required        = nil %}
+    {% assign resource_settings.pass_init_data  = nil %}
+    {% assign resource_settings.dependencies    = nil %}
+    {% assign depends         = nil %}
+    {% assign resource_settings.data            = nil %}
+    ---------------------------------------------------------------------------- {% endcomment %}
+  {% endif %}
+{% endif %}