Change request - Glossaries and Pattern lists
Currently, the glossary is generated by processing all files in the doc/terms
directory.
However, glossaries are supposed to list terms, whereas the doc/terms
directory also contains other artifacts, such as pattern-descriptions.
This issue makes the following requests:
generate a glossary
that
-
only includes files where the type
attribute in the docusaurus header is eitherconcept
orterm
. That not only rids us from the 'undefined' entry in the glossary (which links to a README), but it also allows us to have other kinds of documents in that directory, e.g. terminology-maintenance scripts for editors (e.g. VSCode). AND, it would get rid of a bug, which is that the glossary seems to be generated based on filenames rather than theid
attribute (evidence of which is that if they differ, an error is generated that says there is a broken link in the glossary, which cannot happen if theid
attribute would have been used). -
uses (the (new) 'glossaryText' header item rather the 'hoverText' header item), and processes the %%-references that appear in the 'glossaryText' header item in the same way as it is used in other texts. -
appends the generated text to the docs/glossary.md
file; note that later, when we allow for multiple glossaries, a glossary-file should provide additional specifications that will change the glossary generation process.
generate a pattern-list,
with similar requirements, i.e.: that only includes files where the type
attribute in the docusaurus header is pattern
, allows for %%-references in the text for the various patterns in the list, and is appended to patterns-list.md
file.