Template:Infobox weapon/doc: Difference between revisions
(update /doc) |
m (1 revision imported) |
(No difference)
|
Latest revision as of 13:01, 23 August 2023
File:Edit-copy green.svg | This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original template page. |
Warning | This template is used on approximately 7,600 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
File:Information icon4.svg | This template adds an automatically generated short description. If the automatic short description is not optimal, replace it by adding {{Short description}} at the top of the article. |
Usage
Weapon infobox
Rifle, Caliber .30, M1 | |
---|---|
File:M1-Garand-Rifle.jpg | |
Type | Semi-automatic rifle |
Place of origin | United States |
Service history | |
In service | 1936–present (U.S. military training and parades) |
Used by | See § Users |
Wars | |
Production history | |
Designer | John Garand |
Designed | 1932 |
Manufacturer | |
Produced | 1936–1957 |
No. built | Approx. 6.0 million[2] |
Variants | M1C, M1D |
Specifications | |
Mass | 9.5 to 11.6 lb (4.3 to 5.3 kg) |
Length | 43.5 in (1,100 mm) |
Barrel length | 24 in (610 mm) |
Cartridge |
|
Action | Gas-operated, rotating bolt |
Muzzle velocity | 2,800 ft/s (850 m/s) |
Effective firing range | 440 yd (400 m)[3] |
Feed system | 8-round en bloc clip, internal magazine |
Sights | Iron sights: Aperture rear, barleycorn-type front |
A weapon infobox may be used to summarize information about a particular weapon or weapon system (such as a firearm, a sword, a grenade, an artillery piece, a torpedo, or a tank); cartridges and artillery shells should use {{Infobox firearm cartridge}}
instead. The infobox should be added using the {{Infobox weapon}}
template, as shown below:
<syntaxhighlight lang="wikitext" style="overflow:auto">
Place of origin | Country name |
---|---|
Specifications | |
Mass | 123 kg (271 lb) |
Length | 123 mm (4.8 in) |
length | 123 mm (4.8 in) |
</syntaxhighlight>
Note: When using parameters, avoid the ambiguous abbreviation "N/A", and instead use "unknown" or "none". All subjective or qualitative judgements and numerical quantities or statistics must be cited to a reliable source (see WP:MILMOS#CITE).
The infobox is intended as a quick reference. Don't add non-data items, like question marks, “none”, “see text” or links to article sections (the article's table of contents already does this). Only add “unknown” to assert that an information point is unknowable, not as a placeholder to show that it is missing from the article. Choose a representative model and indicate what it is with the spec_label
parameter, instead of listing multiple data items in one field.
The template can also be used for general categories of weapons, such as tank and Katyusha rocket launcher, by including only some general characteristics.
General parameters:
- name – the formal name of the weapon.
- image – optional – an image of the weapon. The image must be given in the form File:Example.jpg in particular, the thumb attribute must not be selected.
- image_size – the size (in pixels) the image should be. Only required if the image is not a sensible size without being changed, but normally set anyway. Typically set to 300.
- alt – optional – a description of the image that replaces the image if it fails to load.
- caption – optional – the text to be placed below the image.
- type – optional – the type of weapon (e.g. "service rifle", "dress sword", and so forth).
- origin – optional – the country or place where the weapon originated or was first manufactured. Flag icons should not be used in this field, per MOS:INFOBOXFLAG and WP:MILMOS#FLAGS.
Type selection parameters (these parameters control whether—and how—particular specification fields will be displayed; multiple ones may be enabled where appropriate):
- is_ranged – "yes" if the weapon is a ranged weapon, such as a firearm or bow; must be left blank otherwise.
- is_bladed – "yes" if the weapon is a bladed, pointed, or blunt hand-held weapon, such as a sword, mace, or polearm; must be left blank otherwise.
- is_explosive – "yes" if the weapon is an explosive device, such as a grenade or bomb; must be left blank otherwise.
- is_artillery – "yes" if the weapon is a type of artillery, such as a cannon or mortar; must be left blank otherwise.
- is_vehicle – "yes" if the weapon is a self-propelled vehicle, such as a tank; must be left blank otherwise.
- is_missile – "yes" if the weapon is a self-propelled missile or torpedo; must be left blank otherwise.
- is_UK – "yes" if the field labels should use British/Commonwealth English (calibre, armour); must be left blank otherwise.
Service history parameters:
- service – optional – the period (usually given in years) when the weapon was in service.
- used_by – optional – the countries, armed forces, or other groups using the weapon; this may be omitted for weapons employed only in their country of origin.
- wars – optional – any wars during which the weapon saw service.
Production history parameters:
- designer – optional – the person or group responsible for designing the weapon.
- design_date – optional – the date (usually given as a year) when the weapon was designed.
- manufacturer – optional – the manufacturer of the weapon.
- unit_cost – optional – the unit cost of the weapon; this should only be indicated for weapons currently being produced.
- production_date – optional – the period (usually given in years) when the weapon was produced.
- number – optional – the number of weapons of this type that were manufactured.
- variants – optional – any variant models of the weapon.
General specification parameters:
- spec_label – optional – a label for the specifications, to be used when data for a particular variant is indicated; should be left blank otherwise.
- mass – optional – the mass of the weapon. For firearms, separate loaded and unloaded masses may be indicated.
- length – optional – the total length of the weapon.
- part_length – optional – a secondary length measurement. For firearms, this should be the barrel length; for bladed weapons, the length of the blade or head.
- width – optional – the total width of the weapon, where applicable; this is intended for use with larger weapons, such as artillery or vehicles.
- height – optional – the total height of the weapon, where applicable; this is intended for use with larger weapons, such as artillery or vehicles.
- diameter – optional – the diameter of the weapon, where applicable; this is intended for use with explosives and missiles.
- crew – optional – for crewed weapons, the number of people required.
- passengers – optional – for vehicles, the number of passengers carried.
Ranged weapon specification parameters (most only available if is_ranged is set to "yes"; some are also activated when is_explosive or is_artillery is set to "yes"):
- cartridge – optional – for firearms or artillery, the type(s) of cartridge or shell used.
- cartridge_weight – optional – for firearms or artillery, the mass of the cartridge or shell used.
- caliber – optional – for non-cartridge firearms or artillery, the caliber or interior diameter of the barrel; for cartridge-loaded firearms, caliber is indicated by the cartridge.
- barrels – optional – for firearms or artillery, the number of distinct barrels; this may be omitted if the weapon is single-barreled.
- action – optional – for firearms, the type of action (e.g. "flintlock").
- rate – optional – the rate of fire. For automatic firearms and auto-loading artillery, this is usually the cyclic rate. For other ranged weapons, an effective rate can be indicated if reputable sources for one are available.
- velocity – optional – for firearms or artillery, the muzzle velocity of the fired projectile.
- range – optional – the effective range of the weapon.
- max_range – optional – the maximum range of the weapon; for firearms this should be the maximum sight setting if used.
- feed – optional – for firearms, the feed system or magazine used.
- sights – optional – for firearms or artillery, the type of sights used.
Artillery specification parameters (only available if is_artillery is set to "yes"):
- breech – optional – for artillery, the type of breech mechanism.
- recoil – optional – for artillery, the recoil system used.
- carriage – optional – for artillery, the type of carriage used.
- elevation – optional – for artillery, the vertical range of possible firing angles.
- traverse – optional – for artillery, the horizontal range of possible firing angles.
Bladed weapon specification parameters (only available if is_bladed is set to "yes"):
- blade_type – optional – for bladed weapons (e.g. swords), a description of the blade.
- hilt_type – optional – for bladed weapons (e.g. swords), a description of the hilt.
- sheath_type – optional – for bladed weapons (e.g. swords), a description of the scabbard or sheath, if any.
- head_type – optional – for blunt or striking weapons (e.g. axes, polearms, or maces), a description of the head.
- haft_type – optional – for blunt or striking weapons (e.g. axes, polearms, or maces), a description of the haft.
Explosive weapon specification parameters (only available if is_explosive or is_missile is set to "yes"):
- filling – optional – the explosive filling material or warhead.
- filling_weight – optional – the mass of the explosive material or warhead.
- detonation – optional – the detonation trigger type (e.g. "timer", "pressure", "motion sensor").
- yield – optional – for larger explosives, the yield (in tons of TNT) of the device.
Vehicle/missile specification parameters (most only available if is_vehicle is set to "yes"; some are also activated if is_missile is set to "yes"):
- armour – optional – the armour plating of the vehicle; different armour thickness at different points may be indicated if needed.
- primary_weapon – optional – the primary armament mounted on the vehicle, if any.
- secondary_weapon – optional – the secondary armament mounted on the vehicle, if any.
- engine – optional – the type of engine used by the vehicle or missile.
- engine_power – optional – the power output of the engine, usually in hp or kW.
- pw_ratio – optional – the power-to-weight ratio, usually in hp/tonne.
- transmission – optional – the type of transmission used by the vehicle.
- payload_capacity – optional – the overall payload capacity weight of the vehicle.
- propellant – optional – for missiles, the propellant used.
- fuel_capacity – optional – the fuel capacity of the vehicle.
- drive – optional – the drivetrain wheel or track configuration (e.g. 4×4, 6×4, tracked)
- transmission – optional – the transmission of the vehicle.
- suspension – optional – the suspension of the vehicle.
- clearance – optional – the ground clearance of the vehicle.
- wingspan – optional – for missiles, the wingspan.
- vehicle_range – optional – the operational range of the vehicle or missile.
- ceiling – optional – for missiles, the flight ceiling.
- altitude – optional – for missiles, the normal flight altitude.
- depth – optional – for underwater weapons such as torpedoes, the maximum operating depth.
- boost – optional – for missiles, the maximum boost time.
- speed – optional – the maximum speed of the vehicle or missile; this is usually the road speed, but other values may be indicated if appropriate.
- guidance – optional – the guidance system used by the missile (or the vehicle, if uncrewed).
- steering – optional – the steering system used by the missile or vehicle.
- accuracy – optional – for missiles, the guidance accuracy.
- launch_platform – optional – for missiles, the launch platform.
- transport – optional – for missiles, the transportation vehicle or method, if different from the launch platform.
Maintenance categories
Microformat
The HTML mark-up produced by this template includes an hProduct microformat that makes a product's details readily parsable by computer programs. This aids tasks such as the cataloguing of articles and maintenance of databases. For more information about the use of microformats on Wikipedia, please visit the Microformat WikiProject.
If the product has a URL, use {{URL}} to include it.
- Classes used
The HTML classes of this microformat include:
- brand
- category
- description
- fn
- hproduct
- identifier
- listing
- photo
- price
- review
- type
- url
- value
nor collapse nested elements which use them.
Template Data
TemplateData for Infobox weapon
An infobox for weapon.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Name | name | The formal name of the weapon. | String | required |
Image | image | An image of the weapon. The image must be given in the form Example.jpg; in particular, the thumb attribute must not be selected. | File | optional |
Caption | caption | The text to be placed below the image. | String | optional |
Origin | origin | The country or place where the weapon originated or was first manufactured. Flag icons should be avoided in this field, per WP:MOSFLAG and WP:MILMOS#FLAGS. | String | optional |
Type | type | The type of weapon. | String | optional |
Is ranged | is_ranged | Yes if the weapon is a ranged weapon, such as a firearm or bow; must be left blank otherwise. | String | optional |
Is bladed | is_bladed | Yes if the weapon is a bladed, pointed, or blunt hand-held weapon, such as a sword, mace, or polearm; must be left blank otherwise. | String | optional |
Is explosive | is_explosive | Yes if the weapon is an explosive device, such as a grenade or bomb; must be left blank otherwise. | String | optional |
Is artillery | is_artillery | Yes if the weapon is a type of artillery, such as a cannon or mortar; must be left blank otherwise. | String | optional |
Is vehicle | is_vehicle | Yes if the weapon is a self-propelled vehicle, such as a tank; must be left blank otherwise. | String | optional |
Is missile | is_missile | Yes if the weapon is a self-propelled missile or torpedo; must be left blank otherwise. | String | optional |
Is UK | is_UK | Yes if the field labels should use British/Commonwealth English (calibre, armour); must be left blank otherwise. | String | optional |
Service | service | The period (usually given in years) when the weapon was in service. | Line | optional |
Used by | used_by | The countries, armed forces, or other groups using the weapon; this may be omitted for weapons employed only in their country of origin. | Line | optional |
Wars | wars | Any wars during which the weapon saw service. | Line | optional |
Designer | designer | The person or group responsible for designing the weapon. | String | optional |
Design date | design_date | The date (usually given as a year) when the weapon was designed. | String | optional |
Manufacturer | manufacturer | The manufacturer of the weapon. | String | optional |
Unit cost | unit_cost | The unit cost of the weapon; this should only be indicated for weapons currently being produced. | String | optional |
Production date | production_date | The period (usually given in years) when the weapon was produced. | String | optional |
Number | number | The number of weapons of this type that were manufactured. | Number | optional |
Variants | variants | Any variant models of the weapon. | Line | optional |
Special label | spec_label | A label for the specifications, to be used when data for a particular variant is indicated; should be left blank otherwise. | String | optional |
Weight | weight | The weight of the weapon. For firearms, separate loaded and unloaded weights may be indicated. | Number | optional |
Length | length | The total length of the weapon. | Number | optional |
Part length | part_length | A secondary length measurement. For firearms, this should be the barrel length; for bladed weapons, the length of the blade or head. | Number | optional |
Width | width | The total width of the weapon, where applicable; this is intended for use with larger weapons, such as artillery or vehicles. | Number | optional |
Height | height | The total height of the weapon, where applicable; this is intended for use with larger weapons, such as artillery or vehicles. | Number | optional |
Diameter | diameter | The diameter of the weapon, where applicable; this is intended for use with explosives and missiles. | Number | optional |
Wingspan | wingspan | For missiles, the wingspan. | String | optional |
Crew | crew | For crewed weapons, the number of people required. | Number | optional |
Passengers | passengers | For vehicles, the number of passengers carried. | Number | optional |
Cartridge | cartridge | For firearms or artillery, the type(s) of cartridge or shell used. | String | optional |
Cartridge weight | cartridge_weight | For firearms or artillery, the weight of the cartridge or shell used. | Number | optional |
Caliber | caliber | For non-cartridge firearms or artillery, the caliber or interior diameter of the barrel; for cartridge-loaded firearms, caliber is indicated by the cartridge. | Number | optional |
Barrels | barrels | For firearms or artillery, the number of distinct barrels; this may be omitted if the weapon is single-barreled. | Number | optional |
Action | action | For firearms, the type of action (e.g. flintlock). | String | optional |
Rate | rate | The rate of fire. For automatic firearms and auto-loading artillery, this is usually the cyclic rate. For other ranged weapons, an effective rate can be indicated if reputable sources for one are available. | String | optional |
Velocity | velocity | For firearms or artillery, the muzzle velocity of the fired projectile. | Number | optional |
Range | range | The effective range of the weapon. | Number | optional |
Max range | max_range | The maximum range of the weapon; for firearms this should be the maximum sight setting if used. | Number | optional |
Feed | feed | For firearms, the feed system or magazine used. | String | optional |
Sights | sights | For firearms or artillery, the type of sights used. | String | optional |
Breech | breech | For artillery, the type of breech mechanism. | String | optional |
Recoil | recoil | For artillery, the recoil system used. | String | optional |
Carriage | carriage | For artillery, the type of carriage used. | String | optional |
Elevation | elevation | For artillery, the vertical range of possible firing angles. | String | optional |
Traverse | traverse | For artillery, the horizontal range of possible firing angles. | String | optional |
Blade type | blade_type | For bladed weapons (e.g. swords), a description of the blade. | String | optional |
Hilt type | hilt_type | For bladed weapons (e.g. swords), a description of the hilt. | String | optional |
Sheath type | sheath_type | For bladed weapons (e.g. swords), a description of the scabbard or sheath, if any. | String | optional |
Head type | head_type | For blunt or striking weapons (e.g. axes, polearms, or maces), a description of the head. | String | optional |
Haft type | haft_type | For blunt or striking weapons (e.g. axes, polearms, or maces), a description of the haft. | String | optional |
Filling | filling | The explosive filling material or warhead. | String | optional |
filling_weight | filling_weight | The weight of the explosive material or warhead. | Number | optional |
Detonation | detonation | the detonation trigger type (e.g. timer, pressure, motion sensor). | String | optional |
Yield | yield | For larger explosives, the yield (in tons of TNT) of the device. | String | optional |
Armour | armour | The armour plating of the vehicle; different armour thickness at different points may be indicated if needed. | String | optional |
Primary weapon | primary_weapon | The primary armament mounted on the vehicle, if any. | String | optional |
Secondary weapon | secondary_weapon | The secondary armament mounted on the vehicle, if any. | String | optional |
Engine | engine | The type of engine used by the vehicle or missile. | String | optional |
Engine power | engine_power | The power output of the engine, usually in hp or kW. | Number | optional |
Pw ratio | pw_ratio | The power-to-weight ratio, usually in hp/tonne. | Number | optional |
Transmission | transmission | The type of transmission used by the vehicle. | String | optional |
Payload capacity | payload_capacity | The overall payload capacity weight of the vehicle. | String | optional |
Propellant | propellant | For missiles, the propellant used. | String | optional |
Fuel capacity | fuel_capacity | The fuel capacity of the vehicle. | Number | optional |
Suspension | suspension | The suspension of the vehicle. | String | optional |
Clearance | clearance | The ground clearance of the vehicle. | String | optional |
Vehicle range | vehicle_range | The operational range of the vehicle or missile. | String | optional |
Ceiling | ceiling | For missiles, the flight ceiling. | String | optional |
Altitude | altitude | For missiles, the normal flight altitude. | String | optional |
Depth | depth | For underwater weapons such as torpedoes, the maximum operating depth. | String | optional |
Boost | boost | For missiles, the maximum boost time. | String | optional |
Maximum speed | speed | The maximum speed of the vehicle or missile; this is usually the road speed, but other values may be indicated if appropriate. | Number | optional |
Guidance | guidance | The guidance system used by the missile (or the vehicle, if uncrewed). | String | optional |
Steering | steering | The steering system used by the missile or vehicle. | String | optional |
Accuracy | accuracy | For missiles, the guidance accuracy. | String | optional |
Launch platform | launch_platform | For missiles, the launch platform. | String | optional |
Transport | transport | For missiles, the transportation vehicle or method, if different from the launch platform. | String | optional |
References
- ↑ Small Arms Review article on Italian-made Garands
- ↑ Lua error in Module:Citation/CS1/Configuration at line 2083: attempt to index field '?' (a nil value). Excerpted from The M1 Garand: Owner's Guide copyright 1994 by Scott A. Duff.
- ↑ Lua error in Module:Citation/CS1/Configuration at line 2083: attempt to index field '?' (a nil value).