Template:Infobox public transit/doc

From IxWiki
Revision as of 16:00, 25 April 2020 by >Vanisaac (→‎TemplateData: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
{{{name}}}
[[File:{{{image}}}|{{{imagesize}}}|alt={{{alt}}}]]
{{{caption}}}
[[File:{{{image2}}}|{{{imagesize2}}}|alt={{{alt2}}}]]
{{{caption2}}}
[[File:{{{image3}}}|{{{imagesize3}}}|alt={{{alt3}}}]]
{{{caption3}}}
Overview
Native name{{{native_name}}}
Owner{{{owner}}}
Area served{{{area served}}}
Locale{{{locale}}}
Transit type{{{transit_type}}}
Number of lines{{{lines}}}
Line number{{{line_number}}}
Number of stations{{{stations}}}
Daily ridership{{{daily_ridership}}}
or: {{{ridership}}}
Annual ridership{{{annual_ridership}}}
Chief executive{{{chief_executive}}}
Headquarters{{{headquarters}}}
Website{{{website}}}
Operation
Began operation{{{began_operation}}}
Operation will start{{{operation_will_start}}}
Ended operation{{{ended_operation}}}
Operator(s){{{operator}}}
Reporting marks{{{marks}}}
Host railroads{{{host}}}
Character{{{character}}}
Number of vehicles{{{vehicles}}}
Train length{{{train_length}}}
Headway{{{headway}}}
Technical
System length{{{system_length}}}
No. of tracks{{{notrack}}}
Track gauge{{{track_gauge}}}
Old gauge{{{ogauge}}}
Minimum radius of curvature{{{minimum_radius_of_curvature}}}
Electrification{{{el}}}
Average speed{{{average_speed}}}
Top speed{{{top_speed}}}
{{{map_name}}}

{{{map}}}

This infobox is mainly for rail transit systems. For a specific line within a rail system, or for a rail system with only one line, {{Infobox rail line}} may be a better choice. For transit bus-only systems, please consider using {{Infobox bus transit}}.

Usage

{{Infobox public transit
| box_width                   = 
| name                        = 
| image                       = 
| alt                         = 
| imagesize                   = 
| caption                     = 
| image2                      = 
| alt2                        = 
| imagesize2                  = 
| caption2                    = 
| image3                      = 
| alt3                        = 
| imagesize3                  = 
| caption3                    = 
| native_name                 = <!-- use {{lang}} -->
| owner                       = 
| area served                 = 
| locale                      = 
| transit_type                = 
| lines                       = 
| line_number                 = 
| start                       = 
| end                         =
| stations                    = 
| daily_ridership             = 
| annual_ridership            = 
| chief_executive             = <!-- or | key_people = -->
| headquarters                = 
| website                     = 
| began_operation             = 
| operation_will_start        = 
| ended_operation             =
| operator                    =
| marks                       =
| host                        =
| character                   = 
| vehicles                    =
| train_length                = 
| headway                     = 
| system_length               = <!-- {{convert|0|mi|km|abbr=on}} -->
| notrack                     =
| track_gauge                 = <!-- {{Track gauge|sg|allk=on}} -->
| ogauge                      = <!-- {{Track gauge|sg|allk=on}} -->
| minimum_radius_of_curvature = <!-- {{convert|0|ft|0|in|mm|0}} -->
| el                          =
| average_speed               = <!-- {{convert|0|mph|km/h|abbr=on}} -->
| top_speed                   = <!-- {{convert|0|mph|km/h|abbr=on}} -->
| map                         =
| map_name                    =
| map_state                   = <!-- show or collapsed -->
}}

Parameters

Parameter Required Description
box_width No Width of infobox, default:22em; Note: use auto for automatic width
name No Name of transit system; default: PAGENAME
image No Filename of image for the header (typically a logo, but photo can be used if no logo is available)
alt No Description of image for those who cannot see it (see alt text).
imagesize No Size of image defined above; default:200px
caption No Caption for the first image
image2 No Filename of second image for the header (allows for use of a picture if the logo was used for the first image parameter)
alt2 No Description of image for those who cannot see it.
imagesize2 No Size of second image defined above; default:200px
caption2 No Caption for the first image or both
image3 No Filename of third image for the header
alt3 No Description of third for those who cannot see it.
imagesize3 No Size of third image defined above; default:200px
caption3 No Caption for the third image (or all three)
native_name No Name of the system in its native language (the place's official languages(s))
owner No Owner of transit system (if different than operator; if publicly owned, list that and its stock ticker)
area served No
locale Yes City or region transit system is located
transit_type Yes Type of transit system. Types may include (one or more):

or other types of transit. This includes Bicycle sharing systems which their infoboxes use this template.

lines No Number of lines/routes
line_number No Line number(s) or route number(s)
start No Name of the start of the system/line
end No Name of the end of the system/line
stations No Number of stations/stops

For bicycle share system: This is the number of station areas, not the number of bicycle docks. Ignore this if it is a dockless system.

daily_ridership
or: ridership
No Daily system ridership
annual_ridership No Annual system ridership
chief_executive No Chief executive of the operator
headquarters No Location of the operator's headquarters (address and city)
website No Website http address
began_operation No Date system operations began
operation_will_start No Date system operations will start in the future
ended_operation No Date system operations ended
operator(s) No Operator of transit system (typically a subsidiary of the system's owner)
marks No Reporting marks of transit operator
host No Reporting marks or names of railroad companies that own trackage that the transit system uses. Leave blank if system owns all right-of-ways, but add system's own mark if it is mixed between owned by system and trackage rights assigned to system.
character No Character of system or route – e.g. At-grade street running, or Fully elevated and grade-separated, or Underground subway, etc.
vehicles No Number of transit vehicles (or bicycles for bicycle share)
train_length No Number of traincars or coaches per trainset
headway No Time between trains on the same track
system_length No System length, otherwise known as route length (use {{convert|5|mi|km}} or {{convert|5|km|mi}} to display both U.S. and metric units)
notrack No Number of tracks on the lines the system uses
track_gauge No Track gauge (use template {{Track gauge}})
ogauge No Old track gauge (use template {{Track gauge}})
minimum_radius_of_curvature No (use template {{convert}})
el No Overhead lines or Third rail, Voltage, AC or DC, etc.
average_speed No Average speed (if known; use {{convert|0|mph|km/h|abbr=on}} or {{convert|0|km/h|mph|abbr=on}} to display both U.S. and metric units))
top_speed No Top speed (if known; use {{convert}} similar to average speed)
map No Map of line
map_name No Title of map; default: System map
map_state No Shows or hides map. Use show or collapsed

Example

Sochi Light Metro
Bombardier Spacium train mockup
Overview
OwnerCity of Sochi
LocaleSochi, Russia
Transit typeLight Metro
Number of lines3
Number of stations24
Operation
Operation will start2013
Technical
System length86.4 km (53.7 mi)
Track gauge1,520 mm (4 ft 11+2732 in) Russian gauge

An example from the Sochi Light Metro rapid transit system:

{{Infobox public transit
| name                 = Sochi Light Metro
| image                = Coat_of_Arms_of_Sochi_(Krasnodar_krai).png
| imagesize            = 150 px
| caption              = Bombardier Spacium train mockup
| owner                = City of Sochi
| locale               = [[Sochi]], [[Russia]]
| transit_type         = [[Medium capacity system|Light Metro]]
| lines                = 3
| stations             = 24
| operation_will_start = 2013
| system_length        = {{convert|86.4|km|mi|abbr=on}}
| track_gauge          = {{Track gauge|1520mm|allk=on}}
| map                  = {{Sochi Light Metro route diagram}}
| map_state            = collapsed
}}

If some of the row of route map made with WP:ROUTE set (not entirely) breaks apart, possibly the infobox width is too short and forcing some of the text description within the route diagram template to return. Increase the box_width parameter, or putting auto will solve this problem.

Tracking category

TemplateData

TemplateData documentation used by VisualEditor and other tools
See a monthly parameter usage report for Template:Infobox public transit in articles based on its TemplateData.

TemplateData for Infobox public transit

An infobox for public transit systems. Consider {{Infobox tram network}} for tram/streetcar and trolleybus systems with a more extensive history.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Infobox widthbox_width

The width of the infobox. Use 'auto' for automatic width.

Default
22em
Example
500px
Stringoptional
Namename

The transit system's name.

Default
PAGENAME
Stringoptional
First imageimage

Image for the header, such as the system's logo, or a photograph.

Filesuggested
Size of first imageimagesize

Size of the first image, if provided.

Default
200px
Stringsuggested
Alternative text for first imagealt

Description of content of the first image, read aloud by screen readers.

Stringsuggested
First image captioncaption

Caption of the first image, if provided.

Contentsuggested
Second imageimage2

An additional image for the header.

Fileoptional
Size of second imageimagesize2

Size of the second image, if provided.

Default
200px
Stringoptional
Alternative text for second imagealt2

Description of content of the second image, read aloud by screen readers.

Stringoptional
Second image captioncaption2

Caption of the second image, if provided.

Contentoptional
Third imageimage3

A third image for the header.

Fileoptional
Size of third imageimagesize3

Size of the third image, if provided.

Default
200px
Stringoptional
Alternative text for third imagealt3

Description of content of the third image, read aloud by screen readers.

Stringoptional
Third image captioncaption3

Caption of the third image, if provided.

Contentoptional
Native namenative_name

The name of the system in its local language, if not English. Consider using {{lang}}.

Stringoptional
Owner(s)owner

The owner(s) of the system. Use {{plainlist}} or {{unbulleted list}} if multiple (see [[MOS:PLIST]]).

Contentsuggested
Area(s) servedarea served

The area(s) in the specified 'locale' the system serves. Use {{plainlist}} or {{unbulleted list}} if multiple (see [[MOS:PLIST]]).

Contentsuggested
Localelocale

The smallest single administrative territorial entity that the complete system serves. May be wikilinked.

Contentsuggested
Transit type(s)transit_type

The type(s) of the transit system. Use {{plainlist}} or {{unbulleted list}} if multiple (see [[MOS:PLIST]]). May be wikilinked.

Contentsuggested
Number of lines/routeslines

The number of lines/routes that are part of the system. Does not apply to bicycle-sharing systems.

Numberoptional
Line/Route number(s)line_number

A list of the lines/routes that are part of the system, for number-based systems with a small number of lines/routes. Delimit with commas. May be wikilinked.

Contentsuggested
Startstart

The name of the system (or line)'s start.

Example
empty
Contentsuggested
Endend

The name of the system (or line)'s start.

Example
empty
Contentsuggested
Number of stations/stopsstations

The total number of stations or stops in the system. For bike-share systems, this is not the number of bicycle docks.

Numbersuggested
Daily ridershipdaily_ridership ridership

The average daily patronage of the system, if available.

Contentoptional
Annual ridershipannual_ridership

The annual patronage of the system. Specify the time interval of the data.

Contentsuggested
Chief executive(s)chief_executive key_people

The chief executive(s) or key people of the system's administration. Use {{plainlist}} or {{unbulleted list}} if multiple (see [[MOS:PLIST]]). May be wikilinked.

Contentsuggested
Location of headquartersheadquarters

The address of the administration's headquarters. May be wikilinked.

Contentoptional
Websitewebsite

The URL of the operator's website, using wiki syntax.

URLsuggested
Opening date (past)began_operation

The date, however incomplete, of the system's first day of operations. Use 'operation_will_start' for future dates. The use of {{Start date and age}} is recommended, unless the date is a bound/limit (e.g. before April 1907).

Contentsuggested
Expected opening date (future)operation_will_start

The date of the system's expected first day of operations. The use of {{Start date and age}} is recommended.

Contentoptional
Closing dateended_operation

The date, however incomplete, of the system's last day of operations. The use of {{End date and age}} is recommended, unless the date is a bound/limit (e.g. before April 1907).

Contentoptional
Operator(s)operator

The operator(s) of the system. Use {{plainlist}} or {{unbulleted list}} if multiple (see [[MOS:PLIST]]).

Contentsuggested
Reporting mark(s)marks

The reporting mark(s) for each operator. Only applies to rail systems in some countries.

Stringoptional
Host railroad(s)host

The name(s) or reporting mark(s) of the companies owning the rail infrastructure used by the system. Use {{plainlist}} or {{unbulleted list}} if multiple (see [[MOS:PLIST]]). Ignore if the system owns the entire network.

Contentoptional
Charactercharacter

A brief description of the system's structure.

Example
At-grade [[street running]]
Contentsuggested
Number of vehiclesvehicles

Total number of vehicles in the system for commuter service.

Numbersuggested
Number of sections per vehicletrain_length

The number of sections (traincars, coaches or bogies) per vehicle. Does not apply to bicycle-sharing systems. Use {{plainlist}} or {{unbulleted list}} if multiple (see [[MOS:PLIST]]).

Contentoptional
Headway or service frequencyheadway

The amount of time between vehicles on the same track. Does not apply to bicycle-sharing system or when used in an article for a system with multiple lines/routes.

Contentoptional
System (route) lengthsystem_length

Total length of all routes in the system. Sections where multiple lines overlap are only counted once. Consider using {{convert}}. Does not apply to bicycle-sharing systems.

Contentoptional
Number of tracksnotrack

The number of tracks on the line the system uses. Does not apply to bus or bicycle-sharing systems.

Numberoptional
Track gaugetrack_gauge

The track gauge used by the rail system. Consider using {{track gauge}}. Does not apply to bus or bicycle-sharing systems.

Contentoptional
Former track gaugeogauge

The former track gauge used by the rail system. Consider using {{track gauge}}. Does not apply to bus or bicycle-sharing systems.

Contentoptional
Minimum curve radiusminimum_radius_of_curvature

The minimum curve radius used by the system. Consider using {{convert}}. Does not apply to bus or bicycle-sharing systems.

Contentoptional
Electrification systemel

The electrification system for transit systems using electricity. If the power source is the mains, specify the voltage, current type (direct or alternating) and delivery method. If the power source is from a battery, just state 'battery'. May be wikilinked.

Example
600 [[Volt|V]] [[Direct current|DC]] [[overhead line|overhead]]
Contentoptional
Average speedaverage_speed

The average speed of vehicles in the system. Does not apply to bicycle-sharing systems.

Contentoptional
Maximum speedtop_speed

The maximum speed of vehicles in the system. Does not apply to bicycle-sharing systems.

Contentoptional
Mapmap

A map of the system. This could be one generated from {{routemap}}, or could be an image file (if this is the case, wiki syntax is required).

Contentsuggested
Default state of mapmap_state

The initial state of the map, if specified, when the page is loaded. Use 'show' to expand and 'collapsed' to collapse.

Default
show
Stringsuggested
Map headermap_name

The header of the map section of the infobox. May be wikilinked.

Default
System map
Contentoptional