Template:BS-map/doc

This is a shorthand template which groups Railway line header, BS-header and BS-table all in one single entity to ease the creation of standalone Route diagram template table. If your map is transcluded in another infobox, you may consider using BS-table3 in the map template rather than this one.

Parameters
{ "description": "An infobox template to contain the diagram created with Route Diagram Template standard.", "params": { "style": { "label": "Additional CSS", "description": "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.", "type": "string", "default": "", "required": false }, "inline": { "label": "inline switch", "description": "Disables title and collapsible function, remove floating, margin and border, widens template width to 100% for transcluding this template into other templates such as infobox. should be contained within the  template when this parameter is used.", "type": "string", "default": "", "required": false }, "width": { "label": "Width of the whole box.", "description": "Width of the whole box. Can be overridden by style entry.", "type": "string", "default": "", "required": false }, "title-bg": { "label": "Background color of the title bar", "description": "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 template colorbox or icon image next to the title text.", "type": "string", "default": "white", "required": false }, "navbar": { "label": "navbar on box header", "description": "Specify the template name if your map is written in a separated template page, it will include a mini bracketed template Navbar in the title bar. Leave this parameter blank if you directly use this template in the article.", "type": "string", "default": "", "required": false }, "collapsible": { "label": "collapsible or not", "description": "Allow the box collapsible or not.", "type": "string", "default": "yes", "required": false }, "collapse": { "label": "Collapse state", "description": "Collapse state of the whole box. For templates that are collapsed, it is recommended to use the string “|collapse = ” so that the template will display in expanded form when viewing the template's page.", "type": "string", "default": "no", "required": false }, "legend": { "label": "Legend page link", "description": "Legend page link", "type": "string", "default": "route", "required": false }, "map": { "label": "1st map space", "description": "Add BSn row templates in this parameter to construct a diagram.", "type": "string", "default": "", "required": false }, "map2": { "label": "2nd map space", "description": "Add BSn row templates in this parameter to construct a diagram.", "type": "string", "default": "", "required": false }, "map3": { "label": "3rd map space", "description": "Add BSn row templates in this parameter to construct a diagram.", "type": "string", "default": "", "required": false }, "map4": { "label": "4th map space", "description": "Add BSn row templates in this parameter to construct a diagram.", "type": "string", "default": "", "required": false }, "map5": { "label": "5th map space", "description": "Add BSn row templates in this parameter to construct a diagram.", "type": "string", "default": "", "required": false }, "map-title": { "label": "map title", "description": "Optional title for map", "type": "string", "default": "", "required": false }, "map2-title": { "label": "map2 title", "description": "Optional title for map2", "type": "string", "default": "", "required": false }, "map3-title": { "label": "map3 title", "description": "Optional title for map3", "type": "string", "default": "", "required": false }, "map4-title": { "label": "map4 title", "description": "Optional title for map4", "type": "string", "default": "", "required": false }, "map5-title": { "label": "map5 title", "description": "Optional title for map5", "type": "string", "default": "", "required": false }, "map-collapsible": { "label": "Collapsible or not of map", "description": "Allow the map collapsible or not. no by default, yes will call the expand collapse button. You MUST have something written in the mapn-title otherwise the mapn-collapsible alone is not enough to turn it on.", "type": "string", "default": "no", "required": false }, "map2-collapsible": { "label": "Collapsible or not of map2", "description": "Allow the map collapsible or not. no by default, yes will call the expand collapse button. You MUST have something written in the mapn-title otherwise the mapn-collapsible alone is not enough to turn it on.", "type": "string", "default": "no", "required": false }, "map3-collapsible": { "label": "Collapsible or not of map3", "description": "Allow the map collapsible or not. no by default, yes will call the expand collapse button. You MUST have something written in the mapn-title otherwise the mapn-collapsible alone is not enough to turn it on.", "type": "string", "default": "no", "required": false }, "map4-collapsible": { "label": "Collapsible or not of map4", "description": "Allow the map collapsible or not. no by default, yes will call the expand collapse button. You MUST have something written in the mapn-title otherwise the mapn-collapsible alone is not enough to turn it on.", "type": "string", "default": "no", "required": false }, "map5-collapsible": { "label": "Collapsible or not of map5", "description": "Allow the map collapsible or not. no by default, yes will call the expand collapse button. You MUST have something written in the mapn-title otherwise the mapn-collapsible alone is not enough to turn it on.", "type": "string", "default": "no", "required": false }, "map-collapse": { "label": "Collapse state of map", "description": "yes for collapsing, no by default.", "type": "string", "default": "no", "required": false }, "map2-collapse": { "label": "Collapse state of map2", "description": "yes for collapsing, no by default.", "type": "string", "default": "no", "required": false }, "map3-collapse": { "label": "Collapse state of map3", "description": "yes for collapsing, no by default.", "type": "string", "default": "no", "required": false }, "map4-collapse": { "label": "Collapse state of map4", "description": "yes for collapsing, no by default.", "type": "string", "default": "no", "required": false }, "map5-collapse": { "label": "Collapse state of map5", "description": "yes for collapsing, no by default.", "type": "string", "default": "no", "required": false }, "top": { "label": "Optional note above the map.", "description": "This is also the good place to include the template BS-Infobox or template Infobox UK railway for lining up image, line length and other information.", "type": "string", "default": "", "required": false }, "bottom": { "label": "Optional note below the map.", "description": "This is also the good place to include the template Navbar if you do not want to display it in the title bar.", "type": "string", "default": "", "required": false } } }

Note

 * Since this template table applies Infobox class it is float to right by default. If you want to align it to center or left, you need to apply the style parameter by adding  or   respectively. Alternatively you can include this template in another table which aligns to center or left like so:
 * Any manually written new row of map should replace the  by.
 * If you are using in-diagram collapsible section which begins with BS-startCollapsible or BS2-startCollapsible, the ending of the collapsible section must be  instead of  . Otherwise the box will end immediately after the collapsible section.

Example
{{BS-map {{BS-Infobox }}
 * title = {{colorbox|orange}} Station layout
 * top =
 * image = Placeholder.png
 * image_size = 150px
 * caption = Platform level
 * length = 500 meters
 * gauge = {{railgauge|standard}}
 * legend = track
 * map =

{{bs2-sc|STRg|STRf||}} {{BS2|KRWgl+l|KRWgr+r||Scissors crossover}} {{!}}}

}}  {{BS-map {{bs-infobox }}
 * bottom = † Diagram not to scale
 * title = {{colorbox|orange}} Station layout
 * top =
 * image = Placeholder.png
 * image_size = 150px
 * caption = Platform level
 * length = 500 meters
 * gauge = {{railgauge|standard}}
 * legend = track
 * map =

{{bs2-sc|STRg|STRf||}} {{BS2|KRWgl+l|KRWgr+r||Scissors crossover}} {{!}}}

}}
 * bottom = † Diagram not to scale