Template:Tp/doc

This is a subpage documenting Template:Tp. To change the template, edit that page; to change the template's documentation (seen below), edit this one.

Documentation

This template is used to markup template parameter names in template documentation (or in talk page discussions, etc.). Template:Tpv can be used to markup template parameter values. (Currently they look exactly the same, but this may change in the future.)

The template does not complain about missing input. The default value (when no input is provided) is the label "parameter_name", as seen above.

The template should not be used in articles.

This template is used on a great many pages. Making any changes to it will cause lots of jobs to be added to the processing queue.

Usage

• {{tp}}
• {{tp|parameter_name}}
• {{tp|parameter_name|full=non-whitespace}}

The last form enables "full" parameter rendering, with a leading vertical bar and trailing equals sign, as seen in the examples below. Assuming you want to enable this feature, the value of full can be any non-whitespace character (or string of same); common choices are 1, y, and true, but 0, n, and false would accomplish the same thing (the template doesn't care what the value actually is, just that it contains non-whitespace). If nothing appears between the equals sign and the closing double-braces, or if only whitespace appears there (e.g., …|full= }}), then the parameter will be seen as "empty", which is equivalent to it not being there at all.

Examples

• {{tp}} ⇒ parameter_name
• {{tp|accessed}} ⇒ accessed
• {{tp|accessed|full=y}} ⇒ |accessed=