Add JS to view glossary

Author: jvns

assets/sass/reference.scss

@@ -57,6 +57,45 @@ h3.plumbing {
   @include background-image-2x($baseurl + "images/icons/plumbing-sm", 17px, 14px, 2px 50%);
 }
 
+.tooltip {
+  background: white;
+  position: absolute;
+  border: 1px solid #ccc;
+  border-radius: 4px;
+  padding: 10px;
+  box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1);
+  max-width: 300px;
+  font-size: 14px;
+  line-height: 1.4;
+  visibility: hidden;
+}
+
+.tooltip.show {
+  visibility: visible;
+}
+
+.expand-icon {
+  position: absolute;
+  top: 8px;
+  right: 8px;
+  text-decoration: none;
+  
+  img {
+    width: 16px;
+    height: 16px;
+    opacity: 0.6;
+  }
+  
+  &:hover img {
+    opacity: 1;
+  }
+}
+
+.hover-term {
+  cursor: help;
+  text-decoration: underline dotted;
+}
+
 // § section sign anchor links
 #content {
   h1>a.anchor,

layouts/_default/baseof.html

@@ -147,6 +147,8 @@ <h3 hidden="true" data-pagefind-weight="{{ $weight }}">{{ $command_name }}</h3>
         </div>
       </div>
       {{ partialCached "footer.html" . }}
+      <script src="{{ relURL "js/nanopop.umd.js" }}"></script>
+      <script src="{{ relURL "js/glossary.js" }}"></script>
     </div>
   {{ else }}
     <div class="inner">

script/update-docs.rb

@@ -116,6 +116,8 @@ def extract_glossary_from_html(content)
     term_names = []
     if term_name == "tree-ish (also treeish)"
       term_names = ['tree-ish', 'treeish']
+    elsif term_name == "arbre-esque (aussi arbresque)"
+      term_names = [''arbre-esque, 'arbresque']
     else
       term_names = [term_name]
     end

static/images/external-link.svg

@@ -0,0 +1,97 @@
+var GitGlossary = {
+  data: null,
+  term: null,
+  tooltip: null,
+
+  init: function() {
+    const language = document.querySelector("html")?.getAttribute("lang") || 'en';
+    $.getJSON(baseURLPrefix + 'js/glossary/' + language + '.json')
+      .done((data) => this.onDataLoaded(data));
+    window.addEventListener('resize', () => this.reposition())
+  },
+
+  onDataLoaded: function(data) {
+    this.data = data;
+    const content = document.querySelector('#content');
+
+    // Create the popover element
+    document.body.insertAdjacentHTML('beforeend',
+      '<div class="tooltip"></div>'
+    );
+    this.tooltip = document.body.lastElementChild;
+    this.attachHoverEvents(content);
+  },
+
+  show: function() {
+    this.tooltip.classList.add('show');
+    this.reposition();
+  },
+
+  hide: function() {
+    this.tooltip.classList.remove('show');
+  },
+
+  reposition: function() {
+    const result = NanoPop.reposition(this.term, this.tooltip, {
+      position: 'bottom',
+      margin: 8,
+      container: {
+        top: 0,
+        left: 0,
+        bottom: window.innerHeight,
+        right: window.innerWidth
+      }
+    });
+  },
+
+  attachHoverEvents: function(content) {
+    let timeout = undefined;
+
+    content.addEventListener('mouseover', (e) => {
+      if (e.target.classList.contains('hover-term')) {
+        console.log(this.term);
+        this.term = e.target;
+        const term = e.target.dataset.term;
+        const definition = this.data[term] || '';
+        const truncatedDefinition = this.truncateWords(definition, 60);
+
+        this.tooltip.innerHTML = `
+            <a href="#" class="expand-icon">
+              <img src="${baseURLPrefix}images/external-link.svg" alt="expand" />
+            </a>
+            <strong>&lt;${term}&gt;</strong><br><br>
+            ${truncatedDefinition}
+          `;
+        this.show();
+      }
+    });
+
+    content.addEventListener('mouseout', (e) => {
+      if (e.target.classList.contains('hover-term')) {
+        this.hide();
+      }
+    });
+
+    // Keep popover open when hovering over it
+    this.tooltip.addEventListener('mouseenter', () => {
+      this.show();
+    });
+
+    this.tooltip.addEventListener('mouseleave', () => {
+      this.hide();
+    });
+  },
+
+  truncateWords: function(text, maxWords) {
+    const words = text.split(/\s+/);
+    if (words.length <= maxWords) {
+      return text;
+    }
+    return words.slice(0, maxWords).join(' ') + '...';
+  },
+};
+
+// Initialize when document is ready
+$(document).ready(() => {
+  GitGlossary.init();
+});