For a tabulated list of many of the pictograms available for railway routemaps, see commons:BSicon/Catalogue.
If you've already read this section, you may want to skip to § Syntax overview.
The markup for composing the diagram in the |map= parameter is different to the {{BSrow}}-based templates. The major differences are the separators in each row. Subtemplates are not necessary, since a new row in the table is simply created by a carriage return (newline).
{{Routemap
Add other parameters like |title= here.
|map=
Map markup goes here!
}}
The third and fourth pairs of tildes can be omitted if there is no content following either of them.
After the last icon ID, if there is only one set of "tilde-tilde" (~~), the following text will be displayed in the main text cell instead of dist./time.
Separating text cells requires at least one empty space; otherwise the tildes will be treated as a signature.
Overlay separator "exclamation mark-tilde" (!~) must follow the icon ID which is to be overlaid.
Overlay is practically unlimited, but legibility should be taken into account.
The width of the underlying icon determines the width of the combination, even if less than the overlay. The icons are aligned with their left edges together, so that they will not be centered on each other if they differ in width. If the overlay extends past the underlying icon, it will overlay the following icon (but not the following icon's overlay).
When using icon overlay and icon link for the same icon cell, the icon link separator (!@) must follow the last (top) overlaying icon ID.
The background color parameter (bg=) requires 5 sets of preceding text separators to be recognizable even if there is no text on that row whatsoever.
Other formatting options
Rows
Example 2.2
bg=#007CC3
1
2
3
color=red,bold=yes
A
C
E
align=l,b=1,fontsize=cmt
B
D
F
colour=orange, align=b, i=y
Aside from bg=, there are several other parameters, separated by commas (,), which can be used to customize the display of a row. Only bg= can be used to change the display of icons; all others only affect text cells.
Parameters for a single icon or text cell (e.g. BHF, *Text) are preceded by two underscores (__).
Parameters for the contents of a table cell (a stack of overlaid objects, or a single icon or text box with no overlays) are preceded by an exclamation mark and an underscore (!_). This must follow the link (if any).
For the last overlaid item in a stack, the individual item parameters (if any) must precede the stack parameters.
Most of the parameters are the same as those for rows, but there are a few additional ones. Additionally, the values for align=, bg= and color= will override the row parameter values.
{{Routemap
|title=Example 4.2: Empty filler
|text-width=150
|map=
-startCollapsible-collapsed-replace
exCONTg~~under construction
leer
exKBHFa~~future terminus
exBHF~~future station
-endCollapsible
KBHFxa~~terminus
KBHFe~~terminus
}}
Example 4.2: Empty filler
under construction
future terminus
future station
terminus
terminus
Both replacement and replaced rows must be as wide as the widest non-collapsible row in the diagram.
If you want to hide the replaced row after expanding the collapsible, use icon (leer) as empty filler as in example 4.2.
In any case, mind to provide a sufficient text-width. Here, using text-width=120 would break the alignment of the icons.
Collapsible elements are intentionally disabled in mobile view, so the replaced row will never be visible. Keep this in mind while creating a diagram.
Dual text sidebar
For larger and more complicated diagrams, it often helps to have a text sidebar on the left as well as the right.
left-left remark~~left remark~~left main text~~left dist./time! !icon ID~~right dist./time~~right main text~~right remark~~right-right remark
or
left main text! !icon ID~~right main text
{{Routemap
|title=Example 5
|map=
~~km! !~~km~~
commuter terminus~~0! !uKBHFa\\KBHFa~~0~~regional terminus
River Boris~~ ~~! !uhKRZWae\WASSERq\hKRZWae~~ ~~ ~~bridge
transfer for HSR~~station~~1! !uINT\LDER\LSTR
commuter terminus~~2! !uKBHFe\\KBHFe~~2~~regional terminus
}}
Example 5
km
km
commuter terminus
0
0
regional terminus
River Boris
bridge
transfer for HSR
station
1
commuter terminus
2
2
regional terminus
Left text cells require "exclamation mark-space-exclamation mark" (! !) separating them from icon cells.
If there is no "tilde-tilde" (~~) separator to the left of "exclamation mark-space-exclamation mark", the text to the left of the separator will be displayed in the left main text cell.
Dual text sidebar collapsible
Code
Result
{{Routemap
|title=Example 6.1: All text cells applied
|text-width=,130,,,110,
|map=
~~km! !\\~~km~~
-startCollapsible
commuter terminus~~0{{0|00}}! !uKBHFa\leer\KBHFa~~{{0|00}}0~~regional terminus
River Boris~~ ~~! !uhKRZWae\WASSERq\hKRZWae~~~~ ~~bridge
-endCollapsible
transfer for HSR~~station~~1! !uINT\LDER\LSTR
commuter terminus~~2{{0|00}}! !uKBHFe\\KBHFe~~{{0|00}}2~~regional terminus
}}
3 values, separated by commas: right dist./time,right main text+right remark,right-right remark
6 values: Left-left remark,left remark+left main text,left dist./time,right dist./time,right main text+right remark,right-right remark
If the number of values is not equal to 1, 3 or 6, the entire parameter will be ignored.
If the text width of right-right remark is smaller than needed, its width definition can be omitted, as in example 6.1.
If a specific text cell is not used anywhere on the map, that width definition can be omitted, as in example 6.2.
Define the general table width with the {{{style}}} parameter if {{{text-width}}} alone cannot prevent a break.
If the empty icon cell of the collapsible row is being squashed, use empty icon (leer) to correct the icon columns.
Syntax overview
Syntax
Purpose
\
Icon separator
!~
Icon overlay
!@
Icon link
!_
Precedes icon stack formatting parameters
__
Precedes icon formatting parameters
~~
Text separator
! !
Separator between icons and left-column text
key=value,...
Formatting parameters
-startCollapsible
Start of collapsing section
-endCollapsible
End of collapsing section
-colspan
Start of non-diagram table cell
-colspan-end
End of non-diagram table cell
-colspan-n
Start of non-diagram table cell; next n lines of code are in that cell (n can be any positive whole number)
Transition from legacy BS row template to Routemap markup
Conversion policies
Many contributors of the English Route Diagram Template project during the implementation of Routemap have conflicting opinions about the justification of replacing all maps of legacy BS row templates by the Lua-based Routemap. Opponents deem the map markups of Routemap to be too esoteric for editors unfamiliar with Routemap markup to modify. While proponents support a complete conversion for better performance. There is no consensus reached at the moment so any transition without massively updating the map appearance for reflecting service and/or structural change in reality should only be done with the following considerations:
The map of the legacy BS row template design has exceeded template size limit in the transcluding page, which means the template does not expand into its intended appearance but only the link to the template page is shown, so there is an imminent need to translate the map into Routemap design to reduce post-expand include size.
If there is no template size issue, respect the preference of the initial contributor of the first completed version of the diagram. If that contributor contests the change to Routemap, retain the BS row template design.
Technical options
All BS row templates have had substitutable counterparts created; hence conversion can be easily done by prepending subst: and appending /safesubst to every BS row template name in the map. For example, change {{BS2|STR|BHF|0|1|2|3|O1=uSTRq}} in the map to {{subst:BS2/safesubst|STR|BHF|0|1|2|3|O1=uSTRq}}, then publish changes; it will produce STR!~uSTRq\BHF~~0~~1~~2~~3. The process can be sped up by using the "replace all" function of advanced edit tool or separate text editor such as Notepad or Notepad++, but the search rule for the BS row templates should ideally be a regular expression, like \{\{(BS\d*(\-2)?)\| → {{{subst:$1/safesubst|, in order to avoid templates with similar names such as BSto and BSsplit in case they are present in the map.
"Column mode editing" can avoid the trouble of find and replace to add safesubst: on all rows efficiently. This function is common in advanced text editors like Geany,[1] Notepad++[2] and Sublime Text[3].
You can also use the "convertbs" function of Module:Routemap.
Function convertbs
Copy and paste the following code to any edit area of this wiki, maybe the map page you are working on:
{{#invoke:Routemap|convertbs|<nowiki>
</nowiki>}}
Then copy and paste the original BS-map or BS-table map code between the <nowiki> tags (alternatively paste the invoke convertbs header before the original map code and the </nowiki>}} ending after the map code) and show preview. It will generate the safesubst version and show the original versions (for comparison) of the map code. You copy the safesubst code from the preview area back to the edit area, and you should remove everything of #invoke:Routemap|convertbs if the preview of the new code works properly.
On the English Wikipedia, the template {{subst:convertbs}} can be used as a shortcut:
{{subst:convertbs|1=
}}
If it doesn't work, it's possible that you haven't copied some of the relevant code, such as table markup for BS-table diagrams, or that you've copied code which actually belongs to something else.
Example
{{#invoke:Routemap|convertbs|<nowiki>
{{BS-map
|title=Demonstration
|map=
{{BS|KBHFa|0 km|A station|Shuttle bus}}
{{BS3|WASSERq|hKRZWae|WASSERq||||{{BSsplit|Suburb|Capital}}}}
{{BS|KINTe|10 km|B station|City hub}}
{{BS-colspan}}
----
Not to scale
}}
</nowiki>}}
Result
Safe substitution:
{{Routemap
|title=Demonstration
|map=
{{safesubst:BS/safesubst|KBHFa|0 km|A station|Shuttle bus}}
{{safesubst:BS3/safesubst|WASSERq|hKRZWae|WASSERq||||{{BSsplit|Suburb|Capital}}}}
{{safesubst:BS/safesubst|KINTe|10 km|B station|City hub}}
-colspan-2
----
Not to scale
}}
Original:
{{BS-map
|title=Demonstration
|map=
{{BS|KBHFa|0 km|A station|Shuttle bus}}
{{BS3|WASSERq|hKRZWae|WASSERq||||{{BSsplit|Suburb|Capital}}}}
{{BS|KINTe|10 km|B station|City hub}}
{{BS-colspan}}
----
Not to scale
}}
Use {{{inline}}} to remove title bar and table border. If creating a separate template which will be embedded into an infobox, wrap inline=1 in <includeonly>...</includeonly> tags. Also {{{navbar pos}}} is helpful to locate the {{Navbar}} better.
{{Infobox station
| name = {{color box|orange}} Station layout
| image = Placeholder.png
| image_upright = 0.5
| image_caption = Platform level
| opened = {{Start date|1935|05|15|df=y}}
| tracks = 2
| route_map =
{{routemap|inline=1|navbar=asd|navbar pos=2|
KBHFa~~terminus
WASSERq\hKRZWae\WASSERq~~ ~~ ~~ ~~Bridge
LDER\INT\~~1 km~~station~~transfer for HSR
\KBHFe\BUS~~2 km~~terminus~~bus terminal
}}
}}
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.
TemplateData for Routemap
<templatedata>
{
"description": "Template for displaying diagram composed of icon images and text labels in uniform style.",
"params": {
"inline": {
"label": "Inline state",
"type": "string",
"required": false,
"description": "Remove title bar and border for transclusion in infobox"
},
"title": {
"label": "Table title",
"type": "string",
"required": false,
"description": "Official title of the system. Value «no» will remove the table title row, but this will also disable the table collapsible switch as well"
},
"title color": {
"label": "Title font color",
"type": "string",
"required": false,
"default": "#FFF or #252525; depends",
"description": "Color of the title's text; automatically black or white to contrast with the title background color. Only use colors that contrast well with the background color",
"aliases": [
"title-color"
]
},
"title bg color": {
"label": "Title background color",
"type": "string",
"required": false,
"default": "#27404E",
"description": "Background color of the title",
"aliases": [
"title-bg"
]
},
"collapsible": {
"label": "Collapsibility",
"type": "string",
"required": false,
"description": "Whether the whole infobox is collapsible or not"
},
"collapse": {
"label": "Collapsing state",
"type": "string",
"required": false,
"description": "Collapsing state. Shown by default. Any value will make the table collapse by default",
"aliases": [
"collapsed"
]
},
"navbar": {
"label": "Template name for Navbar",
"type": "string",
"required": false,
"description": "This must exactly match the diagram template page name so the Navbar template will appear and link to the template page"
},
"navbar pos": {
"label": "Position of the Navbar",
"type": "string",
"required": false,
"description": "Position of the Navbar template. Float to left in the title bar by default; «1» for top-right corner of the map (just under the title bar); «2» for the middle bottom of the map"
},
"legend": {
"label": "Legend appearance",
"type": "wiki-page-name",
"required": false,
"default": "Template:Railway line legend",
"description": "Alias of the legend link. It can be «bus», «canal», «footpath» or «track». «0» or «no» for no legend at all"
},
"legend alt": {
"label": "Legend link text",
"type": "string",
"required": false,
"default": "Legend",
"description": "Different link name in place of «Legend» if desirable"
},
"float": {
"label": "Floating state",
"type": "string",
"required": false,
"default": "right",
"description": "Floating state of the whole box: «right» by default; optionally «left» or «none»"
},
"bg": {
"label": "Background color",
"type": "string",
"required": false,
"default": "#F9F9F9",
"description": "Background color of the whole map area"
},
"style": {
"label": "CSS style values",
"type": "string",
"required": false,
"description": "Additional CSS style definition of the whole infobox"
},
"top": {
"label": "Top note",
"type": "string",
"required": false,
"description": "Space for optional note or infobox above the map",
"aliases": [
"on top"
]
},
"footnote": {
"label": "Bottom note",
"type": "string",
"required": false,
"description": "Space for optional note or infobox below the map",
"aliases": [
"bottom"
]
},
"text-width": {
"label": "Width of map text cell",
"type": "string",
"required": false,
"description": "Extend the width of the map text cell so the collapsible section within the map does not break",
"aliases": [
"tw"
]
},
"map": {
"label": "Map markups",
"description": "Map data which uses specific markup/separators to load icon image and arrange the text in the uniform style",
"required": true,
"type": "string",
"aliases": [
"1"
]
},
"navbar mini": {
"label": "Small navbar",
"description": "If the navbar is not in default position, then this changes whether the navbar displays as \"V · T · E\" (default for navbar pos 1; values: «1», «y», «yes», «true») or \"This diagram: view · talk · edit\" (default for navbar pos 2; values: «0», «n», «no», «false»).",
"type": "string"
}
},
"format": "block",
"paramOrder": [
"inline",
"title",
"title color",
"title bg color",
"collapsible",
"collapse",
"navbar",
"navbar pos",
"navbar mini",
"legend",
"legend alt",
"float",
"bg",
"style",
"top",
"footnote",
"text-width",
"map"
]
}
(
(
