Anonymous edits have been disabled on the wiki. If you want to contribute please login or create an account.

Warning for game developers: PCGamingWiki staff members will only ever reach out to you using the official press@pcgamingwiki.com mail address.
Be aware of scammers claiming to be representatives or affiliates of PCGamingWiki who promise a PCGW page for a game key.

Difference between revisions of "Template:Cleanup/Documentation"

From PCGamingWiki, the wiki about fixing PC games
m (updated description to match eediting guide)
m (removed the use of reason= in the examples of the section call)
Line 41: Line 41:
 
'''Example #3 - Section cleanup needed, reason specifed'''
 
'''Example #3 - Section cleanup needed, reason specifed'''
  
−
{{Cleanup|section|reason=The section needs to be updated to account for the new additions in Update 2.0 as well}}
+
{{Cleanup|section|The section needs to be updated to account for the new additions in Update 2.0 as well}}
  
−
<pre><nowiki>{{Cleanup|section|reason=The section needs to be updated to account for the new additions in Update 2.0 as well}}</nowiki></pre>
+
<pre><nowiki>{{Cleanup|section|The section needs to be updated to account for the new additions in Update 2.0 as well}}</nowiki></pre>
  
 
<includeonly>[[Category:Tag templates]]</includeonly>
 
<includeonly>[[Category:Tag templates]]</includeonly>
 
<noinclude>[[Category:Documentation templates]]</noinclude>
 
<noinclude>[[Category:Documentation templates]]</noinclude>

Revision as of 18:47, 16 June 2019

Description

The cleanup tag is placed at the top of articles or sections that have issues with content formatting or outdated content. Any articles that do not match the standards in the editing guide fall under this label.

The tag should only be removed once the offending article element(s) are made to match the wiki's standards.


Arguments

  • section - Used as the first parameter to indicate that the cleanup only concerns the current section, e.g. {{Cleanup|section|Spelling, grammar, and needs updating}}
  • reason - Adds a reason/explanation for what needs cleaning up. Note that the parameter reason must be in lowercase if used.
    • If section is omitted, reason= can be left out. For example, both of these results in the same end result:
      • {{Cleanup|Spelling, grammar, and needs updating}}
      • {{Cleanup|reason=Spelling, grammar, and needs updating}}


Syntax 

{{Cleanup| section (optional) | reason= (optional) }}


Example #1 - Full page cleanup needed, no reason specified

This page may require cleanup to meet basic quality standards. You can help by modifying the article. The discussion page may contain useful suggestions.
{{Cleanup}}


Example #2 - Full page cleanup needed, reason specified

This page may require cleanup to meet basic quality standards. The specific problem is: spelling, grammar, and similar issues. You can help by modifying the article. The discussion page may contain useful suggestions.
{{Cleanup|spelling, grammar, and similar issues}}


Example #3 - Section cleanup needed, no reason specifed

This section may require cleanup to meet basic quality standards. You can help by modifying the article. The discussion page may contain useful suggestions.
{{Cleanup|section}}


Example #3 - Section cleanup needed, reason specifed

This section may require cleanup to meet basic quality standards. The specific problem is: The section needs to be updated to account for the new additions in Update 2.0 as well. You can help by modifying the article. The discussion page may contain useful suggestions.
{{Cleanup|section|The section needs to be updated to account for the new additions in Update 2.0 as well}}