Template:Rail-interchange/doc

This is a documentation subpage for Template:Rail-interchange.
It contains usage information, categories and other content that is not part of the original template page.

Rail-interchange documentation sub-pages

Americas
Asia
Europe
- Central
- East
- South
- North & West
Oceania

Talk pages:

General
- Americas
- Asia
- Europe
- Oceania
Documentation
Edit requests

About

This article and its sub-pages document all possible combinations for Rail-interchange, also known as RINT. This overview has been ordered and displayed with the following rules in mind:

RINT exists to document public transport networks, specifically urban rail networks, but can also be used to list rail network operators, tram networks, bus rapid transit networks, trolleybus networks, ferry services et cetera. Please refrain from adding entire networks as this will make the template unnecessarily long, and add only the most essential networks in a city or region. If you are doubtful about which lines should be added, then ask other contributors on city or region's talk page.
Entries are sorted by city, cities are sorted per country, and countries are distributed across regions (often continents), which can be found in the navigation box above. If the entry you are looking for isn't listed where it should, it most likely hasn't been added to RINT (yet). In this case, you are welcome to submit a request to have the network or entry added.
Multiple listings which are part of the same network are sorted by the system they are a part of, meaning that metro systems are separated from tram networks, bus networks, ferry networks, et cetera.
Copy-paste-able entry codes for lines, such as B {{rint|rotterdam|B}} are listed with at most one code per group unless the line names in RINT differ from the line name displayed in the output.
Rotterdam has its lines grouped as A , B , C , D and E , meaning that, since the lines have names that follow a logical order, only one copy-paste-code is given.
Unless stated otherwise, the templates displayed on the documentation pages are what is available. If you're missing a line or service, then request an edit or plunge forward yourself if you have the right permissions.

Editing the template

This template, because of its size and usage across Wikivoyage, has been limited to only be edited by users with template editor status or above. Documented below is the structure of the template for eligible editors. The example below is based on the lay-out of Copenhagen's listing.

