swaits
03e8e62c70
Instead of returning an opaque context element with a fixed list of the
pages, return an array of context elements with each a page
(already unique!).
This is conceptually cleaner. Now it's the themes responsability to join
the array of unique pages however it wants. Most times, this will be a
`.join(", ")`, but could be e.g. `.first()` if the theme only wants to
show the page of the first occurance of this term.
Also update the documentation.
Breaking API change in the themes.
No visual differences (tests remain the same), but there are binary
differences.
89 lines
2.1 KiB
Typst
89 lines
2.1 KiB
Typst
#import "/lib.typ": *
|
|
|
|
#let myGlossary = (
|
|
HTML: "Hypertext Markup Language",
|
|
CSS: "Cascading Style Sheets",
|
|
tps: (
|
|
short: "TPS",
|
|
long: "test procedure specification",
|
|
description: "A document on how to run all the test procedures"),
|
|
)
|
|
|
|
#show: init-glossary.with(myGlossary, show-term: (body) => [#emph(body)])
|
|
|
|
#set heading(numbering: "1.1")
|
|
#set page(numbering: "1")
|
|
|
|
= Hello, `glossy`!
|
|
In modern web development, languages like @HTML and @CSS are essential.
|
|
|
|
Now make sure I get your @tps:short reports by 2pm!
|
|
|
|
@tps:cap is defined as: @tps:def.
|
|
|
|
= Examples with modifiers
|
|
|
|
#table(
|
|
columns: 2,
|
|
table.header([*Input*], [*Output*]),
|
|
|
|
[`@tps:short` ], [@tps:short],
|
|
[`@tps:long` ], [@tps:long],
|
|
[`@tps:both` ], [@tps:both],
|
|
[`@tps:long:cap` ], [@tps:long:cap],
|
|
[`@tps:long:pl` ], [@tps:long:pl],
|
|
[`@tps:short:pl` ], [@tps:short:pl],
|
|
[`@tps:both:pl:cap`], [@tps:both:pl:cap],
|
|
[`@tps:def` ], [@tps:def],
|
|
[`@tps:desc` ], [@tps:desc],
|
|
)
|
|
|
|
== Using conflicting modifiers (short, long, both)
|
|
|
|
These modifiers are semantically mutually exclusive, by they can be combined
|
|
syntactically. When multiple are used, `glossy` tries to make a smart choice on
|
|
which one to display.
|
|
|
|
#table(
|
|
columns: 2,
|
|
table.header([*Input*], [*Output*]),
|
|
|
|
[`@tps:short:long` ], [@tps:short:long],
|
|
[`@tps:short:both` ], [@tps:short:both],
|
|
[`@tps:long:both` ], [@tps:long:both],
|
|
[`@tps:short:long:both`], [@tps:short:long:both],
|
|
)
|
|
|
|
#let my-theme = (
|
|
section: (title, body) => {
|
|
heading(level: 1, title)
|
|
body
|
|
},
|
|
group: (name, i, n, body) => {
|
|
if name != "" and n > 1 {
|
|
heading(level: 2, name)
|
|
}
|
|
body
|
|
},
|
|
entry: (entry, i, n) => {
|
|
// i is the entry's index, n is total number of entries
|
|
let output = [#entry.short]
|
|
if entry.long != none {
|
|
output = [#output -- #entry.long]
|
|
}
|
|
if entry.description != none {
|
|
output = [#output: #entry.description]
|
|
}
|
|
block(
|
|
grid(
|
|
columns: (auto, 1fr, auto),
|
|
output,
|
|
repeat([#h(0.25em) . #h(0.25em)]),
|
|
entry.pages.join(", "),
|
|
)
|
|
)
|
|
}
|
|
)
|
|
|
|
#glossary(theme: my-theme)
|