Template:Template parameter usage/doc - Revision history

Matt at 09:26, 16 April 2025

2025-04-16T09:26:11Z

← Older revision		Revision as of 04:26, 16 April 2025
Line 2:		Line 2:
	{{Documentation subpage}}		{{Documentation subpage}}
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
	~~{{shortcut\|1=WP:TPU}}~~		The [https://bambots.brucemyers.com/TemplateParam.php Template Parameters tool] is available for viewing template parameter usage in articles. It works with TemplateData to show the frequency of parameter name usage in a template's mainspace transclusions, along with whether or not each parameter is listed in that template's TemplateData code as a supported parameter. For a required parameter, it can display a list of pages where the template is missing that parameter. The tool also shows commonly used values for each parameter. Each report is updated monthly and does not reflect changes made to articles or to the TemplateData code after the report's generation.
	The [https://bambots.brucemyers.com/TemplateParam.php Template Parameters tool] is available for viewing template parameter usage in articles. It works with ~~[[Wikipedia:~~TemplateData~~\|TemplateData]]~~ to show the frequency of parameter name usage in a template's mainspace transclusions, along with whether or not each parameter is listed in that template's TemplateData code as a supported parameter. For a required parameter, it can display a list of pages where the template is missing that parameter. The tool also shows commonly used values for each parameter. Each report is updated monthly and does not reflect changes made to articles or to the TemplateData code after the report's generation.

	== Usage ==		== Usage ==

Matt at 10:17, 14 April 2025

2025-04-14T10:17:10Z

← Older revision		Revision as of 05:17, 14 April 2025
Line 17:		Line 17:
	:<nowiki>{{Template parameter usage}}</nowiki> → {{Template parameter usage}} [for this page]		:<nowiki>{{Template parameter usage}}</nowiki> → {{Template parameter usage}} [for this page]
	One can enter a template name:		One can enter a template name:
	:<nowiki>~~{{Template parameter usage\|Infobox film}}~~</nowiki> → ~~{{Template parameter usage\|Infobox film}}~~		:<nowiki></nowiki> →

	Optional:		Optional:
	* {{para\|lc\|yes}} for lowercase "click":		* {{para\|lc\|yes}} for lowercase "click":
	* Entering is accepted (namespace is removed). Editor friendly, using a positional parameter.		* Entering is accepted (namespace is removed). Editor friendly, using a positional parameter.
	: When {{para\|1}} is used, "this template" text changes: → ~~{{Template parameter usage\|1=Infobox film}}~~		: When {{para\|1}} is used, "this template" text changes: →
	* {{para\|label}} sets the visible text; it does not change the target link:		* {{para\|label}} sets the visible text; it does not change the target link:
	::{{para\|label}} default → ~~{{Template parameter usage\|1=Infobox film}}~~		::{{para\|label}} default →
	::{{para\|label\|none}} → ~~{{Template parameter usage\|1=Infobox film\|label=none}}~~		::{{para\|label\|none}} →
	::{{para\|label\|for}} → ~~{{Template parameter usage\|1=Infobox film\|label=for}}~~		::{{para\|label\|for}} →
	::{{para\|label\|FooBar}} → ~~{{Template parameter usage\|1=Infobox film\|label=FooBar}}~~		::{{para\|label\|FooBar}} →
	* {{para\|based\|yes}} adds the text "based on this TemplateData" to the end of the template (or "based on its TemplateData" if {{para\|1}} is also used).		* {{para\|based\|yes}} adds the text "based on this TemplateData" to the end of the template (or "based on its TemplateData" if {{para\|1}} is also used).

Matt at 10:16, 14 April 2025

2025-04-14T10:16:30Z

← Older revision		Revision as of 05:16, 14 April 2025
Line 20:		Line 20:

	Optional:		Optional:
	* {{para\|lc\|yes}} for lowercase "click": ~~{{Template parameter usage\|lc=yes\|Infobox film}}~~		* {{para\|lc\|yes}} for lowercase "click":
	* Entering ~~{{para\|1\|Template:Infobox film}}~~ is accepted (namespace is removed). Editor friendly, using a positional parameter.		* Entering is accepted (namespace is removed). Editor friendly, using a positional parameter.
	: When {{para\|1}} is used, "this template" text changes: → {{Template parameter usage\|1=Infobox film}}		: When {{para\|1}} is used, "this template" text changes: → {{Template parameter usage\|1=Infobox film}}
	* {{para\|label}} sets the visible text; it does not change the target link:		* {{para\|label}} sets the visible text; it does not change the target link:

Matt at 21:36, 9 April 2025

2025-04-09T21:36:38Z

← Older revision		Revision as of 16:36, 9 April 2025
Line 1:		Line 1:
	{{wikipedia\|page name}}		{{wikipedia\|page name}}
	{{Documentation subpage}}		{{Documentation subpage}}
	~~{{High-use}}~~
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
	{{shortcut\|1=WP:TPU}}		{{shortcut\|1=WP:TPU}}

Matt at 08:38, 9 April 2025

2025-04-09T08:38:54Z

← Older revision		Revision as of 03:38, 9 April 2025
Line 13:		Line 13:

	===Parameters===		===Parameters===
	~~{{tj\|Template parameter usage~~
	~~\| 1: <!-- template:name, default{{=}}pagename -->~~
	~~\| lc: <!-- yes/no -->~~
	~~\| label: <!-- keywords like "for", or free labeltext -->~~
	}}
	:All parameters are optional, and have a default		:All parameters are optional, and have a default

Line 93:		Line 88:
	</templatedata>		</templatedata>

	~~==See also==~~
	* {{tl\|TemplateData header}} -- major user of this template
	* [[User:Bamyers99/TemplateParametersTool]] - the tool
	<includeonly>{{sandbox other\|\|		<includeonly>{{sandbox other\|\|
	<!-- Categories below this line, please; interwikis at Wikidata -->		<!-- Categories below this line, please; interwikis at Wikidata -->

Matt at 21:24, 5 March 2025

2025-03-05T21:24:27Z

← Older revision		Revision as of 16:24, 5 March 2025
Line 1:		Line 1:
			{{wikipedia\|page name}}
	{{Documentation subpage}}		{{Documentation subpage}}
	{{High-use}}		{{High-use}}

Matt: Protected "Template:Template parameter usage/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2025-03-05T20:34:12Z

Protected "Template:Template parameter usage/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision	Revision as of 15:34, 5 March 2025
(No difference)

Matt: Created page with "{{Documentation subpage}} {{High-use}} {{shortcut|1=WP:TPU}} The [https://bambots.brucemyers.com/TemplateParam.php Template Parameters tool] is available for viewing template parameter usage in articles. It works with TemplateData to show the frequency of parameter name usage in a template's mainspace transclusions..."

2025-03-05T19:12:50Z

Created page with "{{Documentation subpage}} {{High-use}}  {{shortcut|1=WP:TPU}} The [https://bambots.brucemyers.com/TemplateParam.php Template Parameters tool] is available for viewing template parameter usage in articles. It works with TemplateData to show the frequency of parameter name usage in a template's mainspace transclusions..."

New page

{{Documentation subpage}}
{{High-use}}

{{shortcut|1=WP:TPU}}
The [https://bambots.brucemyers.com/TemplateParam.php Template Parameters tool] is available for viewing template parameter usage in articles. It works with [[Wikipedia:TemplateData|TemplateData]] to show the frequency of parameter name usage in a template's mainspace transclusions, along with whether or not each parameter is listed in that template's TemplateData code as a supported parameter. For a required parameter, it can display a list of pages where the template is missing that parameter. The tool also shows commonly used values for each parameter. Each report is updated monthly and does not reflect changes made to articles or to the TemplateData code after the report's generation.

== Usage ==
Example:
<div style="background:#ddd">
* {{tl|Infobox lighthouse}}/documentation: {{Slink|Template:Infobox_lighthouse|TemplateData}} → "''[https://bambots.brucemyers.com/TemplateParam.php?wiki=enwiki&template=Infobox+lighthouse Click here] to see a monthly parameter usage report ...''" → [https://bambots.brucemyers.com/TemplateParam.php?wiki=enwiki&template=Infobox+lighthouse].
</div>

===Parameters===
{{tj|Template parameter usage
| 1: 
| lc: 
| label: 
}}
:All parameters are optional, and have a default

By default, the template links for the template page:
:<nowiki>{{Template parameter usage}}</nowiki> → {{Template parameter usage}} [for this page]
One can enter a template name:
:<nowiki>{{Template parameter usage|Infobox film}}</nowiki> → {{Template parameter usage|Infobox film}}

Optional:
* {{para|lc|yes}} for lowercase "click": {{Template parameter usage|lc=yes|Infobox film}}
* Entering {{para|1|Template:Infobox film}} is accepted (namespace is removed). Editor friendly, using a positional parameter.
: When {{para|1}} is used, "this template" text changes: → {{Template parameter usage|1=Infobox film}}
* {{para|label}} sets the visible text; it does not change the target link:
::{{para|label}} default → {{Template parameter usage|1=Infobox film}}
::{{para|label|none}} → {{Template parameter usage|1=Infobox film|label=none}}
::{{para|label|for}} → {{Template parameter usage|1=Infobox film|label=for}}
::{{para|label|FooBar}} → {{Template parameter usage|1=Infobox film|label=FooBar}}
* {{para|based|yes}} adds the text "based on this TemplateData" to the end of the template (or "based on its TemplateData" if {{para|1}} is also used).

The template is included in transclusions of {{Tl|TemplateData header}}.

== Error reports ==

{{tl|Template parameter usage}}

By default, it links a report for the template-page being viewed. To link a report for a different template-page, pass it as the first parameter:

:{{tlx|Template parameter usage|Example}} makes a link to the error report for [[Template:Example]]:

:→ {{Template parameter usage|Example}}

The first character can be made lowercase to follow on at the end of a sentence:
:<code>Blah, {{tlp|Template parameter usage|2=lc=yes}}</code> → Blah, {{Template parameter usage|lc=yes}}

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
"description": "Short line of text providing a link to a monthly parameter usage report for a template based on its TemplateData",
"format": "inline",
"params": {
"lc": {
"label": "Lowercase",
"description": "Enter \"y\", \"yes\", \"true\", \"on\" or \"1\" here to make the text begin with a lowercase character.",
"type": "line",
"autovalue": "y",
"example": "y"
},
"1": {
"label": "Custom template",
"description": "Enter any template here to change the usage report link to that of that template",
"type": "wiki-template-name",
"example": "Anchor"
},
"label": {
"label": "Custom text",
"description": "Enter any text here to make the template just the usage report link with the given custom text. Alternatively, enter \"none\" to include only the usage report link, or enter \"for\" to include only the usage report link followed by \"for <template name>\".",
"type": "string"
},
"based": {
"label": "Append \"based on this[/its] TemplateData\"",
"description": "Enter \"y\", \"yes\", \"true\", \"on\" or \"1\" here to append the text \"based on this TemplateData\" (or \"based on its TemplateData\" if \"Custom template\" is also used).",
"type": "line",
"autovalue": "y",
"example": "y"
}
},
"paramOrder": [
"lc",
"1",
"label",
"based"
]
}
</templatedata>

==See also==
* {{tl|TemplateData header}} -- major user of this template
* [[User:Bamyers99/TemplateParametersTool]] - the tool
<includeonly>{{sandbox other||

[[Category:External link templates]]

}}</includeonly>