మూస:Routemap/doc పేజీ సోర్సు చూడండి

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Intricate template}}
{{Lua|Module:Routemap}}

This [[Wikipedia:Lua|Lua]]-based template replaces the older parser-function-based {{tl|BS-map}} (and deprecated {{tl|Railway line header}}, {{tl|BS-header}} and {{tl|BS-table}}) templates for [[Wikipedia:Route diagram template]]s because diagrams created by &#123;&#123;Routemap}} load faster.

== Markup for map parameter ==
The markup for composing the diagram in {{{map}}} parameter is different than the legacy BS row templates. The major difference is the separators for separating icon IDs and text of each row. There is no need to call new BS row template for each new row because the [[hard return]] itself serves as a separator for calling another new table row in the diagram. You can use other supplementary templates like {{tl|rmr}} in the text cell as usual, but be aware that special treatment is required for templates like {{tl|BSsplit}} and {{tl|BSto}} because they are essentially calling another new table for formatting.

=== Basic ===
 icon id\icon id\icon id~~dist./time~~main text~~remark~~right remark
or
 icon id\icon id\icon id~~main text
{|
|<pre><nowiki>{{Routemap
|title=Example 1
|map=
KBHFa~~terminus
WASSERq\hWASSER\WASSERq~~ ~~ ~~ ~~Bridge
LDER\INT\~~1 km~~station~~transfer for HSR
\KBHFe\BUS~~2 km~~terminus~~bus terminal
}}</nowiki></pre>
|valign=top|{{Routemap
|collapsible=0
|legend=0
|title=Example 1
|map=
KBHFa~~terminus
WASSERq\hWASSER\WASSERq~~ ~~ ~~ ~~Bridge
LDER\INT\~~1 km~~station~~transfer for HSR
\KBHFe\BUS~~2 km~~terminus~~bus terminal
}}
|}
*The separator between icon IDs uses [[backslash]] (<code>\</code>) instead of [[slash (punctuation)|slash]] (<code>/</code> commonly used by XML closing tag).
*After the last icon ID, if there is only one set of "[[tilde]]-tilde" (<code>~~</code>), 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 it will be treated as a [[Wikipedia:signature|signature]].

=== Icon overlay, icon link, background color and colspan ===
{|
|<pre><nowiki>{{Routemap
|title=Example 2
|map=
-colspan-1
Icon overlay
uSTRq!~STR2!~BHF!~lHUB
-colspan-2-style=border-bottom:5px solid red;
----
icon link
utBHF!@Superhub
-colspan
----
background color
-colspan-end
utSTR~~ ~~ ~~ ~~ ~~bg=#7af
}}</nowiki></pre>
|valign=top|{{Routemap
|collapsible=0
|legend=0
|title=Example 2
|map=
-colspan-1
Icon overlay
uSTRq!~STR2!~BHF!~lHUB
-colspan-2-style=border-bottom:5px solid red;
----
icon link
utBHF!@Superhub
-colspan
----
background color
-colspan-end
utSTR~~ ~~ ~~ ~~ ~~bg=#7af
}}
|}
*Overlay separator "exclamation mark-tilde" (<code>!~</code>) must follow the icon id which is to be overlaid.
*Overlay is practically unlimited, but legibility should be taken into account.
*When using icon overlay and icon link for the same icon cell, the icon link separator (<code>!@</code>) must follow the last (top) overlaying icon id.
*The background color separator (<code>~~bg=</code>) requires 4 sets of preceding text separators to be recognizable even if there is no text on that row whatsoever.

===Collapsible===
{|
|<pre><nowiki>{{Routemap
|title=Example 3.1: Basic collapsible
|text-width=80
|map=
-startCollapsible-collapsed
\KBHFa\~~terminus
hSTRa@g
WASSERq\hWASSER\WASSERq~~ ~~ ~~ ~~bridge
hSTRe@f
-endCollapsible-
LDER\INT\~~ ~~station~~transfer for HSR
\KBHFe\BUS~~ ~~terminus~~bus terminal
}}</nowiki></pre>
|valign=top|{{Routemap
|collapsible=0
|legend=0
|title=Example 3.1: Basic collapsible
|text-width=80
|map=
-startCollapsible-collapsed
\KBHFa\~~terminus
hSTRa@g
WASSERq\hWASSER\WASSERq~~ ~~ ~~ ~~bridge
hSTRe@f
-endCollapsible-
LDER\INT\~~ ~~station~~transfer for HSR
\KBHFe\BUS~~ ~~terminus~~bus terminal
}}
|}
{|
|<pre><nowiki>{{Routemap
|title=Example 3.2: Mixed odd and even rows
|tw=70
|map=
-startCollapsible-collapsed
d\KBHFa\d~~terminus
hWASSER~~ ~~ ~~ ~~bridge
-endCollapsible-
BS2+l\BS2+r~~junction
}}</nowiki></pre>
|valign=top|{{Routemap
|collapsible=0
|legend=0
|title=Example 3.2: Mixed odd and even rows
|tw=70
|map=
-startCollapsible-collapsed
d\KBHFa\d~~terminus
hWASSER~~ ~~ ~~ ~~bridge
-endCollapsible-
BS2+l\BS2+r~~junction
}}
|}
*Adjust {{{''text-width''}}} (or ''tw'') parameter until there is no break.
**Unit "px" by default, but other units such as "em" are acceptable.
**Check the map in different browser and increase text-width if it breaks.
*The icon number of the first row of collapsible section must equal to or greater than the icon number of the widest non-collapsible row.
**As in example 3.2, use half width empty icon {{bsq|d}} as filler when you are mixing both odd and even rows in the same map.
*Change "''collapsed''" to "''nil''" will change the default state of the collapible to uncollapsed.

