Difference between revisions of "Template:Para/doc"
(Created page with "<code><nowiki>|</nowiki>{{#if:{{{1|}}}|{{{1}}}<nowiki>=</nowiki>|}}{{{2|}}}</code><noinclude> {{Documentation}} Category:Pages not to be tested on <!--Categories and inter...") |
|||
| Line 1: | Line 1: | ||
| − | <code>< | + | {{Documentation subpage}} |
| − | {{ | + | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> |
| − | [[Category:Pages not to be tested on]] | + | {{TOCright}} |
| − | + | === Description === | |
| − | </noinclude> | + | '''{{FULLPAGENAME}}''' is for giving examples of [[wikipedia:Wikipedia:Template messages|template]] parameter source code (useful in [[m:Help:template documentation|template documentation]] and [[Help:talk page|talk page]] discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be ''empty'', but it '''must''' be ''present''), and the second (optional) is a value for the first example parameter, or (if the first {{tlx|para}} parameter is empty) an unnamed example parameter. |
| + | |||
| + | ===Examples=== | ||
| + | # {{tlx|para|name}} | ||
| + | #:renders as | ||
| + | #:{{para|name}} | ||
| + | # {{tlx|para|title|<var>book title</var>}} | ||
| + | #:renders as | ||
| + | #:{{para|title|<var>book title</var>}} | ||
| + | # {{tlx|para|3=section|2=<span style="font-size: 1pt;"> </span>}} | ||
| + | #:renders as | ||
| + | #:{{para||section}} | ||
| + | #:(for unnamed parameters in the example code; note the empty first parameter in the {{tlx|para}} template) | ||
| + | # {{tlx|para|<var>parameter</var>|<var>value</var>}} | ||
| + | #:renders as | ||
| + | #:{{para|<var>parameter</var>|<var>value</var>}} | ||
| + | |||
| + | When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <tt><nowiki><var>value</var></nowiki></tt> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4). | ||
| + | |||
| + | === See also === | ||
| + | * {{tlx|Tlx}} — for providing examples of entire-template code with included parameters | ||
| + | <br /> | ||
| + | {{Tl-nav}} | ||
| + | |||
| + | <includeonly> | ||
| + | <!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> | ||
| + | {{DEFAULTSORT:{{PAGENAME}}}} | ||
| + | [[Category:Typing-aid templates]] | ||
| + | [[Category:Formatting and function templates]] | ||
| + | </includeonly><noinclude> | ||
| + | {{pp-move|small=yes}} | ||
| + | {{pp-move-indef}} | ||
| + | {{pp-template|small=yes}} | ||
| + | [[Category:Pages not to be tested on]]</noinclude> | ||
Latest revision as of 16:35, 29 February 2020
Description
Template:Para/doc is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) is a value for the first example parameter, or (if the first {{para}} parameter is empty) an unnamed example parameter.
Examples
- {{para|name}}
- renders as
|name=
- {{para|title|<var>book title</var>}}
- renders as
|title=book title
- {{para| |section}}
- renders as
|section- (for unnamed parameters in the example code; note the empty first parameter in the {{para}} template)
- {{para|<var>parameter</var>|<var>value</var>}}
- renders as
|parameter=value
When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <var>value</var> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4).
See also
- {{Tlx}} — for providing examples of entire-template code with included parameters
Template:Pp-move
Template:Pp-move-indef
Template:Pp-template
