sanskrit-documentation-theme 0.1.6 → 0.1.7

data/assets/js/on_doc_ready/audio_embed.js

@@ -0,0 +1,45 @@
+function mp3Embed(audioEmbedTag) {
+    var src = audioEmbedTag.getAttribute( "src" );
+    var caption = audioEmbedTag.getAttribute( "caption" );
+    if(src.indexOf('.mp3') !== -1) {
+        var srcParts = src.split('?');
+        if(srcParts.length == 1) srcParts[1] = '';
+        var unrecognizedParameterString = srcParts[1];
+        unrecognizedParameterString = unrecognizedParameterString.replace('&','').replace('&','');
+        unrecognizedParameterString = unrecognizedParameterString.replace('autoplay=1','').replace('autoplay=0','');
+        unrecognizedParameterString = unrecognizedParameterString.replace('loop=1','').replace('loop=0','');
+        unrecognizedParameterString = unrecognizedParameterString.replace('controls=0','').replace('controls=1','');
+
+        if (srcParts[0].lastIndexOf('.mp3', srcParts[0].length - 4) === srcParts[0].length - 4 && unrecognizedParameterString.length == 0) {
+            if(srcParts[1].indexOf('autoplay=1') !== -1) var autoplay=1; else var autoplay=0;
+            if(srcParts[1].indexOf('loop=1') !== -1) var loop=1; else var loop=0;
+            if(srcParts[1].indexOf('controls=0') !== -1) var controls=0; else var controls=1;
+            var newInnerHTML = '<audio';
+            if(autoplay==1) newInnerHTML += ' autoplay';
+            if(loop==1) newInnerHTML += ' loop';
+            if(controls==1) newInnerHTML += ' controls';
+            newInnerHTML += '><source src="'+srcParts[0]+'" type="audio/mpeg">Your browser does not support the audio element, but here is <a href="' + srcParts[0] + '">a link.</a></audio>';
+            if(caption) {
+                newInnerHTML += `(${caption})`;
+            }
+            audioEmbedTag.innerHTML = newInnerHTML;
+        }
+    }
+}
+
+function fillAudioEmbeds() {
+    var audioEmbedTags = document.querySelectorAll('.audioEmbed');
+    audioEmbedTags.forEach(function (audioEmbedTag) {
+        mp3Embed(audioEmbedTag);
+    });
+    document.addEventListener('play', function(e){
+        var audios = document.getElementsByTagName('audio');
+        for(var i = 0, len = audios.length; i < len;i++){
+            if(audios[i] != e.target){
+                audios[i].pause();
+            }
+        }
+    }, true);
+}
+
+$(document).ready(fillAudioEmbeds);

data/assets/js/on_doc_ready/handle_includes.js

