Source: document.js

  1. /**
  2.  * @file Build table of contents and index.
  3.  * @version April 20, 2017
  4.  *
  5.  * @author Olivier Pirson --- http://www.opimedia.be/
  6.  * @license GPLv3 --- Copyright (C) 2017 Olivier Pirson
  7.  */
  9. (function () {
  10.     "use strict";
  12.     /**
  13.      * Build index
  14.      * in a HTML list in #Index
  15.      * with all .index with a id.
  16.      */
  17.     function buildIndex() {
  18.         const elements = document.getElementsByClassName("index");
  19.         const indices = [];
  21.         for (let element of elements) {
  22.             const id = element.id;
  24.             if (id) {
  25.                 indices.push([element.innerHTML, id]);
  26.             }
  27.         }
  29.         indices.sort(function(a, b) {
  30.             a = a[0].toUpperCase();
  31.             b = b[0].toUpperCase();
  33.             return (a < b
  34.                     ? -1
  35.                     : (a > b
  36.                        ? 1
  37.                        : 0));
  38.         });
  40.         const lists = document.getElementById("Index").children[1].children;
  42.         for (let i = 0; i < indices.length; ++i) {
  43.             const index = indices[i];
  44.             const li = document.createElement("li");
  46.             li.innerHTML = '<a href="#' + index[1] + '">' + index[0] + '</a>';
  48.             lists[(i > indices.length/3
  49.                    ? (i > 2*indices.length/3
  50.                       ? 2
  51.                       : 1)
  52.                    : 0)].appendChild(li);
  53.         }
  54.     }
  57.     /**
  58.      * Build the table of contents
  59.      * in a HTML list listHtmlElement
  60.      * with all id and > header > h* of sectionHtmlElements
  61.      * and recursively for subsections.
  62.      *
  63.      * @param {HTMLElement} listHtmlElement
  64.      * @param {HTMLCollection} sectionHtmlElements
  65.      */
  66.     function buildTableOfContents(listHtmlElement, sectionHtmlElements) {
  67.         assert(listHtmlElement instanceof HTMLElement, listHtmlElement);
  68.         assert(sectionHtmlElements instanceof HTMLCollection, sectionHtmlElements);
  70.         for (let section of sectionHtmlElements) {
  71.             const id = section.id;
  73.             if (id !== "Contents") {
  74.                 const hContent = section.children[0].children[0].innerHTML;
  75.                 const matches = /^((.|\n)+)<a.+?<\/a>$/im.exec(hContent);
  76.                 const title = matches[1];
  78.                 const li = document.createElement("li");
  80.                 li.innerHTML = '<a href="#' + id + '">' + title + '</a>';
  82.                 const subSections = section.getElementsByTagName("section");
  84.                 if (subSections) {
  85.                     const subList = document.createElement("ul");
  87.                     buildTableOfContents(subList, subSections);
  88.                     li.appendChild(subList);
  89.                 }
  91.                 listHtmlElement.appendChild(li);
  92.             }
  93.         }
  94.     }
  98.     window.addEventListener("load", function () {
  99.         buildIndex();
  100.         buildTableOfContents(document.getElementById("Contents").children[1].children[0],
  101.                              document.getElementsByTagName("main")[0].children);
  104.         // Show/hide subsections in the table contents panel
  105.         document.getElementById("button-Contents-expand-collapse")
  106.             .addEventListener("click",
  107.                               function () {
  108.                                   const contents = document.getElementById("Contents");
  110.                                   cssInvertClass(contents, "collapse");
  111.                               },
  112.                               false);
  114.         // Show/hide the table contents panel
  115.         document.getElementById("button-Contents-on-off")
  116.             .addEventListener("click",
  117.                               function () {
  118.                                   const contents = document.getElementById("Contents");
  120.                                   cssInvertClass(contents, "off");
  121.                               },
  122.                               false);
  123.     });
  124. }());