View source for Wikipedia:Route diagram template/MOS

{{TOC right}}
== General ==
* If a station has a Wikipedia article, link to that rather than the town. 
* Avoid [[WP:overlink|overlinkage]] to a city or railway when its occurrences are adjacent to each other on the route map. When the same feature (river, connecting railway, etc.) appears in multiple places it should be linked in each instance so that it not necessary to search for the wikilink.
* In order to comply with the [[Wikipedia:No original research|no original research]] and [[WP:SPECULATION|Wikipedia is not a crystal ball]] policies, information regarding planned and proposed features need to be [[Wikipedia:Verifiability|verifiable]] with [[Wikipedia:Identifying reliable sources|reliable sources]].
* When a map grows too large (such as [[Template:Shanghai Metro/Line 4|''this'']]), it is recommended to not transclude the map inside an infobox or table which floats or aligns to the left or right, otherwise it would compress the adjacent main text into too narrow a space. This problem is exaggerated for users with low [[screen resolution]]. It is a good idea to center align the standalone table<!--(as explained in [[Template:BS-map#Note|BS-map]])-->. If a left- or right-aligned table is desired, adjust the map width for a minimum of 1024px display width in Monobook or Vector Wiki style. Setting the table to “collapsed” by default (by applying the parameter {{para|collapse|yes}}<!--in BS-map-->) also helps.
* If an unusual situation requires using an icon in a non-standard manner, give an explanation either on the text row with the icon, or by a note at the top or bottom of the map—separated by an empty row or horizontal line—showing the “misused” icon and its meaning.

== Naming ==
If a route template does not have the same title as its parent article ('''Xyz railway''' and '''Template:Xyz railway'''), then the template should use the suffix "RDT" ('''Template:Xyz railway RDT'''). These are [[diagram]]matic representations, ''not'' [[geographic map]]s of routes.

=== Titles ===
Route diagram titles should not be [[Help:Link|wikilinks]]. The diagram should be transcluded into the parent article, and a link to the parent is normally added to the template page by {{tl|Railway-routemap}} or one of its [[Template:RoutemapSeeAlso|related templates]].

If it is necessary to have a link in the title it should be in the {{para|map-title}} subtitle.

== Directionality ==

Route diagrams should be laid out following the standard mapping convention of north at the top. For east-west lines the preference is for west to be at the top, but if there is any north-south aspect to a route that would take precedence. Distances and station numbers can ascend ''or'' descend down the page.

== Colors ==

The standard colors for RDTs are
{| class=wikitable
! In<br/>use !!style="line-height:100%"| Out<br/>of<br/>use !! Line type !! Set
|-
| {{BS-q|STRq|0}} || {{BS-q|exSTRq|0}} || heavy rail || [[C:Category:BSicon/railway|standard]]
|-
| {{BS-q|uSTRq|0}} || {{BS-q|uexSTRq|0}} || light rail/rapid transit<br/>watered canals || [[C:Category:BSicon/railway/set u|set u]]
|-
| {{BS-q|gSTRq|0}} || {{BS-q|gexSTRq|0}} || unwatered canals || [[C:Category:BSicon/railway/set g|set g]]
|-
| {{BS-q|fSTRq|0}} || {{BS-q|fexSTRq|0}} || trails || [[C:Category:BSicon/railway/set f|set f]]
|-
| {{BS-q|uWASSERq|0}} ||rowspan=2| || navigable watercourses || [[C:Category:BSicon/water/navigable|navigable]]
|-
| {{BS-q|WASSERq|0}} || non-navigable watercourses || [[C:Category:BSicon/water|water]]
|}

Although there are over three dozen other colors in the BSicon [[C:Template:BS-color|color palette]], in general they should only be used for [[:Category:System rail transport templates|system diagrams]].

== Symbols ==

=== Lines vs. tracks ===
In general, RDTs should only show physical routes, rather than individual lines and services. Only a single line symbol should be used for the route from one point to the next, regardless of the number of actual tracks. However, for station and junction diagrams each track can be shown. 

=== Stations and stops ===
{{Routemap |collapsible=no |legend=no |title=Adjacent lines |map=
!*{{nay}}\\\!*{{tick}}
A! !HST\STR\d\fHST\fSTR~~A
X! !STR\HST\d\fHST\fSTR~~B
B! !HST\STR\d\fHST\fSTR~~C
Y! !STR\HST\d\fSTR\fHST~~X
C! !HST\STR\d\fSTR\fHST~~Y
Z! !STR\HST\d\fSTR\fHST~~Z
}}

{{bsq|BHF}} indicates a '''major''' stations: a city's central terminal, a multi-platform/multi-track junction, a major division point, a heavily-used (≥ 1,000,000 passengers/year) station, etc. In general, heavy-rail [[rapid transit]] uses this symbol.

A terminal station, especially on a minor branch line, does not automatically warrant the {{BSn|BHF}} symbol.

{{bsq|HST}} indicates a minor/secondary station or stop. In general, [[light rail transit]] uses this symbol.

Similarly,

{{bsq|DST}} indicates a major, non-passenger facility (works, depot, freight station, port, etc.)

{{bsq|BST}} indicates a minor/secondary, non-passenger facility (factory, workshops, etc.). It should '''not''' be used to indicate [[passing track]]s (loops and sidings), [[milestone#Railway mileposts|mileposts]], or [[signalling control]] (signalboxes, switch towers and interlocking); there are specific icons for those: [[c:Category:BSicon/railway/track change|passing]] {{bsq|PSL}}, [[c:Category:BSicon/railway/milepost|mileage]] {{bsq|KMW}}, and [[c:Category:BSicon/railway/legende/feature/signal|signalling]] {{bsq|SIGNALg red|alt=SIGNAL}}.

''Don't'' interleave stations on adjacent lines, as it makes the diagram unnecessarily confusing. (See {{oldid|Template:RTD station map|998221489|this example}} why not to.)

==== Interchanges and junctions ====
{{Routemap |collapsible=no |width=195px |legend=no |title=Options for vee station |map=
STR!~MFADEg\
BHFABZgl+l\CONTfq~~ ~~ ~~{{BSn|BHFABZgl+l}}
STR\
vSTR-STR+l\dCONTfq~~ ~~ ~~{{BSn|vSTR-STR+l}} with
vBHF\d~~ ~~ ~~{{BSn|vBHF}} and
vSHI2g+l-\d~~ ~~ ~~{{BSn|vSHI2g+l-}}
STR\
ABZgl+l!~lBHF\CONTfq~~ ~~ ~~{{BSn|ABZgl+l}} overlaid
STR!~MFADEf\~~ ~~ ~~with {{BSn|lBHF}}
}}
* For [[junction station]]s, show the lines as already joined in the station to indicate the connection or use the [[Commons:BSicon/Catalogue/interchange|interchange set]]. The inclusion of this configuration shows that it has not been overlooked.
* At intermodal interchanges, it is not desirable to list all the routes of the other modes, just the mode(s) themselves. For example, at a central railway station it is enough to show {{rint|subway}}{{rint|bus|1}}, rather than {{rbox|A|3=red}} {{rbox|B||blue}} {{rbox|10}} {{rbox|11}}, etc.

===== INT vs BHF =====
{|class=wikitable
! Icon !! Used !! Example
|-
|rowspan=2| {{bsq|INT}} || between modes || {{Routemap|title-bg=white|collapsible=0|legend=0|tw=110|map=BUS\INT~~[[Airport Station]] {{rint|air}}}}
|-
| between different lines on the same system || {{Routemap|title-bg=white|collapsible=0|legend=0|tw=110|map=leer\STR2+4 red!~fINT3+1~~{{stn|Interchange}}}}
|-
|rowspan=2| {{bsq|BHF}} || between branches of the same line || {{Routemap|title-bg=white|collapsible=0|legend=0|tw=110|map=udSTR!~MFADEg\uSTRc2\ud-STR3+1!~MFADEg!~MFADEfq
udHST-L!~udSTRc2\uSTR3+1!~ulHST-R\udSTRc4~~[[Junction station]]
udABZg+1!~MFADEf\uSTRc4\d}}
|-
| between modes where there is a [[cross-platform interchange]] || {{Routemap|title-bg=white|collapsible=0|legend=0|tw=110|map=v-STR+4!~MFADEg\uvCONTg-
dBHF-L\udBHF-R~~{{stn|Interchange}}
v-STR!~MFADEf\uvSTR2-!~ulCONTf2}}
|}

==== Station codes ====
Station codes should be against the outer edge of the diagram, not between the station symbol and name. Excessive white-space (particularly at junctions) can be confusing when names are separated from their stations.

=== Connecting lines ===
{{Routemap |collapsible=no |width=195px |legend=no |title=Connecting lines |map=
STR!~MFADEg
STR+l\KRZo\CONTfq~~ ~~ ~~{{BSto|Other Railway|to Somewhere|it=all}}{{rmri|R}}{{pad|1em}}
LSTR\BHF\~~Station
KRWl\KRWg+r\~~ ~~ ~~''Other Railway''
STR!~MFADEf
}}
* In general, other lines are shown ''in italics''.
* Connecting lines should be linked to their own articles.
* Connecting lines should be labeled as ''to [place]'' or ''[railway] to [place]''. The consensus is to use "to", ''not'' "towards".
* At the ends of a line, show tracks which go further with a CONTinuation arrow: {{bs-q|CONTgq|0}}{{bs-q|CONT2|0}}{{bs-q|CONTg|0}}{{bs-q|CONT3|0}}{{bs-q|CONTfq|0}}{{bs-q|CONT4|0}}{{bs-q|CONTf|0}}{{bs-q|CONT1|0}}.
* The templates {{tl|RoutemapRouteIcon}}) and {{tl|Arrow2}} are helpful to show route directions in the text column: {{rmri|u}} {{rmri|d}} {{rmri|l}} {{rmri|r}}; {{arrow2|u|12px}} {{arrow2|d|12px}} {{arrow2|l|12px}} {{arrow2|r|12px}}.

=== Interruptions ===
{{Routemap |collapsible=no |width=195px |legend=no |title=Faded<br/>interruption |map=
-STRq\-STRq!~-STR2+r\-KRZvo!~STRc23\-STRq!~-STR3+l\-STRq
uSTRq-!~lKRZo+L-\utSTRq-!~MFADEfq!~STRc1\ABZg+14\utSTRq-!~MFADEgq!~STRc4\uSTRq-!~lKRZo+R-
}}
Crossing and connecting lines which are shown more than once can be connected with interruptions ({{bsq|LSTRq|0}}), but it should not normally be necessary to have more than two interruption icons in a row. Note that [[:WP:WikiProject UK Waterways|WikiProject UK Waterways]] uses dotted lines {{bsq|uLSTR}} to denote routes that are planned or under construction, in which case there is no restriction on the number needed.
* [[:Commons:Template:WP:RDT/BSicon-masks#Fades|Fades]] can also be used for clarity to show interruptions when no features are omitted in the "missing'" section.
{{Clear}}

=== Line ends ===
{{Routemap |collapsible=no |width=195px |legend=no |title=Line ends |map=
ENDEa\POINTERg@gq\~~ ~~ ~~{{BSsplit|Only for a|specific reason}}
BHF\\fKBHFa~~{{BSn|BHF}}│{{BSn|KBHF}}
STR!~MFADEf\\fSTR!~MFADEf
}}
It is sufficient to use a {{BSn|K…}} icon at a terminal, ''unless'' the rails continue for a significant distance beyond (e.g. storage or overrun tracks, provision for a future extension, etc.), or the diagram is detailed enough to show individual tracks.
{{clear}}

=== Waterways ===
* Rivers are only shown continuously when they run adjacent to the railway.
* In rapid transit/light rail diagrams that show both canals and non-navigable waterways, the similarly-coloured [[:Commons:Category:Icons for railway descriptions/set cerulean|cerulean icons]] ({{bsq|STR cerulean|0}}) can be used to distinguish tracks from water ({{bsq|WASSER}}.

=== Non-standard usage ===
{{Routemap |collapsible=no |width=195px |legend=no |title=Custom legend |map=
KBHFa-L\udKBHFa-M\utdKBHFa-R~~Station A
STR\udBHF-L\utdBHF-R~~Station B
STR\udBHF\utdSTR~~Station C
KBHFe-L\udKBHFe-M\utdKBHFe-R~~Station D
|map2-title=Key to services |map2=
STRq~~Express
uSTRq~~Weekday local
utSTRq~~Weekend & holiday local
}}
When icons are used in a different manner than shown in the [[c:BSicon/Catalogue|catalog]], a custom legend should be used.
{{clear}}

== Text ==
{|class=wikitable
|
! Column "0" || Column 1 || Column 2{{efn|{{code|<small></small>}} and {{tlx|small}} should not be used, per [[MOS:SMALLFONT]].}} || Column 3
|-
! <span style="font-weight:normal">plain</span>
| distances<br>mileposts<br>bridge and lock numbers
| {{big|stations and stops<br>major facilities}}
| secondary and minor facilities<br>rivers and roads<br>borders<br>other features
| elevation and length<br>fare zone boundaries<br>station codes<br>interchange icons
|-
! <span style="font-weight:normal">''italic''</span>
| —
| —
| ''connecting lines''
| —
|-
! bold
| —
| —
| '''branch line names'''{{efn|When shown on the diagram, otherwise branches are treated as ''connecting lines''.}}
| —
|}
{{Notelist}}


Standard abbreviations are acceptable to save space:
{|class=wikitable
| and || junction || Railroad || Railway
|-
|align=center| & || Jn {{small|(UK)}}<br>Jct {{small|(US)}} ||align=center| RR || Rwy {{small|(UK)}}<br>Ry {{small|(US)}}
|}

=== Places ===

To avoid clutter and repetition of the word "station" the use of shortcut templates (&thinsp;{{tl|rws}} (railway station), {{tl|stn}} (station) and {{tl|slk}} (station link) – see [[Template:Stnlnk/doc|the documentation]] for a full explanation) is encouraged.

Do not use foreign-language abbreviations in names. (e.g. [[Hauptbahnhof]] rather than Hbf.) The templates {{tl|gare}} and {{tl|hbf}} are used for untranslated French and German station names.

=== Connecting lines ===
{{Routemap |collapsible=no |legend=no |title=Connecting lines |map=
!*{{nay}}\\d\!*{{tick}}
{{rint|njt|mobo}}~~ ~~! !dCONTgq\ABZg+r\d\fABZg+l\fdCONTfq~~ ~~ ~~''[[Montclair-Boonton Line]]''}}
Connecting lines should be labeled as ''to [place]'' or ''[railway] to [place]'' (''not'' "towards"). The names of connecting lines should be spelled out. Icons should not be substituted for text; their use should be restricted to interchange locations.

When a destination is shown for a connecting lines, it is preferred to use the terminus rather than the adjacent station (for consistency with line names).

==== {{tl|Rail-interchange}} icons ====
{{box|{{Rail-interchange/doc/usage}}}}

Icons for connecting services can be either adjacent to names, or in the time/distance column (right/left justified), but not mixed. An exception is the airport icon {{nowrap|({{rint|air}} <code><nowiki>{{Rail-interchange|air}}</nowiki></code>),}} which is often shown on station signage.

Icons should ''not'' be used to indicate connecting lines (i.e. beside {{bsq|CONTgq|alt=CONT}} icons). The route or line name should be spelled out.

=== Station codes ===
When shown on a diagram, station codes should be in a column adjacent to the ''outer'' edge of the diagram. They can take up too much space when placed between the icons and names (particularly at junctions).

=== Dates ===
Dates should be avoided, ''unless'' it is to differentiate between different locations of the same station, or if there is no article for a station; i.e. the information is in no other place.

=== Borders ===
Border information is generally shown in the format <code><nowiki>{{BSsplit|[[political entity above]]|[[political entity below]]|line=-}} border</nowiki></code>, which produces
<div style="display: inline">{{BSsplit|{{fake link|political entity above}}|{{fake link|political entity below}}|line=-}} border</div>
"border" can be linked to the article "Political entity above–Political entity below border" if it exists. (Note that the two divisions will be ordered alphabetically in the article title.)

=== Formatting ===
==== Bold ====
The use of '''bold''', other than for titles, should be avoided as it is automatically applied to names when a diagram is transcluded into that self-same article. Bold is acceptable, as secondary text, for branch names on a diagram.

==== Italics ====
''Italics'', as secondary text, are used for connecting lines. Italics should ''not'' be used for any other features (including closed or future stations).

==== Strike-through ====
<s>Striking out</s> a name should be avoided, as it can obscure the text. An exception is to indicate ''temporary'' closures.

==== Text separation ====
When a visual separator is desired in text fields, the [[Unicode]] [[Box Drawing]] character <code style=color:red>┃</code> should be used. (It is visually identical to the vertical bar, but ignored by [[Wiki markup]] and will not change if italicized.) This character can be coded in [[HTML]] by <code style=color:red>&amp;#2503;</code> or inserted with the {{tl|¡}} template. In Microsoft Windows it can be input directly from the keyboard by holding down {{key press|Alt}}, followed by {{key press|+}}{{key press|2}}{{key press|5}}{{key press|0}}{{key press|3}} on the numeric keypad; or the sequence {{key press|2}}{{key press|5}}{{key press|0}}{{key press|3}} {{key press|Alt|x}}.

== Documentation ==
Route diagram templates do not have [[WP:documentation|documentation]] pages. All necessary information is normally included by transcluding {{tl|Railway-routemap}} or one of the [[Template:RoutemapSeeAlso|similar templates]] into the diagram.

=== Categories ===
{{tl|Railway-routemap}} and its [[Template:RoutemapSeeAlso|related templates]] automatically place RDTs into the appropriate category. However, the default categorization can be overridden if necessary.