साचा:Parameters/doc

Usage

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

check

Generates an invocation of Module:Check for unknown parameters which can be added to a template.

{{subst:Parameters|check|base={{subst:BASEPAGENAME}}}}

Output

{{#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}}

code

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}}}}

Output

{{Infobox high court
| 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 = 
}}

compare

Generates a comparison of the parameters available in two different templates.

{{subst:Parameters|compare|base=Infobox London station|other=Infobox station}}

Output

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

demo

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}}}}

Output

{{Parameter names example|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}}

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.

{{subst:Parameters|dlist|base={{subst:BASEPAGENAME}}}}

Output

; 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:

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.

{{subst:Parameters|list|base={{subst:BASEPAGENAME}}}}

Output

* 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

Common use cases

• 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;}}.