Skip to content

Terminology Engine v 1

This issue describes our understanding about what we need to get a first version of the terminology up and running.

The results of v1 are:

  1. a demonstration of a .mdx file that uses terms for concepts, where such terms 'stick out' of the surrounding text, where hovering over them makes a popup appear with a short explanation of the term, and clickin on the term navigates the user to the page that documents the concept.
  2. an automatically generated glossary of terms, i.e. a webpage that alphabetically sorted list of all terms for documented concepts with a short, where each term is explained with the summary-text as specified in the associated concept-file.

We have agreed on the following items for v1:

  • concept-files will be located under docs/terms. The filename (without extension) will be used to as valid ConceptReferences (issue #10 (closed) specifies how ConceptReferences are to be used).
  • a concept-file starts with a Docusaurus header, to which a few (custom) attributes are added, as follows:
---
id: <as usual in Docusaurus>
title: <as usual in Docusaurus>
scopeid: <phrase that identifies a scope - this will be used (and specified) later in an enhanced version of referencing>
hoverText: "string to be shown as a popover when a user hovers over a term that is associated with a ConceptReference to this file"
---
  • TNO to provide (a small set of) example concept files and an example page that contains ConceptReferences (for testing and demonstration purposes). TNO will use a separate branch for this.
  • GRNET ensures that import statements (that are currently at the beginning of .mdx files) become obsolete.
  • GRNET updates their code so that it conforms to what is agreed above. Requires fixing #17 (closed).
  • GRNET sees that a glossary/dictionary is automatically generated that lists all terms for defined concepts.
Edited by Rieks Joosten