Skip to content

Glossaries based on slisson/mps-richtext for use with mbeddr's requirements and documentation language

License

Notifications You must be signed in to change notification settings

odzhychko/mps-richtext-glossaries

 
 

Repository files navigation

mps-richtext-glossaries

Glossaries based on slisson/mps-richtext for use with mbeddr's requirements and documentation language.

When writing requirements or other documents, "tangible" definitions which are properly referenced are important. Changes to these terms should be propagated to all usages.

This is a basic version of glossaries which allows (glossary) terms to be defined in terms of other (glossary) terms. The result is sometimes not fully natural language, especially when much used terms have been changed afterwards, but this approach does provide quite some consistency in wording.

Some basic checks such as duplicate term definition or using undefined terms has been added to spot "holes" in the definitions.

An example glossary in action can be seen here:

Example glossary

Note that since this uses the more generic mps-richtext plugin, this can also be used in conjunction with mbeddr's requirements and documentation languages. For example:

An example requirement using glossary terms

The current version works on MPS 2021.1 with a corresponding mbeddr.

building

This project uses the com.specificlanguages.mps build plugin. Run gradlew setup to download all dependencies and gradlew build to execute the build.

About

Glossaries based on slisson/mps-richtext for use with mbeddr's requirements and documentation language

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JetBrains MPS 99.8%
  • Kotlin 0.2%