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

From Team Fortress Wiki
Jump to: navigation, search
(Demonstration)
(Function Times)
Line 50: Line 50:
  
 
Readers should be informed of the time figures related to the weapon, such as reloading and firing, or further weapon state times.
 
Readers should be informed of the time figures related to the weapon, such as reloading and firing, or further weapon state times.
 +
 +
==Item Set==
 +
 +
Regarding weapons that are part of an item set, a section under this heading should be included along with links to the other weapons in the pack. Demonstration videos of the pack should be restricted to the item set page itself and not its related weapons.
  
 
==Demonstration==
 
==Demonstration==

Revision as of 10:11, 3 October 2010

The following guide aims to demonstrate to Team Fortress Wiki users the correct layout and style of the wiki's 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.

The article should generally be restricted to this layout and order, simply so the reader is not confused and cannot tread reasonably from one weapon article to another. If a section must be implemented into a page because of nowhere else to go, such as Merchandise, then please place it in a suitable position in the article.

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 and schedule a Merge.

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.

In game use should be kept moderately brief and not delve into too much detail, such as best use within maps, class match ups, etc. Such information is normally contained on the correct Strategy page for the class involved.

Weapon Infobox

All weapon articles should be accompanied by a Template:Weapon infobox, containing a single picture of the weapon (or more, if for example there are team color discrepancies) and its basic information. Ammo, cooldown and other uses may go here.

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.

Item Set

Regarding weapons that are part of an item set, a section under this heading should be included along with links to the other weapons in the pack. Demonstration videos of the pack should be restricted to the item set page itself and not its related weapons.

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. Weapon information may also be included in the video, although be advised it may be out of date in the future.

Blueprint

Most weapons are now accessible through the crafting system through the use of specific blueprints. These blueprints should be included using the preset blueprint table with correct images and names.

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. We are currently implementing Templates of these achievements in order to save space and hassle.

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 or future. 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 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 itself.

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. It may also include a direct link to the weapon's Update page on the Team Fortress 2 Blog.

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.