===Collapsible replacement===
{|
|<pre><nowiki>{{Routemap
|title=Example 4.1
|text-width=150
|map=
KBHFa~~terminus
-startCollapsible-collapsed-replace
\LSTR\~~dispensable section
\hSTRa@g\
WASSERq\hWASSER\WASSERq~~ ~~ ~~ ~~bridge
hSTRe@f
-endCollapsible-
LDER\INT\~~ ~~station~~transfer for HSR
\KBHFe\BUS~~ ~~terminus~~bus terminal
}}</nowiki></pre>
| {{Routemap
|collapsible=0
|legend=0
|title=Example 4.1
|text-width=150
|map=
KBHFa~~terminus
-startCollapsible-collapsed-replace
\LSTR\~~dispensable section
\hSTRa@g\
WASSERq\hWASSER\WASSERq~~ ~~ ~~ ~~bridge
hSTRe@f
-endCollapsible-
LDER\INT\~~ ~~station~~transfer for HSR
\KBHFe\BUS~~ ~~terminus~~bus terminal
}}
|-
|<pre><nowiki>{{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
}}</nowiki></pre>
|{{Routemap
|collapsible=0
|legend=0
|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
}}
|}
*The icon number of both replacement and replaced rows must equal to or greater than the icon number of the widest non-collapsible row.
*If you want to hide the replaced row after expanding the collapsible, use icon {{bsq|leer}} as empty filler as in example 4.2.
*In any case, mind to provide a sufficient text-width. Using here text-width=120 would break the alignment of the icons.

===Dual text cell===
 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
{|
|<pre><nowiki>{{Routemap
|title=Example 5
|map=
commuter terminus! !uKBHFa\\KBHFa~~regional terminus
River Boris~~ ~~ ~~! !uhKRZW\WASSERq\hWASSER~~ ~~ ~~ ~~bridge
transfer for HSR~~station~~1 km! !uINT\LDER\LSTR
commuter terminus~~2 km! !uKBHFe\\KBHFe~~2 km~~regional terminus
}}</nowiki></pre>
|valign=top|{{Routemap
|collapsible=0
|legend=0
|width=300px
|title=Example 5
|text-width=
|map=
commuter terminus! !uKBHFa\\KBHFa~~regional terminus
River Boris~~ ~~ ~~! !uhKRZW\WASSERq\hWASSER~~ ~~ ~~ ~~bridge
transfer for HSR~~station~~1 km! !uINT\LDER\LSTR
commuter terminus~~2 km! !uKBHFe\\KBHFe~~2 km~~regional terminus
}}
|}
*Left text cells require "exclamation mark-space-exclamation mark" (<code>! !</code>) to separate from icon cells.
*If there is no "tilde-tilde" (<code>~~</code>) separator to the left of "exclamation mark-space-exclamation mark", the text to the left of icon cells will be displayed in '''left main text''' cell.

