Skip to content

Commit

Permalink
Merge pull request #25 from indicatelovelace/feat-groups
Browse files Browse the repository at this point in the history 
Groups for entries
  • Loading branch information
@slashformotion
slashformotion authored Apr 7, 2024
2 parents e385afd + 3704abf commit 82d69e4
Show file tree
Hide file tree
Showing 4 changed files with 114 additions and 113 deletions.
10 changes: 8 additions & 2 deletions examples/import-terms-from-yaml-file/glossary.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,17 @@
ntc:
short: NTC
long: Nonlinear Transform Coding
description: |
description: |
This is the opposite of @ltc.
group: Nonlinear

ltc:
short: LTC
long: Linear Transform Coding
description: |
Transform Coding constraint to linear transforms.
Transform Coding constraint to linear transforms.
group: Linear

bor:
short: DEF
long: Default
Binary file modified examples/import-terms-from-yaml-file/main.pdf
View file
Binary file not shown.
17 changes: 13 additions & 4 deletions examples/import-terms-from-yaml-file/main.typ
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@



#import "@local/glossarium:0.2.6": *
#import "../../glossarium.typ": *
// Replace the local import with a import to the preview namespace.
// If you don't know what that mean, please go read typst documentation on how to import packages at https://typst.app/docs/packages/.

Expand All @@ -25,7 +25,7 @@

for key in v.keys() {
assert(
key in ("short", "long", "description"),
key in ("short", "long", "description", "group"),
message: "Found unexpected key `" + key + "` in glossary entry `" + k + "` in `" + file + "`",
)
}
Expand All @@ -48,13 +48,21 @@
message: "The description of glossary entry `" + k + "` in `" + file + "` is not a string",
)
}
}

if "group" in v {
assert(
type(v.group) == str,
message: "The optional group of glossary entry `" + k + "` in `" + file + "` is not a string",
)
}
}

return entries.pairs().map(((key, entry)) => (
key: key,
short: eval(entry.short, mode: "markup"),
long: eval(entry.at("long", default: ""), mode: "markup"),
desc: eval(entry.at("description", default: ""), mode: "markup"),
group: entry.at("group", default: ""),
file: file,
))
}
Expand Down Expand Up @@ -87,6 +95,7 @@

= Test Document

Reference to @ntc
Reference to @ntc \
Reference to @bor

#glossary("glossary.yml")
200 changes: 93 additions & 107 deletions glossarium.typ
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,44 +15,36 @@ SOFTWARE.*/

#let __query_labels_with_key(loc, key, before: false) = {
if before {
query(
selector(label(__glossary_label_prefix + key)).before(loc, inclusive: false),
loc,
)
query(selector(label(__glossary_label_prefix + key)).before(loc, inclusive: false), loc)
} else {
query(
selector(label(__glossary_label_prefix + key)),
loc,
)
query(selector(label(__glossary_label_prefix + key)), loc)
}
}

