Template:Cleanup/Doc: Difference between revisions
Created page with "This template can be used to mark an article or section that suffers from formatting, grammar, style, etc. related issues. When writing an article, you should reference the Manual of Style for guidance. Editors are encouraged to regularly check the list of articles that need cleanup and contribute by reformatting and editing them. This is how this notice looks like: {{Cleanup|category=no}} === Usage =..." |
m Add template data |
||
| (One intermediate revision by the same user not shown) | |||
| Line 10: | Line 10: | ||
{{Cleanup}} | {{Cleanup}} | ||
</pre> | </pre> | ||
You can indicate what part of the article needs cleanup by setting the <code>scope</code>. You can also include a reason for your notice. For example, a notice that would indicate this template documentation needs cleanup because it's too short would look like this: | |||
<pre> | |||
{{Cleanup|scope=template documentation|reason=The documentation is too short.}} | |||
</pre> | |||
{{Cleanup|category=no|scope=template documentation|reason=The documentation is too short.}} | |||
<includeonly> | |||
=== Template data === | |||
<templatedata> | |||
{ | |||
"description": "Housekeeping notice for marking articles that don't follow the Manual of Style.", | |||
"params": { | |||
"scope": { | |||
"label": "Scope", | |||
"description": "The scope of the notice. E.g.: article, section, subsection, etc.", | |||
"type": "line" | |||
}, | |||
"reason": { | |||
"label": "Reason", | |||
"description": "The reason for the notice.", | |||
"type": "line" | |||
} | |||
} | |||
} | |||
</templatedata></includeonly> | |||
Latest revision as of 20:51, 14 June 2025
This template can be used to mark an article or section that suffers from formatting, grammar, style, etc. related issues. When writing an article, you should reference the Manual of Style for guidance. Editors are encouraged to regularly check the list of articles that need cleanup and contribute by reformatting and editing them. This is how this notice looks like:
⚟︎
This article or section needs cleanup. Please edit the article, paying special attention to fixing any formatting issues, inconsistencies, grammar, or phrasing. Make sure to consult the Manual of Style for guidance.
Usage
It is simply sufficient to include this template on a page. This example would produce a notice like the one above:
{{Cleanup}}
You can indicate what part of the article needs cleanup by setting the scope. You can also include a reason for your notice. For example, a notice that would indicate this template documentation needs cleanup because it's too short would look like this:
{{Cleanup|scope=template documentation|reason=The documentation is too short.}}
⚟︎
This template documentation needs cleanup. The documentation is too short. Please edit the article, paying special attention to fixing any formatting issues, inconsistencies, grammar, or phrasing. Make sure to consult the Manual of Style for guidance.