j1-template 2023.6.0 → 2023.7.0

data/assets/themes/j1/core/js/template.js

@@ -2542,6 +2542,16 @@ module.exports = function navigator(options) {
           });
         } // END Translator
 
+        // ---------------------------------------------------------------------
+        // Speak2Me dialog
+        //
+        if ($('li.speak')) {
+          logger.debug('register SHOW event for J1 Speak2Me');
+          $('li.speak > a', this).on('click', function (e) {
+            j1.adapter.speak2me.showDialog();
+          });
+        } // END NBI Notebooks
+
         // ---------------------------------------------------------------------
         // NBI Notebooks dialog
         //
@@ -2957,6 +2967,1653 @@ module.exports = function scrollSmooth(options) {
 
 /***/ }),
 
+/***/ 633:
+/***/ ((module) => {
+
+// -----------------------------------------------------------------------------
+// ESLint shimming
+// -----------------------------------------------------------------------------
+/* eslint indent: "off"                                                       */
+/* eslint no-undef: "off"                                                     */
+/* eslint no-unused-vars: "off"                                               */
+// -----------------------------------------------------------------------------
+
+module.exports = {
+  // Where to render the table of contents.
+  tocSelector: '.js-toc',
+  // Where to grab the headings to build the table of contents.
+  contentSelector: '.js-toc-content',
+  // Which headings to grab inside of the contentSelector element.
+  headingSelector: 'h2, h3, h4, h5, h6',
+  // Headings that match the ignoreSelector will be skipped.
+  ignoreSelector: '.notoc',
+  // For headings inside relative or absolute positioned containers within content
+  hasInnerContainers: false,
+  // Main class to add to links.
+  linkClass: 'toc-link',
+  // Extra classes to add to links.
+  extraLinkClasses: '',
+  // Class to add to active links,
+  // the link corresponding to the top most heading on the page.
+  activeLinkClass: 'is-active-link',
+  // Main class to add to lists.
+  listClass: 'toc-list',
+  // Extra classes to add to lists.
+  extraListClasses: '',
+  // Class that gets added when a list should be collapsed.
+  isCollapsedClass: 'is-collapsed',
+  // Class that gets added when a list should be able
+  // to be collapsed but isn't necessarily collapsed.
+  collapsibleClass: 'is-collapsible',
+  // Class to add to list items.
+  listItemClass: 'toc-list-item',
+  // Class to add to active list items.
+  activeListItemClass: 'is-active-li',
+  // How many heading levels should not be collapsed.
+  // For example, number 6 will show everything since
+  // there are only 6 heading levels and number 0 will collapse them all.
+  // The sections that are hidden will open
+  // and close as you scroll to headings within them.
+  collapseDepth: 3,
+  // Smooth scrolling enabled.
+  scrollSmooth: true,
+  // Smooth scroll duration.
+  scrollSmoothDuration: 300,
+  // Smooth scroll offset.
+  scrollSmoothOffset: 0,
+  // Callback for scroll end.
+  scrollEndCallback: function (e) {},
+  // Headings offset between the headings and the top of the document (this is meant for minor adjustments).
+  headingsOffset: 1,
+  // Timeout between events firing to make sure it's
+  // not too rapid (for performance reasons).
+  throttleTimeout: 150,
+  // Element to add the positionFixedClass to.
+  positionFixedSelector: null,
+  // Fixed position class to add to make sidebar fixed after scrolling
+  // down past the fixedSidebarOffset.
+  positionFixedClass: 'is-position-fixed',
+  // fixedSidebarOffset can be any number but by default is set
+  // to auto which sets the fixedSidebarOffset to the sidebar
+  // element's offsetTop from the top of the document on init.
+  fixedSidebarOffset: 'auto',
+  // includeHtml can be set to true to include the HTML markup from the
+  // heading node instead of just including the textContent.
+  includeHtml: false,
+  // onclick function to apply to all links in toc. will be called with
+  // the event as the first parameter, and this can be used to stop,
+  // propagation, prevent default or perform action
+  onClick: function (e) {},
+  // orderedList can be set to false to generate unordered lists (ul)
+  // instead of ordered lists (ol)
+  orderedList: true,
+  // If there is a fixed article scroll container, set to calculate titles' offset
+  scrollContainer: null,
+  // prevent ToC DOM rendering if it's already rendered by an external system
+  skipRendering: false,
+  // Optional callback to change heading labels.
+  // For example it can be used to cut down and put ellipses on multiline headings you deem too long.
+  // Called each time a heading is parsed. Expects a string in return, the modified label to display.
+  // function (string) => string
+  headingLabelCallback: false,
+  // ignore headings that are hidden in DOM
+  ignoreHiddenElements: false,
+  // Optional callback to modify properties of parsed headings.
+  // The heading element is passed in node parameter and information parsed by default parser is provided in obj parameter.
+  // Function has to return the same or modified obj.
+  // The heading will be excluded from TOC if nothing is returned.
+  // function (object, HTMLElement) => object | void
+  headingObjectCallback: null,
+  // Set the base path, useful if you use a `base` tag in `head`.
+  basePath: '',
+  // Only takes affect when `tocSelector` is scrolling,
+  // keep the toc scroll position in sync with the content.
+  disableTocScrollSync: false
+};
+
+/***/ }),
+
+/***/ 291:
+/***/ ((module) => {
+
+/**
+ * This file is responsible for parsing the content from the DOM and making
+ * sure data is nested properly.
+ *
+ * @author Tim Scanlin
+ */
+
+// -----------------------------------------------------------------------------
+// ESLint shimming
+// -----------------------------------------------------------------------------
+/* eslint indent: "off"                                                       */
+/* eslint no-undef: "off"                                                     */
+/* eslint semi: "off"                                                         */
+// -----------------------------------------------------------------------------
+
+module.exports = function parseContent(options) {
+  var reduce = [].reduce;
+
+  /**
+   * Get the last item in an array and return a reference to it.
+   * @param {Array} array
+   * @return {Object}
+   */
+  function getLastItem(array) {
+    return array[array.length - 1];
+  }
+
+  /**
+   * Get heading level for a heading dom node.
+   * @param {HTMLElement} heading
+   * @return {Number}
+   */
+  function getHeadingLevel(heading) {
+    return +heading.nodeName.split('H').join('');
+  }
+
+  /**
+   * Get important properties from a heading element and store in a plain object.
+   * @param {HTMLElement} heading
+   * @return {Object}
+   */
+  function getHeadingObject(heading) {
+    // each node is processed twice by this method because nestHeadingsArray() and addNode() calls it
+    // first time heading is real DOM node element, second time it is obj
+    // that is causing problem so I am processing only original DOM node
+    if (!(heading instanceof window.HTMLElement)) return heading;
+    if (options.ignoreHiddenElements && (!heading.offsetHeight || !heading.offsetParent)) {
+      return null;
+    }
+    var obj = {
+      id: heading.id,
+      children: [],
+      nodeName: heading.nodeName,
+      headingLevel: getHeadingLevel(heading),
+      textContent: options.headingLabelCallback ? String(options.headingLabelCallback(heading.textContent)) : heading.textContent.trim()
+    };
+    if (options.includeHtml) {
+      obj.childNodes = heading.childNodes;
+    }
+    if (options.headingObjectCallback) {
+      return options.headingObjectCallback(obj, heading);
+    }
+    return obj;
+  }
+
+  /**
+   * Add a node to the nested array.
+   * @param {Object} node
+   * @param {Array} nest
+   * @return {Array}
+   */
+  function addNode(node, nest) {
+    var obj = getHeadingObject(node);
+    var level = obj.headingLevel;
+    var array = nest;
+    var lastItem = getLastItem(array);
+    var lastItemLevel = lastItem ? lastItem.headingLevel : 0;
+    var counter = level - lastItemLevel;
+    while (counter > 0) {
+      lastItem = getLastItem(array);
+      if (lastItem && lastItem.children !== undefined) {
+        array = lastItem.children;
+      }
+      counter--;
+    }
+    if (level >= options.collapseDepth) {
+      obj.isCollapsed = true;
+    }
+    array.push(obj);
+    return array;
+  }
+
+  /**
+   * Select headings in content area, exclude any selector in options.ignoreSelector
+   * @param {String} contentSelector
+   * @param {Array} headingSelector
+   * @return {Array}
+   */
+  function selectHeadings(contentSelector, headingSelector) {
+    var selectors = headingSelector;
+    if (options.ignoreSelector) {
+      selectors = headingSelector.split(',').map(function mapSelectors(selector) {
+        return selector.trim() + ':not(' + options.ignoreSelector + ')';
+      });
+    }
+    try {
+      return document.querySelector(contentSelector).querySelectorAll(selectors);
+    } catch (e) {
+      console.warn('Element not found: ' + contentSelector); // eslint-disable-line
+      return null;
+    }
+  }
+
+  /**
+   * Nest headings array into nested arrays with 'children' property.
+   * @param {Array} headingsArray
+   * @return {Object}
+   */
+  function nestHeadingsArray(headingsArray) {
+    return reduce.call(headingsArray, function reducer(prev, curr) {
+      var currentHeading = getHeadingObject(curr);
+      if (currentHeading) {
+        addNode(currentHeading, prev.nest);
+      }
+      return prev;
+    }, {
+      nest: []
+    });
+  }
+  return {
+    nestHeadingsArray: nestHeadingsArray,
+    selectHeadings: selectHeadings
+  };
+};
+
+/***/ }),
+
+/***/ 229:
+/***/ ((__unused_webpack_module, __unused_webpack_exports, __webpack_require__) => {
+
+/*
+ # -----------------------------------------------------------------------------
+ # ~/assets/themes/j1/modules/speak2me/js/speak2me.js
+ # speak2me v.1.0 implementation (based on Articulate.js) for J1 Theme
+ #
+ # Product/Info:
+ # https://jekyll.one
+ # https://github.com/acoti/articulate.js/tree/master
+ #
+ # Copyright (C) 2023 Juergen Adams
+ # Copyright (C) 2017 Adam Coti
+ #
+ # J1 Theme is licensed under the MIT License.
+ # See: https://github.com/jekyll-one-org/j1-template/blob/main/LICENSE.md
+ # Articulate is licensed under the MIT License.
+ # See: https://github.com/acoti/articulate.js/blob/master/LICENSE
+ # -----------------------------------------------------------------------------
+*/
+
+/* Articulate.js (1.1.0). (C) 2017 Adam Coti.
+  MIT @license: en.wikipedia.org/wiki/MIT_License
+  See Github page at: https://github.com/acoti/articulate.js
+  See Web site at: http://articulate.purefreedom.com
+*/
+
+(function ($) {
+  'use strict';
+
+  const defaultOptions = __webpack_require__(633);
+  const ParseContent = __webpack_require__(291);
+  const parseContent = ParseContent(defaultOptions);
+  const scrollBehavior = 'smooth';
+  const speechCycle = 10;
+  const speechMonitorCycle = 10;
+  const textSliceLength = 30;
+  const minWords = 3;
+  const pageScanCycle = 1000;
+  const pageScanLines = 10000;
+  const isFirefox = /Firefox/i.test(navigator.userAgent);
+  const isEdge = /Edg/i.test(navigator.userAgent);
+  const chrome = /chrome/i.test(navigator.userAgent);
+  const isChrome = chrome && !isEdge;
+  const voiceUserDefault = 'Google UK English Female';
+  const voiceChromeDefault = 'Google US English';
+  const ignoreProvider = 'Microsoft';
+  const defaultLanguage = 'en-GB';
+  var currentTranslation = getCookie('googtrans');
+  var scrollBlockOffset = 100;
+  var customOptions = {};
+  var myOptions = {};
+  var ignoreTagsUser = new Array();
+  var recognizeTagsUser = new Array();
+  var replacements = new Array();
+  var customTags = new Array();
+  var voices = new Array();
+  var headingsArray = [];
+  var rateDefault = 0.9;
+  var pitchDefault = 1;
+  var volumeDefault = 0.9;
+  var rate = rateDefault;
+  var pitch = pitchDefault;
+  var volume = volumeDefault;
+  var pause_spoken = '. ';
+  var chunkCounter = 0;
+  var userStoppedSpeaking = false;
+  var chunkSpoken = false;
+  var scrollOnce = true;
+  var rateUserDefault;
+  var pitchUserDefault;
+  var volumeUserDefault;
+  var currentLanguage;
+  var voiceLanguageDefault;
+  var chunkCounterMax;
+  var user_session;
+  var scanFinished;
+  var voiceLanguageGoogleDefault = {
+    'de-DE': 'Google Deutsch',
+    'en-US': 'Google US English',
+    'en-GB': 'Google UK English Female',
+    'es-ES': 'Google español',
+    'fr-FR': 'Google français',
+    //  'hi-IN':  'Google हिन्दी',
+    //  'id-ID':  'Google Bahasa Indonesia',
+    'it-IT': 'Google italiano',
+    //  'jp-JP':  'Google 日本語',
+    //  'ko-KR':  'Google 한국의',
+    'nl-NL': 'Google Nederlands',
+    'pl-PL': 'Google polski',
+    //  'pt-BR':  'Google português do Brasil',
+    'pt-PT': 'Google português do Brasil'
+    //  'ru-RU':  'Google русский',
+    //  'zh-CN':  'Google 普通话（中国大陆)',
+  };
+
+  var voiceLanguageMicrosoftDefault = {
+    'sq-AL': 'Microsoft Anila Online (Natural) - Albanian (Albania)',
+    'ar-EG': 'Microsoft Salma Online (Natural) - Arabic (Egypt)',
+    'bg-BG': 'Microsoft Kalina Online (Natural) - Bulgarian (Bulgaria)',
+    'zh-CN': 'Microsoft Xiaoxiao Online (Natural) - Chinese (Mainland)',
+    'hr-HR': 'Microsoft Gabrijela Online (Natural) - Croatian (Croatia)',
+    'cs-CZ': 'Microsoft Antonin Online (Natural) - Czech (Czech)',
+    'da-DK': 'Microsoft Christel Online (Natural) - Danish (Denmark)',
+    'nl-NL': 'Microsoft Colette Online (Natural) - Dutch (Netherlands)',
+    'en-GB': 'Microsoft Libby Online (Natural) - English (United Kingdom)',
+    'en-US': 'Microsoft Aria Online (Natural) - English (United States)',
+    'et-EE': 'Microsoft Anu Online (Natural) - Estonian (Estonia)',
+    'fi-FI': 'Microsoft Noora Online (Natural) - Finnish (Finland)',
+    'fr-FR': 'Microsoft Denise Online (Natural) - French (France)',
+    'ka-GE': 'Microsoft Giorgi Online (Natural) - Georgian (Georgia)',
+    'de-DE': 'Microsoft Katja Online (Natural) - German (Germany)',
+    'el-GR': 'Microsoft Athina Online (Natural) - Greek (Greece)',
+    'he-IL': 'Microsoft Avri Online (Natural) - Hebrew (Israel)',
+    'hi-IN': 'Microsoft Madhur Online (Natural) - Hindi (India)',
+    'hu-HU': 'Microsoft Noemi Online (Natural) - Hungarian (Hungary)',
+    'it-IT': 'Microsoft Elsa Online (Natural) - Italian (Italy)',
+    'ja-JP': 'Microsoft Nanami Online (Natural) - Japanese (Japan)'
+  };
+  var voiceLanguageFirefoxDefault = {
+    'en-GB': 'Microsoft Hazel - English (United Kingdom) (en-GB)',
+    'en-US': 'Microsoft Zira Desktop - English (United States) (en-US)',
+    'de-DE': 'Microsoft Katja Online (Natural) - German (Germany)'
+  };
+
+  // -------------------------------------------------------------------------
+  // Internal functions
+  // -------------------------------------------------------------------------
+
+  // scan a page to get correct positions for scrolling and highlightning
+  //
+  function scanPage(options) {
+    // see: https://stackoverflow.com/questions/3163615/how-to-scroll-an-html-page-to-a-given-anchor
+    // see: https://stackoverflow.com/questions/22154129/how-to-make-setinterval-behave-more-in-sync-or-how-to-use-settimeout-instea
+    var line = 0;
+    var lines;
+    function scanSection(counter) {
+      // because of the current translation in progress, the length
+      // of a page may change to higher or lower values (asian)
+      //
+      lines = Math.max(document.body.scrollHeight, document.body.offsetHeight, document.documentElement.clientHeight, document.documentElement.scrollHeight, document.documentElement.offsetHeight);
+      $('#content').attr("style", "opacity: .3");
+      if (line < lines) {
+        setTimeout(function () {
+          counter++;
+          line = line + pageScanLines;
+          window.scrollTo({
+            top: line,
+            behavior: 'smooth'
+          });
+          scanSection(counter);
+        }, pageScanCycle);
+      } else {
+        setTimeout(function () {
+          scanFinished = true;
+          $('#content').attr("style", "opacity: 1");
+          $(window).scrollTop(0);
+        }, pageScanCycle);
+      }
+    }
+    scanSection(0);
+  } // END scanPage
+
+  // merge (configuration) objects
+  //
+  function extend() {
+    var target = {};
+    for (var i = 0; i < arguments.length; i++) {
+      var source = arguments[i];
+      for (var key in source) {
+        if (hasOwnProperty.call(source, key)) {
+          target[key] = source[key];
+        }
+      }
+    }
+    return target;
+  } // END  extend
+
+  // get the conten of a Cookie (by its name)
+  //
+  function getCookie(name) {
+    var nameEQ = name + '=';
+    var ca = document.cookie.split(';');
+    for (var i = 0; i < ca.length; i++) {
+      var c = ca[i];
+      while (c.charAt(0) === ' ') {
+        c = c.substring(1, c.length);
+      }
+      if (c.indexOf(nameEQ) === 0) {
+        var value = c.substring(nameEQ.length, c.length);
+        return value;
+      }
+    }
+    return undefined;
+  } // END getCookie
+
+  function voiceTag(prepend, append) {
+    this.prepend = prepend;
+    this.append = append;
+  } // END  voiceTag
+
+  function voiceObj(name, language) {
+    this.name = name;
+    this.language = language;
+  } // END voiceObj
+
+  // count the number of words in a string
+  //
+  function wordCount(str) {
+    var count = 0;
+    var words = str.split(" ");
+    for (var i = 0; i < words.length; i++) {
+      // inner loop -- do the count
+      if (words[i] != "") {
+        count += 1;
+      }
+    }
+    return count;
+  } // END  wordCount
+
+  // This populates the "voices" array with objects that represent the
+  // available voices in the current browser. Each object has two
+  // properties: name and language. It is loaded asynchronously in
+  // deference to Chrome.
+  //
+  function populateVoiceList() {
+    var systemVoices = speechSynthesis.getVoices();
+    for (var i = 0; i < systemVoices.length; i++) {
+      voices.push(new voiceObj(systemVoices[i].name, systemVoices[i].lang));
+    }
+  } // END populateVoiceList
+
+  populateVoiceList();
+  if (typeof speechSynthesis !== 'undefined' && speechSynthesis.onvoiceschanged !== undefined) {
+    speechSynthesis.onvoiceschanged = populateVoiceList;
+  }
+
+  // After checking for compatability, define the utterance object and
+  // then cancel the speech immediately even though nothing is yet spoken.
+  // This is to fix a quirk in Windows Chrome.
+  //
+  if ('speechSynthesis' in window) {
+    var speech = new SpeechSynthesisUtterance();
+    window.speechSynthesis.cancel();
+  }
+  if (currentTranslation === undefined) {
+    // currentLanguage = 'en-US'
+    currentLanguage = defaultLanguage;
+  } else {
+    var translation = currentTranslation.split('/');
+    if (translation[2] == 'en') {
+      currentLanguage = 'en-GB';
+    } else if (translation[2].includes('ar')) {
+      currentLanguage = 'ar-EG';
+    } else if (translation[2].includes('cs')) {
+      currentLanguage = 'cs-CZ';
+    } else if (translation[2].includes('da')) {
+      currentLanguage = 'da-DK';
+    } else if (translation[2].includes('en')) {
+      currentLanguage = 'en-UK';
+    } else if (translation[2].includes('et')) {
+      currentLanguage = 'et-EE';
+    } else if (translation[2].includes('ka')) {
+      currentLanguage = 'ka-GE';
+    } else if (translation[2].includes('el')) {
+      currentLanguage = 'el-GR';
+    } else if (translation[2].includes('iw')) {
+      currentLanguage = 'he-IL';
+    } else if (translation[2].includes('hi')) {
+      currentLanguage = 'hi-IN';
+    } else if (translation[2].includes('ja')) {
+      currentLanguage = 'ja-JP';
+    } else if (translation[2].includes('zh')) {
+      currentLanguage = 'zh-CN';
+    } else {
+      currentLanguage = translation[2] + '-' + translation[2].toUpperCase();
+    }
+  }
+  if (isChrome) {
+    var voiceLanguageDefault = voiceLanguageGoogleDefault[currentLanguage];
+  }
+  if (isEdge) {
+    var voiceLanguageDefault = voiceLanguageMicrosoftDefault[currentLanguage];
+  }
+  if (isFirefox) {
+    var voiceLanguageDefault = voiceLanguageFirefoxDefault[currentLanguage];
+  }
+
+  // -------------------------------------------------------------------------
+  // Public functions (methods)
+  // -------------------------------------------------------------------------
+  //
+  var methods = {
+    // main speak2me method.
+    //
+    speak: function (options) {
+      var opts = $.extend({}, $.fn.speak2me.defaults, options);
+      var toSpeak = '';
+      var voiceTags = new Array();
+      var _this = this;
+      var obj, processed, finished;
+      var ignoreTags;
+      scanFinished = false;
+      myOptions = extend(defaultOptions, customOptions || {});
+
+      // scan page to find correct positions for scrolling and highlightning
+      //
+      scanPage();
+
+      // Default values
+      //
+      voiceTags['a'] = new voiceTag('Link, ', pause_spoken);
+      voiceTags['q'] = new voiceTag('', pause_spoken);
+      voiceTags['ol'] = new voiceTag('Start of list.', 'End of list. ');
+      voiceTags['ul'] = new voiceTag('Start of list.', 'End of list. ');
+      voiceTags['dl'] = new voiceTag('Start of list.', 'End of list. ');
+      voiceTags['dt'] = new voiceTag('', ', ');
+      voiceTags['img'] = new voiceTag('Start of an embedded image with the description,', ', ');
+      voiceTags['table'] = new voiceTag('Start of an embedded table,', 'This element ist not spoken.');
+      voiceTags['card-header'] = new voiceTag('', '');
+      voiceTags['doc-example'] = new voiceTag('Start of an embedded example element,', 'This element ist not spoken.');
+      voiceTags['admonitionblock'] = new voiceTag('Start of an attention element of type, ', '');
+      voiceTags['listingblock'] = new voiceTag('Start of an embedded structured text block,', 'This element ist not spoken.');
+      voiceTags['carousel'] = new voiceTag('Start of an embedded carousel element,', 'This element ist not spoken.');
+      voiceTags['slider'] = new voiceTag('Start of an embedded slider element,', 'This element ist not spoken.');
+      voiceTags['masonry'] = new voiceTag('Start of an embedded masonry element,', 'This element ist not spoken.');
+      voiceTags['lightbox'] = new voiceTag('Start of an embedded lightbox element,', 'This element ist not spoken.');
+      voiceTags['gallery'] = new voiceTag('Start of an embedded gallery element,', 'This element ist not spoken.');
+      voiceTags['figure'] = new voiceTag('Start of an embedded figure with the caption,', '');
+      voiceTags['blockquote'] = new voiceTag('Blockquote start.', 'Blockquote end.');
+      voiceTags['quoteblock'] = new voiceTag('Start of an embedded quote block element,', 'Quote block element end.');
+
+      //      ignoreTags = ['masonry', 'carousel', 'slider', 'pre','audio','button','canvas','code','del','dialog','embed','form','head','iframe','meter','nav','noscript','object','s','script','select','style','textarea','video'];
+      ignoreTags = ['audio', 'button', 'canvas', 'code', 'del', 'pre', 'dialog', 'embed', 'form', 'head', 'iframe', 'meter', 'nav', 'noscript', 'object', 's', 'script', 'select', 'style', 'textarea', 'video'];
+
+      // TODO: NOT working for multiple 'tab' windows
+      // dispayed in the same browser
+      //
+      // If something is currently being spoken, ignore new voice
+      // request. Otherwise it would be queued, which is doable if
+      // someone wanted that, but not what I wanted.
+      //
+      if (window.speechSynthesis.speaking) {
+        return;
+      }
+      ;
+
+      // TODO: coincident active speech synthesis in multiple
+      // browser windows or tabs does NOT work
+      //
+      // user_session = j1.readCookie('j1.user.session');
+      // if (user_session.speech_synthesis_active === true) {
+      //     return
+      // };
+
+      // user_session.speech_synthesis_active  = true;
+      // j1.writeCookie({
+      //   name:     'user_session',
+      //   data:     user_session,
+      //   secure:   false,
+      //   expires:  0
+      // });
+
+      // top-level function to prepare the HTML content of a page
+      // and transform the resulting (speakable) text into chunks
+      //
+      var processSpeech = setInterval(function () {
+        if (scanFinished) {
+          // Cycle through all the elements in the original jQuery
+          // selector, process and clean them one at a time, and
+          // continually append it to the variable "toSpeak".
+          //
+          _this.each(function () {
+            obj = $(this).clone(); // clone the DOM node and its descendants of what the user wants spoken
+            processed = processDOMelements(obj); // process and manipulate DOM tree of this clone
+            processed = jQuery(processed).html(); // convert the result of all that to a string
+            finished = cleanDOMelements(processed); // do some text manipulation
+            toSpeak = finished;
+          });
+
+          // Check if users have set their own rate/pitch/volume
+          // defaults, otherwise use defaults
+          //
+          if (rateUserDefault !== undefined) {
+            rate = rateUserDefault;
+          } else {
+            rate = rateDefault;
+          }
+          if (pitchUserDefault !== undefined) {
+            pitch = pitchUserDefault;
+          } else {
+            pitch = pitchDefault;
+          }
+          if (volumeUserDefault !== undefined) {
+            volume = volumeUserDefault;
+          } else {
+            volume = volumeDefault;
+          }
+
+          // create and configure the utterance object
+          //
+          speech = new SpeechSynthesisUtterance();
+          speech.rate = rate;
+          speech.pitch = pitch;
+          speech.volume = volume;
+          speech.voice = speechSynthesis.getVoices().filter(function (voice) {
+            return voice.name == voiceLanguageDefault;
+          })[0];
+          speech.previousScrollPosition = 0;
+          processTextChunks(speech, toSpeak);
+          clearInterval(processSpeech);
+        }
+      }, speechCycle); // END processSpeech
+
+      // create the chunks array from (speakable) text generated
+      //
+      function splitTextIntoChunks(text) {
+        var chunks = [];
+
+        // strip strange elements from text
+        // unclear why a elements of ' >' is generated in text
+        // may caused by a HTML tag
+        text = text.replace(/^\s+>/gm, '');
+
+        // cleanup text
+        text = text.replace(/(\r\n|\n|\r)/gm, '');
+        text = text.replace(/\s+/gm, ' ');
+        chunks = text.split('.');
+
+        // 1st cleanup of chunks
+        chunks.forEach((chunk, index) => {
+          chunks[index] = chunks[index].replace(/^\s+/g, '');
+          chunks[index] = chunks[index].replaceAll('""', '');
+        });
+
+        // 2nd cleanup of chunks (delete chunks NOT speakable)
+        chunks.forEach((chunk, index) => {
+          if (chunks[index].length > 0) {
+            chunks[index] = chunks[index] + '. ';
+          } else {
+            // remove empty text element from chunks array
+            chunks.splice(index, 1);
+          }
+        });
+
+        // 3rd cleanup of chunks (delete empty chunks)
+        chunks.forEach((chunk, index) => {
+          if (chunks[index].length == 0) {
+            // remove empty text element from chunks array
+            chunks.splice(index, 1);
+          }
+        });
+
+        // build the chunk OBJECT array
+        //
+        var chunkSet = [];
+        chunks.forEach((chunk, index) => {
+          var text = chunks[index];
+          var sectionText = textSlice(text, textSliceLength, minWords);
+          var $paragraph = $('#content').find("p:contains('" + sectionText + "')");
+          var offset;
+          if ($paragraph.length > 0) {
+            offset = Math.round($paragraph[0].offsetTop);
+          } else {
+            offset = undefined;
+            $paragraph = undefined;
+          }
+          chunkSet.push({
+            text: text,
+            offsetTop: offset,
+            $paragraph: $paragraph
+          });
+        });
+
+        // Get headings array
+        headingsArray = parseContent.selectHeadings(defaultOptions.contentSelector, defaultOptions.headingSelector);
+
+        // parse the headingsArray to add missing offset values
+        // for headlines
+        //
+        chunkSet.forEach((chunk, index) => {
+          var text;
+          var innerText;
+          if (chunk.offset === undefined) {
+            // cleanup the spoken text for compare
+            text = chunk.text.replaceAll('. ', '');
+
+            // jadams:
+            // for this type of loop, NOT all headings are found in the array
+            if (headingsArray !== null) {
+              // see: https://stackoverflow.com/questions/29285897/difference-between-for-in-and-for-of-statements
+              // for in loops over enumerable property names of an object
+              // for of (new in ES6) does use an object-specific iterator
+              // and loops over the values generated by that.
+              for (var node of headingsArray) {
+                //              for (var node in headingsArray) {
+                // cleanup the innerText for compare
+                innerText = node.innerText.replaceAll('?', '');
+                innerText = node.innerText;
+                if (innerText == text) {
+                  var headline = $('#' + node.id);
+                  if (headline.length > 0) {
+                    var offsetTop = headline.offset().top;
+                    chunk.offsetTop = Math.round(offsetTop);
+                    //                    console.debug('speak2me, text: ' + node.innerText + ', offsetTop: ' + chunk.offsetTop);
+                  } else {
+                    //                    console.warn('speak2me, text: ' + node.innerText + ', offsetTop not caclulated.');
+                  }
+                }
+              }
+            }
+          }
+        });
+        return chunkSet;
+      }
+
+      // create a slice of text used later to identify the
+      // containing paragraph
+      //
+      function textSlice(text, slicelenght, wordsMin) {
+        var startSubString = 0;
+        var endSubString = startSubString + slicelenght;
+        var subText = text.substr(startSubString, endSubString);
+        var stringArray = subText.split(/(\s+)/);
+        var words;
+
+        // Remove last two elements are a fraction of subText
+        stringArray.pop();
+        stringArray.pop();
+
+        // built the new string
+        subText = stringArray.join('');
+        subText = subText.replaceAll('.', '');
+
+        // at least two words required
+        words = wordCount(subText);
+        if (words < wordsMin) {
+          return undefined;
+          console.warn('no search possible on this fraction of subText');
+        } else {
+          return subText;
+        }
+      }
+
+      // process chunks (to speak) sequentially
+      //
+      function processTextChunks(speaker, chunks) {
+        const synth = window.speechSynthesis;
+
+        // indicate active converter in the quicklinks bar
+        //
+        $('.mdib-speaker').addClass('mdib-spin');
+
+        // manage scrolling and highlightning for the active spoken text
+        //
+        speaker.addEventListener('start', event => {
+          // store current scroll position
+          //
+          if (speaker.offsetTop !== undefined) {
+            speaker.currentScrollPosition = speaker.offsetTop;
+          }
+
+          // adjust scrolling position offsetTop for 'post series'
+          //
+          if ($('.bmd-layout-header').length) {
+            speaker.offsetTop = $('.bmd-layout-header')[0].offsetTop + (scrollBlockOffset / 2 + 3) + speaker.offsetTop;
+            speaker.previousScrollPosition = speaker.offsetTop;
+          }
+
+          // add highlightning
+          //
+          if (speaker.$paragraph !== undefined) {
+            speaker.$paragraph.addClass('speak-highlighted');
+          }
+
+          // scroll to paragraph currently spoken if a valid
+          // offsetTop is available
+          //
+          if (speaker.offsetTop !== undefined) {
+            if (speaker.offsetTop >= speaker.previousScrollPosition) {
+              window.scrollTo({
+                top: speaker.offsetTop - scrollBlockOffset,
+                behavior: scrollBehavior
+              });
+            }
+          }
+        });
+
+        // listener to manage highlightning for spoken text elements
+        // and set next chunk to speak
+        //
+        speaker.addEventListener('end', function (event) {
+          // workaround WRONG offsetTop positions (LOWER as expected)
+          //
+          if (speaker.offsetTop !== undefined) {
+            if (speaker.offsetTop >= speaker.previousScrollPosition) {
+              speaker.previousScrollPosition = speaker.offsetTop;
+            }
+          }
+
+          // remove highlightning for the paragraph already spoken
+          //
+          if (speaker.$paragraph !== undefined) {
+            speaker.$paragraph.removeClass('speak-highlighted');
+          }
+          chunkSpoken = false;
+          chunkCounter++;
+        });
+
+        // loop to prepare chunks to speak or sto the voice output
+        //
+        var speechMonitor = setInterval(function () {
+          // check if all chunks (text) are spoken
+          //
+          if (chunkCounter == chunkCounterMax || userStoppedSpeaking) {
+            chunkCounter = 0;
+            userStoppedSpeaking = false;
+            chunkSpoken = false;
+            speaker.$paragraph !== undefined && speaker.$paragraph.removeClass('speak-highlighted');
+            window.scrollTo({
+              top: 0,
+              behavior: 'smooth'
+            });
+            $('.mdib-speaker').removeClass('mdib-spin');
+            clearInterval(speechMonitor);
+          } else {
+            // prepare speaker data and start the voice
+            //
+            speaker.text = chunks[chunkCounter].text;
+            speaker.offsetTop = chunks[chunkCounter].offsetTop;
+            speaker.$paragraph = chunks[chunkCounter].$paragraph;
+
+            // speak current text line
+            if (!chunkSpoken) {
+              synth.speak(speaker);
+              chunkSpoken = true;
+            }
+          }
+        }, speechMonitorCycle); // END speechMonitor
+      } // END processTextChunks
+
+      // transform all configured DOM elements of a page that
+      // can be spoken into plain text
+      //
+      function processDOMelements(clone) {
+        var copy, title, title_element, content_type, content_element, content, appended, prepend;
+
+        // Remove tags from the "ignoreTags" array because the
+        // user called "speak2me('recognize')" and said he/she
+        // doesn't want some tags un-spoken. Double negative there,
+        // but it does make sense.
+        //
+        if (recognizeTagsUser.length > 0) {
+          for (var prop in recognizeTagsUser) {
+            var index = ignoreTags.indexOf(recognizeTagsUser[prop]);
+            if (index > -1) {
+              ignoreTags.splice(index, 1);
+            }
+          }
+        }
+        ;
+
+        // Remove DOM objects listed in the "ignoreTags" array
+        //
+        for (var prop in ignoreTags) {
+          jQuery(clone).find(ignoreTags[prop]).addBack(ignoreTags[prop]).not('[data-speak2me-recognize]').each(function () {
+            jQuery(this).html('');
+          });
+        }
+        ;
+
+        // Remove DOM objects specified in the "ignoreTagsUser" array
+        // Specified when calling "speak2me('ignore')".
+        //
+        if (ignoreTagsUser.length > 0) {
+          for (var prop in ignoreTagsUser) {
+            jQuery(clone).find(ignoreTagsUser[prop]).addBack(ignoreTagsUser[prop]).not('[data-speak2me-recognize]').each(function () {
+              jQuery(this).html('');
+            });
+          }
+          ;
+        }
+        ;
+
+        // Remove DOM objects marked in the HTML code by "data-speak2me-ignore".
+        //
+        jQuery(clone).find('[data-speak2me-ignore]').addBack('[data-speak2me-ignore]').each(function () {
+          jQuery(this).html('');
+        });
+
+        // Remove DOM objects in the HTML code mareked by class "speak2me-ignore".
+        //
+        jQuery(clone).find('.speak2me-ignore').addBack('[data-speak2me-ignore]').each(function () {
+          jQuery(this).html('');
+        });
+
+        // Search for prepend data specified in the HTML code by "data-speak2me-prepend".
+        //
+        jQuery(clone).find('[data-speak2me-prepend]').addBack('[data-speak2me-prepend]').each(function () {
+          copy = jQuery(this).data('speak2me-prepend');
+          jQuery(this).prepend(copy + ' ');
+        });
+
+        // Search for append data specified in the HTML code by "data-speak2me-append".
+        //
+        jQuery(clone).find('[data-speak2me-append]').addBack('[data-speak2me-append]').each(function () {
+          copy = jQuery(this).data('speak2me-append');
+          jQuery(this).append(' ' + copy);
+        });
+
+        // Search for tags to prepend and append specified by the "voiceTags" array.
+        //
+        var count = 0;
+        for (var tag in voiceTags) {
+          jQuery(clone).find(tag).each(function () {
+            if (customTags[tag]) {
+              jQuery(this).prepend(customTags[tag].prepend + ' ');
+              jQuery(this).append(' ' + customTags[tag].append);
+            } else {
+              jQuery(this).prepend(voiceTags[tag].prepend + ' ');
+              jQuery(this).append(' ' + voiceTags[tag].append);
+            }
+            ;
+          });
+        }
+        ;
+
+        // Search for <h1> through <h6> and <li> and <br> to add
+        // a pause at the end of those tags. This is done
+        // because these tags require a pause, but often don't
+        // have a comma or period at the end of their text.
+        //
+        jQuery(clone).find('h1,h2,h3,h4,h5,h6,li,p').addBack('h1,h2,h3,h4,h5,h6,li,p').each(function () {
+          jQuery(this).append(pause_spoken);
+        });
+
+        // Search for <br> tags to add a pause at the end.
+        jQuery(clone).find('br').each(function () {
+          jQuery(this).after(pause_spoken);
+        });
+
+        // Search for <figure>, check for <figcaption>, insert
+        // that text if exists and then remove the whole DOM object.
+        //
+        jQuery(clone).find('figure').addBack('figure').each(function () {
+          copy = jQuery(this).find('figcaption').html();
+          if (customTags['figure']) {
+            prepend = customTags['figure'].prepend;
+          } else {
+            prepend = voiceTags['figure'].prepend;
+          }
+          if (copy != undefined && copy !== '') {
+            jQuery('<div>' + prepend + ' ' + copy + '</div>').insertBefore(this);
+          }
+          jQuery(this).remove();
+        });
+
+        // Search for <image> tags, check for ALT attribute, and insert
+        // text if exists and then dinally remove the DOM object.
+        // NOTE: had to make adjustments for nesting in <picture> tags.
+        //
+        jQuery(clone).find('img').addBack('img').each(function () {
+          copy = jQuery(this).attr('alt');
+          var parent = jQuery(this).parent();
+          var parentName = parent.get(0).tagName;
+          if (customTags['img']) {
+            prepend = customTags['img'].prepend;
+          } else {
+            prepend = voiceTags['img'].prepend;
+          }
+          if (copy !== undefined && copy != '') {
+            if (parentName == 'PICTURE') {
+              var par;
+              jQuery('<div>' + prepend + ' ' + copy + pause_spoken + '</div>').insertBefore(parent);
+            } else {
+              jQuery('<div>' + prepend + ' ' + copy + pause_spoken + '</div>').insertBefore(this);
+            }
+          }
+          jQuery(this).remove();
+        });
+
+        // TODO: identify why the text 'Follow the link' is
+        // already placed on the anchor
+        //
+        jQuery(clone).find('a').addBack('a').each(function () {
+          var anchor = jQuery(this);
+          copy = anchor[0].innerText;
+          prepend = voiceTags['a'].prepend;
+          appended = voiceTags['a'].append;
+
+          //        jQuery('<div>' + prepend + copy + '</div>').insertBefore(this);
+          jQuery('<div>' + copy + '</div>').insertBefore(this);
+          jQuery('<div>' + appended + '</div>').insertBefore(this);
+          jQuery(this).remove();
+        });
+
+        // Search for admonitionblock elements and extract the type and
+        // content. Insert type and content and then remove the DOM object.
+        //
+        jQuery(clone).find('.admonitionblock').addBack('admonitionblock').each(function () {
+          content_type = this.classList[1];
+          content_element = jQuery(this).find('.content');
+          content = content_element[0].innerText;
+          prepend = voiceTags['admonitionblock'].prepend + content_type + '. ';
+          appended = voiceTags['admonitionblock'].append;
+          if (content !== undefined && content != '') {
+            jQuery('<div>' + prepend + ' ' + content + '</div>').insertBefore(this);
+            jQuery('<div>' + appended + pause_spoken + '</div>').insertBefore(this);
+          }
+          jQuery(this).remove();
+        });
+
+        // Search for quote block elements.
+        //
+        jQuery(clone).find('.quoteblock').addBack('quoteblock').each(function () {
+          var attribution = jQuery(this).find('.attribution');
+          content_element = jQuery(this).find('blockquote');
+          content = content_element[0].innerText + 'quoted by, ' + attribution[0].innerText + ', ';
+          prepend = voiceTags['quoteblock'].prepend;
+          appended = voiceTags['quoteblock'].append;
+          if (content !== undefined && content != '') {
+            jQuery('<div>' + prepend + ' ' + content + '</div>').insertBefore(this);
+            jQuery('<div>' + appended + pause_spoken + '</div>').insertBefore(this);
+          }
+          jQuery(this).remove();
+        });
+
+        // Search for <table>, check for <caption>, insert text
+        // if exists and then remove the DOM object.
+        //
+        jQuery(clone).find('table').addBack('table').each(function () {
+          copy = jQuery(this).find('caption').text();
+          prepend = voiceTags['table'].prepend;
+          appended = voiceTags['table'].append;
+          if (copy !== undefined && copy != '') {
+            jQuery('<div>' + prepend + ' ' + copy + '</div>').insertBefore(this);
+            jQuery('<div>' + appended + pause_spoken + '</div>').insertBefore(this);
+          }
+          jQuery(this).remove();
+        });
+
+        // Search for cards|header elements and then remove the DOM object.
+        //
+        jQuery(clone).find('.card-header').addBack('card-header').each(function () {
+          title_element = jQuery(this).find('.card-title');
+          prepend = voiceTags['card-header'].prepend;
+          appended = voiceTags['card-header'].append;
+          if (title_element.length) {
+            title = title_element[0].innerText + pause_spoken;
+          } else {
+            title = '';
+          }
+          jQuery('<div>' + prepend + '</div>').insertBefore(this);
+          jQuery('<div>' + appended + title + '</div>').insertBefore(this);
+          jQuery(title_element).remove();
+        });
+
+        // Search for doc-example elements and then remove the DOM object.
+        //
+        jQuery(clone).find('.doc-example').addBack('doc-example').each(function () {
+          prepend = voiceTags['doc-example'].prepend;
+          appended = voiceTags['doc-example'].append;
+          jQuery('<div>' + prepend + '</div>').insertBefore(this);
+          jQuery('<div>' + appended + pause_spoken + '</div>').insertBefore(this);
+          jQuery(this).remove();
+        });
+
+        // Search for listingblock elements, check for previous declared <div>
+        // container that contains the title element and insert the
+        // text if exists and then finally remove the DOM object.
+        //
+        jQuery(clone).find('.listingblock').addBack('listingblock').each(function () {
+          title_element = jQuery(this).find('.title');
+          if (title_element.length) {
+            copy = title_element[0].innerText;
+          } else {
+            copy = '';
+          }
+          prepend = voiceTags['listingblock'].prepend;
+          appended = voiceTags['listingblock'].append;
+          if (copy !== undefined && copy != '') {
+            jQuery('<div>' + prepend + ' with the caption,' + copy + pause_spoken + '</div>').insertBefore(this);
+            jQuery('<div>' + appended + '</div>').insertBefore(this);
+          } else {
+            jQuery('<div>' + prepend + '</div>').insertBefore(this);
+            jQuery('<div>' + appended + '</div>').insertBefore(this);
+          }
+          jQuery(this).remove();
+        });
+
+        // Search for <carousel> tags, check for previous declared <div>
+        // container that contains the title element and insert the
+        // text if exists and finally remove the DOM object.
+        //
+        jQuery(clone).find('carousel').addBack('carousel').each(function () {
+          if ($(this).prev()[0].innerText !== undefined) {
+            title = $(this).prev()[0].innerText;
+            title_element = jQuery(this).prev();
+            // remove the title 'before' the DOM object deleted
+            //
+            jQuery(title_element).remove();
+          } else {
+            title = '';
+          }
+          prepend = voiceTags['carousel'].prepend;
+          appended = voiceTags['carousel'].append;
+          if (title !== undefined && title != '') {
+            jQuery('<div>' + prepend + ' with the caption,' + title + pause_spoken + '</div>').insertBefore(this);
+            jQuery('<div>' + appended + '</div>').insertBefore(this);
+          } else {
+            jQuery('<div>' + prepend + '</div>').insertBefore(this);
+            jQuery('<div>' + appended + '</div>').insertBefore(this);
+          }
+          jQuery(this).remove();
+        });
+
+        // Search for <slider> tags, check for previous declared <div>
+        // container that contains the title element and insert the
+        // text if exists and finally remove the DOM object.
+        //
+        jQuery(clone).find('slider').addBack('slider').each(function () {
+          if ($(this).prev()[0].innerText !== undefined) {
+            title = $(this).prev()[0].innerText;
+            title_element = jQuery(this).prev();
+            // remove the title 'before' the DOM object deleted
+            //
+            jQuery(title_element).remove();
+          } else {
+            title = '';
+          }
+          prepend = voiceTags['slider'].prepend;
+          appended = voiceTags['slider'].append;
+          if (title !== undefined && title != '') {
+            jQuery('<div>' + prepend + ' with the caption, ' + title + pause_spoken + '</div>').insertBefore(this);
+            jQuery('<div>' + appended + '</div>').insertBefore(this);
+          } else {
+            jQuery('<div>' + prepend + '</div>').insertBefore(this);
+            jQuery('<div>' + appended + '</div>').insertBefore(this);
+          }
+          jQuery(this).remove();
+        });
+
+        // Search for <gallery> tags, check for previous declared <div>
+        // container that contains the title element and insert the
+        // text if exists and finally remove the DOM object.
+        //
+        jQuery(clone).find('gallery').addBack('gallery').each(function () {
+          if ($(this).prev()[0].innerText !== undefined) {
+            title = $(this).prev()[0].innerText;
+            title_element = jQuery(this).prev();
+            // remove the title BEFORE the DOM object gets deleted
+            //
+            jQuery(title_element).remove();
+          } else {
+            title = '';
+          }
+          prepend = voiceTags['gallery'].prepend;
+          appended = voiceTags['gallery'].append;
+          if (title !== undefined && title != '') {
+            prepend !== '' && jQuery('<div>' + prepend + ' with the caption ' + title + pause_spoken + '</div>').insertBefore(this);
+            appended !== '' && jQuery('<div>' + appended + '</div>').insertBefore(this);
+          } else {
+            prepend !== '' && jQuery('<div>' + prepend + '</div>').insertBefore(this);
+            appended !== '' && jQuery('<div>' + appended + '</div>').insertBefore(this);
+          }
+          jQuery(this).remove();
+        });
+
+        // Search for <slider> tags, and extract the <caption> tag data,
+        // insert the text if exists and finally remove the DOM object.
+        //
+        jQuery(clone).find('lightbox').addBack('gallery').each(function () {
+          if ($(this).prev()[0].innerText !== undefined) {
+            title = $(this).prev()[0].innerText;
+            title_element = jQuery(this).prev();
+            // remove the title 'before' the DOM object deleted
+            //
+            jQuery(title_element).remove();
+          } else {
+            title = '';
+          }
+          prepend = voiceTags['lightbox'].prepend;
+          appended = voiceTags['lightbox'].append;
+          if (title !== undefined && title != '') {
+            jQuery('<div>' + prepend + ' with the caption,' + title + pause_spoken + '</div>').insertBefore(this);
+            jQuery('<div>' + appended + '</div>').insertBefore(this);
+          } else {
+            jQuery('<div>' + prepend + '</div>').insertBefore(this);
+            jQuery('<div>' + appended + '</div>').insertBefore(this);
+          }
+          jQuery(this).remove();
+        });
+
+        // Search for DOM object to be replaced specified in
+        // the HTML code by "data-speak2me-swap".
+        //
+        jQuery(clone).find('[data-speak2me-swap]').addBack('[data-speak2me-swap]').each(function () {
+          copy = jQuery(this).data('speak2me-swap');
+          jQuery(this).text(copy);
+        });
+
+        // Search for DOM object to spelled out specified in
+        // the HTML code by "data-speak2me-spell".
+        //
+        jQuery(clone).find('[data-speak2me-spell]').addBack('[data-speak2me-spell]').each(function () {
+          copy = jQuery(this).text();
+          copy = copy.split('').join(' ');
+          jQuery(this).text(copy);
+        });
+        return clone;
+      }
+
+      // run final cleanups on all DOM elements processed.
+      //
+      function cleanDOMelements(final) {
+        var start, ended, speak, part1, part2, final;
+
+        // Search for <speak2me> in comments, copy the text,
+        // place it outside the comment, and then splice together
+        // "final" string again, which omits the comment.
+        //
+        while (final.indexOf('<!-- <speak2me>') != -1) {
+          start = final.indexOf('<!-- <speak2me>');
+          ended = final.indexOf('</speak2me> -->', start);
+          if (ended == -1) {
+            break;
+          }
+          speak = final.substring(start + 17, ended);
+          part1 = final.substring(0, start);
+          part2 = final.substring(ended + 17);
+          final = part1 + ' ' + speak + ' ' + part2;
+        }
+        ;
+
+        // Strip out remaining comments.
+        //
+        final = final.replace(/<!--[\s\S]*?-->/g, '');
+
+        // Strip out remaining HTML tags.
+        //
+        final = final.replace(/(<([^>]+)>)/ig, '');
+
+        // Replace a string of characters with another as specified
+        // by "speak2me('replace')".
+        //
+        var len = replacements.length;
+        var i = 0;
+        var old, rep;
+        while (i < len) {
+          old = replacements[i];
+          old = old.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&');
+          rep = replacements[i + 1] + ' ';
+          var regexp = new RegExp(old, 'gi');
+          var final = final.replace(regexp, rep);
+          i = i + 2;
+        }
+
+        // Remove double quotes.
+        //
+        final = final.replaceAll('"', '');
+        final = final.replaceAll('“', '');
+        final = final.replaceAll('”', '');
+
+        // Remove all colon ':' and replace by a dot.
+        //
+        final = final.replaceAll(':', '.');
+
+        // Replace all strange '., ' by a pause.
+        //
+        final = final.replaceAll('., ', '. ');
+        final = final.replaceAll(' , ', ', ');
+
+        // Remove strange double pause elements.
+        //
+        final = final.replaceAll('. .', '');
+        final = final.replaceAll(', .', '');
+        final = final.replaceAll('  ,  ', '');
+
+        // Replace empty lines.
+        //
+        final = final.replace(/^$/g, '\n');
+        final = final.replace(/^\s+$/g, '\n');
+
+        // Replace single full stops in line ' . ' or '. '.
+        //
+        final = final.replace(/\s+\.\s+/g, '\n');
+        final = final.replace(/\s+\.\s+$/g, '\n');
+
+        // Replace strange double full stops '..'.
+        //
+        final = final.replace(/\.\./g, '.');
+
+        // Replace the abbreviations '.e.g.', 'E.g.' and 'etc.'.
+        //
+        final = final.replaceAll('e.g.', 'for example');
+        final = final.replaceAll('E.g.', 'For example, ');
+        final = final.replaceAll('etc.', 'and so on, ');
+
+        // Replace language specific abbreviations.
+        // NOTE: may required for some voices|languages (like Gewrman)
+        //
+        final = final.replaceAll('z. B.', 'zum Beispiel, ');
+
+        // Remove question and exclamation (?|!) marks.
+        //
+        final = final.replace(/[\!\?]/g, '. ');
+
+        // Replace em-dashes and double-dashes with a pause
+        // since most voices doesn't do so when speaking.
+        //
+        final = final.replaceAll('—', pause_spoken);
+        final = final.replaceAll('–', pause_spoken);
+        final = final.replaceAll('--', pause_spoken);
+
+        // When read from the DOM, a few special characters
+        // (&amp; for example) display as their hex codes
+        // rather than resolving into their actual character.
+        //
+        var txt = document.createElement('textarea');
+        txt.innerHTML = final;
+        final = txt.value;
+
+        // split the final text in to chunks (sentences).
+        //
+        const textChunks = splitTextIntoChunks(final);
+        chunkCounterMax = textChunks.length;
+        return textChunks;
+      }
+
+      // return the Utterance object of the SpeechSynthesis API.
+      //
+      return speech;
+    },
+    // END speak
+
+    pause: function () {
+      window.speechSynthesis.pause();
+      return this;
+    },
+    // END pause
+
+    resume: function () {
+      window.speechSynthesis.resume();
+      return this;
+    },
+    // END resume
+
+    // jadams
+    stop: function () {
+      window.speechSynthesis.cancel();
+      userStoppedSpeaking = true;
+
+      // jadams
+      // NOTE: stopping coincident active speech synthesis
+      // in multiple browser windows (tabs) does NOT work
+      //
+      //    user_session.speech_synthesis_active = false;
+      //    j1.writeCookie({
+      //      name:     'user_session',
+      //      data:     user_session,
+      //      secure:   false,
+      //      expires:  0
+      //    });
+
+      return this;
+    },
+    // END stop
+
+    enabled: function () {
+      return 'speechSynthesis' in window;
+    },
+    // END enabled
+
+    isSpeaking: function () {
+      return window.speechSynthesis.speaking;
+    },
+    // END is Speaking
+
+    isPaused: function () {
+      return window.speechSynthesis.paused;
+    },
+    // END isPaused
+
+    rate: function () {
+      var num = arguments[0];
+      if (num >= 0.1 && num <= 10) {
+        rateUserDefault = num;
+      } else if (num === undefined) {
+        rateUserDefault = void 0;
+        rate = rateDefault;
+      }
+      return this;
+    },
+    // END rate
+
+    pitch: function () {
+      var num = arguments[0];
+      if (num >= 0.1 && num <= 2) {
+        pitchUserDefault = num;
+      } else if (num === undefined) {
+        pitchUserDefault = void 0;
+        pitch = pitchDefault;
+      }
+      return this;
+    },
+    // END pitch
+
+    volume: function () {
+      var num = arguments[0];
+      if (num >= 0 && num <= 1) {
+        volumeUserDefault = num;
+      } else if (num === undefined) {
+        volumeUserDefault = void 0;
+        volume = volumeDefault;
+      }
+      ;
+      return this;
+    },
+    // END volume
+
+    ignore: function () {
+      var len = arguments.length;
+      ignoreTagsUser.length = 0;
+      while (len > 0) {
+        len--;
+        ignoreTagsUser.push(arguments[len]);
+      }
+      ;
+      return this;
+    },
+    // END ignore
+
+    recognize: function () {
+      var len = arguments.length;
+      recognizeTagsUser.length = 0;
+      while (len > 0) {
+        len--;
+        recognizeTagsUser.push(arguments[len]);
+      }
+      return this;
+    },
+    // END recognize
+
+    replace: function () {
+      var len = arguments.length;
+      replacements.length = 0;
+      var i = 0;
+      while (i < len) {
+        replacements.push(arguments[i], arguments[i + 1]);
+        i = i + 2;
+        if (len - i == 1) {
+          break;
+        }
+        ;
+      }
+      ;
+      return this;
+    },
+    // END replace
+
+    customize: function () {
+      var len = arguments.length;
+      if (len == 0) {
+        customTags = [];
+      }
+      if (len == 2) {
+        if (['img', 'table', 'figure'].indexOf(arguments[0]) == -1) {
+          console.warn("When customizing, tag indicated must be either 'img', 'table', or 'figure'.");
+          return;
+        }
+        customTags[arguments[0].toString()] = new voiceTag(arguments[1].toString());
+      }
+      if (len == 3) {
+        if (['q', "ol", "ul", "blockquote"].indexOf(arguments[0]) == -1) {
+          console.warn("When customizing, tag indicated must be either 'q', 'ol', 'ul' or 'blockquote'.");
+          return;
+        }
+        customTags[arguments[0].toString()] = new voiceTag(arguments[1].toString(), arguments[2].toString());
+      }
+      return this;
+    },
+    // END customize
+
+    getVoices: function () {
+      // If no arguments, then the user has requested the array of
+      // voices populated earlier.
+      //
+      if (arguments.length == 0) {
+        return voices;
+      }
+
+      // If there's another argument, we'll assume it's a jQuery
+      // selector designating where to put the dropdown menu.
+      // And if there's a third argument, that will be custom text
+      // for the dropdown menu.
+      // Then we'll create a dropdown menu with the voice names and,
+      //in parenthesis, the language code.
+      //
+      var obj = jQuery(arguments[0]);
+      var selectionTxt = 'Choose a voice';
+      if (arguments[1] !== undefined) {
+        selectionTxt = arguments[1];
+      }
+      obj.append(jQuery("<select id='voiceSelect' name='voiceSelect'><option value='none'>" + selectionTxt + "</option></select>"));
+
+      // jadams
+      var skippedVoices = 0;
+      for (var i = 0; i < voices.length; i++) {
+        if (isChrome && voices[i].name.includes(ignoreProvider)) {
+          skippedVoices++;
+          continue;
+        }
+        if (isEdge && !voices[i].name.includes('Natural')) {
+          skippedVoices++;
+          continue;
+        }
+        var option = document.createElement('option');
+        option.textContent = voices[i].name + ' (' + voices[i].language + ')';
+        option.setAttribute('value', voices[i].name);
+
+        // set used voice as 'selected'
+        if (voiceLanguageDefault !== undefined) {
+          if (voices[i].name === voiceLanguageDefault) {
+            option.setAttribute('selected', 'selected');
+          }
+        } else {
+          if (voices[i].name.includes(voiceUserDefault)) {
+            //          option.setAttribute('selected', 'selected');
+          }
+        }
+        option.setAttribute('data-speak2me-language', voices[i].language);
+        obj.find('select').append(option);
+      }
+      return i - skippedVoices;
+    },
+    // END get Voiuces
+
+    setVoice: function () {
+      // The setVoice function has to have two attributes
+      // if not, exit the function.
+      //
+      if (arguments.length < 2) {
+        return this;
+      }
+      var requestedVoice, requestedLanguage;
+
+      // User wants to change the voice directly. If that name indeed
+      // exists, update the "voiceUserDefault" variable.
+      //
+      if (arguments[0] == 'name') {
+        requestedVoice = arguments[1];
+        for (var i = 0; i < voices.length; i++) {
+          if (voices[i].name == requestedVoice) {
+            voiceUserDefault = requestedVoice;
+          }
+        }
+      }
+
+      // User wants to change the voice by only specifying the
+      // first two characters of the language code. Case insensitive.
+      //
+      if (arguments[0] == 'language') {
+        requestedLanguage = arguments[1].toUpperCase();
+        if (requestedLanguage.length == 2) {
+          for (var i = 0; i < voices.length; i++) {
+            if (voices[i].language.substring(0, 2).toUpperCase() == requestedLanguage) {
+              voiceUserDefault = voices[i].name;
+              break;
+            }
+          }
+        } else {
+          // User wants to change the voice by specifying the
+          // complete language code.
+          for (var i = 0; i < voices.length; i++) {
+            if (voices[i].language == requestedLanguage) {
+              voiceUserDefault = voices[i].name;
+              break;
+            }
+          }
+        }
+      }
+      return this;
+    } // END set Voice
+  }; // END methods
+
+  // main speak2me method
+  //
+  $.fn.speak2me = function (method) {
+    if (methods[method]) {
+      return methods[method].apply(this, Array.prototype.slice.call(arguments, 1));
+    } else if (typeof method === 'object' || !method) {
+      return methods.speak.apply(this, arguments);
+    } else {
+      jQuery.error('Method ' + method + ' does not exist on jQuery.speak2me');
+    }
+  };
+})(jQuery);
+
+/***/ }),
+
 /***/ 525:
 /***/ ((module) => {
 
@@ -9871,6 +11528,7 @@ window.j1.core.scrollSmooth = __webpack_require__(814);
 
 const J1Tocbot = __webpack_require__(799);
 const J1AttrChangeListener = __webpack_require__(610);
+const J1Speak2Me = __webpack_require__(229);
 
 // Passing log data over Internet|SeeMe (currently NOT used)
 // -----------------------------------------------------------------------------