View source for Template:Infobox locomotive/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
{{esoteric}}

This is an '''infobox for steam, diesel or electric [[locomotive]]s'''.

For [[Electric Multiple Unit]]s, [[Diesel Multiple Unit]]s and carriages, use {{tlx|Infobox train}} instead.

=== Usage === 
{{Infobox locomotive
| name= EMD GP30
| powertype= Diesel
| gauge= {{RailGauge|ussg}}
| image= WC 715 EMD GP30.jpg
| caption= [[Soo Line Railroad|WC]] 715 at the [[National Railroad Museum]] in [[Green Bay, Wisconsin|Green Bay, WI]]
| builder= [[Electro-Motive Diesel|General Motors Electro-Motive Division]] (EMD)
| aarwheels= B-B
| uicclass= Bo′Bo′
| cylindercount= [[V16 engine|V16]]
| primemover= [[EMD 567|EMD 567D3]]
| builddate= July 1961 &ndash; November 1963
| totalproduction= 948
| locale= [[North America]]
| poweroutput= {{Convert|2,250|hp|abbr=on}}
| topspeed= {{Convert|78|mph|abbr=on}}
| locoweight= {{Convert|253,000|lb|abbr=on}}
| tractiveeffort= {{Convert|63,375|lbf|abbr=on}}
| length= {{Convert|56|ft|2|in|abbr=on}}
| enginetype= Two-stroke diesel
| aspiration= Mechanically-assisted [[turbocharger]]
| cylindersize= {{Convert|8.5|×|10|in|1|abbr=on}}
| displacement= {{Convert|9072|cuin|L|abbr=on}}
| transmission= DC generator, DC traction motors
| locobrakes= [[Railway air brake|Straight air]], [[Dynamic braking|Dynamic]]
| trainbrakes= 26-L air
| buildmodel= GP30
}}
{{Infobox locomotive
|  name= ''John Bull''
|  caption= The ''John Bull'', c. 1893.
|  image= John Bull.jpg
|  powertype= Steam
|  gauge= {{RailGauge|ussg}}
|  builder= [[Robert Stephenson and Company]]
|  builddate= 1831
|  railroad= [[Camden and Amboy Railroad]],<br>[[Pennsylvania Railroad]] (initial preservation)
|  whytetype= [[4-2-0]] (although built by Stephenson as an [[0-4-0]])
|  boiler= {{Convert|2|ft|6|in|abbr=on}} diameter<br> x {{Convert|6|ft|9|in|abbr=on}} length
|  firegrate= {{Convert|10.07|sqft|abbr=on}}
|  cylindersize= {{Convert|9|in|1|abbr=on}} diameter<br> x {{Convert|20|in|abbr=on}} stroke
|  driverdiamter= {{Convert|4|ft|6|in|abbr=on}} diameter
|  wheelbase= {{Convert|4|ft|11|in|abbr=on}}<br> between driving axles
|  framesize= {{Convert|14|ft|9|in|abbr=on}} length<br> x {{Convert|6|ft|3|in|abbr=on}} width
|  firstrundate= September 15, 1831
|  uicclass= 1′1A (built as B)
|  deliverydate= September 4, 1831
|  currentowner= [[Smithsonian Institution]]
|  retiredate= 1866
|  restoredate= September 15, 1981
|  disposition= Static display in [[Washington, D.C.]]
|  roadnumber= 1
|  officialname= ''Stevens'' (after C&A president [[Robert L. Stevens]])
}}

=== Parameters === 
This template has a large number of parameters, all of which are optional:

