Khon 模板:BS-map/doc ke ngièn-sṳ́-mâ

{{Documentation subpage}}
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{template shortcut|bs-map|bsmap}}

This is a shorthand template which groups the deprecated templates {{tl|Railway line header}}, {{tl|BS-header}} and {{tl|BS-table}} into a single entity to simplify the creation of [[Wikipedia:Route diagram template|Route Diagram Template]]s.

== Usage ==
{{Parameter names example
|title
|top
|map-title
|map
|bottom
}}
{|
|
 <span style="background-color:palegreen">{&#123;BS-map</span>
 <span>|navbar = </span> 
 <span>|title = </span>
 <span style="background-color:silver">|title-bg = </span>
 <span style="background-color:silver">|bg = </span>
 <span style="background-color:silver">|collapsible = </span>
 <span style="background-color:silver">|collapse = </span>
 <span style="background-color:silver">|style = </span>
 <span style="background-color:silver">|width = </span>
 <span style="background-color:silver">|top = </span>
 <span style="background-color:silver">|legend = </span>
 <span style="background-color:silver">|map-title = </span>
 <span style="background-color:palegreen">|map = </span>
 <span style="background-color:silver">|map{{math|{{small|''n''}}}}-title = </span>
 <span style="background-color:silver">|map{{math|{{small|''n''}}}} = </span>
 <span style="background-color:silver">|bottom = </span>
 <span style="background-color:palegreen">}}</span>
|
{{legend|palegreen|required}}
{{legend|transparent|recommended}}
{{legend|silver|optional}}
|}

== Notes ==
* {{math|''n''}} represents a number 2 through 10
* For diagrams with collapsible section(s) embedded in an infobox, the collapsible section must be ended with <code style=color:red><nowiki>{{end}}</nowiki></code> instead of <code style=color:red><nowiki>|}</nowiki></code>. Otherwise the box will end immediately after the collapsible section.

== Parameters ==
{{BS-map/parameters}}

== Example ==
{{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 = &#32;
{{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|PSTR(R)|PSTR(L)||[[Side platform]]s}}
{{BS2|PSTR(R)|PSTR(L)}}
{{BS2|STRg|STRf||}}
|bottom = † Diagram not to scale
}}
}}
<pre style="border:0px;overflow:auto;">
{{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 = &amp;#32;
{{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|PSTR(R)|PSTR(L)||[[Side platform]]s}}
{{BS2|PSTR(R)|PSTR(L)}}
{{BS2|STRg|STRf||}}
|bottom = † Diagram not to scale
}}
}}
</pre>
{{clear}}

== Supporting template ==
* {{tl|Greater color contrast ratio}}

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"description": "An infobox template to contain the diagram created with Route Diagram Template standard.",
	"params": {
		"navbar": {
			"label": "navbar in 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",
			"suggested": true
		},
		"title-bg": {
			"label": "Background color of the title bar",
			"description": "Background color of the title bar to indicate a color appropriate to the subject.",
			"type": "string",
			"default": "#27404E",
			"required": false
		},
		"top": {
			"label": "Note above",
			"description": "Optional note above the map, directly below the header row.",
			"type": "string",
			"required": false
		},
		"float": {
			"label": "Floating alignment",
			"description": "Change which side of the template floats to. Default set to right. Values 'left' and 'center' are acceptable for their literal meanings.",
			"type": "string",
			"required": false
		},
		"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",
			"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 rail line}}. If code of the diagram is not transcluded, but is contained within the code of the infobox, &#32; should be added before {{BS-map}} to force proper table layout.",
			"type": "string",
			"required": false
		},
		"width": {
			"label": "Width of the whole box.",
			"description": "Width of the whole box. Can be overridden by style entry.",
			"type": "string",
			"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 = {{collapse|<includeonly>yes</includeonly>}}” 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-title": {
			"label": "map title",
			"description": "Optional title for map",
			"type": "string",
			"required": false
		},
		"map": {
			"label": "1st map space",
			"description": "Add BSn row templates in this parameter to construct a diagram.",
			"type": "content",
			"required": true
		},
		"map2-title": {
			"label": "map2 title",
			"description": "Optional title for map2",
			"type": "string",
			"required": false
		},
		"map2": {
			"label": "2nd map space",
			"description": "Add BSn row templates in this parameter to construct a diagram.",
			"type": "content",
			"required": false
		},
		"map3-title": {
			"label": "map3 title",
			"description": "Optional title for map3",
			"type": "string",
			"required": false
		},
		"map3": {
			"label": "3rd map space",
			"description": "Add BSn row templates in this parameter to construct a diagram.",
			"type": "content",
			"required": false
		},
		"map4-title": {
			"label": "map4 title",
			"description": "Optional title for map4",
			"type": "string",
			"required": false
		},
		"map4": {
			"label": "4th map space",
			"description": "Add BSn row templates in this parameter to construct a diagram.",
			"type": "content",
			"required": false
		},
		"map5-title": {
			"label": "map5 title",
			"description": "Optional title for map5",
			"type": "string",
			"required": false
		},
		"map5": {
			"label": "5th map space",
			"description": "Add BSn row templates in this parameter to construct a diagram.",
			"type": "content",
			"required": false
		},
		"map-centered": {
			"label": "map centered?",
			"description": "Any value makes this map centered",
			"type": "string",
			"deprecated": true
		},
		"map2-centered": {
			"label": "map2 centered?",
			"description": "Any value makes this map centered",
			"type": "string",
			"deprecated": true
		},
		"map3-centered": {
			"label": "map3 centered?",
			"description": "Any value makes this map centered",
			"type": "string",
			"deprecated": true
		},
		"map4-centered": {
			"label": "map4 centered?",
			"description": "Any value makes this map centered",
			"type": "string",
			"deprecated": true
		},
		"map5-centered": {
			"label": "map5 centered?",
			"description": "Any value makes this map centered",
			"type": "string",
			"deprecated": true
		},
		"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
		},
		"bottom": {
			"label": "Note below",
			"description": "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.",
			"type": "string",
			"required": false
		},
		"bottomstyle": {
			"label": "Note below style",
			"description": "Optional CSS style for the note below the map, for example text-align:center;.",
			"type": "string",
			"required": false
		}
	}
}
</templatedata>

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Rail routemap templates]]
}}</includeonly>