https://github.com/andrie/quarto-gongtimer

A timer for quarto reveal.js presentations, based on the ElapsedTimeBar extension
https://github.com/andrie/quarto-gongtimer

Last synced: about 1 month ago
JSON representation

A timer for quarto reveal.js presentations, based on the ElapsedTimeBar extension

• Host: GitHub
• URL: https://github.com/andrie/quarto-gongtimer
• Owner: andrie
• License: mit
• Created: 2024-01-30T15:27:08.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-12T10:09:01.000Z (about 1 year ago)
• Last Synced: 2025-02-14T13:16:56.453Z (3 months ago)
• Language: HTML
• Homepage: https://andrie.quarto.pub/gongtimer
• Size: 45.9 KB
• Stars: 13
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.html
  • License: LICENSE

Awesome Lists containing this project

README

        


readme

code{white-space: pre-wrap;}

span.smallcaps{font-variant: small-caps;}

div.columns{display: flex; gap: min(4vw, 1.5em);}

div.column{flex: auto; overflow-x: auto;}

div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}

ul.task-list{list-style: none;}

ul.task-list li input[type="checkbox"] {

  width: 0.8em;

  margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */ 

  vertical-align: middle;

}

/* CSS for syntax highlighting */

pre > code.sourceCode { white-space: pre; position: relative; }

pre > code.sourceCode > span { line-height: 1.25; }

pre > code.sourceCode > span:empty { height: 1.2em; }

.sourceCode { overflow: visible; }

code.sourceCode > span { color: inherit; text-decoration: inherit; }

div.sourceCode { margin: 1em 0; }

pre.sourceCode { margin: 0; }

@media screen {

div.sourceCode { overflow: auto; }

}

@media print {

pre > code.sourceCode { white-space: pre-wrap; }

pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }

}

pre.numberSource code

  { counter-reset: source-line 0; }

pre.numberSource code > span

  { position: relative; left: -4em; counter-increment: source-line; }

pre.numberSource code > span > a:first-child::before

  { content: counter(source-line);

    position: relative; left: -1em; text-align: right; vertical-align: baseline;

    border: none; display: inline-block;

    -webkit-touch-callout: none; -webkit-user-select: none;

    -khtml-user-select: none; -moz-user-select: none;

    -ms-user-select: none; user-select: none;

    padding: 0 4px; width: 4em;

  }

pre.numberSource { margin-left: 3em;  padding-left: 4px; }

div.sourceCode

  {   }

@media screen {

pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }

}



gong

A quarto extension for reveal.js that adds an elapsed time bar at the bottom of the presentation.

This is based on the ElapsedTimeBar Reveal.js extension

https://github.com/wicksome/reveal.js-elapsed-time-bar


Installation

To install this extension in your current directory (or into the Quarto project that you’re currently working in), use the following command:

quarto install extension andrie/quarto-gongtimer


Enabling

Add this to your document or project options:

format: 

  revealjs:

    gongtimer:

      - allottedTime: 1

revealjs-plugins: 

  - gongtimer


Global options

You can change these options:


Option

Description

allottedTime

Time in minutes for the presentation

progressBarHeight

Height (in pixels) of the page / time progress bar

barColor

Bar color, expressed as hex #00ff00 or rgb(0, 255, 0)

