Template:Improve documentation/doc: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 21:59, 13 February 2024

{{nodoc}}

This is a documentation subpage for Template:Improve documentation.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 3,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

Usage

For use on template/module documentation pages whose content is missing, insufficient, incomplete and/or inaccurate.

Example: {{Improve documentation|date=August 2024}}

The template adds pages to Category:Templates with missing or incorrect documentation.

TemplateData

Tags templates with inadequate or nonexistent documentations.

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Typ	Status
Has details on talk page	`talk` `1`	Shows "See the talk page for details" if a value is supplied	Boolean	optional
Date	`date`	Date tagged Auto value `{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}`	String	optional

@@ Line 1: / Line 1: @@
+{{tsh|nodoc}}
 {{Documentation subpage}}
+{{High-use}}
-<!-- Categories and interwikis go at the bottom of this page. -->
+{{No subst}}
+<!-- Categories where indicated at the bottom of this page, please. -->
 == Usage ==
+For use on '''template/module documentation pages''' whose content is missing, insufficient, incomplete and/or inaccurate.
+Example: {{Tlx|Improve documentation|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
+The template adds pages to [[:Category:Templates with missing or incorrect documentation]].
+==TemplateData==
+<templatedata>
+{
+	"params": {
+		"talk": {
+			"aliases": [
+				"1"
+			],
+			"label": "Has details on talk page",
+			"description": "Shows \"See the talk page for details\" if a value is supplied",
+			"type": "boolean"
+		},
+		"date": {
+			"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
+			"label": "Date",
+			"description": "Date tagged",
+			"type": "string"
+		}
+	},
+	"description": "Tags templates with inadequate or nonexistent documentations.",
+	"format": "block"
+}
+</templatedata>
 == See also ==
+* {{tl|Documentation}}
+* [[Wikipedia:Template documentation]]
+* {{tlg|Ombox}} the template transcluded into this one. It provides the basic framework.
+<includeonly>{{Sandbox other||
+<!-- Categories below this line, please: -->
-<includeonly>
+[[Category:Template documentation cleanup templates]]
-<!-- Categories and interwikis go here: -->
-[[Category:Template message boxes}]
+[[Category:Request templates]]
-</includeonly>
+}}</includeonly>