User:Martinvl/Infobox public transit/doc
This is a documentation subpage for User:Martinvl/Infobox public transit. It may contain usage information, categories and other content that is not part of the original user template page. |
This user page employs intricate features of template syntax.
You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. You can conduct experiments, and should test all major changes, in either this template's sandbox, the general template sandbox, or your user space before changing anything here. |
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, please use {{Infobox rail line}}. For transit bus-only systems, please use {{Infobox bus transit}}.
Usage
[edit]Full syntax
[edit]{{Infobox public transit |box_width = |name = |image = |alt = |imagesize = |image2 = |alt2 = |imagesize2 = |image3 = |alt3 = |imagesize3 = |caption = |owner = |locale = |transit_type = |lines = |stations = |ridership = |annual_ridership = |chief_executive = |headquarters = |website = |callcentre = |began_operation = |operation_will_start = |ended_operation = |operator = |marks = |host = |vehicles = |train_length = |headway = |system_length = <!-- {{convert|0|mi|km|abbr=on}} --> |notrack = |track_gauge = |ogauge = |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}} --> |osm_id = |map = |map_name = |map_state = <!-- show or collapsed --> }}
Parameters
[edit]Name | Parameter | Required | Definition |
---|---|---|---|
Infobox width | box_width |
No | Width of infobox, default:22em; Note: use auto for automatic width
|
Name | name |
No | Name of transit system; default:PAGENAME |
Image | image |
No | Filename of image for the header (typically a logo, but photo can be used if no logo is available) |
Image alt text | alt |
No | Description of image for those who cannot see it (see alt text). |
Image size | imagesize |
No | Size of image defined above; default:200px |
2nd 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) |
2nd Image alt text | alt2 |
No | Description of image for those who cannot see it. |
2nd Image size | imagesize2 |
No | Size of second image defined above; default:200px |
3rd Image | image2 |
No | Filename of third image for the header |
3rd Image alt text | alt2 |
No | Description of third for those who cannot see it. |
3rd Image size | imagesize2 |
No | Size of third image defined above; default:200px |
Caption | caption |
No | Caption of the image (especially if an image was used for the second image where a logo and image are used). Text appears under images. |
Owner | owner |
No | Owner of transit system (if different than operator; if publicly owned, list that and its stock ticker) |
Locale | locale |
Yes | City or region transit system is located |
Transit type | transit_type |
Yes | Type of transit system. Types may include (one or more):
or other types of transit. (This also include Bicycle sharing systems which also use this template) |
Number of lines | lines |
No | Number of lines/routes |
Number of stations | stations |
No | Number of stations/stops
For bicycle share system: This is the number of stations, not the number of bicycle docks. |
Daily ridership | ridership |
No | Daily system ridership |
Annual ridership | annual_ridership |
No | Annual system ridership |
Chief executive | chief_executive |
No | Chief executive of the operator |
Headquarters | headquarters |
No | Location of the operator's headquarters (address and city) |
Website | website |
No | Website http address |
Call Centre | callcentre |
No | Local Call Center for information on timetables, delays, routes etc. |
Began operation | began_operation |
No | Date system operations began |
Operation will start | operation_will_start |
No | Date system operations will start in the future |
Ended operation | ended_operation |
No | Date system operations ended |
Operator(s) | operator(s) |
No | Operator of transit system (typically a subsidiary of the system's owner) |
Reporting marks | marks |
No | Reporting marks of transit operator |
Host Railroads | 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. |
Number of vehicles | vehicles |
No | Number of transit vehicles (or bicycles for bicycle share) |
Train length | train_length |
No | Train length |
Headway | headway |
No | Time between trains on the same track |
System length | system_length |
No | System length (use {{convert|5|mi|km}} or {{convert|5|km|mi}} to display both U.S. and metric units) |
No. of tracks | notrack |
No | Number of tracks on the lines the system uses |
Track gauge | track_gauge |
No | Track gauge (use template – see Category:Rail transport gauge templates) |
Old gauge | ogauge |
No | Track gauge (use template – see Category:Rail transport gauge templates) |
Minimum radius of curvature | minimum_radius_of_curvature |
No | (use template convert ) |
Electrification | el |
No | Overhead lines or Third rail, Voltage, AC or DC, etc. |
Average speed | 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 | top_speed |
No | Top speed (if known; use {{convert}} as used with average speed) |
osm_id | osm_id |
No | OpenStreet Map id. Enter the "way" id from OpenStreetMap |
Map | map |
No | Map of line |
Map title | map_name |
No | Title of map; default: System map |
Show/hide line map | map_state |
No | Shows or hides map. Use show or collapsed
|
Example
[edit]Sochi Light Metro | |
---|---|
Overview | |
Owner | City of Sochi |
Locale | Sochi, Russia |
Transit type | Light Metro |
Number of lines | 3 |
Number of stations | 24 |
Operation | |
Operation will start | 2013 |
Technical | |
System length | 86.4 km (53.7 mi) |
Track gauge | 1520 (Russian gauge) |
An example from the Sochi Light Metro rapid transit system:
<pre.raw style="border:0px;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 = {{RailGauge|1520}} ([[Russian gauge]]) |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.
<includeonly> [[Category:Transport infobox templates|Public transit]] [[Category:Business infobox templates|Public transit]] </includeonly> <includeonly> [[be-x-old:Шаблён:Грамадзкі транспарт]] [[fr:Modèle:Infobox réseau de transport en commun]] [[id:Templat:Infobox Public transit]] [[pt:Predefinição:Infobox Transportes Públicos]] [[ru:Шаблон:Infobox public transit]] [[simple:Template:Infobox Public transit]] </includeonly>