Editing Template:Parameters/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{subst only|auto=yes}}
{{Lua|Module:Parameters}}
__TOC__
== Usage ==
{{Tl|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: {{Para|1}}, the output format; and {{Para|base}}, the title of a template. The <code>compare</code> function requires a third parameter, {{Para|other}}. {{Tl|Parameters}} ''must'' always be substituted. Its usage is demonstrated below.

=== Common use cases ===
* To add a {{Tl|Parameter names example}} to a template's documentation, use: <code><nowiki>{{subst:Parameters|demo|base={{subst:BASEPAGENAME}}}}</nowiki></code>
* To document the transclusion syntax, use: <code><nowiki>{{subst:Parameters|code|base={{subst:BASEPAGENAME}}}}</nowiki></code>

== Options ==

=== check ===
Generates an invocation of [[Module:Check for unknown parameters]] which can be added to a template.
<pre style="margin-left:20px;margin-right:20px;">{{subst:Parameters|check|base={{subst:BASEPAGENAME}}}}</pre>
{{collapse top|title=Generated wikitext}}
<pre style="white-space: normal; word-break: break-all;">{{#invoke:Check for unknown parameters|check|unknown=[[Category:Pages using Template:Infobox high court with unknown parameters]]|court_name|native_name|image|imagesize|width|height|caption|image2|imagesize2|caption2|established|dissolved|country|location|coordinates|motto|type|at|authority|appeals|terms|positions|budget|website|chiefjudgetitle|chiefjudgename|termstart|termend|termend2|chiefjudgetitle2|chiefjudgename2|termstart2|termend3|termend4}}</pre>
{{collapse bottom}}

=== code ===
Generates display of the transclusion syntax (a blank template) which can added to a template's documentation. {{Para|pad|yes}} aligns the equal signs vertically.
<pre style="margin-left:20px;margin-right:20px;">{{subst:Parameters|code|base={{subst:BASEPAGENAME}}}}</pre>
{{collapse top|title=Example of {{tlsp|Parameters|code|base{{=}}Infobox court|pad{{=}}yes}}}}
 <nowiki>{{Infobox court
| court_name        = 
| native_name       = 
| image             = 
| imagesize         = 
| alt               = 
| caption           = 
| image2            = 
| imagesize2        = 
| alt2              = 
| caption2          = 
| established       = 
| dissolved         = 
| jurisdiction      = 
| location          = 
| coordinates       = 
| motto             = 
| type              = 
| at                = 
| authority         = 
| appealsto         = 
| appeals           = 
| appealsfrom       = 
| terms             = 
| positions         = 
| budget            = 
| language          = 
| tribunal-type     = 
| website           = 
| chiefjudgetitle   = 
| chiefjudgename    = 
| termstart         = 
| termend           = 
| termend2          = 
| chiefjudgetitle2  = 
| chiefjudgename2   = 
| termstart2        = 
| termend3          = 
| termend4          = 
| chiefjudgetitle3  = 
| chiefjudgename3   = 
| termstart3        = 
| termend5          = 
| division_map      = 
| division_map_size = 
| division_map_alt  = 
| division_caption  = 
}}</nowiki>
{{collapse bottom}}

=== flatcode ===
Generates code to display the transclusion syntax (a blank template) which can added to a template's documentation. The automatically added values can the be edited manually.
<pre style="margin-left:20px;margin-right:20px;">{{subst:Parameters|flatcode|base={{subst:BASEPAGENAME}}}}</pre>
{{collapse top|title=Example of {{tlps|Parameters|flatcode|base{{=}}color}}}}
Output:

 {{tlp|color |1{{=}}<var>1</var> |2{{=}}<var>2</var>}}

Edited manually to:

 {{tlp|color |1{{=}}<var>color</var> |2{{=}}<var>text</var>}}
{{collapse bottom}}

=== demo ===
Generates an invocation of {{tl|Parameter names example}}, formerly known as {{tl|Generic template demo}}, which can added to a template's documentation.
<pre style="margin-left:20px;margin-right:20px;">{{subst:Parameters|demo|base={{subst:BASEPAGENAME}}}}</pre>
{{collapse top|title=Example of {{tlsp|Parameters|demo|base{{=}}Infobox court}}}}
{{Parameter names example|_template=Infobox court|court_name|native_name|image|imagesize|alt|caption|image2|imagesize2|alt2|caption2|established|dissolved|jurisdiction|location|coordinates|motto|type|at|authority|appealsto|appeals|appealsfrom|terms|positions|budget|language|tribunal-type|website|chiefjudgetitle|chiefjudgename|termstart|termend|termend2|chiefjudgetitle2|chiefjudgename2|termstart2|termend3|termend4|chiefjudgetitle3|chiefjudgename3|termstart3|termend5|division_map|division_map_size|division_map_alt|division_caption}}
{{collapse bottom}}

=== dlist ===
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.
<pre style="margin-left:20px;margin-right:20px;">{{subst:Parameters|dlist|base={{subst:BASEPAGENAME}}}}</pre>
{{collapse top|title=Example of {{tlps|Parameters|dlist|base{{=}}Infobox court}}}}
; court_name: 
; native_name: 
; image: 
; imagesize: 
; alt: 
; caption: 
; image2: 
; imagesize2: 
; alt2: 
; caption2: 
; established: 
; dissolved: 
; jurisdiction: 
; location: 
; coordinates: 
; motto: 
; type: 
; at: 
; authority: 
; appealsto: 
; appeals: 
; appealsfrom: 
; terms: 
; positions: 
; budget: 
; language: 
; tribunal-type: 
; website: 
; chiefjudgetitle: 
; chiefjudgename: 
; termstart: 
; termend: 
; termend2: 
; chiefjudgetitle2: 
; chiefjudgename2: 
; termstart2: 
; termend3: 
; termend4: 
; chiefjudgetitle3: 
; chiefjudgename3: 
; termstart3: 
; termend5: 
; division_map: 
; division_map_size: 
; division_map_alt: 
; division_caption: 
{{collapse bottom}}

=== dlistpara ===
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 using template {{tl|para}} the description is indented.
<pre style="margin-left:20px;margin-right:20px;">{{subst:Parameters|dlistpara|base={{subst:BASEPAGENAME}}}}</pre>
{{collapse top|title=Example of {{tlps|Parameters|dlistpara|base{{=}}Infobox court}}}}
; {{para|court_name}}: 
; {{para|native_name}}: 
; {{para|image}}: 
; {{para|imagesize}}: 
; {{para|alt}}: 
; {{para|caption}}: 
; {{para|image2}}: 
; {{para|imagesize2}}: 
; {{para|alt2}}: 
; {{para|caption2}}: 
; {{para|established}}: 
; {{para|dissolved}}: 
; {{para|jurisdiction}}: 
; {{para|location}}: 
; {{para|coordinates}}: 
; {{para|motto}}: 
; {{para|type}}: 
; {{para|at}}: 
; {{para|authority}}: 
; {{para|appealsto}}: 
; {{para|appeals}}: 
; {{para|appealsfrom}}: 
; {{para|terms}}: 
; {{para|positions}}: 
; {{para|budget}}: 
; {{para|language}}: 
; {{para|tribunal-type}}: 
; {{para|website}}: 
; {{para|chiefjudgetitle}}: 
; {{para|chiefjudgename}}: 
; {{para|termstart}}: 
; {{para|termend}}: 
; {{para|termend2}}: 
; {{para|chiefjudgetitle2}}: 
; {{para|chiefjudgename2}}: 
; {{para|termstart2}}: 
; {{para|termend3}}: 
; {{para|termend4}}: 
; {{para|chiefjudgetitle3}}: 
; {{para|chiefjudgename3}}: 
; {{para|termstart3}}: 
; {{para|termend5}}: 
; {{para|division_map}}: 
; {{para|division_map_size}}: 
; {{para|division_map_alt}}: 
; {{para|division_caption}}: 
{{collapse bottom}}

=== list ===
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.
<pre style="margin-left:20px;margin-right:20px;">{{subst:Parameters|list|base={{subst:BASEPAGENAME}}}}</pre>
{{collapse top|title=Example of {{tlps|Parameters|list|base{{=}}Infobox court}}}}

* court_name
* native_name
* image
* imagesize
* alt
* caption
* image2
* imagesize2
* alt2
* caption2
* established
* dissolved
* jurisdiction
* location
* coordinates
* motto
* type
* at
* authority
* appealsto
* appeals
* appealsfrom
* terms
* positions
* budget
* language
* tribunal-type
* website
* chiefjudgetitle
* chiefjudgename
* termstart
* termend
* termend2
* chiefjudgetitle2
* chiefjudgename2
* termstart2
* termend3
* termend4
* chiefjudgetitle3
* chiefjudgename3
* termstart3
* termend5
* division_map
* division_map_size
* division_map_alt
* division_caption

{{collapse bottom}}

=== compare ===
Generates a comparison of the parameters available in two different templates.
<pre style="margin-left:20px;margin-right:20px;">{{subst:Parameters|compare|base=Infobox London station|other=Infobox station}}</pre>
{{collapse top|title=Output}}
<pre>Identical:
* borough
* caption
* events1
* events10
* events11
* events2
* events3
* events4
* events5
* events6
* events7
* events8
* events9
* latitude
* longitude
* map_type
* name
* original
* platforms
* postgroup
* pregroup
* symbol
* symbol2
* symbol3
* symbol4
* tracks
* years1
* years10
* years11
* years2
* years3
* years4
* years5
* years6
* years7
* years8
* years9

Similar:
* events12; events13; events14; events15 < events; events1; events2; events3; events4; events5; events6; events7; events8; events9; events10; events11 [events]
* years12; years13; years14; years15 < years; years1; years2; years3; years4; years5; years6; years7; years8; years9; years10; years11 [years]

Disparate:
* access
* access_note
* alt_name
* alt_name1
* coord_region
* ctbat0910
* ctbat1011
* cyclepark
* dft_category
* dlrbat0708
* dlrbat0809
* dlrbat1011
* fare_zone
* fare_zone_1
* fare_zone_note
* gridref
* image_alt
* image_name
* image_size
* imagesize
* interchange
* interchange1
* interchange2
* interchange3
* interchange4
* interchange5
* interchange_note
* label_position
* listing_amended
* listing_detail
* listing_entry
* listing_grade
* listing_reference
* listing_start
* locale
* manager
* manager1
* manager2
* owner
* owner1
* owner2
* railcode
* railcode1
* railcode2
* railexits0203
* railexits0405
* railexits0506
* railexits0607
* railexits0708
* railexits0809
* railexits0910
* railexits1011
* railexits1112
* railexits1213
* railexits1314
* railint0203
* railint0405
* railint0506
* railint0607
* railint0708
* railint0809
* railint0910
* railint1011
* railint1112
* railint1213
* railint1314
* raillowexits0203
* raillowexits0405
* raillowexits0506
* raillowexits0607
* raillowexits0708
* raillowexits0809
* raillowexits0910
* raillowexits1011
* raillowexits1112
* raillowexits1213
* raillowexits1314
* raillowint0203
* raillowint0405
* raillowint0506
* raillowint0607
* raillowint0708
* raillowint0809
* raillowint0910
* raillowint1011
* raillowint1112
* raillowint1213
* raillowint1314
* railstation
* replace
* toilets
* tubeexits03_ref
* tubeexits04_ref
* tubeexits05_ref
* tubeexits06_ref
* tubeexits03
* tubeexits04
* tubeexits05
* tubeexits06
* tubeexits07
* tubeexits08
* tubeexits09
* tubeexits10
* tubeexits11
* tubeexits12
* tubeexits13
</pre>
{{collapse bottom}}

== See also ==
* {{ml|params}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Documentation assistance templates]]
[[Category:Wikipedia formatting templates]]
[[Category:Template namespace templates]]
[[Category:Documentation templates]]
}}</includeonly>