toc-css.lua

--[[
https://github.com/cysouw/toc-css

toc-css.lua: lua script to add CSS and Vanilla Javascript to native Pandoc HTML output
Formats HTML table of content as produced by Pandoc to the top left of the document

Copyright © 2021 Michael Cysouw <cysouw@mac.com>

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
]]

css = [[
<!-- CSS added by filter 'toc-css.lua' for TOC hovering to the side -->
<!-- TODO: try doing sometthing in px instead of cm to make it more device independent -->
<style>
body {
  padding-left: 1.5cm;
  padding-right: 1cm;
  transition: 0.5s;
}
nav {
  width: 1cm;
  margin-left: -1.5cm;
  color: grey;
  transition: 0.5s;
  float: left;
  position: fixed;
  top: 0;
  bottom: 0;
  white-space: nowrap;
  overflow: hidden;
  overflow-y: scroll;
  transition: 0.5s;
  z-index: 10;
}
nav::-webkit-scrollbar {
  display: none;
}
nav a, nav a:visited {
  color: grey;
}
nav h2:before {
  content: "≡ ";
  font-size: 150%;
}
nav h2:after {
  content: " ◂";
}
nav > ul {
  padding-left: 1em;
}
nav li {
  margin-left: 1em;
  padding-left: 0;
  white-space: nowrap;
  overflow: hidden;
  text-overflow: ellipsis;
}
nav ul {
  padding-left: 1em;
  margin-left: 0;
}
nav li > a:not(:only-child):before {
  content: "▸ ";
}
nav li li li {
  font-size: smaller;
}
nav ul li ul  {
  visibility: hidden;
  display: none;
  margin-top: 0.2em;
  margin-bottom: 0.2em;
  transition: 0.5s;
}
.paddingleft {
  padding-left: 11cm;
  transition: 0.5s;
}
.navside {
  width: 10cm;
  margin-left: -10.5cm;
  padding-right: 1em;
  transition: 0.5s;
}
.navside h2:after {
  content: " ▸ ";
}
.navshown {
  width: 50%;
  transition: 0.5s;
  background-color: rgba(16, 13, 13, 0.95);
}
.subShow > ul {
  visibility: visible;
  display: block;
  transition: 0.5s;
}
.subShow > a:not(:only-child):before {
  content: " ▾ ";
}

.toc-invisible {
  visibility: hidden;
}
.navside > .toc-invisible {
  visibility: visible;
}
.navshown > .toc-invisible {
  visibility: visible;
}
</style>
]]

-----------------------------

script = [[

<!-- Javascript added by toc-css.lua to make TOC expandable on click -->
<script>

  const b = document.querySelector("body");
  const n = document.querySelector("nav");
  const buttonsize = 15;

  // click on "toc-title" to show TOC to the side
  document.querySelector("#toc-title").addEventListener("click", function(e) {
    if (e.clientX < e.currentTarget.getBoundingClientRect().left + buttonsize) {
      n.classList.toggle("navshown");
    } else {
      b.classList.toggle("paddingleft");
      n.classList.toggle("navside");
      n.classList.remove("navshown");
    };
  });

  // by default show TOC in large window
  window.onload = function() {
    if (window.innerWidth > 1000) {
      b.classList.add("paddingleft");
      n.classList.add("navside");
    };
  };

  // show/hide TOC on resize
  window.onresize = function () {
    // scrolling on mobile devices triggers resize, so we disable it altogether (for now)
    if (typeof window.orientation !== 'undefined') {
      return;
    };

    if (window.innerWidth > 1000) {
      b.classList.add("paddingleft");
      n.classList.add("navside");
    } else {
      b.classList.remove("paddingleft");
      n.classList.remove("navside");
    };
  };

  // show/hide subsections
  const allLis = document.querySelectorAll("nav li");

  for (const li of allLis) {
    li.addEventListener('click', function (e) {
      // show/hide subsection if arrow is clicked
      if (e.clientX < e.currentTarget.getBoundingClientRect().left + buttonsize
        && e.clientY < e.currentTarget.getBoundingClientRect().top + buttonsize) {

        li.classList.toggle('subShow');
        e.preventDefault();
      };

      // hide full nav if clicked outside
      if (e.currentTarget.getBoundingClientRect().left + 3*buttonsize < e.clientX) {
        n.classList.remove("navshown");
      };
    });

    li.classList.add('subShow');
  };

  // hide ToC if no overruling
  document.querySelector("nav ul").classList.add("toc-invisible");

  // show full nav on tab, hide full nav on escape
  document.addEventListener("keydown", function (e) {
    if (e.which === 27) {
      n.classList.remove("navshown");
      e.preventDefault();
    };
    if (e.which === 9) {
      n.classList.add("navshown");
      e.preventDefault();
    };
  });

  // insert key info
  n.insertAdjacentHTML("beforeend", "<span class='toc-invisible'> \
                                     <br/> \
                                     <p>Press <kbd>Tab</kbd> to show extended width TOC.</p> \
                                     <p>Presss <kbd>Esc</kbd> to go back to normal width.</p> \
                                     </span>");

  // hide full nav when clicked outside
  document.addEventListener("click", function(e) {
    if (n.classList.contains("navshown")) {
      if (!n.contains(e.target)) {
        n.classList.remove("navshown");
      };
    };
  });

</script>
]]

----------------------------

function addCSS (meta)
  -- read current "header-includes" from metadata, or make a new one
  -- and add css to the end of "header-includes"
  local current = meta['header-includes'] or pandoc.MetaList{meta['header-includes']}
  current[#current+1] = pandoc.MetaBlocks(pandoc.RawBlock("html", css))
  meta['header-includes'] = current
  -- add default toc-title if there is none
  if meta['toc-title'] == nil then
    meta['toc-title'] = "Contents"
  end
  -- return metadata
  return(meta)
end

----------------------------

function addScript (doc)
  -- add javascript to the end of the document
  table.insert(doc.blocks, pandoc.RawBlock("html", script) )
  return(doc)
end

----------------------------

return {
  { Meta = addCSS },
  { Pandoc = addScript }
}