===Dual text cell collapsible===
{|
|<pre><nowiki>{{Routemap
|title=Example 6.1: All text cells applied
|style=width:540px
|text-width=65,150,30,30,120,
|map=
-startCollapsible
commuter terminus! !uKBHFa\leer\KBHFa~~regional terminus
River Boris~~ ~~ ~~! !uhKRZW\WASSERq\hWASSER~~ ~~ ~~ ~~bridge
-endCollapsible
transfer for HSR~~station~~1 km! !uINT\LDER\LSTR
commuter terminus~~2 km! !uKBHFe\\KBHFe~~2 km~~regional terminus
}}</nowiki></pre>
|valign=top|{{Routemap
|style=float:none;margin:none;width:540px
|collapsible=0
|legend=0
|title=Example 6.1: All text cells applied
|text-width=65,150,30,30,120,
|map=
-startCollapsible
commuter terminus! !uKBHFa\leer\KBHFa~~regional terminus
River Boris~~ ~~ ~~! !uhKRZW\WASSERq\hWASSER~~ ~~ ~~ ~~bridge
-endCollapsible
transfer for HSR~~station~~1 km! !uINT\LDER\LSTR
commuter terminus~~2 km! !uKBHFe\\KBHFe~~2 km~~regional terminus
}}
|}
{|
|<pre><nowiki>{{Routemap
|map-title=Example 6.2: Only main text cell applied
|style=width:380px
|text-width=,120,,,120,
|map=
-startCollapsible
commuter terminus! !uKBHFa\\KBHFa~~regional terminus
River Boris! !uhKRZW\WASSERq\hWASSER~~bridge
-endCollapsible
station! !uINT\LDER\LSTR
commuter terminus! !uKBHFe\\KBHFe~~regional terminus
}}</nowiki></pre>
|valign=top|{{Routemap
|style=float:none;margin:none;width:380px
|collapsible=0
|legend=0
|title=Example 6.2: Only main text cell applied
|text-width=,120,,,120,
|map=
-startCollapsible
commuter terminus! !uKBHFa\\KBHFa~~regional terminus
River Boris! !uhKRZW\WASSERq\hWASSER~~bridge
-endCollapsible
station! !uINT\LDER\LSTR
commuter terminus! !uKBHFe\\KBHFe~~regional terminus
}}
|}
*Apply {{{text-width}}} to eliminate the break: 
**Only 1 value: <code>'''right main text+right remark'''</code>
**3 values, separated by commas: <code>'''right dist./time''','''right main text+right remark''','''right-right remark'''</code>
**6 values: <code>'''Left-left remark''','''left remark+left main text''','''left dist./time''','''right dist./time''','''right main text+right remark''','''right-right remark'''</code>
**If the amount of values does not equal to 1, 3 or 6, the whole parameter will be ignored.
*If the text width of '''right-right remark''' is shorter to some degree, its width definition can be omitted, as in example 6.1.
*If the entire map never uses a specific text cell, that width definition can be omitted, as in example 6.2.
*Define the general table width in {{{style}}} parameter as well if {{{text-width}}} alone is ineffective to prevent the break.
*If the empty icon cell of the collapsible row is being squashed, use empty icon {{bsq|leer}} to fixate the icon columns.

===[[Template:BSsplit|BSsplit]], [[Template:BSto|BSto]], [[Template:BScvt|BScvt]] templates===
If you use these templates, the vertical line separator (<code>|</code>) right after the template name must be converted to {{tl|!}} otherwise you will get a mess of unprocessed markups.
{|
|<pre><nowiki>{{Routemap
|title=Example 7.1: Correct usage
|map=
BHF~~{{BSsplit{{!}}upper|lower}}
}}
}}</nowiki></pre>
|valign=top|{{Routemap
|collapsible=0
|legend=0
|title=Example 7.1: Correct usage
|map=
BHF~~{{BSsplit{{!}}upper|lower}}
}}
|}
{|
|<pre><nowiki>{{Routemap
|title=Example 7.2: Wrong usage
|map=
BHF~~{{BSto{{!}}upper|lower}}
}}
}}</nowiki></pre>
|valign=top|
|}

==Transition from legacy BS row template to Routemap markup==
All [[:Category:Route diagram templates|BS row templates]] have been amended with [[WP:SAFESUBST|safesubst]] commands, hence conversion can be easily done by adding the <code>safesubst:</code> markup before every BS row template name in the map. For example, change <code><nowiki>{{BS2|STR|BHF|0|1|2|3|O1=uSTRq}}</nowiki></code> in the map to <code><nowiki>{{safesubst:BS2|STR|BHF|0|1|2|3|O1=uSTRq}}</nowiki></code>, then save change, it will produce <code><nowiki>STR!~uSTRq\BHF~~0~~1~~2~~3</nowiki></code>. The process can be sped up by using the "replace all" function of advanced edit tool or separate text editor such as [[Notepad (software)|Notepad]] or [[Notepad++]], but the search rule for the BS row templates should be specified to the number of icon columns in order to avoid templates with similar name such as BSto and BSsplit in case they are present in the map.<br> One can also use an Unix script (mind all non subst-ed templates, that require the {{tl|!}} protection of their first ''bar''. ): 
<pre>
#! /bin/bash

cat <<EOF > tmp_sed 

