Help:Cleanup

From Valve Developer Community
Jump to: navigation, search

Articles may develop a variety of problems which require cleanup in order to get the article to a higher level of quality. Problems can include typographical errors and poor grammar and spelling, poor wording, articles written in the first person, and other problems. If you run across such issues, please do the best you can to fix them yourself! If you can't fix an issue yourself and want to mark it for others, there are templates provided below.

Links

One of the more common problems on VDC is that people fail to use wikilinks - linking words to other articles. Wikilinks can save a lot of time and increase understanding for readers. For example, if an article mentions a brush entity, but doesn't say what that is, a novice level editor might be confused and have to type "brush entity" into the search bar. It's a lot easier to link the words brush entity!

If you put [[ ]] brackets on either side of a word or phrase, this will automatically link to an article that has the same title. So [[brush entity]] leads to the brush entity article. If you need to use different wording, you can format like this: [[actual article title|text you want to display]]. So [[Half-Life 2: Episode Two|the second episode]] leads to the second episode.

You normally only need to link a term the first time it is mentioned in an article, but if the seperate mentions are far apart you might want to link it more than once.

Point of View

Articles should be writen in the third person, avoiding the usage of "I" (first person) and "you" (second person) whenever possible. If referring to gameplay, use "the player" rather than "you" ("The player can stand on the button to open the door".) In tutorials and other material related to development, the word "you" can be acceptable, or it may be possible to remove it, for example changing "Next, you tie the brush to..." to "Next, tie the brush to...". In tutorials, phrasing such as "I prefer to use the..." can be changed to "A good choice is the...".

Cleanup templates

These templates may be inserted into an article to mark various issues with the article and list it as an article needing cleanup. Most of these templates will add the article to Category:Cleanup. Each template tag added to the article should be given its own line, except superscript templates which are used inline at the end of word or sentence.

It is optional whether to capitalize the first letter of the template tag.

Header templates

These templates are placed at the very top of the article to mark that the problem is a general problem with the article.

{{cleanup}}
Used to mark articles in need of cleanup to conform to a sufficient level of quality.
Note:There are alternate translations for this template. Please use them accordingly with the page language.
{{pov}}
Used to mark articles which use first-person or second-person speech.
{{wip}}
Use this to tell other editors you are currently editing the article.
{{DISPLAYTITLE|title}}
Not really a template. Used to fix the title of articles misnamed by MediaWiki, and to give translated articles localised names.
{{DISPLAYTITLE|func_detail}}
{{Split-apart}}
For suggesting an article has become too long or is covering too broad a subject
{{Shortcut}}
Used to put a little box to the right, displaying a shortcut title to a redirect page to that article.
{{Stub}}
Used to mark and categorize a stub article. A stub is a very short article needing expansion.
{{orphan}}
Used to mark and categorize an orphan article that should be linked from other articles. An orphan is an article with few or no links to it.
{{screenshot}}
For suggesting an article receive a screenshot to visually illustrate the subject.
{{morescreenshots}}
For suggesting an article with at least one screenshot receive additional screenshots to better illustrate the subject.
{{delete}}
For suggesting a candidate for speedy deletion. Including a reason is optional.
{{update}}
Used to mark outdated articles in need of an update with current information.

Body templates

These templates mark a specific problem in the body of the article.

{{clarify}}
Inserts supertext indicating clarification is needed. Example: Causes NPCs to act busy[Clarify].
{{How?}}
Inserts supertext indicating explanation of how to do something is needed. Example: To use it, just set it up[How?].
{{Why}}
Inserts superscript indicating explanation of why something is done is needed. Example: Now flip the entity upside-down[Why?]


See also