Mostrar código-fonte de Predefinição:BS-map/doc

{{Subpágina de documentação}}
<!-- Categories and interwikis go at the bottom of this page. -->
{{esoteric}}
This is a shorthand template which groups {{tl|Railway line header}}, {{tl|BS-header}} and {{tl|BS-table}} all in one single entity to ease the creation of standalone [[Wikipedia:Route diagram template]] table.

== Parameters ==
{|class=wikitable
|'''style'''||Additional CSS syntax which defines the style of the whole box. It is useful when you are transcluding this map box into other infobox, e.g. add "border:0px; width:100%" to remove the border and let it fully stretch inside the infobox.
|-
|'''title'''|| Title of the map.
|-
|'''title-bg'''|| Background color of the title bar to indicate the livery color of the subject. But this is preferable not to be applied as per [[WP:COLOR]] and instead use {{tl|colorbox}} or icon image next to the title text. '''White''' by deafult.
|-
|'''title-color'''|| Font color of title text, please avoid using this parameter as a concern for accessibility of color. '''Black''' by default.
|-
|'''navbar'''|| Specify the template name if your map is written in a separated template page, it will include a mini bracketed {{tl|Navbar}} in the title bar. Leave this parameter blank if you directly use this template in the article.
|-
|'''collapsible'''|| Allow the box collapsible or not. '''yes''' by default, '''no''' will void the "show/hide" collapsible button.  You MUST have something written in the '''title''' otherwise the '''collapsible''' alone is not enough to turn it on.
|-
|'''collapse'''|| Collapse state of the whole box. '''yes''' for collapsing, '''no''' by default.
|-
|'''width'''|| Width of the whole box. No given default value because it will void the '''tw''' parameter in the BS# row template which is applied to override the text column width of BS# row collapsible section.
|-
|'''legend'''|| Legend page link:
* '''route''' or '''1''' (default): {{tl|Railway line legend}}, the most generic legend for railway map.
* '''track''': {{tl|Railway track legend}} for railway track and platform alignment diagram.
* '''bus''': {{tl|Bus route legend}} for any type of bus route map.
* '''canal''', '''water''' or '''waterway''': {{tl|Waterways legend}} for waterway or canal map.
* '''walkway''', '''foot''' or '''footpath''': [[Wikipedia:Route diagram template/Catalog of pictograms/trails|Trails icon catalog]] for footpath map.
* '''no''' or '''0''': No legend page link.
|-
|'''map'''|| BS row templates which comprise the diagram. No {{tl|BS-table}} is required.
|-
|'''map#'''|| # represents 2 to 10. Additional map space. By separating maps into different map parameters, the column alignment of the maps will not implicate to each other. This is useful if you are displaying two maps, one uses the ordinary BS# row templates (single-side text columns) and the other one uses BS#-2 (dual-side text columns) which are not compatible to each other.
|-
|'''map-title'''<br>'''map#-title'''|| # represents 2 to 10. Optional title header for each map.
|-
|'''map-collapsible'''<br>'''map#-collapsible'''|| # represents 2 to 10. Allow the individual map collapsible or not. '''no''' by default, '''yes''' will call the "show/hide" collapsible button. You MUST have something written in the '''map#-title''' otherwise the '''map#-collapsible''' alone is not enough to turn it on.
|-
|'''map-collapse'''<br>'''map#-collapse'''|| # represents 2 to 10. Collapse state of the individual map. '''yes''' for collapsing, '''no''' by default.
|-
|'''bg'''|| Background color of the whole digram, including the text column in the row templates.
|-
|'''top'''|| Optional note above the map. This is also the good place to include {{tl|BS-Infobox}} or {{tl|Infobox UK railway}} for neat data display.
|-
|'''bottom'''|| Optional note below the map. Also a good place to include the {{tl|Navbar}} if you do not want to display it in the title bar.
|}

== Usage ==
<pre><nowiki>{{BS-map
|style = 
|title = 
|title-bg = 
|navbar = 
|collapsible = 
|collapse = 
|width = 
|top = 
|legend = 
|bg = 
|map-title = 
|map = 
|map2-title = 
|map2 = 
|bottom = 
}}</nowiki></pre>
<!--Korean original version parameters:
{{노선도
|제목 = title
|제목배경 = title-bg
|상태 = collapse
|너비 = width
|내용 = map
|내용배경 = bg
|위 = top
|아래 = bottom
}}
style, title-color, navbar collapsible, legend, map# and map(#)-title parameters are not available in Korean version during adoption of this template.
-->

== Note ==
* Since this template table applies Infobox class which means you cannot directly control its alignment to center or left in '''style''' parameter. To override the compulsive right alignment, include this template in another table which aligns to center or left like so:
<pre><nowiki>
{|align=center
|
{{BS-map}}
|}
</nowiki></pre>
* Any manually written new row should replace the <code style=color:red><nowiki>|</nowiki></code> by <code style=color:red><nowiki>{{!}}</nowiki></code>.
* If you are using in-diagram collapsible section which begins with {{tl|BS-startCollapsible}} or {{tl|BS2-startCollapsible}}, the ending of the collapsible section must be <code style=color:red><nowiki>{{!}}}</nowiki></code> instead of <code style=color:red><nowiki>|}</nowiki></code>. Otherwise the box will end immediately after the collapsible section.

== Example ==
{{BS-map
|title = {{colorbox|orange}} Station layout
|top = {{{!}} align=center
{{!}}
{{bs-infobox
|image = Placeholder.png
|image_size = 150px
|caption = Platform level
|length = 500 meters
|gauge = S
}}
{{!}}}
|legend = track
|map = 
{{BS2|STR|STR}}
{{bs2-sc|STRg|STRf||}}
{{BS2|KRWgl+l|KRWgr+r||[[Scissors crossover]]}}
{{!}}}
{{BS2|STR|STR}}
{{BS2|STR+BSr|STR+BSl||[[Side platform]]s|tw=150px}}
{{BS2|STR+BSr|STR+BSl}}
{{BS2|STRg|STRf||}}
|bottom = † Diagram not to scale
}}
<pre.raw style="border:0px;overflow:auto;"><nowiki>
{{BS-map
|title = {{colorbox|orange}} Station layout
|top = {{{!}} align=center
{{!}}
{{bs-infobox
|image = Placeholder.png
|image_size = 150px
|caption = Platform level
|length = 500 meters
|gauge = S
}}
{{!}}}
|legend = track
|map = 
{{BS2|STR|STR}}
{{bs2-sc|STRg|STRf||}}
{{BS2|KRWgl+l|KRWgr+r||[[Scissors crossover]]}}
{{!}}}
{{BS2|STR|STR}}
{{BS2|STR+BSr|STR+BSl||[[Side platform]]s|tw=150px}}
{{BS2|STR+BSr|STR+BSl}}
{{BS2|STRg|STRf||}}
|bottom = † Diagram not to scale
}}
</nowiki></pre>
<includeonly>
<!-- Categories and interwikis go here: -->
[[Categoria:Rail routemap templates]]

[[ar:قالب:BS-map]]
[[ca:Plantilla:BS-capçalera]]
[[en:Template:BS-map]]
[[es:Plantilla:Inicio BS]]
[[ko:틀:노선도]]
[[ru:Шаблон:BS-map]]
[[zh:Template:BS-map]]
</includeonly>