@@ -0,0 +1,175 @@
+
+/*
+Example: absoluteUrl("../subfolder1/divaspari.md", "images/forest-fire.jpg") == "../subfolder1/images/forest-fire.jpg"
+ */
+function absoluteUrl(base, relative) {
+    // console.debug(base, relative);
+    if (relative.startsWith("http") || relative.startsWith("file")) {
+        return relative;
+    }
+    if (relative.startsWith("/") && !base.startsWith("http") && !base.startsWith("file")) {
+        return relative;
+    }
+    var stack = base.toString().split("/"),
+        parts = relative.split("/");
+    stack.pop(); // remove current file name (or empty string)
+                 // (omit if "base" is the current folder without trailing slash)
+    for (var i=0; i<parts.length; i++) {
+        if (parts[i] == ".")
+            continue;
+        if (parts[i] == "..")
+            stack.pop();
+        else
+            stack.push(parts[i]);
+    }
+    return stack.join("/");
+}
+
+// WHen you include html from one page within another, you need to fix image urls, anchor urls etc..
+function fixIncludedHtml(url, html, newLevelForH1) {
+    // We want to use jquery to parse html, but without loading images. Hence this.
+    // Tip from: https://stackoverflow.com/questions/15113910/jquery-parse-html-without-loading-images
+    var virtualDocument = document.implementation.createHTMLDocument('virtual');
+    var jqueryElement = $(html, virtualDocument);
+
+    // console.debug(jqueryElement.html());
+    // Remove some tags.
+    jqueryElement.find("script").remove();
+    jqueryElement.find("footer").remove();
+    jqueryElement.find("#disqus_thread").remove();
+    jqueryElement.find("#toc").remove();
+    jqueryElement.find("#toc_header").remove();
+    jqueryElement.find(".back-to-top").remove();
+    // console.debug(jqueryElement.html());
+
+    // Deal with includes within includes. Do this before fixing images urls etc.. because there may be images within the newly included html.
+    jqueryElement.find('.js_include').each(function() {
+        if (newLevelForH1 < 1) {
+            console.error("Ignoring invalid newLevelForH1: %d, using 6", newLevelForH1);
+            newLevelForH1 = 6;
+        }
+        var jsIncludeElement = $(this);
+        var includedPageNewLevelForH2 = parseInt(jsIncludeJqueryElement.attr("newLevelForH1"));
+        if (includedPageNewLevelForH2 == undefined) {
+            includedPageNewLevelForH2 = 6;
+        }
+        includedPageNewLevelForH2 = Math.min(6, ((includedPageNewLevelForH2 - 2) + newLevelForH1));
+        fillJsInclude($(this), includedPageNewLevelForH2);
+    });
+
+    /*
+    Fix headers in the included html so as to not mess up the table of contents 
+    of the including page.
+    Adjusting the heading levels to retain substructure seems more complicated -
+    getting the heading "under" which jsIncludeJqueryElement falls seems non-trivial.
+     */
+    var headers = jqueryElement.find(":header");
+    if (headers.length > 0) {
+        var id_prefix = headers[0].id;
+        headers.replaceWith(function() {
+            var headerElement = $(this);
+            // console.debug(headerElement);
+            var hLevel = parseInt(headerElement.prop("tagName").substring(1));
+            var hLevelNew = Math.min(6, newLevelForH1 - 1 + hLevel);
+            var newId = id_prefix + "_" + headerElement[0].id;
+            return $("<h" + hLevelNew +" id='" + newId + "'/>").append(headerElement.contents());
+        });
+    }
+
+    // Fix image urls.
+    jqueryElement.find("img").each(function() {
+        // console.log(absoluteUrl(url, $(this).attr("src")));
+        // console.log($(this).attr("src"))
+        $(this).attr("src", absoluteUrl(url, $(this).attr("src")));
+        // console.log($(this).attr("src"))
+    });
+
+    // Fix links.
+    jqueryElement.find("a").each(function() {
+        // console.debug($(this).html());
+        var href = $(this).attr("href");
+        if (href.startsWith("#")) {
+            var headers = jqueryElement.find(":header");
+            var new_href = href;
+            if (headers.length > 0) {
+                var id_prefix = headers[0].id;
+                new_href = id_prefix + "_" + href.substr(1);
+                // console.debug(new_href, id_prefix, href);
+                jqueryElement.find(href).each(function () {
+                    $(this).attr("id", new_href.substr(1));
+                });
+            }
+            $(this).attr("href", new_href);
+        } else {
+            $(this).attr("href", absoluteUrl(url, href));
+        }
+    });
+
+    return jqueryElement;
+}
+
+function fillJsInclude(jsIncludeJqueryElement, includedPageNewLevelForH1) {
+    var includedPageUrl = jsIncludeJqueryElement.attr("url").replace(".md", ".html");
+    if (includedPageNewLevelForH1 == undefined) {
+        includedPageNewLevelForH1 = parseInt(jsIncludeJqueryElement.attr("newLevelForH1"));
+    }
+    if (includedPageNewLevelForH1 == undefined) {
+        includedPageNewLevelForH1 = 6;
+    }
+    $.ajax(includedPageUrl,{
+        success: function(responseHtml) {
+            // We want to use jquery to parse html, but without loading images. Hence this.
+            // Tip from: https://stackoverflow.com/questions/15113910/jquery-parse-html-without-loading-images
+            var virtualDocument = document.implementation.createHTMLDocument('virtual');
+
+            var titleElements = $(responseHtml, virtualDocument).find(".post-title-main");
+            var title = "";
+            if (titleElements.length > 0) {
+                // console.debug(titleElements[0]);
+                title = titleElements[0].textContent;
+            }
+
+            var contentElements = $(responseHtml, virtualDocument).find(".post-content");
+            // console.log(contentElements);
+            if (contentElements.length == 0) {
+                console.warn("Could not get \"post-content\" class element.");
+                console.log(responseHtml);
+            } else {
+                // We don't want multiple post-content divs, hence we replace with an included-post-content div.
+                var elementToInclude = $("<div class='included-post-content'/>")
+                var titleHtml = "";
+                if (jsIncludeJqueryElement.attr("includeTitle")) {
+                    titleHtml = "<h1 id='" + title + "'>" + title + "</h1>" +
+                    "<a class='btn btn-default' href='" + absoluteUrl(document.location, includedPageUrl) + "'>See separately</a>";
+                }
+                elementToInclude.html(titleHtml + contentElements[0].innerHTML);
+                var contentElement = fixIncludedHtml(includedPageUrl, elementToInclude, includedPageNewLevelForH1);
+                jsIncludeJqueryElement.html(contentElement);
+                fillAudioEmbeds();
+                fillVideoEmbeds();
+                updateToc();
+            }
+        },
+        error: function(xhr, error){
+            var titleHtml = "";
+            var title = "Missing page.";
+            if (jsIncludeJqueryElement.attr("includeTitle")) {
+                titleHtml = "<h1 id='" + title + "'>" + title + "</h1>";
+            }
+            jsIncludeJqueryElement.html(titleHtml + "Could not get: " + includedPageUrl + " See debug messages in console for details.");
+            console.debug(xhr); console.debug(error);
+        }
+    });
+}
+
+// Process includes of the form:
+// <div class="js_include" url="index.md"/> 
+$( document ).ready(function() {
+    $('.js_include').each(function() {
+        console.debug("Inserting include for " + $(this).html());
+        var jsIncludeJqueryElement = $(this);
+        // The actual filling happens in a separate thread!
+        fillJsInclude(jsIncludeJqueryElement);
+    });
+});
+

