ravenous_typst/setup/glossary.typ

109 lines
2.6 KiB
Plaintext

#import "macros.typ" as macros
// ----- Safely evaluate trusted Typst expressions from data files passing needed macros -----
#let eval-typst(value, mode: "code") = {
eval(
value,
scope: (
box: box,
image: image,
text: text,
sym: sym,
ddlvl: macros.ddlvl,
resist: macros.resist,
inline_help: macros.inline_help,
),
mode: mode,
)
}
// ----- Read and normalize glossary entries from a YAML file -----
#let read-glossary-entries(file) = {
yaml(file).map(entry => {
let result = (:)
// ----- Convert each YAML field to its Typst representation -----
let sort_key = ""
for (key, value) in entry {
result.insert(
key,
if type(value) == dictionary
and value.at("typst", default: none) != none {
eval-typst(value.typst)
} else if key == "short" {
if value == none {
panic("Short key cannot be null")
} else if type(value) == str {
sort_key = value
eval(value, mode: "markup")
}
} else if key == "long" {
value
} else if key == "description" {
if value == none {
none
} else if type(value) == str {
eval-typst(value, mode: "markup")
} else {
value
}
} else {
value
},
)
}
// ----- Fill in missing optional fields -----
if "short" not in result {
panic("Missing key short for:", result)
}
if "sort" not in result {
if "long" in result {
result.insert("sort", result.long)
} else {
result.insert("sort", sort_key)
}
}
// if "long" not in result {
// result.insert("long", "")
// }
result
})
}
// ----- Load glossary entries from one or more YAML files -----
#let read-glossary(files) = {
let entries = ()
// ----- Normalize a single file into an array -----
if type(files) != array {
files = (files,)
}
for file in files {
let new = read-glossary-entries(file)
// ----- Reject duplicate glossary keys -----
for entry in new {
let duplicate = entries.find(e => e.key == entry.key)
if duplicate != none {
panic(
"Found duplicate key `" + entry.key + "` in files `" + file + "`",
)
}
}
entries += new
}
entries
}
// ----- Load all project glossaries -----
#let glossary = read-glossary((
"../data/src/glossaries/general.yml",
"../data/src/glossaries/classes.yml",
"../data/src/glossaries/alterations.yml",
"../data/src/glossaries/terms.yml",
))