Parameters
From Unofficial Stationeers Wiki
30px | This template uses Lua: |
Usage[edit]
{{Parameters}} extracts a specified template's parameters and performs a variety of tasks to aid in its documentation or WP:TFD merge nominations. It itself takes two parameters: |1=
, the output format; and |base=
, the title of a template. The compare
function requires a third parameter, |other=
. {{Parameters}} must always be substituted. Its usage is demonstrated below.
Options[edit]
check[edit]
Generates an invocation of Module:Check for unknown parameters which can be added to a template.
{{subst:Parameters|check|base={{subst:BASEPAGENAME}}}}
code[edit]
Generates code to display the transclusion syntax (a blank template) which can added to a template's documentation. |pad=yes
aligns the equal signs vertically.
{{subst:Parameters|code|base={{subst:BASEPAGENAME}}}}
compare[edit]
Generates a comparison of the parameters available in two different templates.
{{subst:Parameters|compare|base=Infobox London station|other=Infobox station}}
demo[edit]
Generates an invocation of {{Parameter names example}}, formerly known as {{Generic template demo}}, which can added to a template's documentation.
{{subst:Parameters|demo|base={{subst:BASEPAGENAME}}}}
dlist[edit]
Generates a parameter description list which can be filled in and added to a template's documentation. The output uses the semicolon and colon format where the parameter name is displayed in bold text and the description is indented.
{{subst:Parameters|dlist|base={{subst:BASEPAGENAME}}}}
list[edit]
Generates a parameter description list which can be filled in and added to a template's documentation. Similar to dlist but uses asterisks which will generate a bulleted list.
{{subst:Parameters|list|base={{subst:BASEPAGENAME}}}}
Common use cases[edit]
- To add a {{Parameter names example}} to a template's documentation, use:
{{subst:Parameters|demo|base={{subst:BASEPAGENAME}}|_base=}}
- To document the transclusion syntax, use:
{{subst:#tag:pre|{{subst:Parameters|code|base={{subst:BASEPAGENAME}}}}|style=overflow: auto;}}
The above documentation is transcluded from Template:Parameters/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |