Wikipedia

Template:Infobox locomotive auto/doc

< Template:Infobox locomotive auto

Examples

change

For examples see Template:Infobox Locomotive Auto/examples

Overview

change

This is a modified version of the {{Infobox Locomotive}} template. Several new features have been added such as auto-linking, default values for common fields that may be over ridden if another value is entered. Several optional features such as a secondary image, service type, locomotive type, etc. Categories are automatically added by locomotive builder, aar wheel type. You no longer need to add those categories to the article, it is automatically done for you.

A note on the auto-linking features of this template.

The auto-linking features of this template are designed for ease of use. However, if you choose you may enter your own value. Any value you add to the available options that the template does not recognize will override the preprogrammed variables and print your customized text.

Usage

change

Working examples can be here This template has a large number of parameters, but only two are required:

Required fields

change
  • name - The name that will appear above the top line of the infobox. This is a required field, if no name is provided "Please enter a name" will be displayed.
  • powertype - The type of power that the locomotive employs. This is a required field, if no power type is given, "Missing power type" will be displayed. (e.g. "steam", "diesel", "diesel-electric", "electric", etc.)

Primary image

change
  • image - The filename for the primary infobox image. If no image is provided the default image will be added. Also, if no primary image is added the article will automatically be added to Category:Infoboxes without image. When a primary image is provided, or added the article will automatically be removed from this category.
  • imagesize - The size of the image in pixels (as in imagesize=200|), default value is 200; to use the image's actual size, specify imagesize as a blank value (as in imagesize=|). Setting image size above 300px are not recommended.
  • caption - The image caption that will be displayed

Optional secondary image added in new Infobox version.

change
  • image2 - The filename for the sedcondary infobox image. The secondary image is optional added for convenience. It is the editors choice how to use this option. (Perhaps e.g. cab view of the locomotive, different perspective, etc.)
  • image2size - The size of the image in pixels (as in imagesize=200|), default value is 200; to use the image's actual size, specify imagesize as a blank value (as in imagesize=|). Setting image size above 300px are not recommended.
  • caption2 - The image caption that will be displayed. If the image2 option is not used, this caption will not be displayed.

The remaining parameters are as follows

change

(in the order that they will appear in the template output)

  • update - Optional field to show when the article was last updated.
  • multiunit - Multiple unit for EMU and DMU trainsets. Does not display if option is not chosen. (Syntax: multiunit = <emu/dmu>)

Service classes

change
  • serviceclass - Type of locomotive, a unit, b unit, slug, control cab, etc.This is an auto-linking section linking to the related article. (Syntax: serviceclass = <type of loco>)
    • a unit - an A unit a fully equipped Locomotive, drivable by itse;f, or may be part of an MU.
    • b unit - a B unit is similar to a locomotive in the fact that it has an engine (prime mover) and traction motors. However, it lacks a control cab and cannot be driven on its own. It must be connected to an "A unit".
    • cab - a fully equipped Locomotive also known as an A unit
    • control - a Control cab, a vehicle that may resemble a locomotive may or may not contain traction motors by itself, it is non-drivable. Used to control a fully equipped locomotive. More often used in passenger service, seldom used in freight service.
    • slug - a Slug, a diesel-electric locomotive "Booster" contains no cab and no engine (prime mover) of its own. Its traction motors are powered directly from the master unit. Or "Mother" locomotive.
  • service - Type of service the locomotive was originally designed for. This is an auto-linking section linking to the related article when available. (Syntax: service = <type of loco>)

Builder

change
Enter one of the following builder options and the template will automatically provide a link to that builders article, if available Also included in this field is automatic addition to that locomotive into the appropriate category. You no longer need to add the builders category in the article. If the builder is not listed, you may enter your own, or use "builderother" and define the builder and/or link. Entries are not case-sensitive, (e.g. both BLW and blw should work.) If the builder is not found in this list then the page will be added to the "plain" locomotives category.

