j1-template 2020.0.2 → 2020.0.7

data/{lib/starter_web/assets → assets}/themes/j1/adapter/js/navigator.js

@@ -26,6 +26,11 @@ regenerate:                             true
  # Example: var str = JSON.stringify(obj, null, 2); // spacing level = 2
  # See: https://stackoverflow.com/questions/4810841/how-can-i-pretty-print-json-using-javascript
  # -----------------------------------------------------------------------------
+ # NOTE:
+ #  jadams, 2020-06-21:
+ #    J1 Navigator needs a general revision on BS4 code and functionalities
+ #    Current, only base function are tested with BS4 (was coded for BS3)
+ # -----------------------------------------------------------------------------
 {% endcomment %}
 
 {% comment %} Liquid procedures
@@ -67,8 +72,6 @@ regenerate:                             true
 {% assign nav_quicklinks_settings       = navigator_settings.nav_quicklinks %}
 {% assign nav_topsearch_defaults        = navigator_defaults.nav_topsearch %}
 {% assign nav_topsearch_settings        = navigator_settings.nav_topsearch %}
-{% assign nav_sidebar_defaults          = navigator_defaults.nav_sidebar %}
-{% assign nav_sidebar_settings          = navigator_settings.nav_sidebar %}
 {% assign nav_authclient_defaults       = authentication_defaults.auth_client %}
 {% assign nav_authclient_settings       = authentication_settings.auth_client %}
 
@@ -79,12 +82,10 @@ regenerate:                             true
 {% assign nav_menu_options              = nav_menu_defaults | merge: nav_menu_settings %}
 {% assign quicklinks_options            = nav_quicklinks_defaults | merge: nav_quicklinks_settings %}
 {% assign topsearch_options             = nav_topsearch_defaults | merge: nav_topsearch_settings %}
-{% assign sidebar_options               = nav_sidebar_defaults | merge: nav_sidebar_settings %}
 {% assign authclient_options            = nav_authclient_defaults | merge: nav_authclient_settings %}
 
 {% assign nav_bar_id                    = navigator_defaults.nav_bar.id %}
 {% assign nav_menu_id                   = navigator_defaults.nav_menu.id %}
-{% assign nav_sidebar_id                = navigator_defaults.nav_sidebar.id %}
 {% assign nav_quicklinks_id             = navigator_defaults.nav_quicklinks.id %}
 {% assign nav_navbar_media_breakpoint   = navigator_defaults.nav_bar.media_breakpoint %}
 {% assign authclient_modals_id          = navigator_defaults.nav_authclient.xhr_container_id %}
