வார்ப்புரு:Adjacent stations/doc
This is a documentation subpage for வார்ப்புரு:Adjacent stations. It may contain usage information, பகுப்புகள் and other content that is not part of the original வார்ப்புரு page. |
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Pages related to |
Module:Adjacent stations |
---|
(talk | sandbox | sub-pages) |
{{Infobox station}} |
(talk | sandbox | testcases) |
{{Station link}} |
(talk | sandbox | testcases) |
{{Station icon link}} |
(talk | sandbox | testcases) |
{{Rail color}} |
(talk | sandbox | testcases) |
{{Line link}} |
(talk | sandbox | testcases) |
{{Short line link}} |
(talk | sandbox | testcases) |
{{Rail icon}} |
(talk | sandbox | testcases) |
{{Rail color box}} |
(talk | sandbox | testcases) |
{{Adjacent stations}} |
(talk | sandbox | testcases) |
{{Line terminus link}} |
(talk | sandbox | testcases) |
This template uses TemplateStyles: |
Adjacent stations is a specialised succession box template that links adjacent station articles, along with the termini of one or more lines or services. It is a Lua version of {{S-line}} (see differences).
Usage
தொகுData module
தொகுBefore the template can be used, a module needs to be created that includes information about the transport system such as the title, lines and the termini of those lines. The data module needs to be a sub-page of Module:Adjacent stations (Module:Adjacent stations/system), and needs to be of a specific structure.
See Module:Adjacent stations for a guide on creating and editing data modules. Note that not all variables are used by this template.
If a system exists in {{S-line}}, you can also use {{Adjacent stations/row|system|line}}
inside Special:ExpandTemplates to simplify subpage creation for lines with two termini. You will need to replace every two spaces with a tab space afterwards.
Transclusion
தொகுFor multiple lines or systems, this template only needs to be transcluded once. Each line is assigned a number. The parameters for the corresponding line are suffixed by the number (e.g. system2
, line2
). Parameters without a number suffix are treated as group 1.
Parameters
தொகுParameter | Description | Behaviour if absent | Notes |
---|---|---|---|
systemn | The system to which line n belongs. This should correspond to a subpage of Module:Adjacent stations. |
|
Displays error message if unrecognised. |
linen | The name of line n (or recognised alias). This should correspond to a key under ["lines"] in data. Displays the termini of the line as subtext in left and right cells by default. Renders Terminus as subtext if adjacent station is terminus.
|
|
Displays error message if unrecognised. |
leftn | The name of the previous station. Renders the formatted station name in the left cell as main text. | Renders Terminus in the left cell as main text. | |
rightn | The name of the next station. Renders the formatted station name in the right cell as main text. | Renders Terminus in the right cell as main text. | |
to-leftn | The left terminus name or alias. Used to replace left terminus where it is non-default. | Uses default left terminus. | Uses un-formatted name if terminus is absent in data. |
to-rightn | The right terminus name or alias. Used to replace right terminus where it is non-default. | Uses default right terminus. | Uses un-formatted name if terminus is absent in data. |
ton | Terminus name or alias on either side. Used to replace either terminus where it is non-default. | Uses default termini. | Only replaces side with defined terminus in data. |
transfern | The name of the transfer station for the line, at stations where an interchange with a line at another nearby station is possible. | ||
oneway-leftn | If entered, 'One-way operation' is displayed in the left cell instead of the small text which indicates the line terminus. This can also be entered for the whole line in the system subpage. | ||
oneway-rightn | If entered, 'One-way operation' is displayed in the right cell instead of the small text which indicates the line terminus. This can also be entered for the whole line in the system subpage. | ||
nonstopn | If entered, instead of displaying previous and next stations, displays 'line does not stop here'. If the value for this parameter is 'former', then 'did not stop here' will be used instead. | ||
headern | A table header across the width of the table, displayed above the succession for the line. This will display with or without other parameters with the same number. | ||
hide-systemn | When set to any value, the system row is not displayed. This is useful in the middle of a table when a different module is used but the displayed system name would be the same. | System name is displayed. | See Coevorden railway station for an example. |
note-rown | A note across the width of the table, displayed below the succession for the line. This will display with or without other parameters with the same number. | ||
note-leftn | A note, displayed below the left (previous) station's name. | ||
note-midn | A note, displayed below the line name. | ||
note-rightn | A note, displayed below the right (next) station's name. | ||
throughn | The through line – trains on the line run through to this line. If this is entered, 'through to line', in italics, displays where 'Terminus' would. | ||
through-leftn | The through line for the left cell only (primarily for compatibility purposes). | ||
through-rightn | The through line for the right cell only (primarily for compatibility purposes). | ||
reversen | If this is entered, 'reverses direction', in italics, displays where 'Terminus' would. | ||
reverse-leftn | The same for the left cell only (primarily for compatibility purposes). | ||
reverse-rightn | The same for the right cell only (primarily for compatibility purposes). | ||
noclear | Prevents the template from inserting the equivalent of {{clear}} before the template. In the article body, this parameter can be set to y for an inline version of the template. Do not use this parameter inside {{Infobox station}}'s |services= parameter.
|
The equivalent of {{clear}} is inserted before the template. This is the default. |
Conversion from S-line
தொகுAfter creating the module subpage, you can use the convert
function of Module:Adjacent stations to replace transclusions of the S-line series templates (this currently does not work with {{Rail line}}-series templates). This can be semi-automated using regular expressions in AWB and other tools:
Find | Replace | Notes |
---|---|---|
\|\s*system\s*=\s*oldSystem | |system=newSystem | Replacement for system name in {{S-line}}, if the old system is different from the new system. (Not necessary for {{S-rail}}, which is ignored.) Use the g regular expression flag to replace multiple uses. |
(\| *(?:services|other_services) *=)((?:\s*\{\{.+\}\})+) | $1 {{subst:#invoke:Adjacent stations|convert|$2}} |
Replacement for {{Infobox station}}'s |services= and |other_services= parameters.
|
(\{\{[Ss](?:(?:-rail)?-s)?tart\}\}(?:\s*\{\{.+\}\})+\s*\{\{(?:[Ss]-end|[Ee]nd)\}\}) | {{subst:#invoke:Adjacent stations|convert|$1}} | Replacement for standalone succession boxes. Use the g regular expression flag to replace multiple boxes on the page. |
The conversion will not work if
- the input includes templates other than those in the S-line series;
- a system or line in the input is unrecognized or otherwise invalid;
- there are unmatched square or curly brackets in the input.
Differences from S-line
தொகுPages related to |
Module:Adjacent stations |
---|
(talk | sandbox | sub-pages) |
{{Infobox station}} |
(talk | sandbox | testcases) |
{{Station link}} |
(talk | sandbox | testcases) |
{{Station icon link}} |
(talk | sandbox | testcases) |
{{Rail color}} |
(talk | sandbox | testcases) |
{{Line link}} |
(talk | sandbox | testcases) |
{{Short line link}} |
(talk | sandbox | testcases) |
{{Rail icon}} |
(talk | sandbox | testcases) |
{{Rail color box}} |
(talk | sandbox | testcases) |
{{Adjacent stations}} |
(talk | sandbox | testcases) |
{{Line terminus link}} |
(talk | sandbox | testcases) |
The output of {{Adjacent stations}} is nearly identical to that of {{S-line}}, but is used differently. Here are lists of comparable elements in the two templates.
Data
தொகுItem | {{S-line}} | {{Adjacent stations}} |
---|---|---|
System name, title and icon | In {{S-rail/lines}} | Subpage name, values of ["system title"] and ["system icon"]
|
Line name and title | In Template:system lines | Key beneath ["lines"] and value of ["title"] beneath the corresponding line
|
Branch/type name and title | In Template:system branches | Key beneath ["types"] and value of ["title"] beneath the corresponding type
|
Station format | In Template:system stations | Key–value pairs beneath ["station format"]
|
Colour | In Template:system color | Value of ["color"] beneath the corresponding line or type
|
Left terminus name | In Template:S-line/system left/line | Value of ["left terminus"] beneath the corresponding line
|
Right terminus name | In Template:S-line/system right/line | Value of ["right terminus"] beneath the corresponding line
|
Transclusion parameters
தொகு{{S-line}} | {{Adjacent stations}} |
---|---|
system |
system
|
line |
line
|
previous , next |
left , right
|
type , type2 |
to-left , to-right
|
New feature | to (for both sides)
|
{{S-text}} | note-row
|
note , notemid , note2 |
note-left , note-mid , note-right
|
{{S-note}} | header
|
oneway1 , oneway2 |
oneway-left , oneway-right
|
rows1 , hide1 |
Not needed |
rows2 , hide2 |
Not needed |
rowsmid , hidemid |
Not needed |
transfer |
transfer
|
circular , circular1 , circular2 |
Must be set for whole line in data |
round1 , round2 |
reverse (for both sides), reverse-left , reverse-right
|
branch |
type
|
state1 , state2 |
Not implemented |
through1 , through2 |
through-left , through-right
|
Examples
தொகுகுறியீடு | காட்டப்படுவது | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{Adjacent stations |system=JR East |line=Tohoku Shinkansen|type=Yamabiko |left=Fukushima|right=Sendai }} |
Lua error in package.lua at line 80: module 'Module:Adjacent stations/JR East' not found. | ||||||||||||||||||||
{{Adjacent stations |system=New York City Subway |line=Rockaway |left=Rockaway Boulevard|right=Aqueduct–North Conduit Avenue |oneway-right=yes }} |
Lua error in package.lua at line 80: module 'Module:Adjacent stations/New York City Subway' not found. | ||||||||||||||||||||
{{Adjacent stations |system=London Underground |line1=Bakerloo|left1=Regent's Park|right1=Piccadilly Circus |line2=Central|left2=Bond Street|right2=Tottenham Court Road |line3=Victoria|left3=Green Park|right3=Warren Street }} |
Lua error in package.lua at line 80: module 'Module:Adjacent stations/London Underground' not found. | ||||||||||||||||||||
{{Adjacent stations |system=Walt Disney World Monorail |line1=Resort|left1=Contemporary|right1=Polynesian Village |oneway-left1=yes |line2=Express|left2=Magic Kingdom|right2=Magic Kingdom |oneway-right2=yes |line3=Epcot|right3=Epcot }} |
Lua error in package.lua at line 80: module 'Module:Adjacent stations/Walt Disney World Monorail' not found. | ||||||||||||||||||||
{{Adjacent stations |system1=Taiwan High Speed Rail |left1=Nangang|right1=Banqiao |system2=Taiwan Railways |line2=West Coast|left2=Songshan|right2=Wanhua }} |
Module:Adjacent stations/Taiwan High Speed Rail Lua error in package.lua at line 80: module 'Module:Adjacent stations/Taiwan High Speed Rail' not found.Module:Adjacent stations/Taiwan Railways (Taipei Main Station) | ||||||||||||||||||||
{{Adjacent stations |system=RTA Rapid Transit |line1=Red |left1=West 25th–Ohio City|right1=Tri-C–Campus District |line2=Blue |through-left2=Waterfront Line|right2=Tri-C–Campus District |line3=Green |through-left3=Waterfront Line|right3=Tri-C–Campus District |line4=Waterfront |left4=Settlers Landing|through-right4=Blue and Green Lines }} |
Lua error in package.lua at line 80: module 'Module:Adjacent stations/RTA Rapid Transit' not found. | ||||||||||||||||||||
{{Adjacent stations |system=MTR |line1=Tung Chung|left1=Tsing Yi|right1=Tung Chung |line2=Disneyland Resort|right2=Disneyland Resort |line3=Airport Express|nonstop3=yes }} |
| ||||||||||||||||||||
See also
தொகு- {{Sequence}} - a similarly formatted template for providing previous/next navigation to more general subjects