You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
56 lines
926 B
Markdown
56 lines
926 B
Markdown
# Glossary
|
|
|
|
You can use glossary entries in Snekdown to provide
|
|
a way of linking abbreviations to their longer form
|
|
and auto expand the first occurrence of an abbreviation.
|
|
|
|
|
|
Glossary entries can be defined in a separate TOML File.
|
|
Per default the `Glossary.toml` file gets imported.
|
|
|
|
```toml
|
|
# Glossary.toml
|
|
|
|
[SHORT]
|
|
long = "Long Form"
|
|
description = "The description of the entry"
|
|
|
|
# Example
|
|
[HTML]
|
|
long = "Hypertext Markup Language"
|
|
description = "The markup language of the web"
|
|
```
|
|
|
|
The defined entries can be used in the text by using the following syntax:
|
|
|
|
|
|
Short entry:
|
|
```
|
|
~SHORT
|
|
~HTML
|
|
```
|
|
|
|
~SHORT
|
|
~HTML
|
|
|
|
|
|
The first occurrence expands to the long form. When using it a second time it uses the shorter form:
|
|
|
|
~SHORT
|
|
~HTML
|
|
|
|
|
|
You can force Snekdown to use the long form for an entry by writing
|
|
|
|
```
|
|
~~SHORT
|
|
~~HTML
|
|
```
|
|
|
|
~~SHORT
|
|
~~HTML
|
|
|
|
|
|
The list of glossary entries can be inserted with the `[[GLS]]` placeholder.
|
|
|
|
[[GLS]] |