Difference between revisions of "Template:Para/doc"
From Summertime Saga Wiki
m (→Usage) |
m |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | The {{ | + | The template {{tlg|para}} 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 {{ | + | 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 {{tlg|code=yes|nolink=yes|para}} parameter is empty, an unnamed example parameter. |
== Examples == | == Examples == | ||
| Line 12: | Line 12: | ||
! Notes | ! Notes | ||
|- | |- | ||
| − | | {{ | + | | {{tlg|code=yes|nolink=yes|para|name}} |
| {{para|name}} | | {{para|name}} | ||
| | | | ||
|- | |- | ||
| − | | | + | | {{tlg|code=yes|nolink=yes|para|title|{{var|book title}}}} |
| {{para|title|{{var|book title}}}} | | {{para|title|{{var|book title}}}} | ||
| | | | ||
|- | |- | ||
| − | | {{ | + | | {{tlg|code=yes|nolink=yes|para|2{{=}}<span style="font-size:1pt;"> </span>|3{{=}}section}} |
| {{para||section}} | | {{para||section}} | ||
| For unnamed parameters; note empty first parameter in the code | | For unnamed parameters; note empty first parameter in the code | ||
|- | |- | ||
| − | | | + | | {{tlg|code=yes|nolink=yes|para|{{var|parameter}}|{{var|value}}}} |
| {{para|{{var|parameter}}|{{var|value}}}} | | {{para|{{var|parameter}}|{{var|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 {{ | + | 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 {{tlg|code=yes|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 == | ||
| − | * {{ | + | * {{tlg|tag}} - provides a similar service for HTML tags. |
[[Category:Templates]][[Category:Semantic markup templates]][[Category:Templates documentation]] | [[Category:Templates]][[Category:Semantic markup templates]][[Category:Templates documentation]] | ||
Latest revision as of 18:42, 21 July 2020
The template {{para}} 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 {{para}} parameter is empty, an unnamed example parameter.
Examples
| Markup | Renders as | Notes |
|---|---|---|
{{para|name}}
|
|name=
|
|
{{para|title|book title}}
|
|title=book title
|
|
{{para|3=section}}
|
|section
|
For unnamed parameters; note empty first parameter in the code |
{{para|parameter|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 {{var|value}} (as in the second example above). The same should be done for non‐literal, example parameters (fourth example above).
See also
- {{tag}} - provides a similar service for HTML tags.