Template:Tp/doc

From Angelina Jordan Wiki
Revision as of 21:57, 28 October 2020 by Dcljr (talk | contribs) (doc created)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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.

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