View source for Template:Infobox rail service/doc

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

== Usage ==
This template is designed to supply information on passenger rail services or auto-train services. It is based on [[Template:Infobox rail line]], with parameters altered to suit passenger trains.

=== Blank syntax ===
{{Parameter names example|access|alt|autorack|baggage|box_width|caption|catering|class|distance|el|end|entertainment|first|formeroperator|frequency|gauge|image|image_size|image_width|journeytime|last|line_used|locale|logo|logo_width|map|map_state|name|observation|operator|otherfacilities|owners|predecessor|ridership|ridership2|routenumber|seating|sleeping|speed|trainlength|start|status|stock|stops|successor|trainnumber|type|website}}
<pre style="overflow: auto;">{{Infobox rail service
| box_width       = 
| name            = 
| color           = 
| logo            = 
| logo_width      = 
| image           = 
| image_width     = 
| alt             =
| caption         = 
| type            = 
| status          = 
| locale          = 
| predecessor     = 
| first           = <!--{{Start date|YYYY|MM|DD|df=y}}-->
| last            = <!--{{Start date|YYYY|MM|DD|df=y}}-->
| successor       = 
| operator        = 
| formeroperator  = 
| ridership       = 
| ridership2      = 
| website         = 
| start           = 
| stops           = 
| end             = 
| distance        = 
| journeytime     = 
| frequency       = 
| trainnumber     = 
| line_used       = 
| class           = 
| access          = 
| seating         = 
| sleeping        = 
| autorack        = 
| catering        = 
| observation     = 
| entertainment   = 
| baggage         = 
| otherfacilities = 
| stock           = 
| gauge           = 
| el              = 
| speed           = 
| trainlength     = 
| owners          = 
| routenumber     = 
| maintenance     =
| sharing         =
| map             = 
| map_state       = 
| module          = 
}}</pre>

{{Clear}}

=== Example ===
{{Infobox rail service
| box_width       = 25em
| name            = TranzAlpine
| color           =
| logo            = <!-- Do not use a non-free image here, per WP:NFCC #9 -->
| logo_width      =
| image           = Tranz_alpine.jpg
| image_width     = 300px
| alt             = Blue train on single track surrounded by trees near a river
| caption         = The TranzAlpine skirting the [[Waimakariri River]].
| type            = [[Inter-city rail]]
| status          = Operating
| locale          = [[South Island]], [[New Zealand]]
| first           = {{Start date|1987|11|22|df=y}}
| last            =
| operator        = [[Tranz Scenic]], a division of [[KiwiRail]]
| formeroperator  = [[Tranz Scenic|InterCity Rail]] (1987–95)
| ridership       = 204,000 (2006 financial year)
| website         = {{URL|www.kiwirailscenic.co.nz/tranzalpine/|TranzAlpine}}
| start           = [[Christchurch]]
| stops           = 9
| end             = [[Greymouth]]
| distance        = {{convert|223|km|abbr=on}}
| journeytime     = 4 hours, 25 minutes
| frequency       = Daily each way
| class           = Standard class only
| access          = Restricted due to age of rolling stock
| seating         = {{Hlist|Airline style|table bay}}
| sleeping        =
| autorack        =
| catering        = On-board café
| observation     = {{Hlist|Large windows in all carriages|open-air carriage in middle of train}}
| entertainment   =
| baggage         = {{Hlist|Overhead racks|baggage carriage}}
| otherfacilities =
| stock           = {{Plainlist|
* Two [[NZR DC class]] locomotives
* Nine [[NZR 56-foot carriage]]s
* One NZR 56-foot baggage carriage
* One open-air observation carriage
 }}
| gauge           = {{Track gauge|1067mm}}
| el              =
| speed           =
| map             = {{Midland Line, New Zealand}}
| map_state       = collapsed
}}
<pre style="overflow: auto;">{{Infobox rail service
| box_width       = 25em
| name            = TranzAlpine
| color           =
| logo            = <!-- Do not use a non-free image here, per WP:NFCC #9 -->
| logo_width      =
| image           = Tranz_alpine.jpg
| image_width     = 300px
| alt             = Blue train on single track surrounded by trees near a river
| caption         = The TranzAlpine skirting the [[Waimakariri River]].
| type            = [[Inter-city rail]]
| status          = Operating
| locale          = [[South Island]], [[New Zealand]]
| first           = {{Start date|1987|11|22|df=y}}
| last            =
| operator        = [[Tranz Scenic]], a division of [[KiwiRail]]
| formeroperator  = [[Tranz Scenic|InterCity Rail]] (1987–95)
| ridership       = 204,000 (2006 financial year)
| website         = {{URL|www.kiwirailscenic.co.nz/tranzalpine/|TranzAlpine}}
| start           = [[Christchurch]]
| stops           = 9
| end             = [[Greymouth]]
| distance        = {{convert|223|km|abbr=on}}
| journeytime     = 4 hours, 25 minutes
| frequency       = Daily each way
| class           = Standard class only
| access          = Restricted due to age of rolling stock
| seating         = {{Hlist|Airline style|table bay}}
| sleeping        =
| autorack        =
| catering        = On-board café
| observation     = {{Hlist|Large windows in all carriages|open-air carriage in middle of train}}
| entertainment   =
| baggage         = {{Hlist|Overhead racks|baggage carriage}}
| otherfacilities =
| stock           = {{Plainlist|
* Two [[NZR DC class]] locomotives
* Nine [[NZR 56-foot carriage]]s
* One NZR 56-foot baggage carriage
* One open-air observation carriage
 }}
| gauge           = {{Track gauge|1067mm}}
| el              =
| speed           =
| maintenance     = 
| sharing         =
| map             = {{Midland Line, New Zealand}}
| map_state       = collapsed
}}</pre>

