Template:Cleanup/doc: Difference between revisions

(10 intermediate revisions by 4 users not shown)

Line 1:

;Description

; Description

:These articles should be reformatted or otherwise improved for grammar, typographical errors, organization, readability, and other non-content related changes. ~~Compare [[:Category:Needing_Updates]] where the content itself needs work or is innacurate.~~

: These articles should be reformatted or otherwise improved for grammar, typographical errors, organization, readability, and other non-content related changes.

~~;Basic Syntax~~

: Putting this template on a page also adds it to the [[:Category:Candidates for cleanup|Candidates for cleanup]] category.

~~:Type <code>{{t|Cleanup}}</code> at the top of the page.~~

~~;Sample output~~

:~~<code><nowiki>{{Cleanup}}</nowiki></code> produces~~ this ~~banner:~~

~~:{{Cleanup}}~~

~~;Optional descriptors~~

~~:Place~~ a ~~reason after the first pipe (the symbol | ), and the parameter <code>date=</code>~~ to ~~indicate~~ the ~~month of the request. Copy this format, replacing with a reason, and it will automatically add the month of the request~~: ~~<br/>~~

:~~<code><nowiki>{{Cleanup~~|~~</nowiki>''<Place your reason here!>''<nowiki>|date={{subst:#time: F Y}} }}</nowiki></code>~~

~~;Sample output~~

~~:<code><nowiki>{{Cleanup|overly verbose with multiple redundancies~~.~~|date={{#time: F Y}}</nowiki></code> produces this banner:~~

~~:{{Cleanup|overly verbose with multiple redundancies.|date={{#time: F Y}}}}~~

~~Putting this template on a page also adds it to the [[~~:~~Category~~:~~Candidates for Cleanup~~|~~Candidates for Cleanup]] category.~~

; Dependencies

: Uses:

:: {{Tl|Banner}}

<noinclude>[[Category:Template documentation~~|{{PAGENAME}}~~]]</noinclude>

;Syntax

: {{T|Cleanup|reason|3=date= day month year}}

:: reason (optional) - Reason why the page need cleanup, If omitted defaults to ''unspecified''.

:: date (optional) - Month when the banner is placed

; Sample output

: <code><nowiki>{{Cleanup}}</nowiki></code> gives...

{{Banner|color= #153E7E|border= #153E7E

|'''This article should be cleaned up or improved}}

: <nowiki>{{Cleanup|Overly verbose with multiple redundancies}}</nowiki> gives...

{{Banner|color= #153E7E|border= #153E7E

|'''This article should be cleaned up or improved{{#if: {{{date|}}}|, as of {{{date}}}|}}.'''<br>The reason is: ''Overly verbose with multiple redundancies''}}

: <nowiki>{{Cleanup|Overly verbose with multiple redundancies|date= February 2017}}</nowiki> gives...

{{Banner|color= #153E7E|border= #153E7E

| '''This article should be cleaned up or improved, as of February 2017.''' <br>The reason is: ''Overly verbose with multiple redundancies''}}

: <nowiki>{{Cleanup||date= February 2017}}</nowiki> gives...

{{Banner|color= #153E7E|border= #153E7E

|'''This article should be cleaned up or improved, as of February 2017.'''<br> The reason is: ''unspecified''}}

== See also ==

* {{Tl|Update}}, for pages which need facts checked, numbers updated, or entire sections altered, to reflect recent game changes.

<includeonly>[[Category:Maintenance templates]]</includeonly>

<noinclude>[[Category:Template documentation]]</noinclude>

@@ Line 1: / Line 1: @@
-;Description
+; Description
-:These articles should be reformatted or otherwise improved for grammar, typographical errors, organization, readability, and other non-content related changes. Compare [[:Category:Needing_Updates]] where the content itself needs work or is innacurate.
+: These articles should be reformatted or otherwise improved for grammar, typographical errors, organization, readability, and other non-content related changes.
-;Basic Syntax
+: Putting this template on a page also adds it to the [[:Category:Candidates for cleanup|Candidates for cleanup]] category.
-:Type <code>{{t|Cleanup}}</code> at the top of the page.
-;Sample output
-:<code><nowiki>{{Cleanup}}</nowiki></code> produces this banner:
-:{{Cleanup}}
-;Optional descriptors
-:Place a reason after the first pipe (the symbol | ), and the parameter <code>date=</code> to indicate the month of the request. Copy this format, replacing with a reason, and it will automatically add the month of the request: <br/>
-:<code><nowiki>{{Cleanup|</nowiki>''<Place your reason here!>''<nowiki>|date={{subst:#time: F Y}} }}</nowiki></code>
-;Sample output
-:<code><nowiki>{{Cleanup|overly verbose with multiple redundancies.|date={{#time: F Y}}</nowiki></code> produces this banner:
-:{{Cleanup|overly verbose with multiple redundancies.|date={{#time: F Y}}}}
-Putting this template on a page also adds it to the [[:Category:Candidates for Cleanup|Candidates for Cleanup]] category.
+; Dependencies
+: Uses:
+:: {{Tl|Banner}}
-<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+;Syntax
+: {{T|Cleanup|reason|3=date= day month year}}
+:: reason (optional) - Reason why the page need cleanup, If omitted defaults to ''unspecified''.
+:: date (optional) - Month when the banner is placed
+; Sample output <!-- Not using the actual template to avoid the automatic category assigning -->
+: <code><nowiki>{{Cleanup}}</nowiki></code> gives...
+{{Banner|color= #153E7E|border= #153E7E
+|'''This article should be cleaned up or improved}}
+: <nowiki>{{Cleanup|Overly verbose with multiple redundancies}}</nowiki> gives...
+{{Banner|color= #153E7E|border= #153E7E
+|'''This article should be cleaned up or improved{{#if: {{{date|}}}|, as of {{{date}}}|}}.'''<br>The reason is: ''Overly verbose with multiple redundancies''}}
+: <nowiki>{{Cleanup|Overly verbose with multiple redundancies|date= February 2017}}</nowiki> gives...
+{{Banner|color= #153E7E|border= #153E7E
+| '''This article should be cleaned up or improved, as of February 2017.''' <br>The reason is: ''Overly verbose with multiple redundancies''}}
+: <nowiki>{{Cleanup||date= February 2017}}</nowiki> gives...
+{{Banner|color= #153E7E|border= #153E7E
+|'''This article should be cleaned up or improved, as of February 2017.'''<br> The reason is: ''unspecified''}}
+== See also ==
+* {{Tl|Update}}, for pages which need facts checked, numbers updated, or entire sections altered, to reflect recent game changes.
+<includeonly>[[Category:Maintenance templates]]</includeonly>
+<noinclude>[[Category:Template documentation]]</noinclude>