Template:Para/doc: Difference between revisions

From wikiNonStop
Browse history interactively
Content added Content deleted
VisualWikitext
m (→‎Examples: consistent coloring)
m (1 revision imported: initial Setup)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Distinguish|Template:Paragraph break|Template:Param}}
{{Distinguish|Template:Param|Template:Parameter}}
{{High-use|590427}}
{{Uses TemplateStyles|Template:Mono/styles.css|Template:Nowrap/styles.css}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
__TOC__

{{clear}}
== Usage ==
== Usage ==
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).
This template is for giving examples of [[w: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.


===Examples===
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 [[Help:Templates#Parameters|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 {{tlx|Refimprove|section}}).
#&nbsp;&nbsp;{{tlx|para|name}}
#:renders as
#:{{para|name}}
#&nbsp;&nbsp;{{tlx|para|title|&lt;var&gt;book title&lt;/var&gt;}}
#:renders as
#:{{para|title|<var>book title</var>}}
#&nbsp;&nbsp;{{tlx|para|3=section|2=<span style="font-size: 1pt;">&nbsp;</span>}}
#:renders as
#:{{para||section}}
#:(for unnamed parameters in the example code; note the empty first parameter in the {{tlx|para}} template)
#&nbsp;&nbsp;{{tlx|para|&lt;var&gt;parameter&lt;/var&gt;|&lt;var&gt;value&lt;/var&gt;}}
#: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 <code><nowiki><var>value</var></nowiki></code> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4).
=== Examples ===
{| class="wikitable"
! Code
! Result
! Notes
|-
| <syntaxhighlight lang="wikitext" inline>{{para|name}}</syntaxhighlight>
| {{para|name}}
|
|-
| <syntaxhighlight lang="wikitext" inline>{{para|title|The Oxford English Dictionary}}</syntaxhighlight>
| {{para|title|The Oxford English Dictionary}}
|
|-
| <syntaxhighlight lang="wikitext" inline>{{para||section}}</syntaxhighlight>
| {{para||section}}
| For [[Help:Templates#Parameters|unnamed parameters]];<br />note empty first<br />parameter in<br />the code
|-
| <syntaxhighlight lang="wikitext" inline>{{para|{{var|parameter}}|{{var|value}}}}</syntaxhighlight>
| {{para|{{var|parameter}}|{{var|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 {{tlx|var|parameter}} and/or {{tnull|var|value}} (as in the last example above).


== Parameters ==
== TemplateData ==
{{TemplateData header}}
* {{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 [[Help:Templates#Parameters|unnamed parameter]] (which, depending on the context, may serve as a valueless parameter name); e.g., {{tnull|para||section}} → {{para||section}}
{{#invoke:TNT|doc|para}}
* {{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 {{kbd|y}}) – 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.
* {{para|mxt|y}} or {{para|green|y}} – to apply the style (green text, but still monospaced as code) that would be applied by {{tlx|mxt}} ("monospaced example text"). This is so that {{tnull|para}} can be used inside a passage of {{tnull|mxt}} content without the {{tag|code|o}} markup inside {{tnull|para}} overriding the color of {{tnull|mxt}}. This parameter cooperates with {{para|plain}} in applying the color but respecting the removal of border and background.
* {{para|!mxt|y}} or {{para|red|y}} – same as above, but applies the red of {{tlx|!mxt}}, the "bad monospaced example text" template.
* {{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 {{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.
** If you want to only style the parameter name and/or the value, just do so directly;<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}}}}

==TemplateData==
{{TemplateData header|noheader=1}}
<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": {
"label": "Plain",
"description": "Removes the faint border and light-grey background.",
"type": "boolean",
"default": "y"
},
"mxt": {
"label": "Green text",
"description": "Colors the text in green.",
"type": "boolean",
"aliases": [
"green"
],
"default": "y"
},
"!mxt": {
"label": "Red text",
"description": "Colors the text in red.",
"type": "boolean",
"aliases": [
"red"
],
"default": "y"
},
"style": {
"label": "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>


== See also ==
== See also ==
* {{tl|ApiParam}} &ndash; for documenting API parameters
The three tables below describe the family of approximately forty templates built for talking about templates.
{{tl-nav}}

There are also some related templates or subjects not found in those tables:
* {{tlx|Param}}, for markup of examples of parameter names as they would appear in MediaWiki source code of templates, e.g. {{tnull|param|foo}} gives: {{param|foo}}
* {{tlx|Template journal parameter}}, for markup of examples of parameter names as they would appear in the {{tl|tj}} and {{tl|tji}} templates.
* {{tlx|Tag|...|attribs}}, for markup of examples of HTML elements' attributes and values; e.g. {{tji|tag|a|attribs: href{{=}}/demo.php|o}} gives: {{tag|a|attribs=href=/demo.php|o}}<!--


This area creates a more user-friendly gap to clearly isolate area for adding See also entries that are not part of {{tl-nav}}.


-->
{{Tl-nav}}
{{Semantic markup templates}}
<includeonly>{{Sandbox other||
<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
<!------CATEGORIES ETC HERE, PLEASE------>
[[Category:Wikitext typing-aid templates]]
[[Category:Typing-aid templates{{#translation:}}]]
[[Category:Wikipedia utility templates]]
[[Category:Formatting templates{{#translation:}}]]
[[Category:Semantic markup templates{{#translation:}}]]
}}</includeonly>
}}</includeonly>

Revision as of 14:15, 15 August 2024

Not to be confused with Template:Param or Template:Parameter.

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 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 {{para}} parameter is empty) an unnamed example parameter.

Examples

  1.   {{para|name}}
    renders as
    |name=
  2.   {{para|title|<var>book title</var>}}
    renders as
    |title=book title
  3.   {{para| |section}}
    renders as
    |section
    (for unnamed parameters in the example code; note the empty first parameter in the {{para}} template)
  4.   {{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).

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Para

No description.

Template parameters

ParameterDescriptionTypeStatus
Name1

The parameter name.

Stringrequired
Value2

The parameter value.

Stringsuggested
Plain?plain

Whether to use plain text instead of <code>.

Default
0
Auto value
1
Booleanoptional
Nowrap?nowrap

Whether to add `style="white-space:nowrap"`.

Default
1
Auto value
0
Booleanoptional

Edit parameter translations

See also

  • {{ApiParam }} – for documenting API parameters

These tables: view · talk · edit

Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓ {{tlg}} options[note 1]
to achieve text style 		Link style
Linked Unlinked Linked with subst
{{tlg}} options[note 1]
to achieve link style 		N/A DEFAULT nolink=1 subst=1
normal DEFAULT
code code=1
monospace mono=1[note 4]
N/A
plaincode plaincode=1[note 5]
kbd kbd=1[note 6]
  1. ↑ 1.0 1.1 1.2 {{tlg}} is the most general template, allowing any combination of text style and/or link style options.
  2. ↑ 2.0 2.1 2.2 Prevents wrapping of text by placing it inside <span style="white-space:nowrap">...</span> tags.
  3. ↑ Allows links to templates in any namespace.
  4. ↑ 4.0 4.1 4.2 Displays monospaced font using <span style="font-family:monospace">...</span>.
  5. ↑ {{Template:Para/doc}} uses <code style="background:transparent;border:none">...</code> .
  6. ↑ {{Template:Para/doc}} uses ‎<kbd> tags.
Retrieved from "https://compusofia.com/w/index.php?title=Template:Para/doc&oldid=899"