Template:Para/doc: Difference between revisions

Template:Para/doc (view source)

Revision as of 09:38, 23 January 2025

5,472 bytes added , 23 January

→‎Usage: clean up

VisualWikitext

Anonymous user

wikipedia>Gonnym

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
+{{Distinguish|Template:Paragraph break|Template:Param}}
+{{High-use|590427}}
 <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 == 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).  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.
+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).
-===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|More citations needed|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 <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).
+=== 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 ==
+* {{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}}
+* {{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|&#124;section}} → {{para||section}}
+* {{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 ({{mxt|green monospaced text}}) that would be applied by {{tlx|mxt}}. Since {{tnull|para}} contains {{tag|code|o}} markup inside its source which would override the color of {{tnull|mxt}}, these parameters can be used when {{tnull|para}} is used for text inside a passage of {{tnull|mxt}} content. 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 “{{!mxt|bad monospaced example text}}" template.
+* {{para|style}} – to apply arbitrary [[Wikipedia:Css|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}}}}
+==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 ==
-* [[Template:Tlx]] &ndash; for providing examples of entire-template code with included parameters
+The three tables below describe the family of approximately forty templates built for talking about templates.
+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}}.
-<includeonly>[[Category:Core wiki templates]]</includeonly>
+-->
-<noinclude>[[Category:Core wiki templates]]</noinclude>
+{{Tl-nav}}
+{{Semantic markup templates}}
+<includeonly>{{Sandbox other||
+<!------CATEGORIES ETC HERE, PLEASE------>
+[[Category:Wikitext typing-aid templates]]
+[[Category:Wikipedia formatting templates]]
+}}</includeonly>