View source for Template:Infobox public transit/doc

{{Documentation subpage}}
<!-- Place categories at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Lua|Module:Check for unknown parameters}}
{{Parameter names example | name | image | imagesize | alt | caption | image2 | imagesize2 | alt2 | caption2 | image3 | imagesize3 | alt3 | caption3 | native_name | owner | area served | locale | transit_type | lines | line_number | start | end | stations | daily_ridership = {{{daily_ridership}}}<br/>''or:'' {{{ridership}}} | annual_ridership | chief_executive | headquarters | website | began_operation | operation_will_start | ended_operation | operator | marks | host | character | stock | vehicles | train_length | headway | system_length | notrack | track_gauge | ogauge | minimum_radius_of_curvature | el | average_speed | top_speed | map | map_name }}

This infobox is mainly for rail transit systems. For a specific service within a rail system, or for a rail system with only one route, {{tl|Infobox rail service}} may be a better choice. For railway lines, please use {{tl|Infobox rail line}} instead. For [[transit bus]]-only systems, consider using {{tl|Infobox bus transit}}.

==Usage==
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{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                    = <!-- or | stops = -->
| daily_ridership             = 
| annual_ridership            = 
| chief_executive             = <!-- or | key_people = -->
| headquarters                = 
| website                     = 
| began_operation             = 
| operation_will_start        = 
| ended_operation             =
| operator                    =
| marks                       =
| host                        =
| character                   = 
| stock                       =
| 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 -->
}}
</syntaxhighlight>
{{clear}}

