Skip to content

MVE Glossary

Definition (Spec-Up style)

a construct of the form [[def: {term}, {alias1}, {alias2}, ... ]] ~ {definition}, which specifies the mapping between the term {term} and a description of the term's meaning (provided by {definition}.

Notes

  • {alias1}, {alias2}, ... is optional syntax that specifies aliases (synomyms) for {term}.
  • In TEv2, {term} and its aliases would be specified as form phrases.
  • A recent addition is the use of so-called XRefs, which allows definitions to be used across diffrent files and projects.

XRef

See: External Reference (Spec-Up style)

External Reference (Spec-Up style)

a construct of the form [[xref: {title} {term}]], where {title} is a tag that identifies the source of the definition of {term}.

Notes

  • The {title} tags are defined [to be described, link to actual specs thereof].
  • When an XRef is processed by a TEv2 tool, {title} is treated as the equivalent of a scopetag and/or the default terminology in the associated scope.

MVE

See: Minimal Viable Example

Minimal Viable Example

a GitHub repo, the contents of which is documentation that is published as a static website using GitHub Pages or Jekyll, and that includes the minimal stuff for using the TEv2 tools and demonstrating its results.

Term 1

This is the first term we will define.

Notes

  • Like Term Two and Term 3, this term is defined for illustration purposes only.

Term 2

This is the second term, but not the last.

Notes

  • Like Term One and Term 3, this term is defined for illustration purposes only.

Term 3

This is the last term, because you know what they say: third term's the charm!

Notes

  • Like Term 1 and Term Two, this term is defined for illustration purposes only.

Term Reference (Spec-Up style)

a construct of the form [[ref: {term}]], where {term} is (an alias of some) term defined in a Spec-Up definition.

Notes

Workflow file

a YAML file stored in the .github/workflows directory of a GitHub repository that defines jobs, steps, and triggers for GitHub Actions. In our context, this file is used to compile and deploy the static website of an MVE.