| copenhagen={{#switch: {{lc: {{{2}}} }}
  |1|m1   = {{RbE|M1|#397C5D|r=c|mo=Copenhagen Metro M1 (Vanløse - Vestamager)}}
  |2|m2   = {{RbE|M2|#EBD043|black|r=c|mo=Copenhagen Metro M2 (Vanløse - Lufthavn)}}
  |3|m3   = {{RbE|M3|#007DC4|r=c|mo=Copenhagen Metro M3 (Circular)}}
  |4|m4   = {{RbE|M4|#F8901E|black|r=c|mo=Copenhagen Metro M4 (Ny Ellebjerg - Orientkaj)}}
  |a|sa   = {{RbE|A|#15A4DD|r=e|mo=Copenhagen S-tog A (Køgebugtbanen - Nordbanen)}}
  |b|sb   = {{RbE|B|#4BAA47|r=e|mo=Copenhagen S-tog B (Hareskovbanen - Farum)}}
  |bx|sbx = {{RbE|Bx|#77C044|r=e|mo=Copenhagen S-tog Bx (Hareskovbanen - Farum)}}
  |c|sc   = {{RbE|C|#F68620|r=e|mo=Copenhagen S-tog C (Klampenborg - Frederikssund)}}
  |e|se   = {{RbE|E|#6B67AF|r=e|mo=Copenhagen S-tog E (Køge - Hillerød)}}
  |f|sf   = {{RbE|F|#FFC225|r=e|mo=Copenhagen S-tog F (Hellerup - Ny Ellebjerg)}}
  |h|sh   = {{RbE|H|#EF4236|r=e|mo=Copenhagen S-tog H (Østerport - Frederikssund)}}
  |letbane= {{RbE|Letbane|#6ec382|mo=Hovstadens Letbane (Ishøj - Lundtofte)}}
  }}

Breaking down the source wikitext above, it lists:

The defining of the second parameter (city/region), of which the only variable between different cities is copenhagen. The | and ={{#switch: {{lc: {{{2}}} }} parts are universal across entries, enabling the selection of lines, and converting the input to be entirely lower case symbols. This enables {{RINT|Copenhagen|M1}} and {{rint|copenhagen|m1}} to give the exact same output, that being M1 .
Entries within a city are listed by network system. In Copenhagen's case, these are the Metro (1|m1 to 4|m4), S-Tog/S-Train (a|sa to h|sh) and lastly the Letbane/Tram (letbane).
Note that both the Metro and S-Tog use aliases. These aliases are separated from each other with a pipe (|).
For each line, two spaces are entered to make the structure of the template more distinguishable to editors. After that follows a pipe symbol (|), followed by all acceptable labels for this line, often summarised to a few symbols (m1 rather than metroline1). All of these are to be listed completely in lower case. Following the labels is an equals-sign (=).
Each label uses {{RbE}} (Routebox Entry). This is done as to not make the template dependable on Wikimedia Commons, and having possible edits and deletions there alter the way the template works here. Using Routebox Entry makes these labels only editable within RINT.
Full documentation of Routebox Entry can be found here.
In short, each label contains some basic information which, then separated with pipe symbols, defines how Routebox Entry should display the label for this entry. For Copenhagen's M2 ( M2 {{rint|copenhagen|m2}} ), these are:
- M1: The label, which is the text that is displayed in the label.
- #397C5D: The background colour for the label.
- black: The text colour of the label. Both this parameter and the background colour parameter accept both RGB codes when defined with a #, or HTML-defined colour codes (black, white, magenta, lime, et cetera).
- r=c: Summarised form of "Rounding = Circle", meaning that the label's corners get grounded to roughly make a circle.
- mo=…: Summarised form of "Mouse-over", meaning that what follows is the text displayed in the tooltip shown when hovering over a label with the mouse.
Routebox Entry allows some more customisation than the above, such as border definitions and colouring. For this, refer to that template's documentation page.
Having reached the end of a city's coverage, a single line containing only }} is entered, as to close the Switch-parameter at the beginning of the city's entry.

Key maintenance rules

When editing, do not work destructively, unless you have verified that your edit doesn't break existing instances of RINT on articles. For this, check the existing articles and pages that might use the template's labels for the city you're editing. If there are articles that use these labels, leave behind an alias for these articles to use. If this isn't possible, which might be the case with complete overhauls of the physical networks, make the necessary edits in the articles as soon as possible.
RINT is vast. Do not feel as if you have to edit all of the template. Know when to take a break from the template, as maintenance can suck you in.
On the same line, know what to add and what not to add. In the end, the added labels in the template should reflect whatever is most relevant to the traveller/reader. This typically makes it to where specific networks are omitted. As a general rule of thumb:
- Definitely useful: Metro networks, tram networks (or premetro networks), light railway networks.
- Often useful: Bus rapid transit networks (BRT), commuter railway networks, heritage rail- or tramways, large ferryboat networks.
- Occasionally useful: Heavy rail networks, narrow-gauge rail networks, (trolley)bus networks, rural networks.
- Not useful: Funicular railways, cable car systems, bike rental systems, individual ferries, air links (plane, helicopter, et cetera), long-distance networks (unless part of any of the useful systems listed above).
Find fitting solutions. Real-life networks aren't always simply converted into a RINT-compatible list. For example, the Helsinki and Tampere networks overlap. The only line that is exclusive to Tampere is R . The solution to this was to make tampere a fitting alternative to the city-parameter of helsinki, which makes every Helsinki line also display when instead of {{rint|Helsinki|…}}, {{rint|Tampere|…}} is entered. Note of this has been made below the listed network. When such anomalies and irregularities happen, find a fitting solution to the issue at hand. If you cannot do so alone, call in second opinions on the related RINT/doc talk page.