✨ Implement make-glossary

The-Notebookinator · May 21, 2024 · 09baab2 · 09baab2
1 parent ae63080
commit 09baab2
Show file tree

Hide file tree

Showing 5 changed files with 126 additions and 80 deletions.
diff --git a/themes/linear/components/glossary.typ b/themes/linear/components/glossary.typ
@@ -1,17 +1,26 @@
-#import "../../../utils.typ"
-
-#let glossary() = utils.print-glossary(
-  glossary => {
-    stack(
-      dir: ttb,
-      spacing: 15pt,
-      ..for entry in glossary {([
-        #box(inset: 0.5em, fill: gray)[== #entry.word]
-        #h(5pt)
-        #box(baseline: -10pt, width: 1fr, line(length: 100%))
+#import "/utils.typ"
 
-        #entry.definition
-      ],)}
-    )
-  }
-)
+#let glossary = utils.make-glossary(glossary => {
+  stack(
+    dir: ttb,
+    spacing: 15pt,
+    ..for entry in glossary {
+      (
+        [
+          #box(
+            inset: 0.5em,
+            fill: gray,
+          )[== #entry.word]
+          #h(5pt)
+          #box(
+            baseline: -10pt,
+            width: 1fr,
+            line(length: 100%),
+          )
+
+          #entry.definition
+        ],
+      )
+    },
+  )
+})
diff --git a/themes/linear/components/toc.typ b/themes/linear/components/toc.typ
@@ -8,51 +8,75 @@
 ///   #components.toc()
 /// ]
 /// ```
-#let toc() = utils.print-toc(
-  (_, body, appendix) => style(
-    styles => {
-      let previous-date
-
-      let toc = stack(
-        dir: ttb,
-        spacing: 0.3em,
-        ..for entry in body {
-          let date-content = if entry.date == previous-date {} else {
-            box(inset: 5pt, fill: white, entry.date.display("[day]/[month]/[year]"))
-          }
-
-          previous-date = entry.date
-          ([
-            // Single line content
-            #box(baseline: 0.35em, width: 5em)[
-              #set align(center)
-              #date-content
-            ]
-            #h(1em)
-            #box(
-              fill: entry-type-metadata.at(entry.type),
-              inset: (x: .4em, y: .6em),
-              baseline: 25%,
-            )[#entry.title #h(1.4em)]
-            #h(1em)
-            #box(width: 1fr, line(length: 100%, start: (0pt, -.35em)))
-            #h(1em)
-            #entry.page-number
-          ],)
-        },
-      )
-
-      let height = measure(toc, styles).height
-
-      box[
-        #place(
-          top + left,
-          dx: 2.5em,
-          dy: 1em,
-          line(angle: 90deg, length: height - 12pt),
+#let toc = utils.make-toc((
+  _,
+  body,
+  appendix,
+) => {
+  let previous-date
+
+  let toc = stack(
+    dir: ttb,
+    spacing: 0.3em,
+    ..for entry in body {
+      let date-content = if entry.date == previous-date { } else {
+        box(
+          inset: 5pt,
+          fill: white,
+          entry.date.display("[day]/[month]/[year]"),
         )
-        #toc
-      ]
+      }
+
+      previous-date = entry.date
+      (
+        [
+          // Single line content
+          #box(
+            baseline: 0.35em,
+            width: 5em,
+          )[
+            #set align(center)
+            #date-content
+          ]
+          #h(1em)
+          #box(
+            fill: entry-type-metadata.at(entry.type),
+            inset: (
+              x: .4em,
+              y: .6em,
+            ),
+            baseline: 25%,
+          )[#entry.title #h(1.4em)]
+          #h(1em)
+          #box(
+            width: 1fr,
+            line(
+              length: 100%,
+              start: (
+                0pt,
+                -.35em,
+              ),
+            ),
+          )
+          #h(1em)
+          #entry.page-number
+        ],
+      )
     },
-  ),
-)
+  )
+
+  let height = measure(toc).height
+
+  box[
+    #place(
+      top + left,
+      dx: 2.5em,
+      dy: 1em,
+      line(
+        angle: 90deg,
+        length: height - 12pt,
+      ),
+    )
+    #toc
+  ]
+})
diff --git a/themes/radial/components/glossary.typ b/themes/radial/components/glossary.typ
@@ -9,7 +9,7 @@
 ///   #components.glossary()
 /// ]
 /// ```
-#let glossary() = utils.print-glossary(glossary => {
+#let glossary = utils.make-glossary(glossary => {
   columns(2)[
     #for entry in glossary {
       box[

diff --git a/utils/components.typ b/utils/components.typ
@@ -11,7 +11,7 @@
 /// })
 /// ```
 /// - callback (function): A function which takes the #link(<ctx>)[ctx] of all entries as input, and returns the content of the entire table of contents.
-/// -> content
+/// -> function
 #let make-toc(
   callback,
 ) = {
@@ -62,7 +62,6 @@
     return result
   }
 
-
   return () => context {
     let frontmatter-entries = helper("frontmatter")
     let body-entries = helper("body")
@@ -76,6 +75,34 @@
   }
 }
 
-// Glossary
+/// Constructor for a glossary function
+/// - callback (function): A function that returns the content of the glossary
+/// -> function
+#let make-glossary(
+  callback,
+) = {
+  return () => context {
+    let sorted-glossary = globals.glossary-entries.final().sorted(key: (
+      (
+        word: word,
+        definition: definition,
+      ),
+    ) => word)
+    callback(sorted-glossary)
+  }
+}
+
 // Pro / Con
+#let make-pro-con(
+  callback,
+) = { }
+
 // Decision Matrix
+#let make-decision-matrix(
+  callback,
+) = { }
+
+// TODO: add method for these extra components:
+// - plot
+// - pie chart
+//
diff --git a/utils/misc.typ b/utils/misc.typ
@@ -2,20 +2,6 @@
 
 
 
-/// A utility function meant to help themes implement a glossary
-/// - callback (function): A function that returns the content of the glossary
-/// -> content
-#let print-glossary(
-  callback,
-) = locate(loc => {
-  let sorted-glossary = globals.glossary-entries.final(loc).sorted(key: (
-    (
-      word: word,
-      definition: definition,
-    ),
-  ) => word)
-  callback(sorted-glossary)
-})
 
 /// A utility function that does the calculation for decision matrices for you
 ///