Help:Cleanup: Difference between revisions

Latest revision as of 07:36, 14 July 2024

This is a help page
That means that this article contains information intended to advise or aid on the functions of the wiki, on how to use the wiki, or on general recommendations for users of the wiki.

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

Main article: Help:Linking

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!

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...".

@@ Line 1: / Line 1: @@
-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.
+{{LanguageBar}}
+{{Subpage|[[Help:Contents]]}} {{Help page}} [[category:wiki]]
-==Point of View==
+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.
-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 usually be dropped altogether, 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==
+==Links==
-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.
+{{main|Help:Linking}}
+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]]!
-It is optional whether to capitalize the first letter of the template tag.
+==Point of View==
-===Header templates===
+'''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..."''.
-These templates are placed at the very top of the article to mark that the problem is a general problem with the article.
-; {{tl|cleanup}}
-: Used to mark articles in need of cleanup to conform to a sufficient level of quality.
-; {{tl|pov}}
-: Used to mark articles which use first-person or second-person speech.
-; {{tl|wip}}
-: Use this to tell other editors you are currently editing the article.
-; <code><nowiki>{{DISPLAYTITLE|title}}</nowiki></code>
-: Not really a template. Used to fix the title of articles misnamed by MediaWiki, and to give translated articles localised names.
-: <code><nowiki>{{DISPLAYTITLE|func_detail}}</nowiki></code>
-; {{tl|Split-apart}}
-: For suggesting an article has become too long or is covering too broad a subject
-; {{tl|Shortcut}}
-: Used to put a little box to the right, displaying a shortcut title to a redirect page to that article.
-; {{tl|Stub}}
-: Used to mark and categorize a [[Help:stubs|stub]] article. A stub is a very short article needing expansion.
-; {{tl|screenshot}}
-: For suggesting an article receive a screenshot to visually illustrate the subject.
-; {{tl|morescreenshots}}
-: For suggesting an article with at least one screenshot receive additional screenshots to better illustrate the subject.
-; {{tl|delete}}
-: For suggesting a candidate for speedy deletion, no reason given.
-; {{tl|deletebecause}}
-: For suggesting a candidate for speedy deletion, reason given.
-; {{tl|deleteagain}}
-: For suggesting reposted content that has been removed before but brought back.
-; {{tl|nonsense}}
-: For suggesting a candidate for speedy deletion because article is [[Wikipedia:Wikipedia:Patent nonsense|patent nonsense]].
-===Body templates===
-These templates mark a specific problem in the body of the article.
-; {{tl|clarify}}
-: Inserts supertext indicating clarification is needed. '''Example:''' Causes NPCs to act busy{{clarify}}.
-; {{tl|How?}}
-: Inserts supertext indicating explanation of how to do something is needed. '''Example:''' To use it, just set it up{{how?}}.
-; {{tl|Why}}
-: Inserts superscript indicating explanation of why something is done is needed. '''Example:''' Now flip the entity upside-down{{why}}.
-; {{tl|morescreenshots}}
-: This template can also be placed in the body of the article to indicate a specific section of the article needs screenshots.
 ==See also==
-*[[Help:Editing]]
 *[[Help:Stubs]]
 *[[Help:Deletion]]
 *[[:Category:Cleanup]]
+*[[:Category:Content maintenance]]
 *[[:Category:Screenshot needed]]
-[[Category:Tutorials]]
-[[Category:Wiki]]

Help:Cleanup: Difference between revisions

Latest revision as of 07:36, 14 July 2024

Links

Point of View

See also

Navigation menu

Search