data/assets/js/on_doc_ready/sidebar.js

@@ -0,0 +1,119 @@
+$('#displayed_sidebar').height($(".nav").height());
+
+function getSidebarItemHtml(sidebarItem) {
+    var item_url_stripped = sidebarItem.url || "#";
+    item_url_stripped = item_url_stripped.replace("index.html", "").replace(".md", ".html");
+
+    var urlTarget = "";
+    if (item_url_stripped.startsWith("http://") || item_url_stripped.startsWith("https://") || item_url_stripped.startsWith("ftp://")) {
+        urlTarget = "_newTab";
+    }
+    var list_item_css_class = "inactive";
+    if (pageSettings.url.replace("#[^/]*$", "") == item_url_stripped) {
+        list_item_css_class = "active";
+    }
+    // console.debug(sidebarItem);
+    if(sidebarItem.hasOwnProperty("contents")) {
+        var contentHtml = "";
+        for(let subitem of sidebarItem.contents) {
+            contentHtml = `${contentHtml}\n ${getSidebarItemHtml(subitem)}`;
+        }
+        var title = sidebarItem.title || pageUrlToTitle[item_url_stripped];
+        var itemHtml = `<li><a href="${item_url_stripped}"> ${title}</a>\n<ul>${contentHtml}\n</ul>\n</li>\n`;
+    } else if (sidebarItem.url.startsWith("dir://")) {
+        var dirUrl = sidebarItem.url.replace("dir://", "/");
+        if (dirUrl.endsWith("/")) {
+            dirUrl = dirUrl.slice(0,-1);
+        }
+        if (dirUrl in pageDirectoryToUrl) {
+            var itemHtml = "";
+            // console.debug(dirUrl);
+            for (let contentUrl of pageDirectoryToUrl[dirUrl]) {
+                var subitem = {"url": contentUrl};
+                itemHtml = `${itemHtml}\n ${getSidebarItemHtml(subitem)}`;
+            }
+        } else {
+            console.error(`No such directory ${dirUrl}`)
+        }
+    }
+    else {
+        var title = sidebarItem.title || pageUrlToTitle[item_url_stripped];
+        var itemHtml = `<li class="${list_item_css_class}"><a href="${siteBaseurl + item_url_stripped }" target="">${title}</a></li>`;
+    }
+    return itemHtml;
+}
+
+function insertSidebarItems() {
+    var sidebar = siteData.sidebars[pageSettings.sidebar];
+    $("#displayed_sidebar .sidebarTitle").html(sidebar.title);
+    // console.debug(sidebar);
+    for (let sidebarItem of sidebar.contents) {
+        $("#displayed_sidebar").append(getSidebarItemHtml(sidebarItem));
+    }
+    // this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page.
+    $("li.active").parents('li').addClass("active");
+    $("li.active").parents('li').removeClass("inactive");
+}
+
+function insertTopnavDropdownItems() {
+    var topnavDropdown = siteData.sidebars[pageSettings.topnav];
+    // console.debug(topnavDropdown);
+    for (let item of topnavDropdown.contents) {
+        $("#topnav_dropdown").append(getSidebarItemHtml(item));
+    }
+    // this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page.
+    $("li.active").parents('li').addClass("active");
+    $("li.active").parents('li').removeClass("inactive");
+}
+
+$(document).ready(function() {
+    insertSidebarItems();
+    insertTopnavDropdownItems();
+    // Initialize navgoco sidebar with default options
+    $("#displayed_sidebar").navgoco({
+        caretHtml: '',
+        accordion: true,
+        openClass: 'active', // open
+        save: true,
+        cookie: {
+            name: 'navgoco_sidebar',
+            expires: false,
+            path: '/'
+        },
+        slide: {
+            duration: 400,
+            easing: 'swing'
+        }
+    });
+});
+
+$( document ).ready(function() {
+
+    //this script says, if the height of the viewport is greater than 800px, then insert affix class, which makes the nav bar float in a fixed
+    // position as your scroll. if you have a lot of nav items, this height may not work for you.
+    var h = $(window).height();
+    //console.log (h);
+    if (h > 800) {
+        $( "#displayed_sidebar" ).attr("class", "nav affix");
+    }
+
+    /**
+     * AnchorJS
+     */
+    anchors.add('h2,h3,h4,h5');
+
+});
+
+// Code to make the "Nav" button, which toggles the sidebar.
+var toggleSidebar = function() {
+    $("#tg-sb-sidebar").toggle();
+    $("#tg-sb-icon").toggleClass('fa-toggle-on');
+    $("#tg-sb-icon").toggleClass('fa-toggle-off');
+    $("#tg-sb-icon-content-pane").toggleClass('fa-toggle-on');
+    $("#tg-sb-icon-content-pane").toggleClass('fa-toggle-off');
+};
+
+$(document).ready(function() {
+    $("#tg-sb-link").click(toggleSidebar);
+    $("#hide-sb-link").click(toggleSidebar);
+});

