>Shkuru Afshar at 12:58, 27 September 2024

2024-09-27T12:58:54Z

New page

{{Documentation subpage}}

{{High-use}}
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Check for unknown parameters}}

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

<syntaxhighlight lang="wikitext" style="overflow: auto;">
{{Infobox rail service
| box_width =
| name =
| color =
| logo =
| logo_width =
| image =
| image_width =
| 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 =
| module =
}}
</syntaxhighlight>
{{Clear}}

=== Example ===
{{Infobox rail service
| box_width = 25em
| name = TranzAlpine
| color =
| logo = 
| 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
}}
<syntaxhighlight lang="wikitext" style="overflow: auto;">{{Infobox rail service
| box_width = 25em
| name = TranzAlpine
| color =
| logo = 
| 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
}}</syntaxhighlight>
{{Clear}}

=== Example with the color parameter===
{{Infobox rail service
| box_width = 25em
| name = TranzAlpine
| color = 27aae1
| logo = 
| 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
}}
<syntaxhighlight lang="wikitext" style="overflow: auto;">{{Infobox rail service
| box_width = 25em
| name = TranzAlpine
| color = 27aae1
| logo = 
| 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
}}</syntaxhighlight>
{{Clear}}

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

{{TemplateData header}}
<templatedata>
{
"params": {
"box_width": {
"label": "Infobox width",
"description": "Width of infobox. Default is 25em.",
"example": "25em",
"type": "string"
},
"color": {
"label": "Color",
"description": "Color of rail service (6-digit hex code without \"#\"). Colors two lines on top of the infobox.",
"type": "string"
},
"name": {
"label": "Name",
"description": "Name of rail service. Defaults to the article's name.",
"type": "string"
},
"color2": {
"label": "Alternate color",
"description": "Colors the bottom line. 6-digit hex code without \"#\". Use in conjunction with \"Color\".",
"type": "string"
},
"logo": {
"label": "Logo",
"type": "wiki-file-name",
"suggested": true
},
"logo_width": {
"label": "Size of logo",
"description": "In pixels. Default is 200.",
"type": "number"
},
"logo_alt": {
"label": "Logo alt text",
"description": "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.",
"type": "content"
},
"image": {
"label": "Image",
"description": "Preferably of the train.",
"type": "wiki-file-name",
"suggested": true
},
"image_width": {
"aliases": [
"image_size"
],
"label": "Image width",
"description": "In pixels. Default is 250.",
"type": "number"
},
"alt": {
"aliases": [
"image_alt"
],
"label": "Image alt text",
"description": "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.",
"type": "content"
},
"caption": {
"label": "Image caption",
"type": "content",
"suggested": true
},
"type": {
"label": "Type",
"description": "Type of passenger service.",
"example": "[[Inter-city rail]]",
"type": "content",
"suggested": true
},
"status": {
"label": "Status",
"example": "Operating",
"type": "string",
"suggested": true
},
"locale": {
"label": "Locale",
"description": "City or region transit system is located.",
"example": "[[Cape Denison]], [[Antartica]]",
"type": "string"
},
"predecessor": {
"label": "Predecessor",
"description": "The name of the predecessor to the service.",
"type": "string"
},
"first": {
"label": "First service",
"type": "date"
},
"last": {
"label": "Last service",
"type": "date"
},
"successor": {
"label": "Successor",
"description": "The name of the successor to the service.",
"type": "string"
},
"operator": {
"label": "Current operator(s)",
"description": "The name(s) of the current operator(s) of the service.",
"example": "[[Amtrak]]",
"type": "string",
"suggested": true
},
"formeroperator": {
"label": "Former operator(s)",
"description": "The name(s) of the former operator(s) of the service.",
"example": "[[British Rail]]",
"type": "string"
},
"ridership": {
"label": "Ridership",
"example": "20,000 (weekly)",
"description": "Service ridership (i.e. average weekday, average weekly, or average monthly). For daily ridership and annual ridership, use the respective parameters.",
"type": "string",
"suggested": true
},
"ridership2": {
"label": "Annual ridership",
"type": "string"
},
"website": {
"label": "Official website",
"type": "url"
},
"start": {
"label": "Start",
"description": "Name of starting terminal station. Labelled in the infobox as a \"termini\" along with parameter \"End\".",
"type": "string",
"suggested": true
},
"stops": {
"label": "Stops",
"description": "Number of stations/stops en route.",
"type": "number",
"suggested": true
},
"end": {
"label": "End",
"description": "Name of ending terminal station. Labelled in the infobox as a \"termini\" along with parameter \"Start\".",
"type": "string"
},
"distance": {
"label": "Distance travelled",
"description": "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.",
"type": "string"
},
"journeytime": {
"label": "Average journey time",
"example": "4 hours, 25 minutes",
"type": "string"
},
"frequency": {
"label": "Service frequency",
"example": "Daily",
"type": "string"
},
"trainnumber": {
"label": "Train number(s)",
"description": "The official train numbers, as shown in employee timetables.",
"type": "content"
},
"line_used": {
"label": "Line(s) used",
"description": "The line(s) used by the service.",
"type": "content"
},
"class": {
"label": "Class(es)",
"example": "Standard class only",
"type": "content"
},
"access": {
"label": "Disabled access",
"example": "Restricted due to age of rolling stock",
"type": "content"
},
"seating": {
"label": "Seating arrangements",
"type": "content",
"example": "Airline style"
},
"sleeping": {
"label": "Sleeping arrangements",
"type": "content"
},
"autorack": {
"label": "Auto-rack arrangements",
"type": "content"
},
"catering": {
"label": "Catering facilities",
"example": "On-board café",
"type": "content"
},
"observation": {
"label": "Observation facilities",
"example": "Open-air carriage in middle of train",
"type": "content"
},
"entertainment": {
"label": "Entertainment facilities",
"type": "content"
},
"baggage": {
"label": "Baggage facilities",
"example": "Overhead racks",
"type": "content"
},
"otherfacilities": {
"label": "Other facilities",
"type": "content"
},
"stock": {
"label": "Rolling stock",
"description": "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 }}",
"type": "content"
},
"gauge": {
"label": "Gauge",
"description": "The track gauge used. Use {{Track gauge}}.",
"example": "{{Track gauge|1067mm}}",
"type": "content"
},
"el": {
"aliases": [
"electrification"
],
"label": "Electrification",
"description": "The voltage and frequency used, if the route is electrified.",
"type": "content"
},
"speed": {
"label": "Operating speed",
"description": "The average speed of the service.",
"type": "content"
},
"owners": {
"label": "Track owner(s)",
"description": "The owners of the track on which the service runs, if different to the operator.",
"type": "content"
},
"routenumber": {
"label": "Timetable number(s)",
"type": "content"
},
"maintenance": {
"label": "Rake maintenance",
"description": "The yard where the maintenance of the rake done.",
"type": "content"
},
"sharing": {
"label": "Rake sharing",
"description": "The same rake used for other services.",
"type": "content"
},
"trainlength": {
"label": "Average length",
"description": "The average length of the train.",
"type": "content"
},
"map": {
"label": "Map",
"description": "Map of line. Usually a prebuilt {{routemap}}.",
"example": "{{Midland Line, New Zealand}}",
"type": "content",
"suggested": true
},
"map_state": {
"label": "Show/collapse line map",
"description": "Shows or collapses map. Use \"show\" or \"collapsed\" only. Defaults to \"show\".",
"type": "string",
"suggestedvalues": [
"show",
"collapsed"
]
},
"map_name": {
"label": "Map title",
"description": "Title of map. Default is \"Route map\".",
"type": "string"
},
"module": {
"label": "Module",
"description": "Used for embedding other infoboxes. Unnecessary for most purposes.",
"type": "content"
},
"system": {
"label": "System"
},
"daily_ridership": {
"label": "Daily ridership",
"type": "string"
},
"states": {
"deprecated": "locale",
"label": "States",
"type": "content"
},
"journey time": {
"deprecated": "journeytime",
"type": "content"
},
"train number": {
"deprecated": "trainnumber",
"type": "content"
}
},
"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",
"color2",
"name",
"logo",
"logo_width",
"logo_alt",
"image",
"image_width",
"alt",
"caption",
"type",
"system",
"status",
"locale",
"predecessor",
"first",
"last",
"successor",
"operator",
"formeroperator",
"ridership",
"daily_ridership",
"ridership2",
"website",
"start",
"end",
"stops",
"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_name",
"map",
"map_state",
"module",
"states",
"journey time",
"train number"
],
"format": "{{_\n| __________________ = _\n}}\n"
}
</templatedata>

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

== See also ==
* {{tl|Infobox train}}
* {{tl|Infobox station}}
* {{tl|Infobox rail line}}
* {{tl|Infobox locomotive}}

<includeonly>{{Sandbox other||


[[Category:Rail transport infobox templates]]
[[Category:Infobox templates with module parameter]]
[[Category:Templates that add a tracking category]]
}}</includeonly>

Template:Infobox rail service/doc - Revision history

>Shkuru Afshar at 12:58, 27 September 2024