See Category:Locomotives by builder.

  • builderother - <builder name/link> Enter a manufacturer name and/or link. You may omit this option if a selection from above is used, or it may be used as a second builder in a partnership. However; a link if desired, must be provided since there is no auto linking on this feature.
The following options may be omitted and the field will not be displayed unless otherwise noted.
  • 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
  • whytetype - The wheel arrangement in Whyte notation (Steam locomotive)


Wheel arrangement auto-linking

change
Auto-linking for AAR wheel arrangement, (U.S. diesel, diesel-electric or electric) enter one of the following if this field is not provided a default will not be displayed. Entries are not case-sensitive, (e.g. both A1A-A1A and a1a-a1a will work.) AAR types added will automatically add that locomotive to the appropriate category.

Where possible please use UIC codes.


  • uicclass - The UIC classification (European wheel arrangement) (see list below) (Syntax: uicclass = <uic code>)
    • (a1a)(a1a) - (A1A)(A1A) (A1A-A1A) is displayed
    • bb - BB is displayed
    • b - B (B) is displayed
    • b'b' - B'B' (B-B) is displayed
    • bo'(A1A) = B'(A1A) (B-A1A) is displayed
    • bo'bo' - Bo'Bo' is displayed, items added to Bo Bo category
    • bo'bo'bo' - Bo'Bo'Bo' is displayed
    • c'c' - C'C' is displayed
    • Co'Co' - Co'Co' (C-C) is displayed, items added to Co Co category
    • d - D is displayed
    • 1'd1' - 1'D1' is displayed

Technical specifications

change
  • gauge - The rail gauges on which the locomotive operated. Note: If no value is given standard gauge, 4 ft 8 1⁄2 in (1,435 mm) is assumed.
  • trucks - The type of trucks (U.S.)
  • bogies - The type of bogies
  • leadingsize - The size of the locomotive's leading wheels (Usually on steam only)
  • driversize - The size of the locomotive's driving wheels (Usually on steam only)
  • wheeldiameter - The diameter of the locomotive's wheels
  • trailingsize - The size of the locomotive's trailing wheels (Usually on steam only)
  • 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. (Usually on steam only)
  • weight - The locomotive's total weight
  • locotenderweight - The combined locomotive and tender total weight (Usually on steam only)
  • fueltype - The type of fuel that the locomotive consumes
  • fuelcap - The locomotive's full fuel capacity
  • oilcap - Lubrication oil capacity
  • coolantcap - Engine coolant capacity
  • watercap - The tender's full water capacity (Usually on steam only)
  • tendercap - The tender's full fuel and water capacity (Usually on steam only)
  • sandbox - The locomotive's full sandbox capacity
  • consumption - The locomotive's average fuel consumption rate
  • watercons - The locomotive's average water consumption rate (Usually on steam only)
  • electricsystem - The electric system(s) under which the locomotive operates
  • collectionmethod - The locomotive's (electrical) current collection method
  • primemover - The locomotive's prime mover model
  • 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 motors
  • boiler - The locomotive's boiler size (Usually on steam only)
  • boilerpressure - The total boiler pressure rating (Usually on steam only)
  • feedwaterheater - Type of feedwater heater installed (Usually on steam only)
  • firearea - The area of the locomotive's fire grate (Usually on steam only)
  • tubearea - Heating surface - tubes (Usually on steam only)
  • fluearea - Heating surface - flues (Usually on steam only)
  • tubesandflues - Heating surface - tubes and flues (if not broken out in published specs) (Usually on steam only)
  • fireboxarea - Heating surface - firebox (Usually on steam only)
  • totalsurface - Heating surface - total (Usually on steam only)
  • superheatertype - Superheater type (Usually on steam only)
  • superheaterarea - Superheater area (Usually on steam only)
  • 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 (Usually on steam only)
  • rearcylindersize - Size of the rear cylinders (Usually on steam only)
  • hpcylindersize - Size of the high-pressure cylinders in a compound (explain arrangement in cylindercount) (Usually on steam only)
  • lpcylindersize - Size of the low-pressure cylinders in a compound (Usually on steam only)
  • valvegear - Type of valve-gear used on a steam locomotive (Usually on steam only)
  • transmission - The type of transmission used
  • 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)
  • locobrakes - The type of locomotive brakes installed, Note: if no value is given by default this value is "Straight air".
  • trainbrakes - The type of train brake system installed. Note: if no value is given, by default this value is "26-L air", the most common braking system.
  • 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 designation assigned by the operating railroad
  • 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
  • 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
  • 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


