ଛାଞ୍ଚ:BS-map/doc
This is a documentation subpage for ଛାଞ୍ଚ:BS-map. It may contain usage information, categories and other content that is not part of the original ଛାଞ୍ଚ page. |
This ଛାଞ୍ଚ 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. You can conduct experiments, and should test all major changes, in either this template's sandbox, the general template sandbox, or your user space before changing anything here. |
Use the superseding {{Routemap}} for shorter loading time and smaller template size! |
This is a shorthand template which groups the deprecated templates {{Railway line header}}, {{BS-header}} and {{BS-table}} all in one single entity to ease the creation of standalone Wikipedia:Route diagram template tables.
Usage
[ସମ୍ପାଦନା]{{{title}}} | |||
---|---|---|---|
{{{top}}} | |||
| |||
| |||
{{{bottom}}} |
{{BS-map | style = | title = | title-bg = | navbar = | collapsible = | collapse = | width = | top = | legend = | bg = | map-title = | map = | map2-title = | map2 = | bottom = }}
Note
[ସମ୍ପାଦନା]- 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
{{end}}
instead of|}
. Otherwise the box will end immediately after the collapsible section.
Parameters
[ସମ୍ପାଦନା]Parameter names | Function |
---|---|
inline | 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 rail line}}. If the code of the diagram is not transcluded, but is contained within the code of the infobox,   should be added before {{BS-map}} to force proper table layout.
|
float | Which side the template floats to. Default to "right" but can be "left" or "center". |
style | Additional CSS syntax which defines the style of the whole box. |
width | Width of the whole box. Can be overridden by style entry. No default value because it will void the tw parameter in the BSn row template which is applied to override the text column width of BSn 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 {{color box}} or icon image next to the title text. White by default. |
title-color | Font color of title text. 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. |
collapse | Collapse state of the whole box. yes for collapsing, no by default. |
legend | Legend page link:
|
bg | Background color of the whole diagram, 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. |
bottomstyle | Optional CSS style for the note below the map, for example text-align:center;. |
map | BS row templates which comprise the diagram. |
mapn | n represents numbers 2 to 10. Additional map space. By separating maps into different map parameters, the column alignment of the maps will not affect each other. This is useful if you are displaying two maps where one uses the ordinary BSn row templates (single-side text columns) and the other one uses BSn-2 (dual-side text columns), as the different row templates are not compatible with each other. |
map-title mapn-title |
n represents numbers 2 to 10. Optional title header for each map. |
map-centered mapn-centered |
n represents numbers 2 to 10. Allows centering/centring each map; will be toggled on for any value. |
map-collapsible mapn-collapsible |
n represents numbers 2 to 10. Allows changing the collapsibility of each map. no by default; yes will call the "expand/collapse" button. You must have something in the mapn-title; the mapn-collapsible alone cannot turn it on. |
map-collapse mapn-collapse |
n represents numbers 2 to 10. Collapse state of the individual map. yes for collapsing, no by default. |
Example
[ସମ୍ପାଦନା]Station layout | ||||||
---|---|---|---|---|---|---|
Station statistics | ||||||
Tracks | 2 | |||||
Other information | ||||||
Opened | 15 ମଇ 1935 | |||||
|
{{Infobox station | name = {{color box|orange}} Station layout | image = Placeholder.png | image_size = 150px | image_caption = Platform level | opened = {{Start date|1935|05|15|df=y}} | tracks = 2 | route_map =   {{BS-map | inline = 1 | legend = track | map = {{BS2|STR|STR}} {{BS2-startCollapsible|STRg|STRf||}} {{BS2|KRWgl+l|KRWgr+r||[[Scissors crossover]]}} {{end}} {{BS2|STR|STR|tw=200px}} {{BS2|STR+BSr|STR+BSl||[[Side platform]]s}} {{BS2|STR+BSr|STR+BSl}} {{BS2|STRg|STRf||}} | bottom = † Diagram not to scale }} }}
TemplateData
[ସମ୍ପାଦନା]TemplateData for BS-map
An infobox template to contain the diagram created with Route Diagram Template standard.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Floating alignment | float | Change which side of the template floats to. Default set to right. Values 'left' and 'center' are acceptable for their literal meanings. | String | optional |
Additional CSS | 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. | String | optional |
inline switch | inline | 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 rail line}}. If code of the diagram is not transcluded, but is contained within the code of the infobox,   should be added before {{BS-map}} to force proper table layout. | String | optional |
Width of the whole box. | width | Width of the whole box. Can be overridden by style entry. | String | optional |
Background color of the title bar | 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 template color box or icon image next to the title text.
| String | optional |
navbar on box header | navbar | 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. | String | optional |
collapsible or not | collapsible | Allow the box collapsible or not.
| String | optional |
Collapse state | collapse | Collapse state of the whole box. For templates that are collapsed, it is recommended to use the string “|collapse = {{collapse|<includeonly>yes</includeonly>}}” so that the template will display in expanded form when viewing the template's page.
| String | optional |
Legend page link | legend | Legend page link
| String | optional |
1st map space | map | Add BSn row templates in this parameter to construct a diagram. | Content | required |
2nd map space | map2 | Add BSn row templates in this parameter to construct a diagram. | Content | optional |
3rd map space | map3 | Add BSn row templates in this parameter to construct a diagram. | Content | optional |
4th map space | map4 | Add BSn row templates in this parameter to construct a diagram. | Content | optional |
5th map space | map5 | Add BSn row templates in this parameter to construct a diagram. | Content | optional |
map title | map-title | Optional title for map | String | optional |
map2 title | map2-title | Optional title for map2 | String | optional |
map3 title | map3-title | Optional title for map3 | String | optional |
map4 title | map4-title | Optional title for map4 | String | optional |
map5 title | map5-title | Optional title for map5 | String | optional |
map centered? | map-centered | Any value makes this map centered | String | optional |
map2 centered? | map2-centered | Any value makes this map centered | String | optional |
map3 centered? | map3-centered | Any value makes this map centered | String | optional |
map4 centered? | map4-centered | Any value makes this map centered | String | optional |
map5 centered? | map5-centered | Any value makes this map centered | String | optional |
Collapsible or not of map | map-collapsible | 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.
| String | optional |
Collapsible or not of map2 | map2-collapsible | 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.
| String | optional |
Collapsible or not of map3 | map3-collapsible | 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.
| String | optional |
Collapsible or not of map4 | map4-collapsible | 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.
| String | optional |
Collapsible or not of map5 | map5-collapsible | 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.
| String | optional |
Collapse state of map | map-collapse | yes for collapsing, no by default.
| String | optional |
Collapse state of map2 | map2-collapse | yes for collapsing, no by default.
| String | optional |
Collapse state of map3 | map3-collapse | yes for collapsing, no by default.
| String | optional |
Collapse state of map4 | map4-collapse | yes for collapsing, no by default.
| String | optional |
Collapse state of map5 | map5-collapse | yes for collapsing, no by default.
| String | optional |
Note above | top | Optional note above the map, directly below the header row. | String | optional |
Note below | bottom | Optional note below the map. This is also the good place to include the template Navbar if you do not want to display it in the title bar. | String | optional |
Note below style | bottomstyle | Optional CSS style for the note below the map, for example text-align:center;. | String | optional |