Template:BS-map/doc
This is a documentation subpage for Template:BS-map (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
This template employs intricate features of template syntax.
You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. Remember that you can conduct experiments, and should test all improvements, in your user space before changing anything here. |
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 map template tables. If your map is transcluded in another infobox, you may consider using {{BS-table3}} in the map template rather than this one.
Parameters[edit]
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. |
width | Width of the whole box. Can be overridden by style entry. No default value because it will void the tw parameter of the BS# row template which is applied to override the text column width of BS# row collapsible section. |
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 {{colorbox}} or icon image next to the title text. White by default. |
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 {{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 "expand/collapse" 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. |
legend | Legend page link:
|
map | BS row templates which comprise the diagram. No {{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 map#-title |
# represents 2 to 10. Optional title header for each map. |
map-collapsible map#-collapsible |
# represents 2 to 10. Allow the individual map collapsible or not. no by default, yes will call the "expand/collapse" button. You MUST have something written in the map#-title otherwise the map#-collapsible alone is not enough to turn it on. |
map-collapse 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. |
bottom | Optional note below the map. Also a good place to include the {{Navbar}} if you do not want to display it in the title bar. |
Usage[edit]
{{BS-map |style = |title = |title-bg = |navbar = |collapsible = |collapse = |width = |top = |legend = |bg = |map-title = |map = |map2-title = |map2 = |bottom = }}
Note[edit]
- 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
float:none; margin:auto
orfloat:left
respectively. Alternatively you can include this template in another table which aligns to center or left like so:
{|align=center | {{BS-map}} |}
- Any manually written new row should replace the
|
by{{!}}
.