* ''name'' - The name that will appear above the top line of the infobox. If it is the name of a specific locomotive, then it should be in italics, as per [[WP:ITALIC]], e.g. <code><nowiki>name = ''Mallard''</nowiki></code>.
* ''powertype'' - The type of power that the locomotive employs (e.g. "steam", "diesel", "electric", etc.)
* ''image'' - The filename for the infobox image. Use the bare image name, ie {{para|image|Example.jpg}} not {{para|image|<nowiki>[[File:Example.jpg]]</nowiki>}}
* ''alt'' - [[WP:ALT|alternative text]] for the image, displayed when the image cannot be shown (such as for visually impaired users, or for spoken articles)
* ''imagesize'' - The size of the image in pixels (as in <tt>imagesize= 200</tt>), default value is 300; to use the image's actual size, specify imagesize as a blank value (as in <tt>imagesize= |</tt>).
* ''caption'' - The image caption that will be displayed
* ''hatnote'' - A label-less centered text field for notices. Appears below ''powertype''.
* ''designer'' - The name of the locomotive's designer
* ''builder'' - The locomotive builder
* ''ordernumber'' - The locomotive's order number
* ''serialnumber'' - The locomotive's serial number
* ''buildmodel'' - The builder's model number
* ''builddate'' - The date(s) that the locomotive (or locomotive model) was built
* ''totalproduction'' - The total number of locomotives of the given class that were built
* ''rebuilder'' - The locomotive rebuilder
* ''rebuilddate'' - The date(s) that the locomotive (or locomotive model) was rebuilt
* ''numberrebuilt'' - The total number of locomotives of the given class that were rebuilt
* ''whytetype'' - The wheel arrangement in [[Whyte notation]]
* ''aarwheels'' - The [[AAR wheel arrangement]]
* ''uicclass'' - The [[UIC classification]]
* ''gauge'' - The [[track gauge]]s on which the locomotive operated
* ''trucks'' - The type of [[bogie|truck]]s
* ''bogies'' - The type of [[bogie]]s
* ''leadingdiameter'' - The diameter of the locomotive's [[leading wheel]]s
* ''driverdiameter'' - The diameter of the locomotive's [[driving wheel]]s
* ''wheeldiameter'' - The diameter of the locomotive's wheels
* ''trailingdiameter'' - The diameter of the locomotive's [[trailing wheel]]s
* ''minimumcurve'' - The minimum radius curve that the locomotive will negotiate. North American practice would use degrees of curvature 
* ''wheelbase'' - The locomotive's wheelbase
* ''length'' - The locomotive's total length
* ''width'' - The locomotive's total width
* ''height'' - The locomotive's total height
* ''framesize'' - The size of the [[locomotive frame]]
* ''axleload'' - max. axle load
* ''weightondrivers'' - The weight on the driven wheels only
* ''locoweight'' - The weight of the locomotive (excluding tender)
* ''tenderweight'' - The weight of the locomotive's tender
* ''locotenderweight'' - The combined weight of the locomotive and tender
* ''tendertype'' - The type of tender; typically the number of axles, the designer, or (where issued), the class of tender 
* ''fueltype'' - The type of fuel that the locomotive consumes
* ''fuelcap'' - The locomotive's full fuel capacity
* ''lubecap'' - Lubrication oil capacity
* ''coolantcap'' - Engine coolant capacity
* ''watercap'' - The tender's full water capacity
* ''tendercap'' - The tender's full fuel and water capacity
* ''sandcap'' - The locomotive's full sandbox capacity
* ''consumption'' - The locomotive's average fuel consumption rate
* ''watercons'' - The locomotive's average water consumption rate
* ''electricsystem'' - The electric system(s) under which the locomotive operates
* ''collectionmethod'' - The locomotive's (electrical) current collection method (i.e. [[pantograph (rail)|pantograph]], [[third rail]], etc.)
* ''primemover'' - The locomotive's [[Prime mover (locomotive)|prime mover]] model
* ''rpmrange'' - The [[revolutions per minute]] (rpm) range of the prime mover
* ''enginetype'' - The specific engine type
* ''aspiration'' - The method that the engine uses to mix fuel and air
* ''displacement'' - The engine displacement
* ''alternator'' - The locomotive's alternator type/model
* ''generator'' - The locomotive's generator type/model
* ''tractionmotors'' - The type/model of [[traction motor]]s
* ''headendpower'' - The [[head end power]]
* ''boiler'' - The locomotive's boiler size
* ''boilerpressure'' - The total boiler pressure rating
* ''feedwaterheater'' - Type of feedwater heater installed
* ''firearea'' - The area of the locomotive's fire grate
* ''tubearea'' - Heating surface - tubes
* ''fluearea'' - Heating surface - flues
* ''tubesandflues'' - Heating surface - tubes and flues (if not broken out in published specs)
* ''fireboxarea'' - Heating surface - firebox
* ''totalsurface'' - Heating surface - total
* ''superheatertype'' - Superheater type
* ''superheaterarea'' - Superheater area
* ''cylindercount'' - The number of cylinders
* ''cylindersize'' - The size of the engine's cylinders
* ''frontcylindersize'' - Size of the front cylinders in an articulated locomotive, if they differ
* ''rearcylindersize'' - Size of the rear cylinders
* ''hpcylindersize'' - Size of the high-pressure cylinders in a compound (explain arrangement in ''cylindercount'')
* ''lpcylindersize'' - Size of the low-pressure cylinders in a compound
* ''valvegear'' - Type of [[valve gear]] used on a steam locomotive
* ''valvetype'' - The type of valves used – slide, piston, poppet, etc.
* ''valvetravel'' - The length of the valve travel
* ''valvelap'' - The lap of the valve gear
* ''valvelead'' - The lead of the valve gear
* ''transmission'' - The type of transmission used
* ''multipleworking'' - The type of [[multiple working]], if fitted
* ''topspeed'' - The locomotive's top speed
* ''poweroutput'' - The locomotive's total power output
* ''tractiveeffort'' - The locomotive's total tractive effort
* ''factorofadhesion'' - Factor of adhesion (weight on drivers divided by tractive effort)
* ''trainheating'' - Train heating system used (usually [[Steam generator (railroad)]], [[Head end power]], or none).
* ''locobrakes'' - The type of locomotive brakes installed
* ''locobrakeforce'' - The braking force supplied by ''locobrakes''
* ''trainbrakes'' - The type of train brake system installed
* ''safety'' - The safety systems installed (auto train stop, cab signalling, etc)
* ''railroad'' - The railroad(s) where the locomotive operated (for articles about individual locomotives and not generic locomotive models); creates a colored heading line like the powertype parameter
* ''railroadclass'' - The [[class (locomotive)|class]] designation assigned by the operating railroad
* ''powerclass'' - The power class or group of the locomotive
* ''numinclass'' - The number of locomotives in the same railroad class
* ''roadnumber'' - The operating number(s) assigned by the railroad
* ''officialname'' - The official name(s) assigned by the railroad, and who or what the locomotive is named after
* ''nicknames'' - Nicknames given to the locomotive
* ''axleloadclass'' - The axle load class or group (e.g. [[Great Western Railway Weight Classification|Great Western Railway colour code]], [[Route Availability|LNER/British Railways Route Availability]] "RA")
* ''locale'' - The locale where the locomotive was operated
* ''deliverydate'' - The date that the locomotive was delivered
* ''firstrundate'' - The date of the locomotive's first run
* ''lastrundate'' - The date of the locomotive's last regular operation
* ''retiredate'' - The date the locomotive was retired from regular service
** ''withdrawndate'' - Commonwealth English equivalent of ''retiredate'' above
* ''restoredate'' - The date the locomotive was restored to operating condition
* ''scrapdate'' - The date the locomotive was scrapped
* ''currentowner'' - The locomotive's current owner
* ''disposition'' - The locomotive's current disposition
* ''notes'' - text box for infobox [[Note (typography)|footnotes]] if needed

