Template:Infobox rail service/doc

TranzAlpine
	The TranzAlpine skirting the Waimakariri River.
Overview
Service type	Inter-city rail
Status	Operating
Locale	South Island, New Zealand
First service	22 November 1987
Current operator(s)	Tranz Scenic, a division of KiwiRail
Former operator(s)	InterCity Rail (1987–95)
Ridership	204,000 (2006 financial year)
Website	TranzAlpine
Route
Termini	Christchurch; Greymouth
Stops	9
Distance travelled	223 km (139 mi)
Average journey time	4 hours, 25 minutes
Service frequency	Daily each way
On-board services
Class(es)	Standard class only
Disabled access	Restricted due to age of rolling stock
Seating arrangements	Airline style; table bay;
Catering facilities	On-board café
Observation facilities	Large windows in all carriages; open-air carriage in middle of train;
Baggage facilities	Overhead racks; baggage carriage;
Technical
Rolling stock	Two NZR DC class locomotives; Nine NZR 56-foot carriages; One NZR 56-foot baggage carriage; One open-air observation carriage;
Track gauge	1,067 mm (3 ft 6 in)
Route map
Route map
	Legend
	8.566 km
	5.323 mi
	Rapahoe Branch
	(formerly Rewanui Branch)
	Hokitika Branch
	(formerly to Ross)
	This diagram: view; talk; edit;

Route map
	{{{map}}}

{{{name}}}
	[[File:{{{logo}}}\|{{{logo_width}}}]]
	[[File:{{{image}}}\|{{{image_width}}}\|alt={{{alt}}}]] {{{caption}}}
Overview
Service type	{{{type}}}
Status	{{{status}}}
Locale	{{{locale}}}
Predecessor	{{{predecessor}}}
First service	{{{first}}}
Last service	{{{last}}}
Successor	{{{successor}}}
Current operator(s)	{{{operator}}}
Former operator(s)	{{{formeroperator}}}
Ridership	{{{ridership}}}
Annual ridership	{{{ridership2}}}
Website	{{{website}}}
Route
Termini	{{{start}}}; {{{end}}}
Stops	{{{stops}}}
Distance travelled	{{{distance}}}
Average journey time	{{{journeytime}}}
Service frequency	{{{frequency}}}
Train number(s)	{{{trainnumber}}}
Line(s) used	{{{line_used}}}
On-board services
Class(es)	{{{class}}}
Disabled access	{{{access}}}
Seating arrangements	{{{seating}}}
Sleeping arrangements	{{{sleeping}}}
Auto-rack arrangements	{{{autorack}}}
Catering facilities	{{{catering}}}
Observation facilities	{{{observation}}}
Entertainment facilities	{{{entertainment}}}
Baggage facilities	{{{baggage}}}
Other facilities	{{{otherfacilities}}}
Technical
Rolling stock	{{{stock}}}
Track gauge	{{{gauge}}}
Electrification	{{{el}}}
Operating speed	{{{speed}}}
Average length	{{{trainlength}}}
Track owner(s)	{{{owners}}}
Timetable number(s)	{{{routenumber}}}
Route map
Route map
	{{{map}}}

This is a documentation subpage for Template:Infobox rail service.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 3,000 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.

This template uses Lua:

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

{{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          = 
}}

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           =
| maintenance     = 
| sharing         =
| map             = {{Midland Line, New Zealand}}
| map_state       = collapsed
}}

Example with the color parameter

TranzAlpine
The TranzAlpine skirting the Waimakariri River.
Overview
Service type	Inter-city rail
Status	Operating
Locale	South Island, New Zealand
First service	22 November 1987 (1987-11-22)
Current operator(s)	Tranz Scenic, a division of KiwiRail
Former operator(s)	InterCity Rail (1987–95)
Ridership	204,000 (2006 financial year)
Website	TranzAlpine
Route
Termini	Christchurch Greymouth
Stops	9
Distance travelled	223 km (139 mi)
Average journey time	4 hours, 25 minutes
Service frequency	Daily each way

{{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
}}

Parameters

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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Infobox rail service in articles based on its TemplateData.

TemplateData for Infobox rail service

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.