// Reference a term
#let gls(key, suffix: none, long: none, display: none) = {
locate(
loc => {
let __glossary_entries = __glossary_entries.final(loc);
if key in __glossary_entries {
let entry = __glossary_entries.at(key)

let gloss = __query_labels_with_key(loc, key, before: true)

let is_first = gloss == ();
let entlong = entry.at("long", default: "")
let textLink = if display !=none {
[#display]
} else if (is_first or long == true) and entlong != [] and entlong != "" and long != false {
[#entry.short#suffix (#emph(entlong))]
} else {
[#entry.short#suffix]
}

[#link(label(entry.key), textLink)#label(__glossary_label_prefix + entry.key)]
context {
let __glossary_entries = __glossary_entries.final(here())
if key in __glossary_entries {
let entry = __glossary_entries.at(key)

let gloss = __query_labels_with_key(here(), key, before: true)

let is_first = gloss == ()
let entlong = entry.at("long", default: "")
let textLink = if display != none {
[#display]
} else if (is_first or long == true) and entlong != [] and entlong != "" and long != false {
[#entry.short#suffix (#emph(entlong))]
} else {
text(fill: red, "Glossary entry not found: " + key)
[#entry.short#suffix]
}
},
)

[#link(label(entry.key), textLink)#label(__glossary_label_prefix + entry.key)]
} else {
text(fill: red, "Glossary entry not found: " + key)
}
}
}

// reference to term with pluralisation
Expand All @@ -71,84 +63,78 @@ SOFTWARE.*/
body
}

#let print-glossary(entries, show-all: false, disable-back-references: false) = {
__glossary_entries.update(
(x) => {
for entry in entries {
x.insert(
entry.key,
(
key: entry.key,
short: entry.short,
long: entry.at("long", default: ""),
desc: entry.at("desc", default: ""),
),
)
}

x
},
)

for entry in entries.sorted(key: (x) => x.key) {
[
#show figure.where(kind: __glossarium_figure): it => it.caption
#par(
hanging-indent: 1em,
first-line-indent: 0em,
)[
#figure(
supplement: "",
kind: __glossarium_figure,
numbering: none,
caption: {
locate(
loc => {
let term_references = __query_labels_with_key(loc, entry.key)
if term_references.len() != 0 or show-all {
let desc = entry.at("desc", default: "")
let long = entry.at("long", default: "")
let hasLong = long != "" and long != []
let hasDesc = desc != "" and desc != []

{
set text(weight: 600)
if hasLong {
emph(entry.short) + [ -- ] + entry.long
}
else {
emph(entry.short)
#let print-glossary(entries, show-all: false, disable-back-references: false, group-pagebreak: false) = {
__glossary_entries.update(x => {
for entry in entries {
x.insert(
entry.key,
(
key: entry.key,
short: entry.short,
long: entry.at("long", default: ""),
desc: entry.at("desc", default: ""),
group: entry.at("group", default: ""),
),
)
}

x
})

let groups = entries.map(x => x.at("group", default: "")).dedup()
// move no group to the front
groups.insert(0, "")
groups.pop()

for group in groups.sorted() {
if group != "" [#heading(group, level: 2) ]
for entry in entries.sorted(key: x => x.key) {
if entry.group == group {
[
#show figure.where(kind: __glossarium_figure): it => it.caption
#par(hanging-indent: 1em, first-line-indent: 0em)[
#figure(
supplement: "",
kind: __glossarium_figure,
numbering: none,
caption: {
context {
let term_references = __query_labels_with_key(here(), entry.key)
if term_references.len() != 0 or show-all {
let desc = entry.at("desc", default: "")
let long = entry.at("long", default: "")
let hasLong = long != "" and long != []
let hasDesc = desc != "" and desc != []
{
set text(weight: 600)
if hasLong {
emph(entry.short) + [ -- ] + entry.long
} else {
emph(entry.short)
}
}
if hasDesc [: #desc ] else [. ]
if disable-back-references != true {
term_references.map(x => x.location()).sorted(key: x => x.page()).fold(
(values: (), pages: ()),
((values, pages), x) => if pages.contains(x.page()) {
(values: values, pages: pages)
} else {
values.push(x)
pages.push(x.page())
(values: values, pages: pages)
},
).values.map(x => link(x)[#numbering(x.page-numbering(), ..counter(page).at(x))]).join(", ")
}
}
}
if hasDesc [: #desc ] else [. ]
if disable-back-references != true {
term_references.map((x) => x.location())
.sorted(key: (x) => x.page())
.fold(
(values: (), pages: ()),
((values, pages), x) => if pages.contains(x.page()) {
(values: values, pages: pages)
} else {
values.push(x)
pages.push(x.page())
(values: values, pages: pages)
},
)
.values
.map(
(x) => link(
x,
)[#numbering(x.page-numbering(), ..counter(page).at(x))],
)
.join(", ")
}
}
},
)
},
)[] #label(entry.key)
]
#parbreak()
]
},
)[] #label(entry.key)
]
#parbreak()
]
}
}
if group-pagebreak {pagebreak(weak: true)}
}
};

0 comments on commit 82d69e4

Please sign in to comment.