Jump to content

Template:GlossaryTerm: Difference between revisions

From GunCAD Wiki
No edit summary
No edit summary
Line 13: Line 13:


[[Category:Glossary]]</includeonly><noinclude>
[[Category:Glossary]]</includeonly><noinclude>
'''Usage''':
<templatedata>
 
{
<pre>
  "description": "Creates a glossary entry with a term, definition, optional notes, and optional see-also links.",
{{GlossaryTerm
  "params": {
| term = Foobar
    "term": {
| definition = A widget used to demonstrate placeholder concepts.
      "label": "Term",
| notes = Common in examples and documentation.
      "description": "The glossary term. Defaults to the page name if left empty.",
| see_also = [[Glossary:Baz]]
      "type": "string",
}}
      "required": false
</pre>
    },
    "definition": {
      "label": "Definition",
      "description": "The definition of the term.",
      "type": "string",
      "required": true
    },
    "notes": {
      "label": "Notes",
      "description": "Optional notes about the term.",
      "type": "string",
      "required": false
    },
    "see_also": {
      "label": "See also",
      "description": "Optional links to related glossary entries.",
      "type": "string",
      "required": false
    }
  }
}
</templatedata>
</noinclude>
</noinclude>

Revision as of 22:11, 22 December 2025

Creates a glossary entry with a term, definition, optional notes, and optional see-also links.

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
Termterm

The glossary term. Defaults to the page name if left empty.

Stringoptional
Definitiondefinition

The definition of the term.

Stringrequired
Notesnotes

Optional notes about the term.

Stringoptional
See alsosee_also

Optional links to related glossary entries.

Stringoptional