diff --git a/glossy/README.md b/glossy/README.md index 65dadd7..b27615e 100644 --- a/glossy/README.md +++ b/glossy/README.md @@ -143,6 +143,7 @@ Available modifiers: - **short**: Shows only short form - **long**: Shows only long form - **def** or **desc**: Shows the description +- **noref** or **noindex**: Don't show the term in the glossary. - **a** or **an**: Include the article (`an` is just an alias of `a`, they're equivalent) @@ -160,6 +161,9 @@ Modifiers can be combined with colons: | `@tps:short:pl` | "TPSes" | | `@tps:both:pl:cap` | "Technical procedure specifications (TPSes)" | | `@tps:def` | "A formal document describing test steps and expected results" | +| `@tps:desc` | _same as above, `desc` is an alias for `def`_ | +| `@tps:noref` | _works as normal, just won't show up in glossary_ | +| `@tps:noindex` | _same as above, `noindex` is an alias for `noref`_ | The `a`/`an` modifier is special because it can either precede or follow the term's key. @@ -180,6 +184,18 @@ For example: Note that the `a`/`an` (article) modifier cannot be combined with the `pl` (plural) modifier. +### First use logic + +Any use of the `short`, `long`, or `both` modifier will not count against the +term's first use. + +This is useful, for example, when you want to use a term in a heading or a +caption. In that case, your term might end up in an `outline()` at the top of +your document. Normally you don't want that to count as a term's first real use. +Normally you want that to happen in the body of your document. So, by using +these modifiers in such situations, you can not only specify exactly how you +want your term to appear, but also control whether it counts as a "first use". + ### Generating the Glossary Display the glossary using the `glossary()` function: diff --git a/glossy/tests/demo/ref/1.png b/glossy/tests/demo/ref/1.png index fa47282..9a91e44 100644 Binary files a/glossy/tests/demo/ref/1.png and b/glossy/tests/demo/ref/1.png differ diff --git a/glossy/tests/demo/test.typ b/glossy/tests/demo/test.typ index ff28dcb..0a422bb 100644 --- a/glossy/tests/demo/test.typ +++ b/glossy/tests/demo/test.typ @@ -47,6 +47,8 @@ Now make sure I get @tps:a:SHORT report by 2pm! @an:tps:cap is very important!!! [`@tps:both:pl:cap`], [@tps:both:pl:cap], [`@tps:def` ], [@tps:def], [`@tps:desc` ], [@tps:desc], + [`@tps:noref` ], [@tps:noref *(not listed in glossary)*], + [`@tps:noindex` ], [@tps:noindex *(not listed in glossary)*], ) == Adding articles via `a`/`an` modifiers diff --git a/glossy/themeshots.png b/glossy/themeshots.png index 9274762..49b0f8b 100644 Binary files a/glossy/themeshots.png and b/glossy/themeshots.png differ diff --git a/glossy/thumbnail.png b/glossy/thumbnail.png index 3c7f7e0..5f43827 100644 Binary files a/glossy/thumbnail.png and b/glossy/thumbnail.png differ