@@ -137,14 +138,12 @@ j1.adapter['navigator'] = (function (j1, window) {
 
   var nav_menu_id                 = '{{nav_menu_id}}';
   var nav_quicklinks_id           = '{{nav_quicklinks_id}}';
-  var nav_sidebar_id              = '{{nav_sidebar_id}}';
   var authclient_modals_id        = '{{authclient_modals_id}}';
 
   var colors_data_path            = '{{template_config.colors_data_path}}';
   var font_size_data_path         = '{{template_config.font_size_data_path}}';
   var nav_menu_data_path          = '{{nav_menu_options.data_path}}';
   var nav_quicklinks_data_path    = '{{quicklinks_options.data_path}}';
-  var nav_sidebar_data_path       = '{{sidebar_options.data_path}}';
   var authclient_modals_data_path = '{{authclient_options.xhr_data_path}}';
 
   var cookie_names                = j1.getCookieNames();
@@ -201,13 +200,11 @@ j1.adapter['navigator'] = (function (j1, window) {
       var navMenuConfig                             = {};
       var navQuicklinksConfig                       = {};
       var navTopsearchConfig                        = {};
-      var navSidebarConfig                          = {};
       var navAuthClientConfig                       = {};
       var navBarOptions                             = {};
       var navMenuOptions                            = {};
       var navQuicklinksOptions                      = {};
       var navTopsearchOptions                       = {};
-      var navSidebarOptions                         = {};
       var navAuthClientOptions                      = {};
       var navAuthMAnagerConfig                      = {};
 
@@ -216,7 +213,6 @@ j1.adapter['navigator'] = (function (j1, window) {
       navMenuConfig                                 = $.extend({}, {{nav_menu_options | replace: '=>', ':' }});
       navQuicklinksConfig                           = $.extend({}, {{quicklinks_options | replace: '=>', ':' }});
       navTopsearchConfig                            = $.extend({}, {{topsearch_options | replace: '=>', ':' }});
-      navSidebarConfig                              = $.extend({}, {{sidebar_options | replace: '=>', ':' }});
       navAuthClientConfig                           = $.extend({}, {{authclient_options | replace: '=>', ':' }});
 
       navAuthMAnagerConfig                          = $.extend({}, {{authentication_options | replace: '=>', ':' }});
@@ -229,7 +225,6 @@ j1.adapter['navigator'] = (function (j1, window) {
       navMenuOptions                                = j1.mergeData(navMenuConfig, navDefaults.nav_menu);
       navQuicklinksOptions                          = j1.mergeData(navQuicklinksConfig, navDefaults.nav_quicklinks);
       navTopsearchOptions                           = j1.mergeData(navTopsearchConfig, navDefaults.nav_topsearch);
-      navSidebarOptions                             = j1.mergeData(navSidebarConfig, navDefaults.nav_sidebar);
       navAuthClientConfig                           = j1.mergeData(navAuthClientConfig, navDefaults.nav_authclient);
 
       // save config settings into the navigator object for global access
@@ -239,7 +234,6 @@ j1.adapter['navigator'] = (function (j1, window) {
       j1.adapter.navigator['navMenuOptions']        = navMenuOptions;
       j1.adapter.navigator['navQuicklinksOptions']  = navQuicklinksOptions;
       j1.adapter.navigator['navTopsearchOptions']   = navTopsearchOptions;
-      j1.adapter.navigator['navSidebarOptions']     = navSidebarOptions;
       j1.adapter.navigator['navAuthClientConfig']   = navAuthClientConfig;
       j1.adapter.navigator['navAuthManagerConfig']  = navAuthMAnagerConfig;
 
@@ -250,35 +244,48 @@ j1.adapter['navigator'] = (function (j1, window) {
       logger.info('state: ' + _this.getState());
       logger.info('module is being initialized');
 
+      // -----------------------------------------------------------------------
+      // Load HTML data (AJAX)
+      // -----------------------------------------------------------------------
+      // jadams, 202-06-24: Promise (chain) if $.when seems NOT to work correctly.
+      // It semms a chain using .then will be a better solution to make it sure
+      // that the last Deferred set the state to 'data_loaded'.
+      // Found the final state randomly set to 'null' what prevent the module
+      // to run mmenuInitializer.
+      // Workaround: Set 'data_loaded' to be returned by all Deferred in
+      // the chain.
+      // See: https://stackoverflow.com/questions/5436327/jquery-deferreds-and-promises-then-vs-done
+      //
       // -----------------------------------------------------------------------
       // data loader
       // -----------------------------------------------------------------------
       logger.info('run deferred data load');
       $.when (
-        j1.xhrData (// sidebar
-          'j1.adapter.navigator', {
-          xhr_container_id: navSidebarOptions.xhr_container_id,
-          xhr_data_path:    navSidebarOptions.xhr_data_path },
-          null),
-        j1.xhrData (// quicklinks
+        j1.xhrData ( // quicklinks
           'j1.adapter.navigator', {
           xhr_container_id: navQuicklinksOptions.xhr_container_id,
           xhr_data_path:    navQuicklinksOptions.xhr_data_path },
           null),
-        j1.xhrData (// authclient
+        j1.xhrData ( // authclient
           'j1.adapter.navigator', {
           xhr_container_id: navAuthClientConfig.xhr_container_id,
           xhr_data_path:    navAuthClientConfig.xhr_data_path },
           null),
-        j1.xhrData (// menubar
+        j1.xhrData ( // menubar
           'j1.adapter.navigator', {
           xhr_container_id: navMenuOptions.xhr_container_id,
           xhr_data_path:    navMenuOptions.xhr_data_path },
           'data_loaded'))
-      .done (function (sideBar, quickLinks, authclient, menuBar) {
+      .done (function (quickLinks, authclient, menuBar) {
         // ---------------------------------------------------------------------
         // core initializer
         // ---------------------------------------------------------------------
+
+        // Make sure that Load HTML data (AJAX) is finished
+        // setTimeout (function() {
+        //   _this.setState('data_loaded');
+        // }, 150);
+
         var dependencies_met_navigator_core = setInterval (function () {
           if (_this.getState() === 'data_loaded') {
             _this.setState('processing');
@@ -325,8 +332,7 @@ j1.adapter['navigator'] = (function (j1, window) {
                 logger.info('apply styles');
                 _this.setCSS (
                   navBarOptions, navMenuOptions,
-                  navQuicklinksOptions, navTopsearchOptions,
-                  navSidebarOptions
+                  navQuicklinksOptions, navTopsearchOptions
                 );
 
                 logger.info('init auth client');
@@ -340,27 +346,28 @@ j1.adapter['navigator'] = (function (j1, window) {
           }
         }, 25); // END 'dependencies_met_navigator_core'
 
-        // -----------------------------------------------------------------------
-        // Register event 'reset on resize' (should moved to core events)
-        // -----------------------------------------------------------------------
+        // --------------------------------------------------------------------
+        // Register event 'reset on resize' to call j1.core.navigator on
+        // manageDropdownMenu to manage the (current) NAV menu for
+        // desktop or mobile
+        // ---------------------------------------------------------------------
         $(window).on('resize', function() {
           j1.core.navigator.manageDropdownMenu(navDefaults, navMenuOptions);
 
+          // Hide|Close topSearch on resize event
           $('.top-search').slideUp();
+
+          // Manage sticky NAV bars
           setTimeout (function(){
             j1.core.navigator.navbarSticky();
           }, 500);
 
-          // Toggle Bars
-          $('button.navigator.navbar-toggler').each (function() {
-            $('.mdi', this).removeClass('mdi-close');
-            $('.mdi', this).addClass('mdi-menu');
-            $(this).removeClass('fixed');
-          });
-
-          $('.navbar-collapse').removeClass('in');
-          $('.navbar-collapse').removeClass('on');
-          $('.navbar-collapse').removeClass('bounceIn');
+          // jadams, 2020-06-21: unclear|forgotten what I'm doing here!
+          // Looks like the old BS3 implementation
+          //
+          // $('.navbar-collapse').removeClass('in');
+          // $('.navbar-collapse').removeClass('on');
+          // $('.navbar-collapse').removeClass('bounceIn');
         });
 
         return true;
@@ -369,12 +376,12 @@ j1.adapter['navigator'] = (function (j1, window) {
 
     // -------------------------------------------------------------------------
     // Initialize JS portion for the dialogs (modals) used by J1AuthClient
-    // NOTE: Currently cookie|sidebar updates NOT processed at the NAV module
+    // NOTE: Currently cookie updates NOT processed at the NAV module
     //       All updates on Cookies are managed by Cookie Consent.
     //       To be considered to re-add cookie updates for the auth state
     // -------------------------------------------------------------------------
     initAuthClient: function(auth_config) {
-      var logger      = log4javascript.getLogger('j1.adapter.navigator.initAuthClient');
+      var logger        = log4javascript.getLogger('j1.adapter.navigator.initAuthClient');
       var user_session  = j1.readCookie(cookie_user_session_name);
 
       _this.modalEventHandler(auth_config);
@@ -502,7 +509,7 @@ j1.adapter['navigator'] = (function (j1, window) {
           logger.info(logText);
           logText = 'initiate signout for provider: ' +provider;
           logger.info(logText);
-          
+
           var route = '/authentication?request=signout&provider=' + provider + '&provider_signout=' + signOut.providerSignOut; // + '/logout/';
           logText = 'call middleware on route : ' +route;
           logger.info(logText);
@@ -526,7 +533,7 @@ j1.adapter['navigator'] = (function (j1, window) {
     // setCSS
     // Set dynamic CSS styles
     // -------------------------------------------------------------------------
-    setCSS: function (navBarOptions, navMenuOptions, navQuicklinksOptions, navTopsearchOptions, navSidebarOptions) {
+    setCSS: function (navBarOptions, navMenuOptions, navQuicklinksOptions, navTopsearchOptions) {
       var logger              = log4javascript.getLogger("j1.adapter.navigator.setCSS");
       var gridBreakpoint_lg   = '992px';
       var gridBreakpoint_md   = '768px';
@@ -571,9 +578,6 @@ j1.adapter['navigator'] = (function (j1, window) {
       navTopsearchOptions.input_color                 = j1.setColorData(navTopsearchOptions.input_color);
       navTopsearchOptions.background_color            = j1.setColorData(navTopsearchOptions.background_color);
 
-      {% comment %} Set|Resolve navSidebarOptions
-      -------------------------------------------------------------------------- {% endcomment %}
-      navSidebarOptions.background_color              = j1.setColorData(navSidebarOptions.background_color);
 
       {% comment %} Set dymanic styles
       -------------------------------------------------------------------------- {% endcomment %}
@@ -595,14 +599,14 @@ j1.adapter['navigator'] = (function (j1, window) {
       $('head').append("<style>@media (min-width: " +gridBreakpoint_lg+ ") { nav.navbar.navigator.navbar-scrolled.light { background-color: " +bg_scrolled+ " !important; } }</style>");
 
       // Menubar collapsed (mobile)
-      $('head').append('<style>.navbar-collapse.collapse.show { background-color: ' +bg_scrolled+ ' !important; }</style>');
+//    $('head').append('<style>.navbar-collapse.collapse.show { background-color: ' +bg_scrolled+ ' !important; }</style>');
 
 
       /* Navbar media-queries, LARGE Window|Desktop (>= 1024) */
       /* jadams:  Oversized menu bar fixed by: overflow: hidden */
 //    $('head').append("<style>@media (max-width: " +gridBreakpoint_lg+ ") { nav.navbar.navigator { background-color: " +navBarOptions.background_color_collapsed+ " !important; overflow: hidden; } }</style>");
-      $('head').append("<style>@media (max-width: " +gridBreakpoint_lg+ ") { nav.navbar.navigator { background-color: " +bg_collapsed+ " !important; overflow: hidden; } }</style>");
-      //$('head').append("<style>@media (max-width: 1023px) { row { margin-left: 0 !important; margin-right: 0 !important; } }</style>");
+//    $('head').append("<style>@media (max-width: " +gridBreakpoint_lg+ ") { nav.navbar.navigator { background-color: " +bg_collapsed+ " !important; overflow: hidden; } }</style>");
+//    $('head').append("<style>@media (max-width: 1023px) { row { margin-left: 0 !important; margin-right: 0 !important; } }</style>");
 
       {% comment %} navQuicklinks styles
       -------------------------------------------------------------------------- {% endcomment %}
@@ -670,10 +674,6 @@ j1.adapter['navigator'] = (function (j1, window) {
       $('head').append("<style>.top-search .input-group-addon { color: " +navTopsearchOptions.input_color+ " !important; }</style>");
       $('head').append("<style>.top-search .input.form-control { color: " +navTopsearchOptions.input_color+ " !important; }</style>");
 
-      {% comment %} navSidebar styles
-      -------------------------------------------------------------------------- {% endcomment %}
-      $('head').append("<style>.side { background-color: " +navSidebarOptions.background_color+ " !important; }</style>");
-
       return true;
     }, // END setCSS
 
@@ -779,4 +779,4 @@ j1.adapter['navigator'] = (function (j1, window) {
 
 {% endcapture %}
 {{ cache | strip_empty_lines }}
-{% assign cache = nil %}
+{% assign cache = nil %}

data/assets/themes/j1/adapter/js/ssm.js

@@ -0,0 +1,507 @@
+---
+regenerate:                             true
+---
+
+{% capture cache %}
+
+{% comment %}
+ # -----------------------------------------------------------------------------
+ # ~/assets/themes/j1/adapter/js/ssm.js
+ # Liquid template to adapt SSM Core functions
+ #
+ # Product/Info:
+ # https://jekyll.one
+ #
+ # Copyright (C) 2020 Juergen Adams
+ #
+ # J1 Template is licensed under the MIT License.
+ # For details, see https://jekyll.one
+ # -----------------------------------------------------------------------------
+ # Test data:
+ #  {{ liquid_var | debug }}
+ # -----------------------------------------------------------------------------
+{% endcomment %}
+
+{% comment %} Liquid var initialization
+-------------------------------------------------------------------------------- {% endcomment %}
+
+{% comment %} Set config files
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign site_config     = site %}
+{% assign template_config = site.data.template_settings %}
+{% assign modules         = site.data.modules %}
+
+{% comment %} Set config data
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign toccer_defaults = modules.defaults.toccer.defaults %}
+{% assign toccer_settings = modules.toccer.settings %}
+{% assign ssm_settings    = modules.ssm.settings %}
+{% assign ssm_defaults    = modules.defaults.ssm.defaults %}
+
+{% comment %} Set config options
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign toccer_options  = toccer_defaults | merge: toccer_settings %}
+{% assign ssm_options     = ssm_defaults | merge: ssm_settings %}
+
+/*
+ # -----------------------------------------------------------------------------
+ # ~/assets/themes/j1/adapter/js/ssm.js
+ # JS Adapter for J1 SSM (Sticky Side Menu)
+ #
+ # Product/Info:
+ # {{site.data.template_settings.theme_author_url}}
+ #
+ # Copyright (C) 2020 Juergen Adams
+ #
+ # J1 Template is licensed under the MIT License.
+ # For details, see {{site.data.template_settings.theme_author_url}}
+ # -----------------------------------------------------------------------------
+ # Adapter generated: {{site.time}}
+ # -----------------------------------------------------------------------------
+*/
+'use strict';
+
+j1.adapter['ssm'] = (function (j1, window) {
+
+  // ---------------------------------------------------------------------------
+  // globals
+  // ---------------------------------------------------------------------------
+  var environment         = '{{environment}}';
+  var dclFinished         = false;
+  var moduleOptions       = {};
+  var cookie_names        = j1.getCookieNames();
+  var user_state;
+  var user_session;
+  var user_data;
+  var sect1Nodes;
+  var sect12Nodes;
+  var _this;
+  var logger;
+  var logText;
+
+  // ---------------------------------------------------------------------------
+  // helper functions
+  // ---------------------------------------------------------------------------
+
+
+  // ---------------------------------------------------------------------------
+  // main object
+  // ---------------------------------------------------------------------------
+  return {
+
+    // -------------------------------------------------------------------------
+    // module initializer
+    // -------------------------------------------------------------------------
+    init: function (options) {
+
+      // create seetings object from frontmatterOptions
+      var frontmatterOptions = options != null ? $.extend({}, options) : {};
+
+      // initialize state flag
+      j1.adapter.ssm.state = 'pending';
+
+      // -----------------------------------------------------------------------
+      // defaults
+      // -----------------------------------------------------------------------
+      var settings  = $.extend({
+        module_name: 'j1.adapter.ssm',
+        generated:   '{{site.time}}'
+      }, options);
+
+      // -----------------------------------------------------------------------
+      // globals
+      // -----------------------------------------------------------------------
+      _this         = j1.adapter.ssm;
+      logger        = log4javascript.getLogger('j1.adapter.ssm');
+      sect12Nodes   = $("[class$='sect1'],[class$='sect2'");
+      sect1Nodes    = $("[class$='sect1']");
+
+      // -----------------------------------------------------------------------
+      // options loader
+      // -----------------------------------------------------------------------
+      var ssmMenuOptions = $.extend({}, {{nav_ssm_options | replace: '=>', ':' }});
+      var ssmOptions = $.extend({}, {{ssm_options | replace: 'nil', 'null' | replace: '=>', ':' }});
+      var xhr_data_path;
+      var menu_id;
+
+      // Load (individual) frontmatter options (currently NOT used)
+      //
+      if (options != null) { var frontmatterOptions = $.extend({}, options) }
+
+      if (typeof frontmatterOptions !== 'undefined') {
+        moduleOptions = j1.mergeData(ssmOptions, frontmatterOptions);
+      }
+
+      // save config settings into the mmenu object for global access
+      //
+      j1.adapter.ssm['moduleOptions'] = moduleOptions;
+
+      _this.setState('started');
+      logger.info('state: ' + _this.getState());
+      logger.info('module is being initialized');
+
+      // jadams, 2020-06-24: Set max_count to 100 what cause to wait 2.5s
+      // for J1 Navigator to finish (init)
+      //
+      var interval_count = 0;
+      var max_count      = 100;
+
+      var dependencies_met_navigator = setInterval(function() {
+        interval_count += 1;
+        if ( j1.adapter.navigator.getState() == 'finished' ) {
+          logger.info('dependencies of module navigator met for: mmenu');
+          logger.info('dependencies of module navigator met after: ' + interval_count * 25 + ' ms');
+          j1.core.ssm.init (moduleOptions);
+          _this.ssmLoader(moduleOptions);
+          clearInterval(dependencies_met_navigator);
+        }
+        if (interval_count > max_count) {
+          logger.warn('dependency check failed for module: navigator');
+          logger.warn('dependencies of module navigator met after: ' + interval_count * 25 + ' ms');
+          j1.core.ssm.init (moduleOptions);
+          _this.ssmLoader(moduleOptions);
+          clearInterval(dependencies_met_navigator);
+        }
+      }, 25);
+
+    }, // END init
+
+    // -------------------------------------------------------------------------
+    // SSM Loader
+    // -------------------------------------------------------------------------
+    ssmLoader: function (ssmOptions) {
+      var menu_id;
+      var xhr_data_path;
+
+      _this.setState('loading');
+      logger.info('status: ' + _this.getState());
+      logger.info('load HTML data for ssm');
+
+      {% assign id_list = "" %}
+
+      $.when (
+        {% assign menu_id       = ssm_options.xhr_container_id %}
+        {% assign xhr_data_path = ssm_options.xhr_data_path %}
+        j1.xhrData (
+          'j1.adapter.ssm', {
+          xhr_container_id: "{{menu_id}}",
+          xhr_data_path:    "{{xhr_data_path}}" },
+          'data_loaded')
+      ).done (function (ssm) {
+        // ---------------------------------------------------------------------
+        // Initialize MMenu Navs and Drawers
+        // ---------------------------------------------------------------------
+        var dependencies_met_mmenu_initialized = setInterval (function () {
+          if (ssm) {
+           if (j1.getState() === 'finished') {
+//         if ( j1.adapter.navigator.getState() == 'finished' ) {
+              logger.info('load HTML data (AJAX): finished');
+              _this.setState('processing');
+              logger.info('status: ' + _this.getState());
+              logger.info('initialize ssm menu');
+              if ( ssmOptions.mode === 'icon') {
+                logger.info('icon mode detected');
+              }
+              _this.scrollSpy(ssmOptions);
+              _this.buttonInitializer(ssmOptions);
+              clearInterval(dependencies_met_mmenu_initialized);
+            }
+          } else {
+            logger.error('initialize ssm failed, HTML data NOT loaded');
+          }
+        }, 25); // END dependencies_met_mmenu_loaded
+      }); // END done
+    }, // END dataLoader
+
+    // -------------------------------------------------------------------------
+    // Button Initializer
+    // -------------------------------------------------------------------------
+    buttonInitializer: function (ssmOptions) {
+      var eventHandler;
+
+      {% for item in ssm_options.items %} {% if item.enabled %}
+
+      {% comment %} Identify the menu (item) type
+      -------------------------------------------------------------------------- {% endcomment %}
+      {% if item.sublevel %}
+        {% assign menu_type = 'sublevel_menu' %}
+      {% else %}
+        {% assign menu_type = 'top_level_item' %}
+      {% endif %}
+
+      {% if menu_type ==  'top_level_item' %}
+      {% assign button_id = item.id %}
+
+      // Create an eventhandler instance if id exists: {{button_id}}
+      if ($('#{{button_id}}').length) {
+        eventHandler = "{{item.event_handler}}"
+
+        // check if eventhandler configured is a SINGLE word
+        if (eventHandler.split(" ").length == 1) {
+          logger.info('register pre-configured eventhandler {{item.event_handler}} on id: {{button_id}}');
+          $('#{{button_id}}').each(function(e) {
+            var $this = $(this);
+            $this.on('click', function(e) {
+              j1.adapter.ssm.{{item.event_handler}}(sect1Nodes);
+            });
+          });
+        } else {
+          logger.info('register custom eventhandler on id: {{button_id}}');
+        }
+
+      } // END items (buttons)
+      {% endif %} // menu_type 'top_level_item'
+      {% endif %} // ENDIF button_id enabled
+      {% endfor %} // ENDFOR items
+    }, // END buttonInitializer
+
+    // -------------------------------------------------------------------------
+    // Eventhandler
+
+    // -------------------------------------------------------------------------
+    // open mobile menu
+    // -------------------------------------------------------------------------
+    open_mmenu: function (id) {
+      logger.info('eventhandler fired on id: ' + id );
+    }, // END open_mmenu
+
+    // -------------------------------------------------------------------------
+    // scroll to previous section
+    // -------------------------------------------------------------------------
+    scroll_previous_section: function (nodes) {
+      var previous_header_id;
+      var currentNode;
+      var prev_node;
+      var anchor_id;
+
+      var index             = 0;
+      var maxNode           = $(nodes).length - 1;
+      var $toc              = $("#sidebar");
+      var current_header_id = $toc.find(".is-active-link").attr('href');
+
+      // logger.info('eventhandler fired on id: ' + id );
+
+      nodes.each(function() {
+        currentNode = $(this).find(current_header_id);
+        if (currentNode.length) {
+          if (index > maxNode) {
+            return false
+          } else {
+            prev_node           = (index > 0) ? nodes[index-1] : nodes[index];
+            previous_header_id  = $(prev_node).find(":header").first()[0].id;
+            anchor_id           = '#' + previous_header_id;
+
+            $('a[href*="' + current_header_id + '"]').removeClass('is-active-link');
+            $('a[href*="' + previous_header_id + '"]').addClass('is-active-link');
+
+            j1.core.scrollSmooth.scroll( anchor_id, {
+              duration: {{toccer_options.scrollSmoothDuration}},
+              offset: {{toccer_options.scrollSmoothOffset}},
+              callback: null
+            });
+            return false;
+          }
+        }
+        (index < maxNode) ? index++ : index;
+      });
+    }, // END scroll_previous_section
+
+    // -------------------------------------------------------------------------
+    // scroll to next section
+    // -------------------------------------------------------------------------
+    scroll_next_section: function (nodes) {
+      var next_header_id;
+      var currentNode;
+      var nextNode;
+      var anchor_id;
+
+      var index             = 0;
+      var maxNode           = $(nodes).length -1;
+      var $toc              = $("#sidebar");
+      var current_header_id = $toc.find(".is-active-link").attr('href');
+
+      // logger.info('eventhandler fired on id: ' + id );
+
+      nodes.each(function() {
+        currentNode = $(this).find(current_header_id);
+        if (currentNode.length) {
+          if (index == maxNode) {
+            return false
+          } else {
+            nextNode = nodes[index+1];
+            next_header_id  = $(nextNode).closest().find(":header").first();
+            next_header_id  = $(nextNode).find(":header").first()[0].id;
+            anchor_id       = '#' + next_header_id;
+
+            $('a[href*="' + current_header_id + '"]').removeClass('is-active-link');
+            $('a[href*="' + next_header_id + '"]').addClass('is-active-link');
+
+            j1.core.scrollSmooth.scroll( anchor_id, {
+              duration: {{toccer_options.scrollSmoothDuration}},
+              offset: {{toccer_options.scrollSmoothOffset}},
+              callback: null
+            });
+            return false;
+          }
+        }
+        (index < maxNode) ? index++ : index;
+      });
+    }, // END scroll_next_section
+
+    // -------------------------------------------------------------------------
+    // scroll to top
+    // -------------------------------------------------------------------------
+    scroll_to_top: function () {
+      var dest = 0;
+
+      // logger.info('eventhandler fired on id: ' + id );
+
+      $('html, body').animate({
+        scrollTop: dest
+      }, 500);
+    }, // END scroll_top
+
+    // -------------------------------------------------------------------------
+    // scroll to bottom
+    // -------------------------------------------------------------------------
+    scroll_to_bottom: function () {
+      var $page           = $(document);
+      var $footer         = $('#j1_footer');
+      var f               = $footer.length ? $footer.outerHeight() : 0;
+      var pageHeight      = $page.height() - f - 400;
+      var pageHeightOuter = $page.outerHeight()
+
+      // logger.info('eventhandler fired on id: ' + id );
+
+      $('html, body').animate({
+        scrollTop: pageHeight
+      }, 500);
+    }, // END scroll_bottom
+
+    // -------------------------------------------------------------------------
+    // scroll to comments (Disqus)
+    // -------------------------------------------------------------------------
+    scroll_to_comments: function () {
+      // logger.info('eventhandler fired on id: ' + id );
+    }, // END scroll_comments
+
+    // -------------------------------------------------------------------------
+    // create generic alert
+    // -------------------------------------------------------------------------
+    alert_me: function (id) {
+      // logger.info('eventhandler fired on id: ' + id );
+      alert ("Hello world!");
+    }, // END alert_me
+    // -------------------------------------------------------------------------
+    // messageHandler
+    // Manage messages (paylods) send from other J1 modules
+    // -------------------------------------------------------------------------
+    messageHandler: function (sender, message) {
+      // var json_message = JSON.stringify(message, undefined, 2);              // multiline
+      var json_message = JSON.stringify(message);
+
+      logText = 'received message from ' + sender + ': ' + json_message;
+      logger.debug(logText);
+
+      // -----------------------------------------------------------------------
+      //  Process commands|actions
+      // -----------------------------------------------------------------------
+      if (message.type === 'command' && message.action === 'module_initialized') {
+        //
+        // Place handling of command|action here
+        //
+        logger.info(message.text);
+      }
+      if (message.type === 'command' && message.action === 'status') {
+        logger.info('messageHandler: received - ' + message.action);
+      }
+
+      //
+      // Place handling of other command|action here
+      //
+
+      return true;
+    }, // END messageHandler
+
+    // -------------------------------------------------------------------------
+    // setState
+    // Set the current (processing) state of the module
+    // -------------------------------------------------------------------------
+    setState: function (stat) {
+      j1.adapter.ssm.state = stat;
+    }, // END setState
+
+    // -------------------------------------------------------------------------
+    // getState
+    // Returns the current (processing) state of the module
+    // -------------------------------------------------------------------------
+    getState: function () {
+      return j1.adapter.ssm.state;
+    }, // END state
+
+    // -------------------------------------------------------------------------
+    // Manage (top) position and sizes (@media breakpoints) of the
+    // SSM container depending on the size of the page header (attic)
+    // -------------------------------------------------------------------------
+    scrollSpy: function (options) {
+      logger = log4javascript.getLogger('j1.adapter.ssm.scrollSpy');
+
+      $(window).scroll(function(event){
+        var $navbar         = $('nav.navbar');
+        var $pagehead       = $('.attic');
+        var $main_content   = $('.js-toc-content');
+        var $adblock        = $('#adblock');
+        var $footer         = $('#j1_footer');
+        var $ssmContainer   = $('#ssm-container');
+        var $page           = $(document);
+
+        var offset          = 0;
+        var pageOffset      = -120;
+        var scrollPos       = $(document).scrollTop();
+        var pageHeight      = $page.height()
+        var pageHeightOuter = $page.outerHeight()
+
+//      var m               = parseInt(pagehead.css('margin-bottom'), 10);
+        var m               = $main_content.offset().top;
+        var s               = $ssmContainer.length ? $ssmContainer.height() : 0;
+        var f               = $footer.length   ? $footer.outerHeight() : 0;
+        var n               = $navbar.length   ? $navbar.height() : 0;
+//      var h               = $pagehead.length ? $pagehead.outerHeight() : 0;
+        var a               = $adblock.length  ? $adblock.outerHeight() : 0;
+
+//      var o               = n + h + a + offset;
+//      var o               = n + m + offset;
+        var o               = n + offset;
+
+        // space above the (fixed) ssm container
+        var showSsmPos      = m + pageOffset;
+
+        // space below the (fixed) ssm container
+        var hideSsmPos      = pageHeight - s - f + pageOffset;
+
+        // set the top position of ssm container for navbar modes
+        // e.g. "sticky" (navbar-fixed)
+        if($navbar.hasClass('navbar-fixed')){
+          $('#ssm-container').css('top', o);
+        } else {
+          $('#ssm-container').css('top', m);
+        }
+
+        // show|hide ssm container on scroll position in page
+        //
+        ( scrollPos >= showSsmPos ) && ( scrollPos <= hideSsmPos )
+          ? $ssmContainer.css('display','block')
+          : $ssmContainer.css('display','none');
+
+        logger.debug('content pos detected as: ' + m + 'px');
+        logger.debug('scroll pos detected as: ' + scrollPos + 'px');
+      }); // END setTop on scroll
+
+    } // END scrollSpy
+
+  }; // END return
+})(j1, window);
+
+{% endcapture %}
+{{ cache | strip_empty_lines }}
+{% assign cache = nil %}