j1-template 2023.8.2 → 2023.9.1

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

@@ -4546,7 +4546,12 @@ module.exports = function parseContent(options) {
 /* 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
+  See Web site at: https://purefreedom.com/articulate/
+*/
+
+/* Further reading
+  https://dev.to/jankapunkt/cross-browser-speech-synthesis-the-hard-way-and-the-easy-way-353
+  https://github.com/jankapunkt/easy-speech
 */
 
 (function ($) {
@@ -4944,31 +4949,37 @@ module.exports = function parseContent(options) {
         // 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, '');
         text = text.replaceAll(' ..', '.');
 
         // 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
@@ -4997,31 +5008,30 @@ module.exports = function parseContent(options) {
           });
         });
 
-        // Get headings array
+        // create the 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 in headingsArray) {
               for (var node of headingsArray) {
-                //              for (var node in headingsArray) {
                 // cleanup the innerText for compare
+                //
                 innerText = node.innerText.replaceAll('?', '');
-                innerText = node.innerText;
+                innerText = node.innerText.replaceAll('!', '');
                 if (innerText == text) {
                   var headline = $('#' + node.id);
                   if (headline.length > 0) {
@@ -5030,12 +5040,13 @@ module.exports = function parseContent(options) {
                     //                    console.debug('speak2me, text: ' + node.innerText + ', offsetTop: ' + chunk.offsetTop);
                   } else {
                     //                    console.warn('speak2me, text: ' + node.innerText + ', offsetTop not caclulated.');
-                  }
-                }
-              }
-            }
-          }
-        });
+                  } // END if headline.length
+                } // END if innerText
+              } // END for headingsArray
+            } // END if headingsArray
+          } // END if chunk.offset
+        }); // END forEach chunkSet
+
         return chunkSet;
       }
 
@@ -5049,15 +5060,18 @@ module.exports = function parseContent(options) {
         var stringArray = subText.split(/(\s+)/);
         var words;
 
-        // Remove last two elements are a fraction of subText
+        // remove last two elements are a fraction of subText
+        //
         stringArray.pop();
         stringArray.pop();
 
-        // built the new string
+        // build the new string
+        //
         subText = stringArray.join('');
         subText = subText.replaceAll('.', '');
 
-        // at least two words required
+        // at least wordsMin words required
+        //
         words = wordCount(subText);
         if (words < wordsMin) {
           return undefined;
@@ -5076,32 +5090,15 @@ module.exports = function parseContent(options) {
         //
         $('.mdib-speaker').addClass('mdib-spin');
 
-        // manage scrolling and highlightning for the active spoken text
+        // listener to ENABLE highlightning and scrolling
+        // on active spoken elements
         //
         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
+          // scroll on ALL valid offsetTop for headings and paragraphs
           //
           if (speaker.offsetTop !== undefined) {
+            // skip scrolling if offsetTop position is LOWER than expected
+            //
             if (speaker.offsetTop >= speaker.previousScrollPosition) {
               window.scrollTo({
                 top: speaker.offsetTop - scrollBlockOffset,
@@ -5109,13 +5106,19 @@ module.exports = function parseContent(options) {
               });
             }
           }
+
+          // manage highlightning on currently spoken paragraph
+          //
+          if (speaker.$paragraph !== undefined) {
+            speaker.$paragraph.addClass('speak-highlighted');
+          }
         });
 
-        // listener to manage highlightning for spoken text elements
-        // and set next chunk to speak
+        // listener to STOP highlightning for already spoken
+        // text elements and set next chunk to speak
         //
         speaker.addEventListener('end', function (event) {
-          // workaround WRONG offsetTop positions (LOWER as expected)
+          // workaround to detect offsetTop positions LOWER than expected
           //
           if (speaker.offsetTop !== undefined) {
             if (speaker.offsetTop >= speaker.previousScrollPosition) {
@@ -5132,7 +5135,7 @@ module.exports = function parseContent(options) {
           chunkCounter++;
         });
 
-        // loop to prepare chunks to speak or sto the voice output
+        // loop to prepare ALL chunks to speak or STOP the voice output
         //
         var speechMonitor = setInterval(function () {
           // check if all chunks (text) are spoken
@@ -5671,6 +5674,18 @@ module.exports = function parseContent(options) {
         txt.innerHTML = final;
         final = txt.value;
 
+        // Replace single word in line
+        //
+        final = final.replace(/^\s*(\b\w+\b)\s*$/gm, "$1. ");
+
+        // Replace month year in line
+        //
+        final = final.replace(/^\s*(\b\w+\b\s*[0-9]{4})$/gm, "$1. ");
+
+        // Replace multiple whitespaces
+        //
+        final = final.replace(/\s+/g, ' ');
+
         // split the final text in to chunks (sentences).
         //
         const textChunks = splitTextIntoChunks(final);