Template:Cleanup/doc: Difference between revisions

From [N8]
Jump to navigation Jump to search
Created page with "<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude> <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -..."
 
Redesigned Template
 
Line 1: Line 1:
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
{{Documentation}}
    <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
'''''Cleanup''''' can be used to highlight articles that need rewriting into a style suited to the wiki.


== Usage ==
Place on articles you believe require a cleanup. This template adds pages to [[:Category:Articles in need of cleanup]].
This table may be added by copy-pasting the template as shown below into an article.


<div style="background:#ddd; border:1px solid black; padding:0.5em 1em 0.5em 1em;">
You must also specify a reasoning by including a parameter.
<pre>
{{Cleanup}}
</pre>
</div>


== Parameters ==
==Usage==
There are none.
{{t|Cleanup|Reason}}


== Effects ==
For example:
Puts a table onto the page reorganization.
{{T|Cleanup|Should be rewritten as prose}} would output:


== Updating this template ==
{{cleanup|Should be rewritten as prose}}
You shouldn't have to.


== Example ==
{{TemplateData|<templatedata>
<pre>{{Cleanup}}</pre>
{
 
"params": {
Will display this:
"1": {
 
"label": "Reason",
{{Cleanup|}}
"description": "Reason why article requires cleanup",
"example": "Should be rewritten as prose",
"type": "string",
"required": true
}
},
"description": "Place on articles you believe require a cleanup. This template adds pages to Category:Articles in need of cleanup.\n\n",
"format": "inline"
}
</templatedata>
}}

Latest revision as of 08:33, 30 May 2020

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

Place on articles you believe require a cleanup. This template adds pages to Category:Articles in need of cleanup.

You must also specify a reasoning by including a parameter.

Usage

{{Cleanup|Reason}}

For example: {{Cleanup|Should be rewritten as prose}} would output:

This article or section requires a cleanup.
Reason: Should be rewritten as prose
It does not meet the Gemini Station Wiki's quality standards; you can edit this page to improve it.

Data

Show/hide template's data

The following information is used by extensions and applications, such as VisualEditor, to help users implement this template onto pages. Please ensure that it is up-to-date.

Place on articles you believe require a cleanup. This template adds pages to Category:Articles in need of cleanup.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Reason1

Reason why article requires cleanup

Example
Should be rewritten as prose
Stringrequired