View source for Template:RoutemapRoute/doc

{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{Lua|Module:Routemap}}
{{Shortcut|template:rmr}}

A template created for use within [[WP:Route diagram template|route diagram templates]], in any text cell.

==Fields==
===Parameters===
*'''{{mono|1}}''': first text item
*'''{{mono|2}}''': second text item
**A dash will be shown between the two text items, provided that both are non-blank; if either or both are blank, the dash is omitted
*'''{{mono|enclosed}}''': when {{para|enclosed|no}}, brackets are suppressed, otherwise they are shown
*'''{{mono|size}}''': size of both icons, in {{abbr|px|pixels}} ''(value <code>s</code> = 7)''
*'''{{mono|L}}''': icon shown before the text
**'''{{mono|Llink}}''': page which the icon links to
**'''{{mono|Lsize}}''': size of that icon only
*'''{{mono|R}}''': icon shown after the text
**'''{{mono|Rlink}}''': page which the icon links to
**'''{{mono|Rsize}}''': size of that icon only

Icon parameters are position- and case-insensitive. Valid values, and the icons displayed, are as follows (further information at {{tl|rmri}}):
{| class="wikitable" style="text-align:center;"
|-
|u, up||{{RoutemapRouteIcon|up}}||d, dn, down||{{RoutemapRouteIcon|down}}||l, left||{{RoutemapRouteIcon|left}}||r, right||{{RoutemapRouteIcon|right}}
|-
|ur, ne, c1||{{RoutemapRouteIcon|ur}}||lr, se, c2||{{RoutemapRouteIcon|lr}}||ll, sw, c3||{{RoutemapRouteIcon|ll}}||ul, nw, c4||{{RoutemapRouteIcon|ul}}
|}

===Notes===
*All parameters are optional.
*Parameter values (except text and links) are case-insensitive.
*Parameter order is not important, but where two 'text items' are specified, the first will always be displayed on the left.
*If the brackets are unneeded, consider using {{tl|rmri}} (or a pair of them) instead of this template.

{| class="wikitable" style="text-align:center;"
|+'''RoutemapRoute template – Example usage'''
!WikiSyntax
!Display
|-
|{{mono|&nbsp;&nbsp;<nowiki>{{RoutemapRoute|L=Left|[[Minehead]]|[[Taunton]]|R=Right}}</nowiki>&nbsp;&nbsp;}}||&nbsp;&nbsp;{{RoutemapRoute|L=Left|[[Minehead]]|[[Taunton]]|R=Right}}&nbsp;&nbsp;
|-
|{{mono|<nowiki>{{RoutemapRoute|[[Taunton]]|[[Minehead]]|L=U|R=D}}</nowiki>}}||{{RoutemapRoute|[[Taunton]]|[[Minehead]]|L=U|R=D}}
|-
|{{mono|<nowiki>{{RoutemapRoute|L=L|[[Minehead]]}}</nowiki>}}||{{RoutemapRoute|L=L|[[Minehead]]}}
|-
|{{mono|<nowiki>{{RoutemapRoute|[[Taunton]]|[[Minehead]]}}</nowiki>}}||{{RoutemapRoute|[[Taunton]]|[[Minehead]]}}
|-
|{{mono|<nowiki>{{RoutemapRoute|L=R|R=L}}</nowiki>}}||{{RoutemapRoute|L=R|R=L}}
|-
|colspan=2| Add '''enclosed=no''' to suppress brackets:
|-
|{{mono|<nowiki>{{RoutemapRoute|[[Taunton]]|R=R|enclosed=no}}</nowiki>}}||{{RoutemapRoute|[[Taunton]]|R=R|enclosed=no}}
|-
|{{mono|<nowiki>{{RoutemapRoute|R=L|enclosed=no}}</nowiki>}}||{{RoutemapRoute|R=L|enclosed=no}}
|-
|{{mono|<nowiki>[[Taunton]] {{rmri|R}}</nowiki>}}||[[Taunton]] {{rmri|R}}
|-
|{{mono|<nowiki>{{rmri|L}}</nowiki>}}||{{rmri|L}}
|}

<includeonly>{{Sandbox other||
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Rail routemap templates]]
<!-- ADD INTERWIKIS BELOW THIS LINE -->
}}</includeonly>