{{Clear}}

=== Example with the color parameter===
{{Infobox rail service
| box_width       = 25em
| name            = TranzAlpine
| color           = 27aae1
| logo            = <!-- Do not use a non-free image here, per WP:NFCC #9 -->
| logo_width      =
| image           = Tranz_alpine.jpg
| image_width     = 300px
| alt             = Blue train on single track surrounded by trees near a river
| caption         = The TranzAlpine skirting the [[Waimakariri River]].
| type            = [[Inter-city rail]]
| status          = Operating
| locale          = [[South Island]], [[New Zealand]]
| first           = {{Start date|1987|11|22|df=y}}
| last            =
| operator        = [[Tranz Scenic]], a division of [[KiwiRail]]
| formeroperator  = [[Tranz Scenic|InterCity Rail]] (1987–95)
| ridership       = 204,000 (2006 financial year)
| website         = {{URL|www.kiwirailscenic.co.nz/tranzalpine/|TranzAlpine}}
| start           = [[Christchurch]]
| stops           = 9
| end             = [[Greymouth]]
| distance        = {{convert|223|km|abbr=on}}
| journeytime     = 4 hours, 25 minutes
| frequency       = Daily each way
}}
<pre style="overflow: auto;">{{Infobox rail service
| box_width       = 25em
| name            = TranzAlpine
| color           = 27aae1
| logo            = <!-- Do not use a non-free image here, per WP:NFCC #9 -->
| logo_width      =
| image           = Tranz_alpine.jpg
| image_width     = 300px
| alt             = Blue train on single track surrounded by trees near a river
| caption         = The TranzAlpine skirting the [[Waimakariri River]].
| type            = [[Inter-city rail]]
| status          = Operating
| locale          = [[South Island]], [[New Zealand]]
| first           = {{Start date and age|1987|11|22|df=y}}
| last            =
| operator        = [[Tranz Scenic]], a division of [[KiwiRail]]
| formeroperator  = [[Tranz Scenic|InterCity Rail]] (1987–95)
| ridership       = 204,000 (2006 financial year)
| website         = {{URL|www.kiwirailscenic.co.nz/tranzalpine/|TranzAlpine}}
| start           = [[Christchurch]]
| stops           = 9
| end             = [[Greymouth]]
| distance        = {{convert|223|km|abbr=on}}
| journeytime     = 4 hours, 25 minutes
| frequency       = Daily each way
}}</pre>

