| Latest revision |
Your text |
| Line 3: |
Line 3: |
|
| |
|
| == Usage == | | == Usage == |
| This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). | | This template is for giving examples of [[Wikipedia:Template messages|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) one is a value for the first example parameter, or (if the first {{tlx|para}} parameter is empty) an unnamed example parameter. |
|
| |
|
| It must have at least 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''). The second (optional) parameter is a value for the first example parameter; or, if the first parameter is empty, the second illustrates an example [[mw:Help:Templates#Anonymous parameters|unnamed parameter]] (which in some cases may serve as a pre-defined parameter that takes no <code>{{!}}{{=}}value</code> after it, e.g. the {{para||section}} in {{tlx|Refimprove|section|SISTER=w:}}).
| | ===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>}} |
|
| |
|
| === Examples ===
| | 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). |
| {| class="wikitable"
| |
| ! Code
| |
| ! Result
| |
| ! Notes
| |
| |-
| |
| | {{tlx|para|name}}
| |
| | {{para|name}}
| |
| |
| |
| |-
| |
| | {{tlx|para|title|The Oxford English Dictionary}}
| |
| | {{para|title|The Oxford English Dictionary}}
| |
| |
| |
| |-
| |
| | {{tlx|para|2=<span style="font-size:1pt;"> </span>|3=section}}
| |
| | {{para||section}}
| |
| | For [[mw:Help:Templates#Parameters|unnamed parameters]]; note empty first parameter in the code
| |
| |-
| |
| | <code><nowiki>{{para|parameter|value}}</nowiki></code>
| |
| | {{para|parameter|value}}
| |
| |
| |
| |}
| |
|
| |
|
| == Parameters == | | == See also == |
| * {{para|1}} or first unnamed parameter – the parameter name. Give this parameter as explicitly blank and just fill in parameter 2 when you want to show an [[mw:Help:Templates#Anonymous parameters|unnamed parameter]] (which, depending on the context, may serve as a valueless parameter name); e.g., {{tlx||para||section}} → {{para||section}} | | * [[Template:Tlx]] – for providing examples of entire-template code with included parameters |
| * {{para|2}} or second unnamed parameter – the value name. When the first parameter is given but is blank, the second represents an unnamed parameter's value (or a valueless parameter name), as illustrated above.
| | |
| * {{para|plain|y}} (or any other value besides y) – removes the faint border and light-grey background, which may be useful in various situations. The border and text color are set to inherit, to use the colors of the surrounding text. This parameter cooperates with the two below, in that if either are used, the text will be colorized while the border and background will still be removed.
| | {{Tl-nav}} |
| * {{para|style}} – to apply arbitrary CSS style, for some specialized contextual purpose. Example: {{para|style|background-color: Yellow;}}. Any color, background-color, or border specified here will override those provided by any of the above parameters, regardless of the order in which the parameters are given in the template. As this template uses a span element, only CSS that can apply to inline elements (not block elements) will work. Like the above parameters, it applies to the entire output.
| |
| ** If you want to only style the parameter name and/or the value, just do so directly;<br />e.g.: <code><nowiki>{{para|page|'''single''' page number}}</nowiki></code>, <code><nowiki>{{para|page'''''<u>s</u>'''''|page '''range''', or '''multiple''' individual pages, or both}}</nowiki></code><br />gives: {{para|page|'''single''' page number}}, {{para|page'''''<u>s</u>'''''|page '''range''', or '''multiple''' individual pages, or both}}
| |
|
| |
|
| ==TemplateData==
| |
| <templatedata>
| |
| {
| |
| "params": {
| |
| "1": {
| |
| "label": "Parameter name",
| |
| "description": "The parameter name. Give this parameter as explicitly blank and just fill in parameter 2 when you want to show an unnamed parameter",
| |
| "type": "string",
| |
| "suggested": true
| |
| },
| |
| "2": {
| |
| "label": "Value name",
| |
| "description": "The value name. When the first parameter is given but is blank, the second represents an unnamed parameter's value (or a valueless parameter name).",
| |
| "type": "string",
| |
| "suggested": true
| |
| },
| |
| "plain": {
| |
| "description": "Removes the faint border and light-grey background",
| |
| "type": "boolean"
| |
| },
| |
| "style": {
| |
| "description": "Apply arbitrary CSS style, for some specialized contextual purpose.",
| |
| "example": "background-color: Yellow;",
| |
| "type": "content"
| |
| }
| |
| },
| |
| "description": "Gives examples of template parameter source code"
| |
| }
| |
| </templatedata>
| |
| <includeonly> | | <includeonly> |
| [[Category:Templates]] | | <!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> |
| | {{DEFAULTSORT:{{PAGENAME}}}} |
| | [[Category:Typing-aid templates]] |
| | [[Category:Wikipedia formatting and function templates]] |
| | [[af:Sjabloon:Para]] |
| | [[as:সাঁচ:Para]] |
| | [[az:Şablon:Para]] |
| | [[be-x-old:Шаблён:Парамэтар шаблёну]] |
| | [[bn:টেমপ্লেট:Para]] |
| | [[cy:Nodyn:Para]] |
| | [[da:Skabelon:Para]] |
| | [[dsb:Pśedłoga:Parameter]] |
| | [[dv:ފަންވަތް:Para]] |
| | [[eo:Ŝablono:Parametro]] |
| | [[es:Plantilla:Parámetro]] |
| | [[et:Mall:Para]] |
| | [[fa:الگو:پارا]] |
| | [[fi:Malline:Para]] |
| | [[gl:Modelo:Parámetro]] |
| | [[gv:Clowan:Para]] |
| | [[hsb:Předłoha:Parameter]] |
| | [[hu:Sablon:Para]] |
| | [[hy:Կաղապար:Para]] |
| | [[id:Templat:Para]] |
| | [[ja:Template:Para]] |
| | [[lad:Xablón:Para]] |
| | [[lt:Šablonas:Mažas]] |
| | [[mr:साचा:Para]] |
| | [[ms:Templat:Para]] |
| | [[no:Mal:Para]] |
| | [[or:ଛାଞ୍ଚ:Para]] |
| | [[pt:Predefinição:Para]] |
| | [[ro:Format:Para]] |
| | [[sd:سانچو:Para]] |
| | [[simple:Template:Para]] |
| | [[sl:Predloga:Para]] |
| | [[sr:Шаблон:Para]] |
| | [[sv:Mall:Para]] |
| | [[ta:வார்ப்புரு:Para]] |
| | [[th:แม่แบบ:Para]] |
| | [[tpi:Template:Para]] |
| | [[tr:Şablon:Parametre]] |
| | [[uk:Шаблон:Para]] |
| | [[ur:سانچہ:پیرا]] |
| </includeonly> | | </includeonly> |
