diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa8a4ce..c01e66e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -69,6 +69,17 @@ There are a few guidelines when it comes to cross-referencing, which work around [Figure] environments must have a `:name:` attribute, prefixed with `fig-`, so that they can be referenced elsewhere. The `:alt:` attribute should explain what is displayed in the picture, as this is an [accessibility] feature. To keep matters brief, components and symbols that are described in other figures already, can be referenced by name instead of explaining them in detail. +#### Glossary + +This project defines terms in a [glossary]. Using the `term` role, it is possible to reference these terms from anywhere. +Given a term `My Term` in the glossary, it is possible to refernce it directly using ```{term}`my term```` or indirectly ```{term}`something else````. + +There are a few rules, that should be kept in mind when creating terms and referencing them. + +* alternative terms for a term may exist in the glossary for completeness (e.g., `My Other Term` may point to `My Term` in the glossary) +* references to a term should always point to the deepest redirect (e.g., if `My Other Term` points to `My Term` in the glossary, references should point to `My Term` and not `My Other Term`) +* even if links to external resources can also be found in a section that is related to a term, the links related to the term should also be present in the glossary + ## License All text contributions fall under the terms of the [CC-BY-SA-4.0]. @@ -87,5 +98,6 @@ Configuration file contributions fall under the terms of the [CC0-1.0]. [explicit targets]: https://myst-parser.readthedocs.io/en/latest/syntax/cross-referencing.html#creating-explicit-targets [Figure]: https://myst-parser.readthedocs.io/en/latest/syntax/images_and_figures.html#figures-images-with-captions [accessibility]: https://en.wikipedia.org/wiki/Computer_accessibility +[glossary]: https://myst-parser.readthedocs.io/en/latest/syntax/typography.html#definition-lists-and-glossaries [CC-BY-SA-4.0]: ./LICENSES/CC-BY-SA-4.0.txt [CC0-1.0]: ./LICENSES/CC0-1.0.txt