;Note that the following parameters have been deprecated, and articles will be added to [[:Category:Unusual parameters of Infobox locomotive template]]. However, each page might need a [[WP:NULL|null edit]] to be included in the category.
* ''weight'' - The weight of the locomotive (may or may not have included a tender) – replaced by ''locoweight'', ''tenderweight'', and ''locotenderweight''.
* ''leadingsize'' - The size of the locomotive's [[leading wheel]]s – replaced by ''leadingdiameter''
* ''driversize'' - The size of the locomotive's [[driving wheel]]s – replaced by ''driverdiameter''
* ''trailingsize'' - The size of the locomotive's [[trailing wheel]]s – replaced by ''trailingdiameter''

The two infoboxes shown to the right are examples of using this template for a generic locomotive model (the EMD GP30 example) and for a specific locomotive (the ''John Bull'' example).

=== Examples === 
{| class= "wikitable"
|+ '''Sample lists of options'''
! Steam !! Diesel || Electric 
|- valign= "top"
| <div style= "width: 200px; background: #dddddd; border: 1px solid black; padding:0.5em 1em 0.5em 1em; ">
<pre>
{{Infobox locomotive
| name             = 
| powertype =Steam
| image            = 
| alt              = 
| caption          = 
| designer         = 
| builder          = 
| ordernumber      = 
| serialnumber     = 
| buildmodel       = 
| builddate        = 
| totalproduction  = 
| rebuilder        = 
| rebuilddate      = 
| numberrebuilt    = 
| whytetype        = 
| uicclass         = 
| gauge ={{RailGauge|}}
| leadingdiameter  = 
| driverdiameter   = 
| trailingdiameter = 
| minimumcurve     = 
| wheelbase        = 
| length           = 
| width            = 
| height           = 
| axleload         = 
| weightondrivers  = 
| locoweight       = 
| tenderweight     = 
| locotenderweight = 
| tendertype       = 
| fueltype         = 
| fuelcap          = 
| watercap         = 
| tendercap        = 
| sandcap          = 
| boiler           = 
| boilerpressure   = 
| feedwaterheater  = 
| firearea         = 
| tubearea         = 
| fluearea         = 
| tubesandflues    = 
| fireboxarea      = 
| totalsurface     = 
| superheatertype  = 
| superheaterarea  = 
| cylindercount    = 
| cylindersize     = 
| frontcylindersize= 
| rearcylindersize = 
| hpcylindersize   = 
| lpcylindersize   = 
| valvegear        = 
| valvetype        = 
| valvetravel      = 
| valvelap         = 
| valvelead        = 
| transmission     = 
| topspeed         = 
| poweroutput      = 
| tractiveeffort   = 
| factorofadhesion = 
| trainheating     = 
| locobrakes       = 
| locobrakeforce   = 
| trainbrakes      = 
| safety           = 
| railroad         = 
| railroadclass    = 
| powerclass       = 
| numinclass       = 
| roadnumber       = 
| officialname     = 
| nicknames        = 
| axleloadclass    = 
| locale           = 
| deliverydate     = 
| firstrundate     = 
| lastrundate      = 
| retiredate       = 
| withdrawndate    = 
| preservedunits   = 
| restoredate      = 
| scrapdate        = 
| currentowner     = 
| disposition      = 
| notes            =
}}
</pre>
</div>
| <div style= "width: 200px; position: top; background: #dddddd; border: 1px solid black; padding:0.5em 1em 0.5em 1em; ">
<pre>
{{Infobox locomotive
| name             = 
| powertype =Diesel
| image            = 
| alt              = 
| caption          = 
| builder          = 
| ordernumber      = 
| serialnumber     = 
| buildmodel       = 
| builddate        = 
| totalproduction  = 
| rebuilder        = 
| rebuilddate      = 
| numberrebuilt    = 
| aarwheels        = 
| uicclass         = 
| gauge  ={{RailGauge|}}
| trucks           = 
| bogies           = 
| wheeldiameter    = 
| trailingdiameter = 
| minimumcurve     = 
| wheelbase        = 
| length           = 
| width            = 
| height           = 
| axleload         = 
| weightondrivers  = 
| locoweight       = 
| fueltype         = 
| fuelcap          = 
| lubecap          = 
| coolantcap       = 
| watercap         = 
| sandcap          =
| powersupply      = 
| consumption      = 
| watercons        = 
| primemover       = 
| rpmrange         = 
| enginetype       = 
| aspiration       = 
| displacement     = 
| alternator       = 
| generator        = 
| tractionmotors   =
| headendpower     =
| cylindercount    = 
| cylindersize     = 
| transmission     = 
| multipleworking  = 
| topspeed         = 
| poweroutput      = 
| tractiveeffort   = 
| factorofadhesion = 
| trainheating     = 
| locobrakes       = 
| locobrakeforce   = 
| trainbrakes      = 
| safety           = 
| railroad         = 
| railroadclass    = 
| powerclass       = 
| numinclass       = 
| roadnumber       = 
| officialname     = 
| nicknames        = 
| axleloadclass    = 
| locale           = 
| deliverydate     = 
| firstrundate     = 
| lastrundate      = 
| retiredate       = 
| withdrawndate    = 
| preservedunits   = 
| restoredate      = 
| scrapdate        = 
| currentowner     = 
| disposition      = 
| notes            =
}}
</pre>
</div>
| <div style= "width: 220px; position: top; background: #dddddd; border: 1px solid black; padding:0.5em 1em 0.5em 1em; ">
<pre>
{{Infobox locomotive
| name             = 
| powertype =Electric
| image            = 
| alt              = 
| caption          = 
| builder          = 
| ordernumber      = 
| serialnumber     = 
| buildmodel       = 
| builddate        = 
| totalproduction  = 
| rebuilder        = 
| rebuilddate      = 
| numberrebuilt    = 
| aarwheels        = 
| uicclass         = 
| gauge ={{RailGauge|}}
| trucks           = 
| bogies           = 
| wheeldiameter    = 
| trailingdiameter = 
| minimumcurve     = 
| wheelbase        = 
| length           = 
| width            = 
| height           = 
| framesize        = 
| axleload         = 
| weightondrivers  = 
| locoweight       = 
| sandcap          =
| powersupply      =
| electricsystem   = 
| collectionmethod = 
| alternator       = 
| generator        = 
| tractionmotors   =
| headendpower     =
| transmission     = 
| multipleworking  = 
| topspeed         = 
| poweroutput      = 
| tractiveeffort   = 
| factorofadhesion = 
| trainheating     = 
| locobrakes       = 
| locobrakeforce   = 
| trainbrakes      = 
| safety           = 
| railroad         = 
| railroadclass    = 
| powerclass       = 
| numinclass       = 
| roadnumber       = 
| officialname     = 
| nicknames        = 
| axleloadclass    = 
| locale           = 
| deliverydate     = 
| firstrundate     = 
| lastrundate      = 
| retiredate       = 
| withdrawndate    = 
| preservedunits   = 
| restoredate      = 
| scrapdate        = 
| currentowner     = 
| disposition      =
| notes            =
}}
</pre>
</div>
|-
! colspan= 2 | Complete list !! !! 
|-
| colspan= 2 | <div style= "width: 400px; position: top; background: #dddddd; border: 1px solid black; padding:0.5em 1em 0.5em 1em; ">
<pre>
{{Infobox locomotive
| name             = 
| powertype        = 
| image            = 
| alt              = 
| imagesize        = 300
| caption          = 
| hatnote          = 
| designer         = 
| builder          = 
| ordernumber      = 
| serialnumber     = 
| buildmodel       = 
| builddate        = 
| totalproduction  = 
| rebuilder        = 
| rebuilddate      = 
| numberrebuilt    = 
| whytetype        = 
| aarwheels        = 
| uicclass         = 
| gauge            = {{RailGauge|}}
| trucks           = 
| bogies           = 
| leadingdiameter  = 
| driverdiameter   = 
| wheeldiameter    = 
| trailingdiameter = 
| minimumcurve     = 
| wheelbase        = 
| length           = 
| width            = 
| height           = 
| framesize        = 
| axleload         = 
| weightondrivers  = 
| locoweight       = 
| tenderweight     = 
| locotenderweight = 
| tendertype       = 
| fueltype         = 
| fuelcap          = 
| lubecap          = 
| coolantcap       = 
| watercap         = 
| tendercap        = 
| sandcap          = 
| consumption      = 
| watercons        =
| powersupply      = 
| electricsystem   = 
| collectionmethod = 
| primemover       = 
| rpmrange         = 
| enginetype       = 
| aspiration       = 
| displacement     = 
| alternator       = 
| generator        = 
| tractionmotors   =
| headendpower     = 
| boiler           = 
| boilerpressure   = 
| feedwaterheater  = 
| firearea         = 
| tubearea         = 
| fluearea         = 
| tubesandflues    = 
| fireboxarea      = 
| totalsurface     = 
| superheatertype  = 
| superheaterarea  = 
| cylindercount    = 
| cylindersize     = 
| frontcylindersize= 
| rearcylindersize = 
| hpcylindersize   = 
| lpcylindersize   = 
| valvegear        = 
| valvetype        = 
| valvetravel      = 
| valvelap         = 
| valvelead        = 
| transmission     = 
| multipleworking  = 
| topspeed         = 
| poweroutput      = 
| tractiveeffort   = 
| factorofadhesion = 
| trainheating     = 
| locobrakes       = 
| locobrakeforce   = 
| trainbrakes      = 
| safety           = 

| railroad         = 
| railroadclass    = 
| powerclass       = 
| numinclass       = 
| roadnumber       = 
| officialname     = 
| nicknames        = 
| axleloadclass    = 
| locale           = 
| deliverydate     = 
| firstrundate     = 
| lastrundate      = 
| retiredate       = 
| withdrawndate    = 
| preservedunits   = 
| restoredate      = 
| scrapdate        = 
| currentowner     = 
| disposition      = 
| notes            =
}}
</pre>
</div>
|}

<includeonly>
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE. -->
[[Category:Rail transport infobox templates|locomotive]]

</includeonly>