Template parameters
This template has custom formatting.
Parameter		Description	Type	Status
Infobox width	`box_width`	Width of infobox. Default is 25em. Example 25em	String	optional
Color	`color`	Color of rail service (6-digit hex code without "#"). Colors two lines on top of the infobox.	String	optional
Alternate color	`color2`	Colors the bottom line. 6-digit hex code without "#". Use in conjunction with "Color".	String	optional
Name	`name`	Name of rail service. Defaults to the article's name.	String	optional
Logo	`logo`	no description	File	suggested
Size of logo	`logo_width`	In pixels. Default is 200.	Number	optional
Logo alt text	`logo_alt`	Alternative text for the logo; for accesibility purposes. This text will be read out by screen readers in place of the image, and is invisible. Describe the contents of the image.	Content	optional
Image	`image`	Preferably of the train.	File	suggested
Image width	`image_width` `image_size`	In pixels. Default is 250.	Number	optional
Image alt text	`alt` `image_alt`	Alternative text for the image; for accesibility purposes. This text will be read out by screen readers in place of the image, and is invisible. Describe the contents of the image.	Content	optional
Image caption	`caption`	no description	Content	suggested
Type	`type`	Type of passenger service. Example [[Inter-city rail]]	Content	suggested
System	`system`	no description	Unknown	optional
Status	`status`	no description Example Operating	String	suggested
Locale	`locale`	City or region transit system is located. Example [[Cape Denison]], [[Antartica]]	String	optional
Predecessor	`predecessor`	The name of the predecessor to the service.	String	optional
First service	`first`	no description	Date	optional
Last service	`last`	no description	Date	optional
Successor	`successor`	The name of the successor to the service.	String	optional
Current operator(s)	`operator`	The name(s) of the current operator(s) of the service. Example [[Amtrak]]	String	suggested
Former operator(s)	`formeroperator`	The name(s) of the former operator(s) of the service. Example [[British Rail]]	String	optional
Ridership	`ridership`	Service ridership (i.e. average weekday, average weekly, or average monthly). For daily ridership and annual ridership, use the respective parameters. Example 20,000 (weekly)	String	suggested
Daily ridership	`daily_ridership`	no description	String	optional
Annual ridership	`ridership2`	no description	String	optional
Official website	`website`	no description	URL	optional
Start	`start`	Name of starting terminal station. Labelled in the infobox as a "termini" along with parameter "End".	String	suggested
End	`end`	Name of ending terminal station. Labelled in the infobox as a "termini" along with parameter "Start".	String	optional
Stops	`stops`	Number of stations/stops en route.	Number	suggested
Distance travelled	`distance`	Distance travelled by the service. Use {{convert\|X\|km\|abbr=on}}, replacing X with the number of kilometers, to allow automatic conversion between kilometres and miles.	String	optional
Average journey time	`journeytime`	no description Example 4 hours, 25 minutes	String	optional
Service frequency	`frequency`	no description Example Daily	String	optional
Train number(s)	`trainnumber`	The official train numbers, as shown in employee timetables.	Content	optional
Line(s) used	`line_used`	The line(s) used by the service.	Content	optional
Class(es)	`class`	no description Example Standard class only	Content	optional
Disabled access	`access`	no description Example Restricted due to age of rolling stock	Content	optional
Seating arrangements	`seating`	no description Example Airline style	Content	optional
Sleeping arrangements	`sleeping`	no description	Content	optional
Auto-rack arrangements	`autorack`	no description	Content	optional
Catering facilities	`catering`	no description Example On-board café	Content	optional
Observation facilities	`observation`	no description Example Open-air carriage in middle of train	Content	optional
Entertainment facilities	`entertainment`	no description	Content	optional
Baggage facilities	`baggage`	no description Example Overhead racks	Content	optional
Other facilities	`otherfacilities`	no description	Content	optional
Rolling stock	`stock`	The type of rolling stock used for the service. Example {{Plainlist\| * Two [[NZR DC class]] locomotives * Nine [[NZR 56-foot carriage]]s * One NZR 56-foot baggage carriage * One open-air observation carriage }}	Content	optional
Gauge	`gauge`	The track gauge used. Use {{Track gauge}}. Example {{Track gauge\|1067mm}}	Content	optional
Electrification	`el` `electrification`	The voltage and frequency used, if the route is electrified.	Content	optional
Operating speed	`speed`	The average speed of the service.	Content	optional
Average length	`trainlength`	The average length of the train.	Content	optional
Track owner(s)	`owners`	The owners of the track on which the service runs, if different to the operator.	Content	optional
Timetable number(s)	`routenumber`	no description	Content	optional
Rake maintenance	`maintenance`	The yard where the maintenance of the rake done.	Content	optional
Rake sharing	`sharing`	The same rake used for other services.	Content	optional
Map title	`map_name`	Title of map. Default is "Route map".	String	optional
Map	`map`	Map of line. Usually a prebuilt {{routemap}}. Example {{Midland Line, New Zealand}}	Content	suggested
Show/collapse line map	`map_state`	Shows or collapses map. Use "show" or "collapsed" only. Defaults to "show". Suggested values `show` `collapsed`	String	optional
Module	`module`	Used for embedding other infoboxes. Unnecessary for most purposes.	Content	optional
States	`states`	no description	Content	deprecated
journey time	`journey time`	no description	Content	deprecated
train number	`train number`	no description	Content	deprecated

Template:Infobox rail service/doc

Usage

Blank syntax

Example

Example with the color parameter

Parameters

Tracking categories

See also