Module:Term/doc: Difference between revisions

From Space Station 14 Wiki
Aliser (talk | contribs)
tests
Aliser (talk | contribs)
updated
 
Line 17: Line 17:
That file contains definitions for terms.
That file contains definitions for terms.


Term is defined with a lowercase key and an object value.
Term is defined with a '''lowercase key''' and an object value.


The object value has following format:
The object value has following format:
<syntaxhighlight lang="json">
<syntaxhighlight lang="json">
{
{
"proper name": "[optional] proper term name, for example: LRP",
"display": "[optional] what to display, for example: LRP",
     "definition": "[optional] term definition",
     "definition": "term definition",
     "link": "[optional] a page to link the term to",
     "link": "[optional] a page to link the term to",
}
}

Latest revision as of 06:22, 25 May 2025

Module documentation
View or edit this documentation (about module documentation)
Uses JSON data
This module uses JSON data pages:

Implements {{Term}}.

Tests

Module:Term/testcases/keys - test whether keys in the JSON file are properly spelled (lowercase).

✅ All tests passed.

Name Expected Actual
test_keys_casing


Adding new terms

Go to the JSON file linked at the top of this page.

That file contains definitions for terms.

Term is defined with a lowercase key and an object value.

The object value has following format:

{
	"display": "[optional] what to display, for example: LRP",
    "definition": "term definition",
    "link": "[optional] a page to link the term to",
}

Note that at least a definition or a link should be provided for a term.