View source for Template:BSto/doc

{{Documentation subpage}}
{{High-use| 5,000 }}
{{Lua|Module:Routemap}}

This is a variant of {{tl|BSsplit}} that has the text in two different sizes.

See [[project:ROUTE#Fractional text display template]] for usage instruction.

== Usage ==

This template displays two lines of text in a text field of [[Wikipedia:Route diagram template|route diagram]] created with {{tl|BS-map}}. It is intended for labeling connecting routes or adding other secondary information, as the second line is smaller and ''italicized''.

* The optional third parameter will provide a wikilink for the text.
* The optional <code>align</code> parameter will left- or right-justify text; if omitted it will default to “inherit”.
* The optional <code>it</code> parameter controls italicization:
** <code>it=all</code> displays both lines in italics;
** <code>it=off</code> displays the second line in normal text.
* A separating line can be forced to appear by providing an argument for the parameter "<code>line=</code>''anything''".
* Background colors can be specified by providing a valid [[Web colors#X11 color names|X11 color name]] (e.g. <code style="color:HotPink;">HotPink</code>) or [[Web colors#Hex triplet|RGB hex triplet]] (e.g. <code style="color:#12A3BC;">#12A3BC</code>) for the parameters "<code>bg1=</code>" (top line) and "<code>bg2=</code>" (bottom line).

'''Note:''' This template will disrupt row spacing when used in the first (main) text area.

=== Example ===
{{left|
{{Routemap
|collapsible=0
|legend=0
|map=
'''Input:'''! !STR!~MFADEg~~'''Result:'''
<kbd><nowiki>{{BSto|Line Name|to Destination}}</nowiki></kbd>! !dCONTgq\ABZgr\d~~{{BSto|Line Name|to Destination}}
&nbsp;! !STR
'''Input:'''! !STR~~'''Result:'''
<kbd><nowiki>{{BSto|Other Route|to Somewhere Else|align=right}}</nowiki></kbd>! !d\ABZgl\dCONTfq~~{{BSto|Other Route|to Somewhere Else|align=right}} 
&nbsp;! !STR
'''Input:'''! !STR~~'''Result:'''
<kbd><nowiki>{{BSto|Station|for Nearby Town|Railway station|it=off}}</nowiki></kbd>! !HST~~{{BSto|Station|for Nearby Town|Railway station|it=off}}
&nbsp;! !STR
'''Input:'''! !STR~~'''Result:'''
<kbd><nowiki>{{BSto|Blue Line|to Terminus|it=all|bg1=#90C0FF}}</nowiki></kbd>! !CONTf~~{{BSto|Blue Line|to Terminus|it=all|bg1=#90C0FF}}
}}
}}

{{clear}}

== Incorrect uses ==

If either line of text is empty, the page that the template is used on will be a member of [[:Category:Pages using BSto or BSsrws with missing text values]].

== See also ==
* {{tl|BSsplit}} for two lines of equal-height text
* {{tl|BSsrws}} for a railway station name on two lines
* {{tl|BScvt}} for two distances
* [[Wikipedia:Route diagram template]]
<includeonly>{{Sandbox other||
[[Category:Template documentation pages]]
[[Category:Rail routemap templates|T]]

}}</includeonly>