Template:Improve documentation/doc: Difference between revisions

Revision as of 23:55, 15 June 2019

Latest revision as of 18:39, 25 June 2025

(22 intermediate revisions by 12 users not shown)

Line 1:

<includeonly>{{Short description|Tag for templates and modules}}</includeonly>

{{Documentation subpage}}

<!-- CategoriesPlease place categories where indicated at the bottom of this page, please.and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

{{High-use}}

{{No subst}}

{{tsh|nodoc}}

<!-- 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.

*If the template already has a documentation subpage, place this template in that subpage before the first heading. Example:

Example*:{{tlc|Documentation subpage}}<br />{{Tlx|Improve documentation|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}<br /><code>==Usage==</code>

*If the template ''does not'' have a documentation subpage, place this template at the end of the main template code, wrapped in {{tag|noinclude}} tags. Example:

*:<code>... main template code ...<br /><nowiki>}}<noinclude></nowiki></code><br />{{tlx|No documentation|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}<br /><code><nowiki></noinclude></nowiki></code>

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

Line 15 ⟶ 21:

{

"params": {

"talk": {},

"datealiases": {}[

"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"

},

"reason": {

"label": "Reason",

"description": "Displays in the message text, prefaced with \"Reason:...\", to indicate what needs improving.",

"example": "too technical to understand.",

"type": "string"

}

},

"description": "Tags templates with inadequate or nonexistent documentationsdocumentation.",

"format": "block"

}

</templatedata>

== Redirects ==

* {{tl|No documentation}} - the same message is given whether the documentation is inadequate or nonexistent

== See also ==

Line 28 ⟶ 54:

* [[Wikipedia:Template documentation]]

* {{tlg|Ombox}} the template transcluded into this one. It provides the basic framework.

<includeonly>{{Sandbox other||

{{#ifeq:{{SUBPAGENAME}}|sandbox| |

<!-- Categories below this line, please:; interwikis at Wikidata -->

[[Category:Template documentation cleanup templates]]

[[Category:TemplateRequest documentationtemplates]]

}}</includeonly>