Wikipedia:Route diagram template

Differences between {{BS-map}} and {{Routemap}}

• See the template documentation for more information.
• If you are creating a table from scratch rather than by using templates, the vertical bar | – which is heavily used in Wiki table syntax – must be replaced by {{!}}. For example, {| is coded as {{(!}}, and |- as {{!}}-. Otherwise, the presence of the bar will corrupt the structure of the template and following article content. This is because when processing a template, the bar functions as a parameter separating entries, which overrides other functions.
• When a visual separator is desired in text fields, the Unicode Box Drawing character ┃ should be used. (It is visually similar to the vertical bar, but ignored by Wiki markup.) This character can be coded in HTML by ে. In Microsoft Windows it can be input directly from the keyboard by holding down Alt, followed by +2503 on the numeric keypad; or the sequence 2503Alt+x.

Transcluding map in other infoboxes

Besides standalone BS-map, row templates can be transcluded in other infobox templates such as {{Infobox rail line}} or {{Infobox public transit}}. The map syntax by BS row templates needs to be written in a separate template page and then transcluded in the infobox.

BSn row templates

When n>1, the unnamed parameters describing the text areas are shifted to make way for extra icon grids sequentially. Therefore, the unnamed (sequential) parameters of {{BS}}, {{BS2}}, {{BS3}} are as follows:

These parameters are used to build four columns as follows:

When adding special styling in the text columns, be careful because the equals sign = will generate unexpected result because it functions exclusively as part of the named parameter syntax in the template (as text columns apply unnamed parameters). This can be bypassed by replacing the equals sign with {{=}} as in the case with vertical bar (pipe) that must be coded as {{!}}.

{{BS-map
|title=BS{{mvar|n}} row templates
|width=400px
|legend=no
|map=
!style="border-bottom:2px solid #be2d2c; text-align:center"{{!}}Icons
!style="border-bottom:2px solid black; text-align:center" colspan=3{{!}}Text columns
{{BS||km / min}}
{{BS3||KBHFa|BUS|0 / 0|Airport|North terminal|Bus interchange}}
{{BS|STR|5=Main tracks}}
{{BS|KBHFe|1 / 1.5|Airport|South terminal}}
}}
{{BS-map
|title=BS{{mvar|n}} row templates
|legend=no
|map=
!style="border-bottom:2px solid #be2d2c; text-align:center"{{!}}Icons
!style="border-bottom:2px solid black; text-align:center" colspan=3{{!}}Text columns
{{BS||km / min}}
{{BS3||KBHFa|BUS|0 / 0|Airport|North terminal|Bus interchange}}
{{BS|STR|5=Main tracks|tw=200px}}
{{BS|KBHFe|1 / 1.5|Airport|South terminal}}
}}

{{BS-map
|title=BS{{mvar|n}} row templates
|width=400px
|legend=no
|map=
!style="border-bottom:2px solid #be2d2c; text-align:center"{{!}}Icons
!style="border-bottom:2px solid black; text-align:center" colspan=3{{!}}Text columns
{{BS||km / min}}
{{BS3||KBHFa|BUS|0 / 0|Airport|North terminal|Bus interchange}}
{{BS|STR|5=Main tracks}}
{{BS|KBHFe|1 / 1.5|Airport|South terminal}}
}}

Cosmetic remark

{{BS-map
|collapsible=0
|legend=0
|title=Right Text and Comment on the same row
|map=
{{BS|BHF||Main text||Comment}}
{{BS|BHF||||Some very long Comment}}
|map2-title=Moving Comment to Right Text2
|map2=
{{BS|BHF||Main text|Right Text2}}
{{BS|BHF||||Some very long Comment}}
|map3-title=Applying {{tl|float}} on Right Text2
|map3=
{{BS|BHF||Main text|{{float|top=-17px|Right Text2}}}}
{{BS|BHF||||Some very long Comment}}
}}

Sometimes applying both main text and Comment in the same row may cause the whole map to stretch too wide because there is some very long Comment text in another row regardless whether the main text and note 1 cells of that row are applied or not. This can be fixed by moving the Comment to note 1. If aligning to right is still highly desired, nest the note 1 text with {{Wikipedia:Route diagram template|top=-17px|...}}.

Remark: at present, this doesn't always work well with some web browsers. Some further research has to be done before this feature can be reused safely.

Named parameters

All BS row templates have named (designated) parameters, providing advanced functions (beware of the uppercase/lowercase alphabets of the parameter names). They are the same for the BSn templates (except for tw-left). For a given n, letter p designs a non greater integer, i.e. 1≤p≤n. Most of the time, p=1 is coded by nothing, rather than by "1".

• bg: Use color name or HTML RGB hex code (with prefix #) as background to "highlight" or to emphasize certain sections, transparent by default
• tw: Width of the Right Text column.
• tw-left: Width of the Left Text column. This is especially required for joining the icons cohesively when the text length in the "normal" BS row template text column is not wide enough to override the BS row collapsible sections.
• PX, PX2,... PXp: size of the icon (e.g. PX=50px). Parameter PX is the default value of the PX2...PXp, while {{BSpx}} is the default value of PX (actually, this amounts to x20px, coding for 20px high. This parameter acts only on its row.
• O(p)(q) (Oh,p,q, not zero,p,q). These parameters are user to describe the icons overlay. For more details, see the overlay section.
• alt1, alt2,... altp: User-defined alt attribute for the icon image to override the alt text generated by {{BS-alt}}. See also Wikipedia:Alternative text for images. Note that this parameter has been deprecated and is no longer in use.
• L1, L2,... Lp, etc.: User-defined internal link for the icon image to override the default link to file description page of the icon.

{{BS-map
|title=Named parameters
|collapsible=no
|legend=no
|map=
{{BS|BHF||<code><nowiki>{{BS|</nowiki>{{bs-q|BHF||15}}<nowiki>|PX=40px|bg=#ccccff|O1=</nowiki>{{bs-q|CSTR||15}}<nowiki>|O12=</nowiki>{{bs-q|uSTRq||15}}<br /><nowiki>|tw=500px|L1=Train station}}</nowiki></code>|PX=40px|bg=#ccccff|O1=CSTR|O12=uSTRq|tw=500px|L1=Train station}}
}}

Lining up BS row templates

{{BS-map
|title=Lining up BS row templates
|collapsible=no
|legend=no
|map-title=Example 1
|map=
{{BS2|STR|BHF||<code><nowiki>{{BS2|</nowiki>{{bs-q|STR||15}}&#124;{{bs-q|BHF||15}}<nowiki>|}}</nowiki></code>}}
{{BS2|BHF|STR||<code><nowiki>{{BS2|</nowiki>{{bs-q|BHF||15}}&#124;{{bs-q|STR||15}}<nowiki>|}}</nowiki></code>}}
|map2-title=Example 2
|map2=
{{BS|KBHFa||<code><nowiki>{{BS|</nowiki>{{bs-q|KBHFa||15}}<nowiki>|}}</nowiki></code>}}
{{BS3|BHF|BHF|BHF||<code><nowiki>{{BS3|</nowiki>{{bs-q|BHF||15}}&#124;{{bs-q|BHF||15}}&#124;{{bs-q|BHF||15}}<nowiki>|}}</nowiki></code>}}
|map3-title=Example 3
|map3=
{{BS4|BHF|BHF|BHF|BHF||<code><nowiki>{{BS4|</nowiki>{{bs-q|BHF||15}}&#124;{{bs-q|BHF||15}}&#124;{{bs-q|BHF||15}}&#124;{{bs-q|BHF||15}}<nowiki>|}}</nowiki></code>}}
{{BS2|KBHFe|KBHFe||<code><nowiki>{{BS2|</nowiki>{{bs-q|KBHFe||15}}&#124;{{bs-q|KBHFe||15}}<nowiki>|}}</nowiki></code>}}
|map4-title=Example 4
|map4=
{{BS|BHF||<code><nowiki>{{BS|</nowiki>{{bs-q|BHF||15}}<nowiki>|}}</nowiki></code>}}
{{BS2|BS2+l|BS2c4|O2=KBHFa||<code><nowiki>{{BS2|</nowiki>{{bs-q|BS2+l||15}}&#124;{{bs-q|BS2c4||15}}<nowiki>|O2=</nowiki>{{bs-q|KBHFa||15}}<nowiki>|}}</nowiki></code>}}
{{BS2|BS2l|BS2r||<code><nowiki>{{BS2|</nowiki>{{bs-q|BS2l||15}}&#124;{{bs-q|BS2r||15}}<nowiki>|}}</nowiki></code>}}
{{BS|STR||<code><nowiki>{{BS|</nowiki>{{bs-q|STR||15}}<nowiki>|}}</nowiki></code>}}
}}

Except for {{BS}}, all BSn row templates will join the icons in the same row cohesively, unless separated by an empty entry. To join the icons vertically, just open the same new BS row template and continue. (Example 1)

Editor can also line up different BSn row templates, because their icon column is set to align to center. This is usually done by joining odd number row template by odd number row template, even number row template by even number row template, in order to omit the need of empty entry to stack up grid space. In examples 2 and 3, the only icon of {{BS}} joins the 2nd icon of {{BS3}} vertically; and the 2nd and 3rd icons of {{BS4}} join the 1st and 2nd icons of {{BS2}} respectively.

When joining odd and even number row templates (example 4), specialized icons such as  (BS2l) and  (BS2c3) (supplementary corner) are required to patch the seam smoothly. (See branching icons catalog.)

Icons repositories

These pages describe the pictograms which are currently available. Watercourse pictograms, for rivers and canals, are listed separately.

The conventional file name format for this project's icons is: BSicon_pictogram ID.svg. In route diagram templates, an editor only needs to type the ID to display the desired icon. The name of a pictogram, or ID, is constructed from prefix + ROOT + suffix jointly (e.g.  (uSTRlg) formed from u STR lg). The prefix and suffix are usually in lowercase, and the ROOT is all caps to distinguish it. All icons contain at least one ROOT, but may combine two or more to form some complex icons. Affixes mostly vary the base icon's color, directional, structure, etc. and may not apply to simple icons.

Because of the number of projects using these icons, additional codes have been created for special uses, including parallel routes and type changes.

Overlay

If a required icon does not exist it may be produced from two to six existing icons using the overlay parameter to superimpose one icon over another. Add the overlay parameters in the BSn row template. O1 corresponds to the first (leftmost) place in the cell (icon grid), O2 to the second place in the cell, etc. More precisely, for a cell comprising n icons side by side, we have:

• O1 (Letter O one, not zero one), O12, O13, O14, O15: ID of an icon to overlay on the leftmost (p=1) icon of the cell, with five overlapping layers in maximum. The greater index of the parameter indicates the upper layer which is over the smaller (the base icon, described by |1= being at the bottom of the pile).
• O2, O22, O23, O24, O25: ID of an icon to overlay on the 2^nd leftmost (p=2) icon of the cell (the base icon, described by |2= being at the bottom of the pile).
• Op, Op2, Op3, Op4, Op5: ID of an icon to overlay on the p^th icon of the cell, etc.
• Overlay parameters require a valid entry for the corresponding base icon cell. Otherwise the overlay icons will not be loaded, and the page will be categorized in Category:RDTs with overlaps but no base icon.

{{BS-map
|title=Overlay
|collapsible=no
|legend=no
|map=
{{BS|uSTRq|O1=STR2|O12=BHF|O13=lHUB||<code><nowiki>{{BS|</nowiki>{{bs-q|uSTRq||15}}<nowiki>|O1=</nowiki>{{bs-q|STR2||15}}<nowiki>|O12=</nowiki>{{bs-q|BHF||15}}<nowiki>|O13=</nowiki>{{bs-q|lHUB||15}}<nowiki>}}</nowiki></code>}}
}}

In order to allow the other editors to edit the diagram code more easily, it is a good practice to list the overlay icons immediately following the corresponding "base" icon entry. That way we humans do not need to look back and forth at the codes.

The following examples A and B give the same result, but example B is recommended:

{{BS-map
|title=Lining up overlay parameters
|collapsible=no
|legend=no
|map=
{{BS2|STR|STR||Example A <code><nowiki>{{BS2|</nowiki>{{bs-q|STR||15}}<nowiki>|</nowiki>{{bs-q|STR||15}}<nowiki>||Example A|O1=</nowiki>{{bs-q|uSTRq||15}}<nowiki>|O12=</nowiki>{{bs-q|lINT||15}}<nowiki>|O2=</nowiki>{{bs-q|uSTRq||15}}<nowiki>}}</nowiki></code>|O1=uSTRq|O12=lINT|O2=uSTRq}}
{{BS2}}
{{BS2|STR|O1=uSTRq|O12=lINT|STR|O2=uSTRq||Example B <code><nowiki>{{BS2|</nowiki>{{bs-q|STR||15}}<nowiki>|O1=</nowiki>{{bs-q|uSTRq||15}}<nowiki>|O12=</nowiki>{{bs-q|lINT||15}}<nowiki>|</nowiki>{{bs-q|STR||15}}<nowiki>|O2=</nowiki>{{bs-q|uSTRq||15}}<nowiki>||Example B}}</nowiki></code>}}
}}

Navbar

v t e Template:BS-map
|navbar=Template

The |navbar= parameter of {{Routemap}} can be used to place view • talk • edit links in a route diagram that does not automatically insert them (for example, when formatted for use in an {{infobox}}). It should be given the name of the RDT, omitting the Template: prefix.

Two-line text display templates

BScvt

Template: BScvt
Result: Input: 0 mi 0 km {{BScvt|0}} 150 m 164 yd {{BScvt|150|in=m}} 100.0 mi 160.9 km {{BScvt|100.0|align=left}}

This template displays a distance as two lines of text in a text field. The default input is miles, and the template calculates the kilometre equivalent.

• Inserting the optional second parameter (any character) reverses the units.
• Decimal values are supported.
• The template automatically adds the units "mi" and "km" after the values.
• Yards, chains and metres are also supported.

The text is right-aligned, but can be changed to left- by applying the parameter "align=left".

BSsplit

Template: BSsplit
opened 1900 closed 1969 {{BSsplit|opened 1900|closed 1969}} simple open 9 am–3 pm {{BSsplit|open|9 am–3 pm|align=right}} right open 9 am–3 pm {{BSsplit|open|9 am–3 pm|align=left}} left Zone free-fare {{BSsplit|Zone|free-fare||it|align=right|line=yes}} it+line+right Canada USA {{BSsplit|Canada|USA|bg1=#f00|bg2=lightblue|align=center}} background param1 param2 {{BSsplit|param1|param2|param3}} link

BSsplit displays two lines of text in a single row table.

• The first two parameters are the two lines.
• The third parameter (alternatively |L=) defines a shared wikilink for both lines of text (no [[ or ]] are needed).
• The fourth parameter (alternatively |4=anything) will change both lines to italic text. Any character or text can be used.
• The fifth parameter (alternatively |5=anything) will change both lines to bold text. Any character or text can be used.
• Named parameter |line=anything forces a separating line to appear. Any character or text can be used.
• Named parameter align=left or align=right overrides the alignment inherited from the parent cell
• Named parameters |bg1= (top line) and |bg2= (bottom line) are used to specify the background colors of the two displayed lines. They can be specified by providing a valid html color or a hex triplet.

The template also adjusts the text height so that it will not cause spaces to appear between the rows of icons.

BSto

Template:BSto
Input: Result: {{BSto|Line Name|to Destination}} Line Name to Destination   Input: Result: {{BSto|Other Route|to Somewhere Else|align=right}} Other Route to Somewhere Else   Input: Result: {{BSto|Station|for Nearby Town|it=off}} Station for Nearby Town   Input: Result: {{BSto|Continuing line|to Terminus|it=all}} Continuing line to Terminus

The BSto template is intended for labeling connecting routes or adding other secondary information, as the second line is smaller and italicized. It also lacks a separating line. The optional align parameter will left- or right-justify text; if omitted it will default to "inherit". The optional it parameter controls italicization.

Stnlnk

Template:Stnlnk
Input: {{Stnlnk|Junction}} or {{rws|Junction}} Result: Junction (links to [[Junction railway station]])

Stnlnk (shortcut: {{rws}}) expands its parameter to link to the appropriate railway station article, without displaying the text "railway station". It is generally preferred to use the station, unless there is a specific reason to link to the place itself.

For new systems and systems in need of maintenance, use the newer {{Station link}} (abbreviated {{stl}} or {{slk}}) instead, which uses the faster and less maintenance-intensive Module:Adjacent stations.

A number of other templates provide the same function for specific systems:

RouteBox

Template:RouteBox
Input: {{RouteBox|Circle line|Circle line (London Underground) |#{{rcr|London Underground|Circle}}|#{{rcr|London Underground|Piccadilly}}}} Note that the command is split into two lines because of space constraints. Result:  Circle line

The {{RouteBox}} (shortcut:{{rbox}}) template displays a borderless box with colorable wikilinked text, suitable for displaying a route or line name in its own color.

Enlarge

Template:Enlarge
Chalk Farm South Kentish Town Camden Town Euston Mornington Crescent

The {{Enlarge}} template displays a magnifying glass icon that links to another RDT to illustrate a small area in greater detail.

RoutemapRouteIcon

A single arrowhead can be displayed using the {{RoutemapRouteIcon}} (shortcut: {{rmri}}) template.

Rail-interchange

Template:Rail-interchange
Generic modal icon  501  City-specific icon with links and optional colour change

The {{Rail-interchange}} (shortcut:{{rint}}) template is used to indicate types of connections. It places the appropriate icon (in some cases with a link) in a map row. Some cities have additional arguments for individual services, and sometimes options for modifying the display. A complete list of icons is at Template:Rail-interchange/doc.

BSflag

Template:BSflag
Arkadelphia

The {{BSflag}} template displays a colored flag to indicate a "flag" or request stop, and links to [[request stop]].

Jctrdt

Code	Result	Links to
{{Jctrdt|state=FL|US|1}}	US 1	[[U.S. Route 1 in Florida]]

The {{Jctrdt}} template will display a smaller highway shield with appropriate link for use in route diagram template rows.

UK road

Code	Result	Links to
{{UK road|A1}}	A1	[[A1 road (Great Britain)]]
{{UK road|B1000}}	B1000	[[B roads in Zone 1 of the Great Britain numbering scheme]]
{{UK road|M10}}	M10	[[M10 motorway (Great Britain)]]

This template displays a small icon with an appropriate link for A and B roads and Motorways in Great Britain.

Basic route diagram template

Eurostar route diagram
Legend
km time 0 St. Pancras International 0:00 Stratford International (opening 2010) 37 Ebbsfleet International 0:15 Fawkham Junction ( Chatham Main Line) 90 Ashford International 0:30 GB-FR border (Channel Tunnel across Strait of Dover) Calais-Fréthun 0:54 Lille-Europe 1:20 France-Belgium border Bruxelles Midi/Brussel-Zuid 1:51 492 Paris Gare du Nord 2:15 Marne la Vallée-Chessy (Disneyland) 2:33 Avignon Centre 5:40 Moûtiers (ski) 6:27 Aime la Plagne (ski, set down only) 6:59 Bourg Saint Maurice (ski) 7:17
Times shown are fastest timetabled journey from London St Pancras.

Note: The code here produces the adjoining map. It does not mean to reflect the current situation.

{{Routemap
|title = Eurostar route diagram
|title-color = white
|title-bg = #27404E
|width = 370px
|map =
~~km~~ ~~ ~~time
KBHFa~~0~~[[St Pancras railway station|St. Pancras International]] [[File:Underground no-text.svg|10px]]~~ ~~0:00
eHST~~ ~~[[Stratford International station|Stratford International]] [[File:DLR no-text roundel.svg|10px]]~~(opening 2010)
HST~~37~~[[Ebbsfleet International railway station|Ebbsfleet International]]~~ ~~0:15
exCONTgq\eABZg+r\~~ ~~ ~~[[Fawkham Junction]] {{RoutemapRoute|Licon=L|[[Chatham Main Line]]|enclosed=yes|}}
HST~~90~~[[Ashford International railway station|Ashford International]]~~ ~~0:30
tSTRa
\tZOLL\~~ ~~ ~~[[United Kingdom|GB]]-[[France|FR]] border ([[Channel Tunnel]] across [[Strait of Dover]])~~ ~~bg=#558cd3
tSTRe
HST~~ ~~[[Gare de Calais-Fréthun|Calais-Fréthun]]~~ ~~0:54
BHF~~ ~~[[Gare de Lille-Europe|Lille-Europe]]~~ ~~1:20
\KRWgl\KRW+r
\STR\GRENZE~~ ~~ ~~[[France]]-[[Belgium]] border
KRW+l\KRWgr\KBHFe~~ ~~[[Brussels-South railway station|Bruxelles Midi/Brussel-Zuid]]~~ ~~1:51
KBHFe\KRWgl\KRW+r~~492~~[[Gare du Nord|Paris Gare du Nord]]~~ ~~2:15
\STR\KHSTe~~ ~~[[Marne la Vallée-Chessy railway station|Marne la Vallée-Chessy]]~~([[Disneyland Resort Paris|Disneyland]])~~2:33
KRW+l\KRWgr\
KHSTe\STR\~~ ~~[[Avignon]] Centre~~ ~~5:40
HST~~ ~~[[Moûtiers]]~~(ski)~~6:27
eHST~~ ~~[[La Plagne|Aime la Plagne]]~~(ski, set down only)~~6:59
KHSTe~~ ~~[[Bourg Saint Maurice]]~~(ski)~~7:17
|bottom=Times shown are fastest timetabled journey from London St Pancras.
}}