Difference between revisions of "Editing Guidelines"

From comp.tf
Jump to navigation Jump to search
(Fixed formatting and punctuation)
 
(16 intermediate revisions by 7 users not shown)
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 <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.”
+
* <span style="color:#c9191d">'''All articles</span> are to be writen in third person'''. No "I, you, me, us, we". etc.<br />
 +
:<small>''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.”''</small>
  
−
* 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...)
+
* There are more scenes out there than just the one you are on about. '''Include things that may be different across scenes'''. ({{abbr|eg|for example}}: Map list, Map rules, 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!” ).
+
* '''Avoid opinions''' and unsupported generalizations.
 +
:<small>''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!”).''</small>
  
 
* 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.
 
* 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.
Line 14: Line 16:
 
* 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 is going on. This also makes it easier for the moderation team to patrol edits efficiently.
+
* '''Summarise your edits'''.
 +
: ''<small>This is for easier revision and moderating purposes.</small>''
  
−
* 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.
+
* '''Add references''' if you can, and if applicable.
  
−
* 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!]
+
* Try to group multiple edits of the same page into a '''single edit'''. We encourage using the "Show Preview" button and proof reading.
 +
: ''<small>This is for easier revision and moderating purposes. Sometimes things slip though, so don't worry if you have that one off.</small>''
  
−
* Always add [[:Category:Maintenance_templates|'''Maintenance Templates''']] to pages accordingly.
+
* '''Categorise''' your page/templates/images and keep them consistent across the board.
 +
: ''<small>If you're unsure of what Category to use, look at other examples of the same thing, ask our staff or simply make a reasonable one yourself.</small>''
 +
 
 +
* '''Always''' add [[:Category:Maintenance_templates|Maintenance Templates]] to pages accordingly.
 +
 
 +
* '''Use Templates''' for pages when available.
 +
: ''<small>They're easy to use and our readers find them far more pleasant to look at.</small>''
 +
 
 +
== Starting a New Page ==
 +
 
 +
* '''Make sure it's a topic that needs its own page''':
 +
# Does the page already exist?  Does it exist under a different name?
 +
# Is the page just a definition of a term or concept? If so, it may 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.
 +
<br />
 +
 
 +
* Once ready and certain for the page, you may create the page by clicking on a red link to that page, or typing in the desired title of the page you want to create, and then clicking the red link.
 +
** Design a layout for the page that gives all related information in a clean format, refer to a recent page of similar topic or use a template.
 +
** 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!]
 +
** Add maintenance Templates to pages accordingly - [[:Category:Maintenance_templates|'''Use the Templates!''']]
  
