Module:Term/doc: Difference between revisions

From Space Station 14 Wiki
Aliser (talk | contribs)
moved to Module:Term, fixing links
Aliser (talk | contribs)
updated docs for new format
Line 2: Line 2:
{{uses json data<!--
{{uses json data<!--
-->|Module:Term/terms.json<!--
-->|Module:Term/terms.json<!--
-->|Module:Term/term links.json<!--
-->}}
-->}}
}}
}}
Line 11: Line 10:
This file contains definitions for terms.
This file contains definitions for terms.


{{Callout|Warning|Use only lowercase for keys, otherwise the term finder won't work. On other hand, value can be any wikitext.}}
Term is defined with a lowercase key and an object value.
 
The object value has following format:
<syntaxhighlight lang="json">
{
"proper name": "[optional] proper term name, for example: LRP",
    "definition": "[optional] term definition",
    "link": "[optional] a page to link the term to",
}
</syntaxhighlight>
 
Note that at least a definition or a link should be provided for a term.

Revision as of 20:50, 14 March 2025

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

Implements {{Term}}.

terms.json

This file contains definitions for terms.

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

The object value has following format:

{
	"proper name": "[optional] proper term name, for example: LRP",
    "definition": "[optional] 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.