Difference between revisions of "Template:Para/doc"
m |
m |
||
| Line 1: | Line 1: | ||
| + | The {{tl|para}} template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). | ||
| + | |||
== Usage == | == Usage == | ||
| − | + | It must have one or two parameters itself. The first parameter is the name of the example parameter to display (this may be {{em|empty}}, but it must be {{em|present}}), and the second (optional) parameter is a value for the first example parameter or, if the first {{tlx|para}} parameter is empty, an unnamed example parameter. | |
| − | + | == Examples == | |
{| class="wikitable" | {| class="wikitable" | ||
| − | ! | + | ! Markup |
| − | ! | + | ! Renders as |
! Notes | ! Notes | ||
|- | |- | ||
| Line 20: | Line 22: | ||
| {{tlx|para|2=<span style="font-size:1pt;"> </span>|3=section}} | | {{tlx|para|2=<span style="font-size:1pt;"> </span>|3=section}} | ||
| {{para||section}} | | {{para||section}} | ||
| − | | For | + | | For unnamed parameters; note empty first parameter in the code |
|- | |- | ||
| <code><nowiki>{{para|{{var|parameter}}|{{var|value}}}}</nowiki></code> | | <code><nowiki>{{para|{{var|parameter}}|{{var|value}}}}</nowiki></code> | ||
| Line 27: | Line 29: | ||
|} | |} | ||
| − | When using literal, | + | When using literal, pre‐specified values, simply provide the value (as in the third example above). When illustrating hypothetical, variable, or user‐definable values, use {{tlx|var|value}} (as in the second example above). The same should be done for non‐literal, example parameters (fourth example above). |
== See also == | == See also == | ||
| − | * {{tl|tag}} - for providing a similar service, but for HTML tags | + | * {{tl|tag}} - for providing a similar service, but for HTML tags. |
| − | [[Category:Templates]] | + | [[Category:Templates]][[Category:Semantic markup templates]][[Category:Templates documentation]] |
| − | [[Category:Templates documentation]] | ||
Revision as of 14:56, 11 July 2020
The Template:Tl template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code).
Usage
It must have one or two parameters itself. The first parameter is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) parameter is a value for the first example parameter or, if the first Template:Tlx parameter is empty, an unnamed example parameter.
Examples
| Markup | Renders as | Notes |
|---|---|---|
| Template:Tlx | |name=
|
|
{{para|title|{{var|book title}}}}
|
|title=book title
|
|
| Template:Tlx | |section
|
For unnamed parameters; note empty first parameter in the code |
{{para|{{var|parameter}}|{{var|value}}}}
|
|parameter=value
|
When using literal, pre‐specified values, simply provide the value (as in the third example above). When illustrating hypothetical, variable, or user‐definable values, use Template:Tlx (as in the second example above). The same should be done for non‐literal, example parameters (fourth example above).
See also
- Template:Tl - for providing a similar service, but for HTML tags.