Difference between revisions of "Help:Style guide/Weapons"

From Team Fortress Wiki
Jump to: navigation, search
(Weapon Infobox)
m (Weapon Infobox: I forgot to hit show preview, and broke things.)
Line 37: Line 37:
 
|No Reload
 
|No Reload
 
|A weapon that doesn't reload ammunition.  For example, [[Minigun]], [[Sapper]].
 
|A weapon that doesn't reload ammunition.  For example, [[Minigun]], [[Sapper]].
 +
|}
  
 
==Damage==
 
==Damage==

Revision as of 17:17, 17 September 2010

The following guide will aim to show people the correct layout and style of Team Fortress Wiki weapon articles. Aside from creating new articles, please refer to this in order to help improve existing weapon pages and raise them to high quality standards.

Please note that the term 'weapon' may not only refer to an item in game that causes damage to players. Weapon refers to all equippable and useable class items in the game. PDAs and Bonk! Atomic Punch, for example, are classed as weapons.

Title

The title of the page should be the weapon name without the 'The-' prefix.

Example: The Backburner article is entitled 'Backburner', not 'The Backburner'.

Occassionally weapon names will be disputed, particularly if they appear in two seperate forms, such as Flamethrower and Flame Thrower. If such an instance occurs, raise the issue on the weapon's talk page.

Introduction

All weapon articles must contain an introduction which will introduce the reader to the weapon and its main uses. It should include information such as but not limited to the class owner, a brief visual description and any relevant gameplay information. This should be kept moderately up to date, and any outdated imformation moved to the Previous Changes section.

Weapon Infobox

All weapon articles should be accompanied by a Template:Weapon infobox, containing at least a picture of the weapon and it's basic information.

If a weapon cannot be selected while equipped (for example, Chargin' Targe) then ammo-loaded and ammo-carried should be set to "N/A". Otherwise, those fields should be populated accordingly along with the reload field.

For consistency, the reload field should be populated with one of the following strings:

Single A weapon that reloads one shell at a time. For example, Sniper Rifle, Flare Gun
Clip A weapon that reloads multiple shells at a time. For example, Shotgun, Force-A-Nature
Recharge A weapon that's reloads via a recharge meter. For example, Bonk! Atomic Punch, Sandvich
No Reload A weapon that doesn't reload ammunition. For example, Minigun, Sapper.

Damage

Figures and calculations relating to the amount of damage dealt by the weapon at certain ranges and in set situations should be included. All numbers should be indicated through community testing and the reader notified if otherwise.

Function Times

Readers should be informed of the time figures related to the weapon, such as reloading and firing, or further weapon state times.

Demonstration

Should a video exist, possibly on Youtube, containing a sufficient demonstation of the weapon, then it should be inserted at this point using Template:Youtube. The video should preferably not contain any distracting information such as custom skins, maps or other alternate weapons.

Related Achievements

Any official achievements in the game that are related to the weapon, either directly in the wording or can still be completed with said weapon, should be included.

Previous Changes

As with any other asset of Team Fortress 2, weapons are subject to overall balance and may have been modified or altered by the developers in the past. Such changes should be noted with possibly a correct internal link to a patch and a summary reason where appropriate.

Trivia

This section is for all additional or interesting information regarding the weapon that does not belong in any other section. Trivia should be detailed information that may be of interest to a reader, possibly something they would not immediately know upon playing the game.

Trivia should not be added for the sake of trivia:

Bad Example: "The Sandvich is a Level 1 Lunchbox item." Not only is this shown in the Bucket icon on the page and therefore irrelevant, it is too short to be worth writing and obviously shown in the game itself.

Good Example: "The Sandvich was the first Lunchbox item to be implemented in the game." This is information that would only be known to those at the time, and is not obvious from looking at the game.

Gallery

Pictures such as player viewmodels should be included to show the weapon as it appears during the game.

Further Links

Readers may wish to know of related articles connected to the weapon. This will usually include a link to user guides, as well as any similar weapon articles.

Categorisation

The article should end with the Template:Allweapons Nav and the relevant class navigation template. The relevant categories (such as weapons should follow this.