Template:Improve documentation/doc: Difference between revisions
Content deleted Content added
m Robot - Moving category Template documentation message boxes to Category:Template documentation cleanup templates per CFD at Wikipedia:Categories for discussion/Log/2018 July 13. |
W like wiki (talk | contribs) m →Usage |
||
| (9 intermediate revisions by 9 users not shown) | |||
| Line 1: | Line 1: | ||
{{tsh|nodoc}} |
|||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
{{High-use}} |
|||
{{No subst}} |
{{No subst}} |
||
<!-- Categories where indicated at the bottom of this page, please. --> |
<!-- Categories where indicated at the bottom of this page, please. --> |
||
== Usage == |
== Usage == |
||
For use on template/module documentation pages whose content is missing, insufficient, incomplete and/or inaccurate. |
For use on '''template/module documentation pages''' whose content is missing, insufficient, incomplete and/or inaccurate. |
||
Example: {{Tlx|Improve documentation|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} |
Example: {{Tlx|Improve documentation|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} |
||
| Line 14: | Line 17: | ||
{ |
{ |
||
"params": { |
"params": { |
||
"talk": { |
"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.", |
"description": "Tags templates with inadequate or nonexistent documentations.", |
||
| Line 27: | Line 42: | ||
* [[Wikipedia:Template documentation]] |
* [[Wikipedia:Template documentation]] |
||
* {{tlg|Ombox}} the template transcluded into this one. It provides the basic framework. |
* {{tlg|Ombox}} the template transcluded into this one. It provides the basic framework. |
||
<includeonly> |
<includeonly>{{Sandbox other|| |
||
{{#ifeq:{{SUBPAGENAME}}|sandbox| | |
|||
<!-- Categories below this line, please: --> |
<!-- Categories below this line, please: --> |
||
[[Category:Template documentation cleanup templates]] |
[[Category:Template documentation cleanup templates]] |
||
[[Category: |
[[Category:Request templates]] |
||
}}</includeonly> |
}}</includeonly> |
||
Latest revision as of 21:59, 13 February 2024
 | 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. |
 | This template should not be substituted. |
Usage
[edit]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
[edit]Tags templates with inadequate or nonexistent documentations.
| 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
| String | optional |
See also
[edit]- {{Documentation}}
- Wikipedia:Template documentation
- {{Ombox}} the template transcluded into this one. It provides the basic framework.