Difference between revisions of "Editing Guidelines"

From comp.tf
Jump to navigation Jump to search
(updated with more info)
Line 3: Line 3:
 
These are the '''Editing Guidelines''' for those wishing to contribute to the wiki.  Please read them before editing pages.
 
These are the '''Editing Guidelines''' for those wishing to contribute to the wiki.  Please read them before editing pages.
  
==Guidelines==
+
=Guidelines=
 
 
 
* Please remember to write ALL ARTICLES in the third person. This means no usage of first or second person pronouns (I, you, me, us, we, etc)
 
* Please remember to write ALL ARTICLES in the third person. This means no usage of first or second person pronouns (I, you, me, us, we, etc)
  
Line 19: Line 18:
 
Please follow these guidelines when creating a page on the wiki.
 
Please follow these guidelines when creating a page on the wiki.
  
* First, make sure it's a topic that needs its own page:
+
* '''First, make sure it's a topic that needs its own page''':
 
# Does the page already exist?  It may not have the exact name you want to use (ie. swiftwater (Payload) vs pl_swiftwater vs vs pl_swiftwater (UGC) vs pl_swiftwater_ugc_final), but check that your work has not already been done.
 
# Does the page already exist?  It may not have the exact name you want to use (ie. swiftwater (Payload) vs pl_swiftwater vs vs pl_swiftwater (UGC) vs pl_swiftwater_ugc_final), but check that your work has not already been done.
 
# Is the page just a definition of a term or concept? If so, it probably belongs in the '''[[Glossary]]'''.
 
# Is the page just a definition of a term or concept? If so, it probably belongs in the '''[[Glossary]]'''.
Line 25: Line 24:
 
# Is it a very broad topic (like "Competitive Team Fortress 2" or "Combat Classes")?  Maybe it should be split into smaller topics.
 
# Is it a very broad topic (like "Competitive Team Fortress 2" or "Combat Classes")?  Maybe it should be split into smaller topics.
  
* Design a layout for the page that gives all related information in a clean format. If this is a page similar to another existing one (ex. an article for a map like the existing [[koth_pro_viaduct_rc3]] page or league organization like the existing [[ETF2L]] page), mirroring an existing format increases readability, familiarity, and consistency.
+
* Design a layout for the page that gives all related information in a clean format.  
 +
* <span style="color:#FF0000">'''Use templates for pages when available, they are really easy to use and make pages much more user friendly'''</span>
 +
**Here are some examples of existing templates:
 +
***[[Template:Player_infobox|Player Info Box]]
 +
* When you are satisfied with what is hopefully at least an introductory amount of information in your article, link to it from related pages in their "See Also" sections so we can see it!
  
* When you are satisfied with what is hopefully at least an introductory amount of information in your article, link to it from related pages in their "See Also" sections so we can see it!
+
* Attribute categories to pages using the [[Category:categoryname]] format, you can place this code at the bottom or start of the page.

Revision as of 21:59, 3 July 2013


These are the Editing Guidelines for those wishing to contribute to the wiki. Please read them before editing pages.

Guidelines

  • Please remember to write ALL ARTICLES in the third person. This means no usage of first or second person pronouns (I, you, me, us, we, etc)
  • Keep in mind this is not a NA centric or EU centric wiki, so if you add info relevant to both scenes, make a way for a scene specific version of that article or add subtopics for each scene if needed. (Ex: Map list, Weapon list, etc...)
  • Avoid opinions and unsupported generalizations. If people disagree with you, it's not something that belongs in a wiki (unless you present it as an opinion, ie. "It is believed by some soldiers that the Black Box is useful for roaming" versus "I like the Black Box, it's great for roamers. Try it out!" ).
  • Use the discussion tabs on each page to discuss possible changes/updates or suggestions to those pages.
  • Make sure to add a brief summary of your edits so everyone can keep up with what's going on. I cannot stress enough how helpful it is to moderators if you tell us what you're doing so we don't have to look through the whole article guessing where the +4 bytes next to your edit came from and making sure you didn't write something inappropriate somewhere.

Starting a New Page

Please follow these guidelines when creating a page on the wiki.

  • First, make sure it's a topic that needs its own page:
  1. Does the page already exist? It may not have the exact name you want to use (ie. swiftwater (Payload) vs pl_swiftwater vs vs pl_swiftwater (UGC) vs pl_swiftwater_ugc_final), but check that your work has not already been done.
  2. Is the page just a definition of a term or concept? If so, it probably belongs in the Glossary.
  3. Is it a topic already covered as a subtopic of another article? If so, make a new page only if it is an advanced topic that can be heavily elaborated on (and don't forget to add a link from that page).
  4. Is it a very broad topic (like "Competitive Team Fortress 2" or "Combat Classes")? Maybe it should be split into smaller topics.
  • Design a layout for the page that gives all related information in a clean format.
  • Use templates for pages when available, they are really easy to use and make pages much more user friendly
  • When you are satisfied with what is hopefully at least an introductory amount of information in your article, link to it from related pages in their "See Also" sections so we can see it!
  • Attribute categories to pages using the format, you can place this code at the bottom or start of the page.