More actions
No edit summary |
No edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{wikipedia|page name}} | {{wikipedia|page name}} | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | ||
| Line 7: | Line 6: | ||
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 template parameter source code (useful in template documentation and talk page discussions of template code). | ||
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 unnamed parameter (which in some cases may serve as a pre-defined parameter that takes no <code>{{!}}{{=}}{{var|value}}</code> after it, e.g. the {{para||section}} in | 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 unnamed parameter (which in some cases may serve as a pre-defined parameter that takes no <code>{{!}}{{=}}{{var|value}}</code> after it, e.g. the {{para||section}} in ). | ||
=== Examples === | === Examples === | ||
| Line 37: | Line 36: | ||
* {{para|2}} or second unnamed parameter – the value name; e.g., {{tnull|para|section|about}} → {{para|section|about}}. | * {{para|2}} or second unnamed parameter – the value name; e.g., {{tnull|para|section|about}} → {{para|section|about}}. | ||
** When the first parameter is given but is blank, the second represents an unnamed parameter's value (or a valueless parameter name), and only the parameter is shown with no equal’s sign; e.g., {{tnull|para||section}} → {{para||section}} | ** When the first parameter is given but is blank, the second represents an unnamed parameter's value (or a valueless parameter name), and only the parameter is shown with no equal’s sign; e.g., {{tnull|para||section}} → {{para||section}} | ||
* {{para|plain|y}} (or any other value besides | * {{para|plain|y}} (or any other value besides ) – removes the faint border and light-grey background, which may be useful in various situations. The border and text color are set to {{samp|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. | ||
* | * or {{para|green|y}} – to apply the style (}) that would be applied by . Since {{tnull|para}} contains {{tag|code|o}} markup inside its source which would override the color of , these parameters can be used when {{tnull|para}} is used for text inside a passage of content. This parameter cooperates with {{para|plain}} in applying the color but respecting the removal of border and background. | ||
* | * or {{para|red|y}} – same as above, but applies the red of , the “" template. | ||
* {{para|style}} – to apply arbitrary CSS style, for some specialized contextual purpose. Example: {{para|style|background-color: Yellow;}}. Any <code>color</code>, <code>background-color</code>, or <code>border</code> 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 {{tag|span|o}} element, only CSS that can apply to inline elements (not block elements) will work. Like the above parameters, it applies to the entire output. | * {{para|style}} – to apply arbitrary CSS style, for some specialized contextual purpose. Example: {{para|style|background-color: Yellow;}}. Any <code>color</code>, <code>background-color</code>, or <code>border</code> 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 {{tag|span|o}} element, only CSS that can apply to inline elements (not block elements) will work. Like the above parameters, it applies to the entire output. | ||
** {{bulb}} To specifically style the parameter name and/or the value:<br />e.g., <syntaxhighlight lang="wikitext" inline>{{para|page|{{var|'''single''' page number}}}}</syntaxhighlight>, <syntaxhighlight lang="wikitext" inline>{{para|page'''''<u>s</u>'''''|{{var|page '''range''', or '''multiple''' individual pages, or both}}}}</syntaxhighlight><br />gives: {{para|page|{{var|'''single''' page number}}}}, {{para|page'''''<u>s</u>'''''|{{var|page '''range''', or '''multiple''' individual pages, or both}}}} | ** {{bulb}} To specifically style the parameter name and/or the value:<br />e.g., <syntaxhighlight lang="wikitext" inline>{{para|page|{{var|'''single''' page number}}}}</syntaxhighlight>, <syntaxhighlight lang="wikitext" inline>{{para|page'''''<u>s</u>'''''|{{var|page '''range''', or '''multiple''' individual pages, or both}}}}</syntaxhighlight><br />gives: {{para|page|{{var|'''single''' page number}}}}, {{para|page'''''<u>s</u>'''''|{{var|page '''range''', or '''multiple''' individual pages, or both}}}} | ||
| Line 94: | Line 93: | ||
} | } | ||
</templatedata> | </templatedata> | ||
Latest revision as of 06:22, 14 April 2025
| This page uses Creative Commons Licensed content from Wikipedia (view authors). |
| This is a documentation subpage for Template:Para It may contain usage information, categories and other content that is not part of the original template page. |
Usage
This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code).
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 unnamed parameter (which in some cases may serve as a pre-defined parameter that takes no |=value after it, e.g. the |section in ).
Examples
| Code | Result | Notes |
|---|---|---|
{{para|name}}
|
|name=
|
|
{{para|title|The Oxford English Dictionary}}
|
|title=The Oxford English Dictionary
|
|
{{para||section}}
|
|section
|
For unnamed parameters; note empty first parameter in the code |
{{para|{{var|parameter}}|{{var|value}}}}
|
|parameter=value
|
When using literal, pre-specified parameter names and values, simply provide them (as in the first through third examples above). When illustrating hypothetical/example parameter names, or variable or user-definable values, use something like {{var|parameter}} and/or {{var|value}} (as in the last example above).
Parameters
|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 unnamed parameter (which, depending on the context, may serve as a valueless parameter name); e.g.,{{para|section}}→|section=|2=or second unnamed parameter – the value name; e.g.,{{para|section|about}}→|section=about.- When the first parameter is given but is blank, the second represents an unnamed parameter's value (or a valueless parameter name), and only the parameter is shown with no equal’s sign; e.g.,
{{para||section}}→|section
- When the first parameter is given but is blank, the second represents an unnamed parameter's value (or a valueless parameter name), and only the parameter is shown with no equal’s sign; e.g.,
|plain=y(or any other value besides ) – 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.- or
|green=y– to apply the style (}) that would be applied by . Since{{para}}contains<code>markup inside its source which would override the color of , these parameters can be used when{{para}}is used for text inside a passage of content. This parameter cooperates with|plain=in applying the color but respecting the removal of border and background. - or
|red=y– same as above, but applies the red of , the “" template. |style=– to apply arbitrary CSS style, for some specialized contextual purpose. Example:|style=background-color: Yellow;. Anycolor,background-color, orborderspecified 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.- Template:Bulb To specifically style the parameter name and/or the value:
e.g.,{{para|page|{{var|'''single''' page number}}}},{{para|page'''''<u>s</u>'''''|{{var|page '''range''', or '''multiple''' individual pages, or both}}}}
gives:|page=single page number,|pages=page range, or multiple individual pages, or both
- Template:Bulb To specifically style the parameter name and/or the value:
TemplateData
TemplateData for Para
Gives examples of template parameter source code
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Parameter name | 1 | The parameter name. Give this parameter as explicitly blank and just fill in parameter 2 when you want to show an unnamed parameter. | String | suggested |
| Value name | 2 | 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). | String | suggested |
| Plain | plain | Removes the faint border and light-grey background.
| Boolean | optional |
| Green text | mxt green | Colors the text in green.
| Boolean | optional |
| Red text | !mxt red | Colors the text in red.
| Boolean | optional |
| Style | style | Apply arbitrary CSS style, for some specialized contextual purpose.
| Content | optional |
This area creates a more user-friendly gap to clearly isolate area for adding See also entries that are not part of Template:Tl-nav.
-->
Template:Tl-nav