−
* <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 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]
+
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, click [http://meta.wikimedia.org/wiki/Help:A_quick_guide_to_templates here] or [http://meta.wikimedia.org/wiki/Help:Template here]. If still stuck, ask one of our staff members.
 +
 
 +
Our most updated list of templates can be consulted '''[[:Category:Template|here]]'''.
 +
 
 +
===Popular Templates===
 +
 
 +
====Map Pages Templates====
 +
* [[Template:NewInfobox Map|Map Infobox]]
 +
* [[Template:Map locations|Map Locations]]
 +
* [[Template:Maps navbox|Maps Navbox]]
 +
 
 +
====Player Pages Templates====
 +
* [[Template:NewInfobox Player|Player Infobox]]
 +
 
 +
====Team Pages Templates====
 +
* [[Template:NewInfobox Team|Team Infobox]]
 +
* [[Template:6sTeamCard|6sTeamCard]] - For dynamic 6v6 Team Cards
 +
* [[Template:6s team roster collapsible|6v6 roster]] - For basic 6v6 rosters
 +
* [[Template:HL_team_roster|Static HL Roster]] & [[Template:HL team roster collapsible|Collapsible HL Roster]] - For basic HL rosters
 +
 
 +
====League / Season Pages Templates====
 +
* [[Template:League infobox|League Infobox]]
 +
* [[Template:6s team roster|6v6 Team Roster Table]]
 +
* [[Template:ETF2L competitions|ETF2L Competitions Navbox]]
 +
* [[Template:Season infobox|Season Infobox]]
 +
 
 +
====Steam Group Pages Templates====
 +
* [[Template:Infobox Group|Steam Group Infobox]]
  
−
<big>'''Use Templates for pages when available — they are really easy to use and make pages much more user friendly.'''</big>
+
====Class page Templates====
 +
* [[Template:Class Weapon Table Row|Class Weapon Table Row]]
 +
* [[Template:Class Weapon Table Header|Class Weapon Table Header]]
 +
* [[Template:Class Weapon Table End|Class Weapon Table End]]
  
−
Here are some examples of the current existing Templates (list might not be updated with every current template):
+
====Social/Community templates====
−
* '''Map Pages Templates'''
+
* [[Image:TeamfortressTV icon.png|link=Template:TFTV_Thread]] [[Template:TFTV_Thread|TFTV Thread]]
−
** [[Template:Map infobox|Map Infobox]]
+
* [[Image:Youtube_icon.png|link=Template:YouTube]] [[Template:YouTube|Youtube Channel]]
−
** [[Template:Map locations|Map Locations]]
+
* [[Image:Youtube_icon.png|link=Template:YouTube_video]] [[Template:YouTube_video|YouTube Video]]
−
** [[Template:Maps navbox|Maps Navbox]]
+
* [[Image:Twitch_icon.png|link=Template:Twitch]] [[Template:Twitch|Twitch Channel]]
−
* '''Player Pages Templates'''
+
* [[Image:Steam_icon.png|link=Template:Steam]] [[Template:Steam|Steam Profile]]
−
** [[Template:Player infobox|Player Infobox]]
+
* [[Image:Steam_icon.png|link=Template:SteamGuide]] [[Template:SteamGuide|Steam Community Guides]]
−
* '''Team Pages Templates'''
+
* [https://www.mediawiki.org/wiki/Extension:EmbedVideo#Usage Embed Video]
−
** [[Template:Team infobox|Team Infobox]]
+
 
−
** [[Template:6s team roster|6v6 Team Roster Table]]
+
====Match Templates====
−
* '''League / Season Pages Templates'''
+
* [[Template:MatchList|Match List]] - ''Simplistic and effective way of showing scores''
−
** [[Template:League infobox|League Infobox]]
+
* [[Template:Logs.tf|Logs.tf link]] - ''Basic logs.tf link''
−
** [[Template:6s team roster|6v6 Team Roster Table]]
+
* [[Template:GroupTableStart|GroupTableStart]] / [[Template:GroupTableSlot|GroupTableSlot]] / [[Template:GroupTableSlot|GroupTableSlot]] ''Basic table scorings''
−
** [[Template:ETF2L competitions|ETF2L Competitions Navbox]]
+
* [[Template:ETF2LGroupTableStart|ETF2LGroupTableStart]] / [[Template:ETF2LGroupTableSlot|ETF2LGroupTableSlot]] / [[Template:ETF2LGroupTableSlot|ETF2LGroupTableSlot]] - ''ETF2L style tables''
−
** [[Template:Season infobox|Season Infobox]]
+
* [[:Category:Brackets]] - ''All our brackets. Some are dynamic.''
−
* '''Steam Group Pages Templates'''
+
 
−
** [[Template:Infobox Group|Steam Group Infobox]]
+
====Others====
−
* '''Class page Templates'''
+
* [[Template:Navbox|Blank Navbox]]
−
** [[Template:Class Weapon Table Row|Class Weapon Table Row]]
+
* [[Template:Popular topics navbox|Popular Topics Navbox]]
−
** [[Template:Class Weapon Table Header|Class Weapon Table Header]]
+
* [[Template:Weekmaps|This week maps Table]]
−
** [[Template:Class Weapon Table End|Class Weapon Table End]]
+
* [[Template:Flag|Flag Icon]]
−
* '''Others'''
+
* [[:Category:Maintenance templates|Maintenance Templates]]
−
** [[Template:Navbox|Blank Navbox]]
 
−
** [[Template:Popular topics navbox|Popular Topics Navbox]]
 
−
** [[Template:Weekmaps|This week maps Table]]
 
−
** [[:Category:Maintenance templates|'''Maintenance Templates''']]
 
  
−
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 ==
+
'''Tip:''' ''To see a template in action, go to the template page and then click "What links here", on the sidebar. This should take you to a page with links to where the template has been used.''
  
−
Please, follow these guidelines when creating a page on the wiki.
+
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.
  
−
* '''First, make sure it's a topic that needs its own page''':
+
== Embedding Videos ==
−
# 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.
+
* Videos can be embedded on the wiki via a media wiki extension, you can check it's usage instructions [http://www.mediawiki.org/wiki/Extension:EmbedVideo#Usage here].
−
# 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.
 
−
* <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 “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!]
 
−
* Always add maintenance Templates to pages accordingly — [[:Category:Maintenance_templates|'''Use the Templates!''']]
 

Latest revision as of 08:44, 13 October 2016


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

Guidelines[edit]

  • All articles are to be writen in third person. No "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.”
  • There are more scenes out there than just the one you are on about. Include things that may be different across scenes. (eg: Map list, Map rules, 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.
  • Summarise your edits.
This is for easier revision and moderating purposes.
  • Add references if you can, and if applicable.
  • Try to group multiple edits of the same page into a single edit. We encourage using the "Show Preview" button and proof reading.
This is for easier revision and moderating purposes. Sometimes things slip though, so don't worry if you have that one off.
  • Categorise your page/templates/images and keep them consistent across the board.
If you're unsure of what Category to use, look at other examples of the same thing, ask our staff or simply make a reasonable one yourself.
  • Use Templates for pages when available.
They're easy to use and our readers find them far more pleasant to look at.

Starting a New Page[edit]

  • Make sure it's a topic that needs its own page:
  1. Does the page already exist? Does it exist under a different name?
  2. Is the page just a definition of a term or concept? If so, it may 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.


  • Once ready and certain for the page, you may create the page by clicking on a red link to that page, or typing in the desired title of the page you want to create, and then clicking the red link.
    • Design a layout for the page that gives all related information in a clean format, refer to a recent page of similar topic or use a template.
    • 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!
    • Add maintenance Templates to pages accordingly - Use the Templates!


Templates[edit]

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, click here or here. If still stuck, ask one of our staff members.

Our most updated list of templates can be consulted here.

Popular Templates[edit]

Map Pages Templates[edit]

Player Pages Templates[edit]

Team Pages Templates[edit]

League / Season Pages Templates[edit]

Steam Group Pages Templates[edit]

Class page Templates[edit]

Social/Community templates[edit]

Match Templates[edit]

Others[edit]


Tip: To see a template in action, go to the template page and then click "What links here", on the sidebar. This should take you to a page with links to where the template has been used.

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.

Embedding Videos[edit]

  • Videos can be embedded on the wiki via a media wiki extension, you can check it's usage instructions here.
Retrieved from "http://comp.tf/index.php?title=Editing_Guidelines&oldid=39790"