==Parameters==
{| class="wikitable"
|-
! Parameter || Required || Description
|-
| <code>box_width</code> || No || Width of infobox, default:22em; Note: use <code>auto</code> for automatic width
|-
| <code>name</code> || No || Name of transit system; default: PAGENAME
|-
| <code>image</code> || No || Filename of image for the header (typically a logo, but photo can be used if no logo is available)
|-
| <code>alt</code> || No || Description of image for those who cannot see it (see [[WP:ALT|alt text]]).
|-
| <code>imagesize</code> || No || Size of image defined above; default:200px
|-
| <code>caption</code> || No || Caption for the first image
|-
| <code>image2</code> || No || Filename of second image for the header (allows for use of a picture if the logo was used for the first image parameter)
|-
| <code>alt2</code> || No || Description of image for those who cannot see it.
|-
| <code>imagesize2</code> || No || Size of second image defined above; default:200px
|-
| <code>caption2</code> || No || Caption for the first image or both
|-
| <code>image3</code> || No || Filename of third image for the header
|-
| <code>alt3</code> || No || Description of third for those who cannot see it.
|-
| <code>imagesize3</code> || No || Size of third image defined above; default:200px
|-
| <code>caption3</code> || No || Caption for the third image (or all three)
|-
| <code>native_name</code> || No || Name of the system in its native language (the place's official languages(s))
|-
| <code>owner</code> || No || Owner of transit system (if different than operator; if publicly owned, list that and its stock ticker)
|-
| <code>area served</code> || No || 
|-
| <code>locale</code> || style="color: #ff0000;" | Yes || City or region transit system is located
|-
| <code>transit_type</code> || style="color: #ff0000;" | Yes || Type of transit system. Types ''may'' include (one or more):
* [[Commuter rail]] – use in lieu of "Regional rail", "Commuter train", etc.
* [[Rapid transit]] – use in lieu of "Metro" or "Subway"
* [[Light rail]]
* [[Tram]] – use in lieu of "Trolley" or "Streetcar"
* [[Bus]]
* [[Bus rapid transit]]
* [[Monorail]]
* [[People mover]]
* [[Interurban]]
or other types of transit. This includes [[Bicycle sharing system]]s which their infoboxes use this template.
|-
| <code>lines</code> || No || Number of lines/routes
|-
| <code>line_number</code> || No || Line number(s) or route number(s)
|-
| <code>start</code> || No || Name of the start of the system/line
|-
| <code>end</code> || No|| Name of the end of the system/line
|-
| <code>stations</code> || 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.
|-
| <code>daily_ridership</code><br /> or: <code>ridership</code> || No || Daily system ridership
|-
| <code>annual_ridership</code> || No || Annual system ridership
|-
| <code>chief_executive</code> || No || Chief executive of the operator
|-
| <code>headquarters</code> || No || Location of the operator's headquarters (address and city)
|-
| <code>website</code> || No || Website http address
|-
| <code>began_operation</code> || No || Date system operations began
|-
| <code>operation_will_start</code> || No || Date system operations will start in the future
|-
| <code>ended_operation</code> || No || Date system operations ended
|-
| <code>operator(s)</code> || No || Operator of transit system (typically a subsidiary of the system's owner)
|-
| <code>marks</code> || No || Reporting marks of transit operator
|-
| <code>host</code> || 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''.
|-
| <code>character</code> || No || Character of system or route – e.g. At-grade street running, or Fully elevated and grade-separated, or Underground subway, etc. 
|-
| <code>stock</code> || No || [[Rolling stock]] used
|-
| <code>vehicles</code> || No || Number of transit vehicles (or bicycles for bicycle share)
|-
| <code>train_length</code> || No || Number of traincars or coaches per trainset
|-
| <code>headway</code> || No || Time between trains on the same track
|-
| <code>system_length</code> || No || System length, otherwise known as [[network length (transport)#Route length|route length]] (use <nowiki>{{convert|5|mi|km}}</nowiki> or <nowiki>{{convert|5|km|mi}}</nowiki> to display both [[United States customary units|U.S.]] and [[metric system|metric]] units)
|-
| <code>notrack</code> || No || Number of tracks on the lines the system uses
|-
| <code>track_gauge</code> || No || Track gauge (use template {{tl|Track gauge}})
|-
| <code>ogauge</code> || No || Old track gauge (use template {{tl|Track gauge}})
|-
| <code>minimum_radius_of_curvature</code> || No || (use template {{tl|convert}})
|-
| <code>el</code> || No || [[Overhead lines]] or [[Third rail]], [[Voltage]], AC or DC, etc.
|-
| <code>average_speed</code> || No || Average speed (if known; use <nowiki>{{convert|0|mph|km/h|abbr=on}} or {{convert|0|km/h|mph|abbr=on}}</nowiki> to display both [[United States customary units|U.S.]] and [[metric system|metric]] units))
|-
| <code>top_speed</code> || No || Top speed (if known; use {{tl|convert}} similar to average speed)
|-
| <code>map</code> || No || Map of line
|-
| <code>map_name</code> || No || Title of map; default: System map
|-
| <code>map_state</code> || No || Shows or hides map. Use <code>show</code> or <code>collapsed</code>
|}

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

An example from the [[Sochi Light Metro]] rapid transit system:
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{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
}}
</syntaxhighlight>

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 <code>auto</code> will solve this problem.
{{clear}}

== Tracking category ==
* {{clc|Pages using infobox public transit with unknown parameters}}

== TemplateData ==
{{Collapse top|title=[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
	"params": {
		"box_width": {
			"label": "Infobox width",
			"description": "The width of the infobox. Use 'auto' for automatic width.",
			"type": "string",
			"default": "22em",
			"example": "500px"
		},
		"name": {
			"label": "Name",
			"description": "The transit system's name.",
			"type": "string",
			"default": "PAGENAME"
		},
		"image": {
			"label": "First image",
			"description": "Image for the header, such as the system's logo, or a photograph.",
			"type": "wiki-file-name",
			"suggested": true
		},
		"imagesize": {
			"label": "Size of first image",
			"description": "Size of the first image, if provided.",
			"type": "string",
			"default": "200px",
			"suggested": true
		},
		"alt": {
			"label": "Alternative text for first image",
			"description": "Description of content of the first image, read aloud by screen readers.",
			"type": "string",
			"suggested": true
		},
		"caption": {
			"label": "First image caption",
			"description": "Caption of the first image, if provided.",
			"type": "content",
			"suggested": true
		},
		"image2": {
			"label": "Second image",
			"description": "An additional image for the header.",
			"type": "wiki-file-name"
		},
		"imagesize2": {
			"label": "Size of second image",
			"description": "Size of the second image, if provided.",
			"type": "string",
			"default": "200px"
		},
		"alt2": {
			"label": "Alternative text for second image",
			"description": "Description of content of the second image, read aloud by screen readers.",
			"type": "string"
		},
		"caption2": {
			"label": "Second image caption",
			"description": "Caption of the second image, if provided.",
			"type": "content"
		},
		"image3": {
			"label": "Third image",
			"description": "A third image for the header.",
			"type": "wiki-file-name"
		},
		"imagesize3": {
			"label": "Size of third image",
			"description": "Size of the third image, if provided.",
			"type": "string",
			"default": "200px"
		},
		"alt3": {
			"label": "Alternative text for third image",
			"description": "Description of content of the third image, read aloud by screen readers.",
			"type": "string"
		},
		"caption3": {
			"label": "Third image caption",
			"description": "Caption of the third image, if provided.",
			"type": "content"
		},
		"native_name": {
			"label": "Native name",
			"description": "The name of the system in its local language, if not English. Consider using {{lang}}.",
			"type": "string"
		},
		"owner": {
			"label": "Owner(s)",
			"description": "The owner(s) of the system. Use {{plainlist}} or {{unbulleted list}} if multiple (see [[MOS:PLIST]]).",
			"type": "content",
			"suggested": true
		},
		"area served": {
			"label": "Area(s) served",
			"description": "The area(s) in the specified 'locale' the system serves. Use {{plainlist}} or {{unbulleted list}} if multiple (see [[MOS:PLIST]]).",
			"type": "content",
			"suggested": true
		},
		"locale": {
			"type": "content",
			"label": "Locale",
			"description": "The smallest single administrative territorial entity that the complete system serves. May be wikilinked.",
			"suggested": true
		},
		"transit_type": {
			"type": "content",
			"label": "Transit type(s)",
			"description": "The type(s) of the transit system. Use {{plainlist}} or {{unbulleted list}} if multiple (see [[MOS:PLIST]]). May be wikilinked.",
			"suggested": true
		},
		"lines": {
			"label": "Number of lines/routes",
			"description": "The number of lines/routes that are part of the system. Does not apply to bicycle-sharing systems.",
			"type": "number"
		},
		"line_number": {
			"label": "Line/Route number(s)",
			"description": "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.",
			"type": "content",
			"suggested": true
		},
                "start": {
			"label": "Start",
			"description": "The name of the system (or line)'s start.",
			"example": "empty",
			"type": "content",
			"suggested": true
		},
                "end": {
			"label": "End",
			"description": "The name of the system (or line)'s start.",
			"example": "empty",
			"type": "content",
			"suggested": true
		},
		"stations": {
			"label": "Number of stations/stops",
			"description": "The total number of stations or stops in the system. For bike-share systems, this is not the number of bicycle docks.",
			"type": "number",
			"suggested": true
		},
		"daily_ridership": {
			"aliases": [
				"ridership"
			],
			"label": "Daily ridership",
			"description": "The average daily patronage of the system, if available.",
			"type": "content"
		},
		"annual_ridership": {
			"label": "Annual ridership",
			"description": "The annual patronage of the system. Specify the time interval of the data.",
			"type": "content",
			"suggested": true
		},
		"chief_executive": {
			"aliases": [
				"key_people"
			],
			"label": "Chief executive(s)",
			"description": "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.",
			"type": "content",
			"suggested": true
		},
		"headquarters": {
			"label": "Location of headquarters",
			"description": "The address of the administration's headquarters. May be wikilinked.",
			"type": "content"
		},
		"website": {
			"label": "Website",
			"description": "The URL of the operator's website, using wiki syntax.",
			"type": "url",
			"suggested": true
		},
		"began_operation": {
			"label": "Opening date (past)",
			"description": "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).",
			"type": "content",
			"suggested": true
		},
		"operation_will_start": {
			"label": "Expected opening date (future)",
			"description": "The date of the system's expected first day of operations. The use of {{Start date and age}} is recommended.",
			"type": "content"
		},
		"ended_operation": {
			"label": "Closing date",
			"description": "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).",
			"type": "content"
		},
		"operator": {
			"label": "Operator(s)",
			"description": "The operator(s) of the system. Use {{plainlist}} or {{unbulleted list}} if multiple (see [[MOS:PLIST]]).",
			"type": "content",
			"suggested": true
		},
		"marks": {
			"label": "Reporting mark(s)",
			"description": "The reporting mark(s) for each operator. Only applies to rail systems in some countries.",
			"type": "string"
		},
		"host": {
			"label": "Host railroad(s)",
			"description": "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.",
			"type": "content"
		},
		"character": {
			"label": "Character",
			"description": "A brief description of the system's structure.",
			"example": "At-grade [[street running]]",
			"type": "content",
			"suggested": true
		},
		"vehicles": {
			"label": "Number of vehicles",
			"description": "Total number of vehicles in the system for commuter service.",
			"type": "number",
			"suggested": true
		},
		"train_length": {
			"label": "Number of sections per vehicle",
			"description": "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]]).",
			"type": "content"
		},
		"headway": {
			"label": "Headway or service frequency",
			"description": "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.",
			"type": "content"
		},
		"system_length": {
			"label": "System (route) length",
			"description": "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.",
			"type": "content"
		},
		"notrack": {
			"label": "Number of tracks",
			"description": "The number of tracks on the line the system uses. Does not apply to bus or bicycle-sharing systems.",
			"type": "number"
		},
		"track_gauge": {
			"label": "Track gauge",
			"description": "The track gauge used by the rail system. Consider using {{track gauge}}. Does not apply to bus or bicycle-sharing systems.",
			"type": "content"
		},
		"ogauge": {
			"label": "Former track gauge",
			"description": "The former track gauge used by the rail system. Consider using {{track gauge}}. Does not apply to bus or bicycle-sharing systems.",
			"type": "content"
		},
		"minimum_radius_of_curvature": {
			"label": "Minimum curve radius",
			"description": "The minimum curve radius used by the system. Consider using {{convert}}. Does not apply to bus or bicycle-sharing systems.",
			"type": "content"
		},
		"el": {
			"label": "Electrification system",
			"description": "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]]",
			"type": "content"
		},
		"average_speed": {
			"label": "Average speed",
			"description": "The average speed of vehicles in the system. Does not apply to bicycle-sharing systems.",
			"type": "content"
		},
		"top_speed": {
			"label": "Maximum speed",
			"description": "The maximum speed of vehicles in the system. Does not apply to bicycle-sharing systems.",
			"type": "content"
		},
		"map": {
			"label": "Map",
			"description": "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).",
			"type": "content",
			"suggested": true
		},
		"map_state": {
			"label": "Default state of map",
			"description": "The initial state of the map, if specified, when the page is loaded. Use 'show' to expand and 'collapsed' to collapse.",
			"type": "string",
			"default": "show",
			"suggested": true
		},
		"map_name": {
			"label": "Map header",
			"description": "The header of the map section of the infobox. May be wikilinked.",
			"type": "content",
			"default": "System map"
		}
	},
	"description": "An infobox for public transit systems. Consider {{Infobox tram network}} for tram/streetcar and trolleybus systems with a more extensive history.",
	"format": "block"
}
</templatedata>
{{Collapse bottom}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Rail transport infobox templates|Public transit]]
[[Category:Transport infobox templates|Public transit]]
[[Category:Business infobox templates|Public transit]]
[[Category:Templates that add a tracking category]]

}}</includeonly>