Template: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  function requires a third parameter, other. Parameters must always be substituted. Its usage is demonstrated below.

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

code
Generates code to display the transclusion syntax (a blank template) which can added to a template's documentation. yes aligns the equal signs vertically. code

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

demo
Generates an invocation of Parameter names example, formerly known as Generic template demo, which can added to a template's documentation. demo

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. dlist

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. list

Common use cases

 * To add a Parameter names example to a template's documentation, use.
 * To document the transclusion syntax, use.