feat(glossy): add sort: true parameter to glossary()

glossy/README.md

@@ -186,8 +186,9 @@ Display the glossary using the `glossary()` function:
 
 ```typst
 #glossary(
-  title: "Web Development Glossary", // Optional: defaults to Glossary
+  title: "Web Development Glossary", // Optional: defaults to Glossary theme:
-  theme: my-theme, // Optionaal: defaults to theme-twocol
+  my-theme, // Optional: defaults to theme-academic
+  sort: true, // Optional: whether or not to sort the glossary
   ignore-case: false, // Optional: ignore case when sorting terms
   groups: ("Web")  // Optional: Filter to specific groups
 )

glossy/src/gloss.typ

@@ -541,6 +541,7 @@
 #let glossary(
   title: "Glossary",
   theme: theme-academic,
+  sort: true,
   ignore-case: false,
   groups: (),
 ) = context {
@@ -601,13 +602,17 @@
       group = if group == none { "" } else { group }
 
       // sort entries by case insensitivity if requested
-      let sorted_entries = current_entries
+      let sorted_entries = if sort {
-        // 1. create array of tuples with (lower [if ignore-case], entry)
+        current_entries
-        .map(e => { if ignore-case { (lower(e.short), e) } else { (e.short, e) } })
+          // 1. create array of tuples with (lower [if ignore-case], entry)
-        // 2. sort the tuples (by first element then second)
+          .map(e => { if ignore-case { (lower(e.short), e) } else { (e.short, e) } })
-        .sorted() // NOTE: sorted() is NOT language-aware
+          // 2. sort the tuples (by first element then second)
-        // 3. strip away the tuple's first element, leaving an array of entries
+          .sorted() // NOTE: sorted() is NOT language-aware
-        .map(t => t.last())
+          // 3. strip away the tuple's first element, leaving an array of entries
+          .map(t => t.last())
+      } else {
+        current_entries
+      }
 
       // add entries to this group's output map
       output.insert(group, sorted_entries)

glossy/tests/no-sort/glossary.yml

@@ -0,0 +1,23 @@
+first:
+  short: "DAL"
+  long: "first"
+
+second:
+  short: "cab"
+  long: "second"
+
+third:
+  short: "delta"
+  long: "third"
+
+fourth:
+  short: "COO"
+  long: "fourth"
+
+fifth:
+  short: "cuckoo"
+  long: "fifth"
+
+sixth:
+  short: "ČR"
+  long: "sixth"

glossy/tests/no-sort/test.typ

@@ -0,0 +1,13 @@
+#import "/lib.typ":*
+
+#show: init-glossary.with(yaml("glossary.yml"))
+
+@first, @second, @third, @fourth, @fifth, @sixth
+
+#glossary(ignore-case: false, sort: true)
+#line(length: 20em)
+#glossary(ignore-case: true, sort: true)
+#line(length: 20em)
+#glossary(ignore-case: false, sort: false)
+#line(length: 20em)
+#glossary(ignore-case: true, sort: false)