s¶{{BS-map¶{{Routemap¶
s¶{{kill-BS-map¶{{Routemap¶
s¶{{BSto|¶{{BSto{{!}}¶g
s¶{{BScvt|¶{{BScvt{{!}}¶g
s¶{{BSkm|¶{{BSkm{{!}}¶g
s¶{{BSsplit|¶{{BSsplit{{!}}¶g
s¶{{BS|¶{{subst:BS|¶g
s¶{{BS\\([2-9]\\)|¶{{subst:BS\\1|¶g
s¶{{BS1\\([0-9]\\)|¶{{subst:BS1\\1|¶g
s¶||}}<!--¶|&amp;#32;|}}&lt;!--¶

EOF

sed -f tmp_sed $from > $vers
</pre>

Fake template <code>kill-BS-map</code> is a trick to choose wich template will not be displayed in an overflown source page

The rule <code>s¶||}}&lt;!--¶|&amp;#32;|}}&lt;!--¶</code> is required when using #if structures

When using <code>Railway line header</code> to avoid a template overflow, the following additional rules can to be used:
<pre>
#! /bin/bash
cat <<EOF >> tmp_sed
 
s¶{|{{Railway line header}}¶{{Routemap¶
s¶{|{{Railway line header|collapse={{#if:{{{collapse|}}}|yes}}}}¶{{Routemap | collapse={{#if:{{{collapse|}}}|yes}}¶
s¶{{BS-header|\\([^|][^|]*\\)|*.*}}¶| title = \\1¶
s¶{{BS-table}}¶| map = ¶
s¶|}\\n|}¶}}¶

EOF
</pre>

== Embedding into infobox ==
*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 <nowiki><includeonly></nowiki> tags. Also {{{navbar pos}}} is helpful to locate the {{tl|Navbar}} better.
{|
|valign=top|<pre><nowiki>{{Infobox station
| name = {{colorbox|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\hWSTR\WASSERq~~ ~~ ~~ ~~Bridge
LDER\INT\~~1 km~~station~~transfer for HSR
\KBHFe\BUS~~2 km~~terminus~~bus terminal
}}
}}</nowiki></pre>
|valign=top|{{Infobox station
| name = {{colorbox|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\hWSTR\WASSERq~~ ~~ ~~ ~~Bridge
LDER\INT\~~1 km~~station~~transfer for HSR
\KBHFe\BUS~~2 km~~terminus~~bus terminal
}}
}}
|}

== Template data ==

<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,
                        "default": "",
                        "description": "Remove title bar and border for transclusion in infobox",
                        "aliases": []
                },
                "title": {
                        "label": "Table title",
                        "type": "string",
                        "required": false,
                        "default": "",
                        "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",
                        "aliases": []
                },
                "title color": {
                        "label": "Title font color",
                        "type": "string",
                        "required": false,
                        "default": "#FFFFFF",
                        "description": "Title font color. Use high contrast color to the title background color",
                        "aliases": ["title-color"]
                },
                "title bg color": {
                        "label": "Title background color",
                        "type": "string",
                        "required": false,
                        "default": "#27404E",
                        "description": "Title background color. Use high contrast color to the title font color",
                        "aliases": ["title-bg"]
                },
                "collapsible": {
                        "label": "Collapsibility",
                        "type": "string",
                        "required": false,
                        "description": "Whether the whole infobox is collapsible or not",
                        "aliases": []
                },
                "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,
                        "default": "",
                        "description": "Type the diagram template page name so the Navbar template will appear and link to the template page",
                        "aliases": ["tnavbar"]
                },
                "navbar pos": {
                        "label": "Position of the Navbar",
                        "type": "string",
                        "required": false,
                        "default": "",
                        "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",
                        "aliases": []
                },
                "legend": {
                        "label": "Legend appearance",
                        "type": "string/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",
                        "aliases": []
                },
                "legend alt": {
                        "label": "Legend link text",
                        "type": "string",
                        "required": false,
                        "default": "Legend",
                        "description": "Different link name in place of «Legend» if desirable",
                        "aliases": []
                },
                "float": {
                        "label": "Floating state",
                        "type": "string",
                        "required": false,
                        "default": "right",
                        "description": "Floating state of the whole box: «right» by default; optionally «left» or «none»",
                        "aliases": []
                },
                "bg": {
                        "label": "Background color",
                        "type": "string",
                        "required": false,
                        "default": "#F9F9F9",
                        "description": "Background color of the whole map area",
                        "aliases": []
                },
                "style": {
                        "label": "CSS style values",
                        "type": "string",
                        "required": false,
                        "description": "Additional CSS style definition of the whole infobox",
                        "aliases": []
                },
                "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,
                        "default": "",
                        "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"]
                }
        }
}</templatedata>

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Route diagram templates]]
}}</includeonly>