Module:Term/doc: Difference between revisions

From Space Station 14 Wiki
Aliser (talk | contribs)
No edit summary
Aliser (talk | contribs)
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{module docs|bb=
{{module docs|bb=
{{uses json data<!--
{{uses json data<!--
-->|Module:Terms/terms.json<!--
-->|Module:Term/terms.json<!--
-->|Module:Terms/term links.json<!--
-->}}
-->}}
}}
}}
Line 8: Line 7:
Implements {{t|Term}}.
Implements {{t|Term}}.


== terms.json ==
== Adding new terms ==
This file contains definitions for terms.
Go to the JSON file linked at the top of this page.


{{Callout|Warning|Use only lowercase for keys, otherwise the term finder won't work. On other hand, value can be any wikitext.}}
That file contains definitions for terms.
 
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.

Latest revision as of 20:51, 14 March 2025

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

Implements {{Term}}.

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:

{
	"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.