Difference between revisions of "Editing Guidelines"
(some small edits and added more info) |
(Fixed formatting and punctuation) |
||
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 | + | * Please, remember to write <span style="color:#FF0000">'''all articles'''</span> in the '''third person'''. This means no usage of first or second person pronouns (I, you, me, us, we, etc). If it helps, write as if you are teaching someone how the game ''is played'', not ''how to play it.'' Example: “Engineers often do so-and-so”, instead of “As an Engineer, you should do so-and-so.” |
− | * Keep in mind this is not a scene-centric wiki, so if you add info relevant to more than 1 scene (ex:NA and EU scene), 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...) | + | * Keep in mind, this is not a scene-centric wiki, so if you add info relevant to more than 1 scene (ex:NA and EU scene), 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 | + | * Avoid opinions and unsupported generalizations. If people disagree with you, it is 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!” ). |
− | * There are always going to be controversial topics | + | * There are always going to be controversial topics like strategies, loadout choices, weapon and offclass choices etc., but because we are a competitive wiki, we aim to help new players as much as possible, so guides and guidelines for classes / strategies can be added even if they are controversial, in a constantly changing game like ours would be almost impossible to set in stone that this or that strategy is 100% sure and not biased. Just make sure to create new sections or appropriate pages with common sense. For example, a very specific spy guide, writed by a specific player, won't obviously be unbiased and 100% right, but it is still a great potential resource for new players if added and tagged accordingly as so. |
− | * Use the discussion tabs on each page to discuss possible changes/updates or suggestions to those pages. | + | * 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 | + | * Make sure to add a brief summary of your edits so everyone can keep up with what is going on. This also makes it easier for the moderation team to patrol edits efficiently. |
− | * Try to group multiple edits of the same page into | + | * Try to group multiple edits of the same page into the big one with a detailed summary and not many smaller ones with no summary at all. No one will die if you forget to bold this or that word and have to go back and make 1 or 2 small edits, but try not to make a different edit for each word you forgot to bold or each pharagraph you forgot to format, this also makes the recent changes list less poluted and easy to patrol by the moderation team. |
* Categorize and always tag pages accordingly, remember to keep [[Special:Categories|Categories]] consistent across all pages and the whole wiki. You can check how categories work on wikis [http://www.mediawiki.org/wiki/Help:Categories Here!] | * Categorize and always tag pages accordingly, remember to keep [[Special:Categories|Categories]] consistent across all pages and the whole wiki. You can check how categories work on wikis [http://www.mediawiki.org/wiki/Help:Categories Here!] | ||
− | * Always add [[:Category:Maintenance_templates|'''Maintenance Templates''']] to pages accordingly | + | * Always add [[:Category:Maintenance_templates|'''Maintenance Templates''']] to pages accordingly. |
− | * <span style="color:#FF0000">'''Use | + | * <span style="color:#FF0000">'''Use Templates for pages when available'''</span> |
− | ==Templates== | + | == Templates == |
− | Templates help make pages look clean and user-friendly and you should learn how to use them and use them whenever you can. To learn how | + | Templates help make pages look clean and user-friendly and you should learn how to use them and use them whenever you can. To learn how Templates work and what they do please go [http://meta.wikimedia.org/wiki/Help:A_quick_guide_to_templates here] or [http://meta.wikimedia.org/wiki/Help:Template here] |
− | <big>'''Use | + | <big>'''Use Templates for pages when available — they are really easy to use and make pages much more user friendly.'''</big> |
− | Here are some examples of the current existing | + | Here are some examples of the current existing Templates (list might not be updated with every current template): |
− | *'''Map Pages | + | * '''Map Pages Templates''' |
− | **[[Template: | + | ** [[Template:Map infobox|Map Infobox]] |
− | **[[Template: | + | ** [[Template:Map locations|Map Locations]] |
− | **[[Template: | + | ** [[Template:Maps navbox|Maps Navbox]] |
− | *'''Player Pages | + | * '''Player Pages Templates''' |
− | **[[Template: | + | ** [[Template:Player infobox|Player Infobox]] |
− | *'''Team Pages | + | * '''Team Pages Templates''' |
− | **[[Template: | + | ** [[Template:Team infobox|Team Infobox]] |
− | **[[Template: | + | ** [[Template:6s team roster|6v6 Team Roster Table]] |
− | *'''League/Season Pages | + | * '''League / Season Pages Templates''' |
− | **[[Template: | + | ** [[Template:League infobox|League Infobox]] |
− | **[[Template: | + | ** [[Template:6s team roster|6v6 Team Roster Table]] |
− | **[[Template: | + | ** [[Template:ETF2L competitions|ETF2L Competitions Navbox]] |
− | **[[Template: | + | ** [[Template:Season infobox|Season Infobox]] |
− | *'''Steam Group Pages | + | * '''Steam Group Pages Templates''' |
− | **[[Template:Infobox Group|Steam Group Infobox]] | + | ** [[Template:Infobox Group|Steam Group Infobox]] |
− | *'''Class page Templates''' | + | * '''Class page Templates''' |
− | **[[Template: | + | ** [[Template:Class Weapon Table Row|Class Weapon Table Row]] |
− | **[[Template: | + | ** [[Template:Class Weapon Table Header|Class Weapon Table Header]] |
− | **[[Template: | + | ** [[Template:Class Weapon Table End|Class Weapon Table End]] |
− | *'''Others''' | + | * '''Others''' |
− | **[[Template:Navbox|Blank Navbox]] | + | ** [[Template:Navbox|Blank Navbox]] |
− | **[[Template: | + | ** [[Template:Popular topics navbox|Popular Topics Navbox]] |
− | **[[Template:Weekmaps|This week maps | + | ** [[Template:Weekmaps|This week maps Table]] |
− | **[[:Category: | + | ** [[:Category:Maintenance templates|'''Maintenance Templates''']] |
− | You are free to create your own | + | You are free to create your own Templates when necessary, but be sure to maintain consistency in colors and format across the wiki and write guidelines for the template usage in the template page. An example of a well elaborated template can be seen [[Template:Player infobox|here]], notice the usage guidelines and the ready to copy template as well as an example given. |
− | ==Starting a New Page== | + | == Starting a New Page == |
− | 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 | + | # Does the page already exist? It may not have the exact name you want to use (ie. swiftwater (Payload) vs. pl_swiftwater 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]]'''. | ||
# 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). | # 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). | ||
− | # Is it a very broad topic (like | + | # 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. | * Design a layout for the page that gives all related information in a clean format. | ||
− | * <span style="color:#FF0000">'''Use | + | * <span style="color:#FF0000">'''Use Templates for pages when available.'''</span> |
− | * 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 | + | * 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! |
* Categorize and always tag pages accordingly, remember to keep [[Special:Categories|Categories]] consistent across all pages and the whole wiki. You can check how categories work on wikis [http://www.mediawiki.org/wiki/Help:Categories Here!] | * Categorize and always tag pages accordingly, remember to keep [[Special:Categories|Categories]] consistent across all pages and the whole wiki. You can check how categories work on wikis [http://www.mediawiki.org/wiki/Help:Categories Here!] | ||
− | * Always add maintenance | + | * Always add maintenance Templates to pages accordingly — [[:Category:Maintenance_templates|'''Use the Templates!''']] |
Revision as of 15:09, 16 July 2014
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). If it helps, write as if you are teaching someone how the game is played, not how to play it. Example: “Engineers often do so-and-so”, instead of “As an Engineer, you should do so-and-so.”
- Keep in mind, this is not a scene-centric wiki, so if you add info relevant to more than 1 scene (ex:NA and EU scene), 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 is 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!” ).
- There are always going to be controversial topics like strategies, loadout choices, weapon and offclass choices etc., but because we are a competitive wiki, we aim to help new players as much as possible, so guides and guidelines for classes / strategies can be added even if they are controversial, in a constantly changing game like ours would be almost impossible to set in stone that this or that strategy is 100% sure and not biased. Just make sure to create new sections or appropriate pages with common sense. For example, a very specific spy guide, writed by a specific player, won't obviously be unbiased and 100% right, but it is still a great potential resource for new players if added and tagged accordingly as so.
- 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 is going on. This also makes it easier for the moderation team to patrol edits efficiently.
- Try to group multiple edits of the same page into the big one with a detailed summary and not many smaller ones with no summary at all. No one will die if you forget to bold this or that word and have to go back and make 1 or 2 small edits, but try not to make a different edit for each word you forgot to bold or each pharagraph you forgot to format, this also makes the recent changes list less poluted and easy to patrol by the moderation team.
- Categorize and always tag pages accordingly, remember to keep Categories consistent across all pages and the whole wiki. You can check how categories work on wikis Here!
- Always add Maintenance Templates to pages accordingly.
- Use Templates for pages when available
Templates
Templates help make pages look clean and user-friendly and you should learn how to use them and use them whenever you can. To learn how Templates work and what they do please go here or here
Use Templates for pages when available — they are really easy to use and make pages much more user friendly.
Here are some examples of the current existing Templates (list might not be updated with every current template):
- Map Pages Templates
- Player Pages Templates
- Team Pages Templates
- League / Season Pages Templates
- Steam Group Pages Templates
- Class page Templates
- Others
You are free to create your own Templates when necessary, but be sure to maintain consistency in colors and format across the wiki and write guidelines for the template usage in the template page. An example of a well elaborated template can be seen here, notice the usage guidelines and the ready to copy template as well as an example given.
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:
- Does the page already exist? It may not have the exact name you want to use (ie. swiftwater (Payload) vs. pl_swiftwater 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 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).
- 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.
- 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!
- Categorize and always tag pages accordingly, remember to keep Categories consistent across all pages and the whole wiki. You can check how categories work on wikis Here!
- Always add maintenance Templates to pages accordingly — Use the Templates!