Template:Parameters/doc

From Wikipedia, the free encyclopedia

Page Module:Message box/ombox.css has no content.

Template:Subst only

Page Module:Message box/ombox.css has no content.

Usage

Template:Tl 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=. Template:Tl must always be substituted. Its usage is demonstrated below.

Common use cases

  • To add a Template:Tl to a template's documentation, use: {{subst:Parameters|demo|base={{subst:BASEPAGENAME}}}}
  • To document the transclusion syntax, use: {{subst:Parameters|code|base={{subst:BASEPAGENAME}}}}

Options

check

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

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

Page Template:Collapse top/styles.css has no content.

code

Generates display of 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}}}}

Page Template:Collapse top/styles.css has no content.

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.

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

Page Template:Collapse top/styles.css has no content.

demo

Generates an invocation of Template:Tl, formerly known as Template:Tl, which can added to a template's documentation.

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

Page Template:Collapse top/styles.css has no content.

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

Page Template:Collapse top/styles.css has no content.

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 Template:Tl the description is indented.

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

Page Template:Collapse top/styles.css has no content.

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

Page Template:Collapse top/styles.css has no content.

compare

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

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

Page Template:Collapse top/styles.css has no content.

See also