window.document.addEventListener("DOMContentLoaded", function (event) {

  const toggleBodyColorMode = (bsSheetEl) => {

    const mode = bsSheetEl.getAttribute("data-mode");

    const bodyEl = window.document.querySelector("body");

    if (mode === "dark") {

      bodyEl.classList.add("quarto-dark");

      bodyEl.classList.remove("quarto-light");

    } else {

      bodyEl.classList.add("quarto-light");

      bodyEl.classList.remove("quarto-dark");

    }

  }

  const toggleBodyColorPrimary = () => {

    const bsSheetEl = window.document.querySelector("link#quarto-bootstrap");

    if (bsSheetEl) {

      toggleBodyColorMode(bsSheetEl);

    }

  }

  toggleBodyColorPrimary();  

  const icon = "";

  const anchorJS = new window.AnchorJS();

  anchorJS.options = {

    placement: 'right',

    icon: icon

  };

  anchorJS.add('.anchored');

  const isCodeAnnotation = (el) => {

    for (const clz of el.classList) {

      if (clz.startsWith('code-annotation-')) {                     

        return true;

      }

    }

    return false;

  }

  const clipboard = new window.ClipboardJS('.code-copy-button', {

    text: function(trigger) {

      const codeEl = trigger.previousElementSibling.cloneNode(true);

      for (const childEl of codeEl.children) {

        if (isCodeAnnotation(childEl)) {

          childEl.remove();

        }

      }

      return codeEl.innerText;

    }

  });

  clipboard.on('success', function(e) {

    // button target

    const button = e.trigger;

    // don't keep focus

    button.blur();

    // flash "checked"

    button.classList.add('code-copy-button-checked');

    var currentTitle = button.getAttribute("title");

    button.setAttribute("title", "Copied!");

    let tooltip;

    if (window.bootstrap) {

      button.setAttribute("data-bs-toggle", "tooltip");

      button.setAttribute("data-bs-placement", "left");

      button.setAttribute("data-bs-title", "Copied!");

      tooltip = new bootstrap.Tooltip(button, 

        { trigger: "manual", 

          customClass: "code-copy-button-tooltip",

          offset: [0, -8]});

      tooltip.show();    

    }

    setTimeout(function() {

      if (tooltip) {

        tooltip.hide();

        button.removeAttribute("data-bs-title");

        button.removeAttribute("data-bs-toggle");

        button.removeAttribute("data-bs-placement");

      }

      button.setAttribute("title", currentTitle);

      button.classList.remove('code-copy-button-checked');

    }, 1000);

    // clear code selection

    e.clearSelection();

  });

  function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) {

    const config = {

      allowHTML: true,

      maxWidth: 500,

      delay: 100,

      arrow: false,

      appendTo: function(el) {

          return el.parentElement;

      },

      interactive: true,

      interactiveBorder: 10,

      theme: 'quarto',

      placement: 'bottom-start',

    };

    if (contentFn) {

      config.content = contentFn;

    }

    if (onTriggerFn) {

      config.onTrigger = onTriggerFn;

    }

    if (onUntriggerFn) {

      config.onUntrigger = onUntriggerFn;

    }

    window.tippy(el, config); 

  }

  const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');

  for (var i=0; i<noterefs.length; i++) {

    const ref = noterefs[i];

    tippyHover(ref, function() {

      // use id or data attribute instead here

      let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');

      try { href = new URL(href).hash; } catch {}

      const id = href.replace(/^#\/?/, "");

      const note = window.document.getElementById(id);

      return note.innerHTML;

    });

  }

  const xrefs = window.document.querySelectorAll('a.quarto-xref');

  const processXRef = (id, note) => {

    // Strip column container classes

    const stripColumnClz = (el) => {

      el.classList.remove("page-full", "page-columns");

      if (el.children) {

        for (const child of el.children) {

          stripColumnClz(child);

        }

      }

    }

    stripColumnClz(note)

    const typesetMath = (el) => {

      if (window.MathJax) {

        // MathJax Typeset

        window.MathJax.typeset([el]);

      } else if (window.katex) {

        // KaTeX Render

        var mathElements = el.getElementsByClassName("math");

        var macros = [];

        for (var i = 0; i < mathElements.length; i++) {

          var texText = mathElements[i].firstChild;

          if (mathElements[i].tagName == "SPAN") {

            window.katex.render(texText.data, mathElements[i], {

              displayMode: mathElements[i].classList.contains('display'),

              throwOnError: false,

              macros: macros,

              fleqn: false

            });

          }

        }

      }

    }

    if (id === null || id.startsWith('sec-')) {

      // Special case sections, only their first couple elements

      const container = document.createElement("div");

      if (note.children && note.children.length > 2) {

        container.appendChild(note.children[0].cloneNode(true));

        for (let i = 1; i < note.children.length; i++) {

          const child = note.children[i];

          if (child.tagName === "P" && child.innerText === "") {

            continue;

          } else {

            container.appendChild(child.cloneNode(true));

            break;

          }

        }

        typesetMath(container);

        return container.innerHTML

      } else {

        typesetMath(note);

        return note.innerHTML;

      }

    } else {

      // Remove any anchor links if they are present

      const anchorLink = note.querySelector('a.anchorjs-link');

      if (anchorLink) {

        anchorLink.remove();

      }

      typesetMath(note);

      return note.innerHTML;

    }

  }

  for (var i=0; i<xrefs.length; i++) {

    const xref = xrefs[i];

    tippyHover(xref, undefined, function(instance) {

      instance.disable();

      let url = xref.getAttribute('href');

      let hash = undefined; 

      if (url.startsWith('#')) {

        hash = url;

      } else {

        try { hash = new URL(url).hash; } catch {}

      }

      if (hash) {

        const id = hash.replace(/^#\/?/, "");

        const note = window.document.getElementById(id);

        if (note !== null) {

          try {

            const html = processXRef(id, note.cloneNode(true));

            instance.setContent(html);

          } finally {

            instance.enable();

            instance.show();

          }

        } else {

          // See if we can fetch this

          fetch(url.split('#')[0])

          .then(res => res.text())

          .then(html => {

            const parser = new DOMParser();

            const htmlDoc = parser.parseFromString(html, "text/html");

            const note = htmlDoc.getElementById(id);

            if (note !== null) {

              const html = processXRef(id, note);

              instance.setContent(html);

            } 

          }).finally(() => {

            instance.enable();

            instance.show();

          });

        }

      } else {

        // See if we can fetch a full url (with no hash to target)

        // This is a special case and we should probably do some content thinning / targeting

        fetch(url)

        .then(res => res.text())

        .then(html => {

          const parser = new DOMParser();

          const htmlDoc = parser.parseFromString(html, "text/html");

          const note = htmlDoc.querySelector('main.content');

          if (note !== null) {

            // This should only happen for chapter cross references

            // (since there is no id in the URL)

            // remove the first header

            if (note.children.length > 0 && note.children[0].tagName === "HEADER") {

              note.children[0].remove();

            }

            const html = processXRef(null, note);

            instance.setContent(html);

          } 

        }).finally(() => {

          instance.enable();

          instance.show();

        });

      }

    }, function(instance) {

    });

  }

      let selectedAnnoteEl;

      const selectorForAnnotation = ( cell, annotation) => {

        let cellAttr = 'data-code-cell="' + cell + '"';

        let lineAttr = 'data-code-annotation="' +  annotation + '"';

        const selector = 'span[' + cellAttr + '][' + lineAttr + ']';

        return selector;

      }

      const selectCodeLines = (annoteEl) => {

        const doc = window.document;

        const targetCell = annoteEl.getAttribute("data-target-cell");

        const targetAnnotation = annoteEl.getAttribute("data-target-annotation");

        const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation));

        const lines = annoteSpan.getAttribute("data-code-lines").split(",");

        const lineIds = lines.map((line) => {

          return targetCell + "-" + line;

        })

        let top = null;

        let height = null;

        let parent = null;

        if (lineIds.length > 0) {

            //compute the position of the single el (top and bottom and make a div)

            const el = window.document.getElementById(lineIds[0]);

            top = el.offsetTop;

            height = el.offsetHeight;

            parent = el.parentElement.parentElement;

          if (lineIds.length > 1) {

            const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]);

            const bottom = lastEl.offsetTop + lastEl.offsetHeight;

            height = bottom - top;

          }

          if (top !== null && height !== null && parent !== null) {

            // cook up a div (if necessary) and position it 

            let div = window.document.getElementById("code-annotation-line-highlight");

            if (div === null) {

              div = window.document.createElement("div");

              div.setAttribute("id", "code-annotation-line-highlight");

              div.style.position = 'absolute';

              parent.appendChild(div);

            }

            div.style.top = top - 2 + "px";

            div.style.height = height + 4 + "px";

            div.style.left = 0;

            let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter");

            if (gutterDiv === null) {

              gutterDiv = window.document.createElement("div");

              gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter");

              gutterDiv.style.position = 'absolute';

              const codeCell = window.document.getElementById(targetCell);

              const gutter = codeCell.querySelector('.code-annotation-gutter');

              gutter.appendChild(gutterDiv);

            }

            gutterDiv.style.top = top - 2 + "px";

            gutterDiv.style.height = height + 4 + "px";

          }

          selectedAnnoteEl = annoteEl;

        }

      };

      const unselectCodeLines = () => {

        const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"];

        elementsIds.forEach((elId) => {

          const div = window.document.getElementById(elId);

          if (div) {

            div.remove();

          }

        });

        selectedAnnoteEl = undefined;

      };

        // Handle positioning of the toggle

    window.addEventListener(

      "resize",

      throttle(() => {

        elRect = undefined;

        if (selectedAnnoteEl) {

          selectCodeLines(selectedAnnoteEl);

        }

      }, 10)

    );

    function throttle(fn, ms) {

    let throttle = false;

    let timer;

      return (...args) => {

        if(!throttle) { // first call gets through

            fn.apply(this, args);

            throttle = true;

        } else { // all the others get throttled

            if(timer) clearTimeout(timer); // cancel #2

            timer = setTimeout(() => {

              fn.apply(this, args);

              timer = throttle = false;

            }, ms);

        }

      };

    }

      // Attach click handler to the DT

      const annoteDls = window.document.querySelectorAll('dt[data-target-cell]');

      for (const annoteDlNode of annoteDls) {

        annoteDlNode.addEventListener('click', (event) => {

          const clickedEl = event.target;

          if (clickedEl !== selectedAnnoteEl) {

            unselectCodeLines();

            const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active');

            if (activeEl) {

              activeEl.classList.remove('code-annotation-active');

            }

            selectCodeLines(clickedEl);

            clickedEl.classList.add('code-annotation-active');

          } else {

            // Unselect the line

            unselectCodeLines();

            clickedEl.classList.remove('code-annotation-active');

          }

        });

      }

  const findCites = (el) => {

    const parentEl = el.parentElement;

    if (parentEl) {

      const cites = parentEl.dataset.cites;

      if (cites) {

        return {

          el,

          cites: cites.split(' ')

        };

      } else {

        return findCites(el.parentElement)

      }

    } else {

      return undefined;

    }

  };

  var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');

  for (var i=0; i<bibliorefs.length; i++) {

    const ref = bibliorefs[i];

    const citeInfo = findCites(ref);

    if (citeInfo) {

      tippyHover(citeInfo.el, function() {

        var popup = window.document.createElement('div');

        citeInfo.cites.forEach(function(cite) {

          var citeDiv = window.document.createElement('div');

          citeDiv.classList.add('hanging-indent');

          citeDiv.classList.add('csl-entry');

          var biblioDiv = window.document.getElementById('ref-' + cite);

          if (biblioDiv) {

            citeDiv.innerHTML = biblioDiv.innerHTML;

          }

          popup.appendChild(citeDiv);

        });

        return popup.innerHTML;

      });

    }

  }

});