{{Clear}}
== Tracking categories ==
* {{clc|Pages using infobox rail service with deprecated parameters}}
* {{clc|Pages using infobox rail service with unknown parameters}}

== Parameters ==
{| class="wikitable"
|-
! Name || Parameter || Required || Definition
|-
| Infobox width || <code>box_width</code>|| No || Width of infobox, default: 25em; Note: use <code>auto</code> for automatic width
|-
| Name || <code>name</code> || No || Name of rail service; default:Article Name
|-
| Color || <code>color</code> || No || Color of rail service (6-digit hex code without "#"); Switching the display location for the name parameter
|-
| Logo || <code>logo</code> || No || Filename of image for the logo
|-
| Logo width || <code>logo_width</code> || No || Size of logo, default: 200px
|-
| Image || <code>image</code> || No || Filename of image
|-
| Image width || <code>image_width</code> || No || Size of image, default: 250px
|-
| Alt || <code>alt</code> || No || Alternative text for the image
|-
| Caption || <code>caption</code> || No || Caption of image
|-
! colspan=4 | Info section
|-
| Type || <code>type</code> || No || Type of passenger service (e.g. inter-city, regional, commuter)
|-
| Status || <code>status</code> || No || Status of rail service
|-
| Locale || <code>locale</code> || No || City or region transit system is located
|-
| Predecessor || <code>predecessor</code> || No || The name of the predecessor to the service (e.g. [[Overlander (train)|Overlander]] → [[NZR RM class (Silver Fern)|Silver Fern]])
|-
| First service || <code>first</code> || No || Date of the first public service
|-
| Last service || <code>last</code> || No || Date of the last public service
|-
| Successor || <code>successor</code> || No || The name of the successor to the service
|-
| Current operator(s) || <code>operator</code> || No || The name(s) of the current operator(s) of the service (e.g. [[Amtrak]], [[SNCF]], [[Tranz Scenic]])
|-
| Former operator(s) || <code>predecessor</code> || No || The name(s) of the former operator(s) of the service (e.g. [[British Rail]], [[Union Pacific]])
|-
| Ridership || <code>ridership</code> || No || Service ridership (i.e. average daily, average weekday, average weekly, or average monthly)
|-
| Annual ridership || <code>ridership2</code> || No || Annual service ridership
|-
| Website || <code>website</code> || No || Website for service
|-
! colspan=4 | Route section
|-
| Start || <code>start</code> || No || Name of starting terminal station
|-
| Stops || <code>stops</code> || No || Number of stations/stops en route
|-
| End || <code>end</code> || No || Name of ending terminal station
|-
| Distance travelled || <code>distance</code> || No || Distance travelled by the service - use <nowiki>{{convert|x|km|mi|0|abbr=on}} or {{convert|x|km|mi|0|abbr=on}}</nowiki> to allow automatic conversion between kilometres and miles. 
|-
| Average journey time || <code>journeytime</code> || No || The average journey time of the service
|-
| Service frequency || <code>frequency</code> || No || The frequency of the service (e.g. hourly, daily, weekly) 
|-
| Train number(s) || <code>trainnumber</code> || No || The official train numbers as shown in all employee and some passenger timetables
|-
| Line(s) used || <code>line_used</code> || No || The line(s) used by the service
|-
! colspan=4 | On-board service section
|-
| Classes || <code>class</code> || No ||   
|-
| Disables access || <code>access</code> || No || 
|-
| Seating arrangements || <code>seating</code> || No || 
|-
| Sleeping arrangements || <code>sleeping</code> || No || 
|-
| Auto-rack arrangements || <code>autorack</code> || No || 
|-
| Catering facilities || <code>catering</code> || No || 
|-
| Observation facilities || <code>observation</code> || No || 
|-
| Entertainment facilities || <code>entertainment</code> || No || 
|-
| Baggage facilities || <code>baggage</code> || No || 
|-
| Other facilities || <code>otherfacilities</code> || No || 
|-
! colspan=4 | Technical section
|-
| Rolling stock || <code>stock</code> || No || The type of rolling stock used for the service
|-
| Gauge || <code>gauge</code> || No || The track gauge used. Please use {{tl|Track gauge}}.
|-
| Electrification || <code>el</code> || No || The voltage and frequency used, if the route is electrified
|-
| Operating speed || <code>speed</code> || No || The speed of the service
|-
| Average length || <code>trainlength</code> || No || The average length of the train
|-
| Track owner(s) || <code>owners</code> || No || The owners of the track on which the service runs, if different to the operator (e.g. [[Amtrak]] outside of the Northeast Corridor).
|-
| Timetable number(s) || <code>routenumber</code> || No || The Timetable number.
|-
| Rake maintenance || <code>maintenance</code> || No || The yard where the maintenance of the rake done.
|-
| Rake sharing || <code>sharing</code> || No || The same rake used for other services.
|-
! colspan=4 | Route map section
|-
| Map || <code>map</code> || No || Map of line
|-
| Map title || <code>map_name</code> || No || Title of map; default: Route map
|-
| Show/hide line map || <code>map_state</code> || No || Shows or hides map. Use <code>show</code> or <code>collapsed</code>
|-
! colspan="4" | Module section
|-
| Module || <code>module</code> || No || Used for embedding other infoboxes into this infobox
|}
<includeonly>{{Sandbox other||
[[Category:Rail transport infobox templates]]
}}</includeonly>
{{TemplateData header}}
<templatedata>
{
	"params": {
		"box_width": {},
		"color": {},
		"name": {},
		"color2": {},
		"logo": {},
		"logo_width": {},
		"logo_alt": {},
		"image": {},
		"image_width": {},
		"image_size": {},
		"image_alt": {},
		"alt": {},
		"caption": {},
		"type": {},
		"status": {},
		"locale": {},
		"predecessor": {},
		"first": {
			"label": "First service",
			"type": "date"
		},
		"last": {
			"label": "Last service",
			"type": "date"
		},
		"successor": {},
		"operator": {},
		"formeroperator": {},
		"ridership": {},
		"ridership2": {},
		"website": {},
		"start": {},
		"stops": {},
		"end": {},
		"distance": {},
		"journeytime": {},
		"frequency": {},
		"trainnumber": {},
		"line_used": {},
		"class": {},
		"access": {},
		"seating": {},
		"sleeping": {},
		"autorack": {},
		"catering": {},
		"observation": {},
		"entertainment": {},
		"baggage": {},
		"otherfacilities": {},
		"stock": {},
		"gauge": {},
		"el": {},
		"speed": {},
		"owners": {},
		"routenumber": {},
		"maintenance": {},
		"sharing": {},
		"trainlength": {},
		"map": {},
		"map_state": {},
		"map_name": {},
		"module": {},
		"system": {
			"label": "System"
		},
		"daily_ridership": {},
		"electrification": {},
		"states": {
			"deprecated": "locale"
		},
		"journey time": {
			"deprecated": "journeytime"
		},
		"train number": {
			"deprecated": "trainnumber"
		}
	},
	"description": "This template is designed to supply information on passenger rail services or auto-train services. It is based on the template Infobox rail line, with parameters altered to suit passenger trains.",
	"paramOrder": [
		"box_width",
		"color",
		"name",
		"color2",
		"logo",
		"logo_width",
		"logo_alt",
		"image",
		"image_width",
		"image_size",
		"image_alt",
		"alt",
		"caption",
		"type",
		"status",
		"locale",
		"predecessor",
		"first",
		"last",
		"successor",
		"operator",
		"formeroperator",
		"ridership",
		"ridership2",
		"website",
		"start",
		"stops",
		"end",
		"distance",
		"journeytime",
		"frequency",
		"trainnumber",
		"line_used",
		"class",
		"access",
		"seating",
		"sleeping",
		"autorack",
		"catering",
		"observation",
		"entertainment",
		"baggage",
		"otherfacilities",
		"stock",
		"gauge",
		"el",
		"speed",
		"trainlength",
		"owners",
		"routenumber",
		"maintenance",
		"sharing",
		"map",
		"map_state",
		"map_name",
		"module",
		"system",
		"daily_ridership",
		"electrification",
		"states",
		"journey time",
		"train number"
	]
}
</templatedata>