change
Matching Navbox tempates. (More added as I move along.)

(I don't claim any glory on these, all I did was change the color to match the new infobox.)

Raw lists

change
Sample lists of options
Complete list Diesel-electric Steam

Complete list of options 

{{Infobox Locomotive Auto
| name             = 
| powertype        = 
| image            = 
| imagesize        = 
| caption          = 
| image2           = 
| image2size       = 
| caption2         = 
| designer         = 
| builder          = (see list)
| serialnumber     = 
| serviceclass     = 
| buildmodel       = 
| service          = 
| builddate        = 
| totalproduction  = 
| whytetype        = 
| aarwheels        =  (see list)
| aarother         = 
| uicclass         = 
| gauge            = 
| trucks           = 
| bogies           = 
| leadingsize      = 
| driversize       = 
| wheeldiameter    = 
| trailingsize     =  
| wheelbase        = 
| length           = 
| width            = 
| height           = 
| framesize        = 
| axleload         = 
| weightondrivers  = 
| weight           = 
| locotenderweight = 
| fueltype         = 
| fuelcap          = 
| oilcap           = 
| coolantcap       = 
| sandbox          = 
| watercap         = 
| tendercap        = 
| consumption      = 
| watercons        = 
| electricsystem   = 
| collectionmethod = {see list}
| primemover       = 
| enginetype       = 
| aspiration       = 
| displacement     = 
| alternator       = 
| generator        = 
| tractionmotors   = 
| cylindercount    = 
| cylindersize     = 
| transmission     = 
| topspeed         = 
| poweroutput      = 
| tractiveeffort   = 
| factorofadhesion = 
| locobrakes       = 
| trainbrakes      = 
| safety           = 
| railroad         = 
| railroadclass    = 
| numinclass       = 
| roadnumber       = 
| officialname     = 
| nicknames        = 
| locale           = 
| deliverydate     = 
| firstrundate     = 
| lastrundate      = 
| retiredate       = 
| restoredate      = 
| scrapdate        = 
| currentowner     = 
| disposition      = 
}}
Basic electric

{{Infobox Locomotive Auto
| name             = 
| powertype        = 
| image            = 
| imagesize        = 
| caption          = 
| designer         = 
| builder          = 
| serialnumber     = 
| buildmodel       = 
| builddate        = 
| totalproduction  = 
| aarwheels        = 
| uicclass         = 
| gauge            = 
| trucks           = 
| length           = 
| weight           = 
| electricsystem   = 
| collectionmethod = 
| alternator       = 
| generator        = 
| tractionmotors   = 
| transmission     = 
| topspeed         = 
| poweroutput      = 
| tractiveeffort   = 
| factorofadhesion = 
| locobrakes       = 
| trainbrakes      = 
| safety           = 
| railroad         = 
| officialname     = 
| nicknames        = 
| locale           = 
}}
Basic diesel-electric

{{Infobox Locomotive Auto
| name             = 
| powertype        = 
| image            = 
| imagesize        = 
| caption          = 
| builder          = 
| buildmodel       = 
| builddate        = 
| totalproduction  = 
| aarwheels        = 
| uicclass         = 
| gauge            = 
| trucks           = 
| bogies           = 
| weight           = 
| fuelcap          = 
| primemover       = 
| enginetype       = 
| aspiration       = 
| cylindercount    = 
| transmission     = 
| poweroutput      = 
| tractiveeffort   = 
| locobrakes       = 
| trainbrakes      = 
| safety           = 
| railroad         = 
| officialname     = 
| nicknames        = 
| locale           = 
}}
Advanced diesel-electric

{{Infobox Locomotive Auto
| name             = 
| powertype        = 
| image            = 
| imagesize        = 
| caption          = 
| designer         = 
| builder          = 
| serialnumber     = 
| buildmodel       = 
| builddate        = 
| totalproduction  = 
| aarwheels        = 
| uicclass         = 
| gauge            = 
| trucks           = 
| bogies           = 
| wheelbase        = 
| length           = 
| width            = 
| height           = 
| framesize        = 
| axleload         = 
| weight           = 
| fueltype         = 
| fuelcap          = 
| watercap         = 
| consumption      = 
| primemover       = 
| enginetype       = 
| aspiration       = 
| displacement     = 
| alternator       = 
| generator        = 
| tractionmotors   = 
| cylindercount    = 
| cylindersize     = 
| transmission     = 
| topspeed         = 
| poweroutput      = 
| tractiveeffort   = 
| factorofadhesion = 
| locobrakes       = 
| trainbrakes      = 
| safety           = 
| railroad         = 
| roadnumber       = 
| officialname     = 
| nicknames        = 
| locale           = 
| deliverydate     = 
| firstrundate     = 
| lastrundate      = 
| retiredate       = 
| restoredate      = 
| scrapdate        = 
| currentowner     = 
| disposition      = 
}}

Basic Steam 

{{Infobox Locomotive Auto
| name             = 
| powertype        = 
| image            = 
| imagesize        = 
| caption          = 
| builder          = 
| serialnumber     = 
| buildmodel       = 
| builddate        = 
| totalproduction  = 
| whytetype        = 
| uicclass         = 
| gauge            = 
| trucks           = 
| leadingsize      = 
| driversize       = 
| wheeldiameter    = 
| trailingsize     = 
| wheelbase        = 
| length           = 
| weightondrivers  = 
| weight           = 
| locotenderweight = 
| fueltype         = 
| fuelcap          = 
| watercap         = 
| tendercap        = 
| enginetype       = 
| displacement     = 
| cylindercount    = 
| cylindersize     = 
| transmission     = 
| topspeed         =  
| poweroutput      = 
| tractiveeffort   = 
| factorofadhesion = 
| locobrakes       = 
| trainbrakes      = 
| safety           = 
| railroad         = 
| officialname     = 
| nicknames        = 
| locale           = 
}}

Advanced Steam 

{{Infobox Locomotive Auto
| name             = 
| powertype        = 
| image            = 
| imagesize        = 
| caption          = 
| designer         = 
| builder          = 
| serialnumber     = 
| buildmodel       = 
| builddate        = 
| totalproduction  = 
| whytetype        = 
| uicclass         = 
| gauge            = 
| trucks           = 
| bogies           = 
| leadingsize      = 
| driversize       = 
| wheeldiameter    = 
| trailingsize     = 
| wheelbase        = 
| length           = 
| width            = 
| height           = 
| framesize        = 
| axleload         = 
| weightondrivers  = 
| weight           = 
| locotenderweight = 
| fueltype         = 
| fuelcap          = 
| watercap         = 
| tendercap        = 
| consumption      = 
| watercons        = 
| primemover       = 
| enginetype       = 
| displacement     = 
| cylindercount    = 
| cylindersize     = 
| transmission     = 
| topspeed         = 
| poweroutput      = 
| tractiveeffort   = 
| factorofadhesion = 
| locobrakes       = 
| trainbrakes      = 
| safety           = 
| railroad         = 
| railroadclass    = 
| numinclass       = 
| roadnumber       = 
| officialname     = 
| nicknames        = 
| locale           = 
| deliverydate     = 
| firstrundate     = 
| lastrundate      = 
| retiredate       = 
| restoredate      = 
| scrapdate        = 
| currentowner     = 
| disposition      = 
}}
Retrieved from "https://simple.wikipedia.org/w/index.php?title=Template:Infobox_locomotive_auto/doc&oldid=8603499"