data/assets/js/on_doc_ready/toc.js

@@ -0,0 +1,159 @@
+function get_toc_item_id(header_id) {
+    return "toc_item_" + header_id;
+}
+
+// https://github.com/ghiculescu/jekyll-table-of-contents
+// This is how a jquery plugin is defined - https://stackoverflow.com/questions/2937227/what-does-function-jquery-mean .
+$.fn.toc = function(options) {
+    console.debug("Setting up TOC for " + document.location);
+    var defaults = {
+      noBackToTopLinks: false,
+      title: '',
+      minimumHeaders: 3,
+      headers: 'h1, h2, h3, h4',
+      listType: 'ol', // values: [ol|ul]
+    },
+    settings = $.extend(defaults, options);
+    
+    // console.debug($(settings.headers));
+    var headers = $(settings.headers).filter(function() {
+      // get all headers with an ID
+      var previousSiblingName = $(this).prev().attr( "name" );
+      if (!this.id && previousSiblingName) {
+        this.id = $(this).attr( "id", previousSiblingName.replace(/\./g, "-") );
+      }
+      return this.id;
+    }), output = $(this);
+    if (!headers.length || headers.length < settings.minimumHeaders || !output.length) {
+      return;
+    }
+    // console.debug(headers);
+    
+    var get_level = function(ele) { return parseInt(ele.nodeName.replace("H", ""), 10); }
+    var highest_level = headers.map(function(_, ele) { return get_level(ele); }).get().sort()[0];
+    
+    var level = get_level(headers[0]),
+      this_level,
+      html = settings.title + " <"+settings.listType+" id=\"toc_ul\" class=\"nav\">";
+    headers.on('click', function() {
+      if (!settings.noBackToTopLinks) {
+        window.location.hash = this.id;
+      }
+    })
+    .addClass('clickable-header')
+    .each(function(_, header) {
+      this_level = get_level(header);
+      if (!settings.noBackToTopLinks && this_level === highest_level) {
+        $(header).addClass('top-level-header');
+      }
+      var toc_item_id = get_toc_item_id(header.id);
+      if (this_level === level) // same level as before; same indenting
+        html += "<li id='" + toc_item_id + "'><a href='#" + header.id + "'>" + header.innerText + "</a>";
+      else if (this_level <= level){ // higher level than before; end parent ol
+        for(i = this_level; i < level; i++) {
+          html += "</li></"+settings.listType+">"
+        }
+        html += "<li  id='" + toc_item_id + "'><a href='#" + header.id + "'>" + header.innerText + "</a>";
+      }
+      else if (this_level > level) { // lower level than before; expand the previous to contain a ol
+        for(i = this_level; i > level; i--) {
+          html += "<"+settings.listType+">";
+          if(i == level + 1) {
+              html +=  "<li id='" + toc_item_id + "'>";
+          } else {
+              html += "<li>";
+          }
+        }
+        html += "<a href='#" + header.id + "'>" + header.innerText + "</a>";
+      }
+      level = this_level; // update for the next one
+    });
+    html += "</"+settings.listType+">";
+    
+    headers.each(function () {
+      var header = $(this);
+      if (!header.next().hasClass("back-to-top")){
+          // There is a javascript click listener (defined later in this file) for the below to scroll up.
+          var return_to_top = $('<div id="toc_up_' + header.attr('id') + '" class="icon-arrow-up back-to-top" style="text-align:right;">Up↑</div>');
+          var toc_item_id = get_toc_item_id(header.attr('id'));
+          return_to_top.click(function () {
+              // First, set up the right selections in the table-of-contents menu.
+              // So, the user can follow the trail of highlights menu items and expand the menu items till he reaches the appropriate level.
+              // On 20181119, I spent close to a working day messing with the menu getting it to expand to the right spot; but on realizing that the above is good enough, gave up.
+              var itemToActivate = undefined;
+              $("#toc_ul").find("li").each(function (liIndex, liElement) {
+                  // console.debug(liIndex, liElement);
+                  if (liElement.id == toc_item_id) {
+                      itemToActivate = $(this);
+                  } else {
+                      $(this).removeClass("active");
+                  }
+              });
+              itemToActivate.addClass("active");
+              itemToActivate.parents("li").addClass("active"); // This call is ineffective for some reason.
+              
+              // Now scroll up.
+              $([document.documentElement, document.body]).animate({
+                  scrollTop: $("[id='" + toc_item_id + "']").offset().top
+              }, 100);
+          });
+          header.after(return_to_top);
+      }
+    })
+    
+    output.html(html);
+    resetNavgocoMenu();
+    // Finally, set up navgoco options.
+};
+
+function resetNavgocoMenu() {
+    $('#toc_ul').navgoco({
+        accordion: true,
+        openClass: 'active', // open
+        save: false,
+        caretHtml: '...', // Make it easier to expand the drawers by increasing click-capture area.
+        cookie: {
+            name: 'navgoco_toc',
+            expires: false,
+            path: '/'
+        },
+        slide: {
+            duration: 0, // 400ms was causing screen shakes with scrolling to the top by pressing the Up bottons.
+            easing: 'swing'
+        }
+    });
+    // console.debug("Set up navgoco.");
+    $("#toc_ul").navgoco('toggle', false);
+}
+
+function updateToc() {
+    $('#toc').toc({minimumHeaders: 0, listType: 'ul', headers: 'h2,h3,h4,h5,h6'});
+}
+
+// Update table of contents (To be called whenever page contents are updated).
+$( document ).ready(updateToc);
+
+
+
+// Code to make the "Nav" button, which toggles the table of contents.
+// Not to be confused with toggling sub-items in that menu.
+var toggleToc = function() {
+    $("#toc").toggle();
+    $("#toggle-toc-icon").toggleClass('fa-toggle-on');
+    $("#toggle-toc-icon").toggleClass('fa-toggle-off');
+};
+
+function toggleTocExpansion() {
+    $("#toggle-toc-expansion-icon").toggleClass('fa-toggle-on');
+    $("#toggle-toc-expansion-icon").toggleClass('fa-toggle-off');
+    if($("#toggle-toc-expansion-icon").hasClass('fa-toggle-on')) {
+        $("#toc_ul").navgoco('toggle', true);
+    } else {
+        $("#toc_ul").navgoco('toggle', false);
+    }
+}
+
+$(document).ready(function() {
+    $("#toggle-toc-icon").click(toggleToc);
+    $("#toggle-toc-expansion-icon").click(toggleTocExpansion);
+});