Skip to content

Commit 4a88f76

Browse files
committed
Update readme to include capitalized commands
1 parent 4e9b53a commit 4a88f76

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

+26-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ After importing the package and before making any calls to `gls`, ` print-glossa
7474
> [!NOTE]
7575
> <h3 align="center">*WHY DO WE NEED THAT?*</h3>
7676
>
77-
> In order to be able to create references to the terms in your glossary using typst [reference syntax](https://typst.app/docs/reference/model/ref/) `@key` glossarium needs to setup some [show rules](https://typst.app/docs/tutorial/advanced-styling/) before any references exist.
77+
> In order to be able to create references to the terms in your glossary using typst [reference syntax](https://typst.app/docs/reference/model/ref/) `@key` glossarium needs to setup some [show rules](https://typst.app/docs/tutorial/advanced-styling/) before any references exist.
7878
7979
> [!CAUTION]
8080
> <h3 align="center">*SHOW RULES CONFLICTS*</h3>
@@ -194,8 +194,33 @@ The `plural` key will be used when `short` should be pluralized and `longplural`
194194
#glspl("potato")
195195
```
196196

197+
Alternatively, you can reference the automatically generated label:
198+
199+
```typ
200+
@potato:pl
201+
```
202+
197203
Please look at the examples regarding plurals.
198204

205+
## Handling capitalization
206+
207+
If you use a term at the beginning of a sentence, you might want to capitalize it.
208+
You can use the `capitalize` argument of `#gls` and `#glspl` to do so,
209+
or, shorter, call `#Gls` and `#Glspl`.
210+
211+
```typ
212+
#Gls("ref")
213+
```
214+
215+
You can also reference the automatically generated labels:
216+
217+
```typ
218+
@Ref
219+
@Ref:pl
220+
```
221+
222+
Please note that these are only generated if the `key` does not start with an uppercase letter.
223+
199224
## Overriding the text shown
200225

201226
You can also override the text displayed by setting the `display` argument.

0 commit comments

Comments
 (0)