View source for Template:Adjacent stations/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{High-use}}
{{overcolored|reason=Module appears to be calculating text color incorrectly; see talk page}}
{{Sidebar Adjacent stations}}
{{tsh|adjstn}}
{{Uses TemplateStyles|Template:Adjacent stations/styles.css}}

''Adjacent stations'' is a specialised [[Wikipedia:WikiProject_Succession_Box_Standardization#Overview|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 {{tl|S-line}} (see [[#Differences from S-line|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 {{tl|S-line}}, you can also use {{tlx|Adjacent stations/row|<var>system</var>|<var>line</var>}} inside [[Special:ExpandTemplates]] to simplify subpage creation for lines with two termini<!-- add explanation for lines with multiple termini stating that the table currently has to be inserted manually -->. 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. <code>system2</code>, <code>line2</code>). Parameters without a number suffix are treated as group 1.

=== Parameters ===
{| class="wikitable"
|+
!Parameter
!Description
!Behaviour if absent
!Notes
|-
|system<small><var>n</var></small>
|The system to which line <small><var>n</var></small> belongs. This should correspond to a subpage of [[Module:Adjacent stations]].
|
* System for <small><var>n</var></small> assumed to be same as the previous group.
* Renders empty table if no systems are entered.
|Displays error message if unrecognised. 
|-
|line<small><var>n</var></small>
|The name of line <small><var>n</var></small> (or recognised alias). This should correspond to a key under <code>["lines"]</code> 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.
|
* Line for <small><var>n</var></small> assumed to be same as the previous group.
* Renders only header row if no lines are entered.
|Displays error message if unrecognised.
|-
|left<small><var>n</var></small>
|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.
|
|-
|right<small><var>n</var></small>
|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-left<small><var>n</var></small>
|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-right<small><var>n</var></small>
|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.
|-
|to<small><var>n</var></small>
|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.
|-
|transfer<small><var>n</var></small>
|The name of the transfer station for the line, at stations where an interchange with a line at another nearby station is possible.
|
|
|-
|oneway-left<small><var>n</var></small>
|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-right<small><var>n</var></small>
|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.
|
|
|-
|nonstop<small><var>n</var></small>
|If entered, instead of displaying previous and next stations, displays '<var>line</var> does not stop here'. If the value for this parameter is 'former', then 'did not stop here' will be used instead.
|
|
|-
|header<small><var>n</var></small>
|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-system<small><var>n</var></small>
|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-row<small><var>n</var></small>
|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-left<small><var>n</var></small>
|A note, displayed below the left (previous) station's name.
|
|
|-
|note-mid<small><var>n</var></small>
|A note, displayed below the line name.
|
|
|-
|note-right<small><var>n</var></small>
|A note, displayed below the right (next) station's name.
|
|
|-
|through<small><var>n</var></small>
|The through line – trains on the line run through to this line. If this is entered, 'through to <var>line'</var>, in italics, displays where 'Terminus' would.
|
|
|-
|through-left<small><var>n</var></small>
|The through line for the left cell only (primarily for compatibility purposes).
|
|
|-
|through-right<small><var>n</var></small>
|The through line for the right cell only (primarily for compatibility purposes).
|
|
|-
|reverse<small><var>n</var></small>
|If this is entered, 'reverses direction', in italics, displays where 'Terminus' would.
|
|
|-
|reverse-left<small><var>n</var></small>
|The same for the left cell only (primarily for compatibility purposes).
|
|
|-
|reverse-right<small><var>n</var></small>
|The same for the right cell only (primarily for compatibility purposes).
|
|
|-
|noclear
|Prevents the template from inserting the equivalent of {{tl|clear}} before the template. In the article body, this parameter can be set to <var>y</var> for an inline version of the template. Do not use this parameter inside {{tl|Infobox station}}'s {{para|services}} parameter.
|The equivalent of {{tl|clear}} is inserted before the template. This is the default.
|
|}

== Conversion from S-line ==
After creating the module subpage, you can use the <code>convert</code> function of [[Module:Adjacent stations]] to replace transclusions of the S-line series templates (this currently does ''not'' work with {{tl|Rail line}}-series templates). This can be semi-automated using [[regular expressions]] in [[WP:AWB|AWB]] and other tools:

{| class="wikitable"
! Find !! Replace !! Notes
|-
| {{mono|1=<nowiki>\|\s*system\s*=\s*</nowiki><var>oldSystem</var>}} || {{mono|1=<nowiki>|system=</nowiki><var>newSystem</var>}} || Replacement for system name in {{tl|S-line}}, if the old system is different from the new system. (Not necessary for {{tl|S-rail}}, which is ignored.) Use the ''g'' regular expression flag to replace multiple uses.
|-
| {{mono|1=<nowiki>(\| *(?:services|other_services) *=)((?:\s*\{\{.+\}\})+)</nowiki>}} || {{codett|1=<nowiki>$1 {{subst:#invoke:Adjacent stations|convert|$2}}</nowiki>|2=wikitext}} || Replacement for {{tl|Infobox station}}'s {{para|services}} and {{para|other_services}} parameters.
|-
| {{mono|1=<nowiki>(\{\{[Ss](?:(?:-rail)?-s)?tart\}\}(?:\s*\{\{.+\}\})+\s*\{\{(?:[Ss]-end|[Ee]nd)\}\})</nowiki>}} || {{codett|1=<nowiki>{{subst:#invoke:Adjacent stations|convert|$1}}</nowiki>|2=wikitext}} || 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 ==
{{Adjacent stations/doc/differences from S-line}}

== Examples ==
{{Markup
|<nowiki>{{Adjacent stations
|system=JR East
|line=Tohoku Shinkansen|type=Yamabiko
|left=Fukushima|right=Sendai
}}</nowiki>
|{{center|[[Module:Adjacent stations/JR East]]<br/>('''[[Shiroishi-Zaō Station]]''')}}{{Adjacent stations
|system=JR East
|line=Tohoku Shinkansen|type=Yamabiko|left=Fukushima|right=Sendai
}}

|<nowiki>{{Adjacent stations
|system=New York City Subway
|line=Rockaway
|left=Rockaway Boulevard|right=Aqueduct–North Conduit Avenue
|oneway-right=yes
}}</nowiki>
|{{center|[[Module:Adjacent stations/New York City Subway]]<br/>('''[[Aqueduct Racetrack station]]''')}}{{Adjacent stations
|system=New York City Subway
|line=Rockaway|left=Rockaway Boulevard|right=Aqueduct–North Conduit Avenue
|oneway-right=yes
}}

|<nowiki>{{Adjacent stations
|system=TTC
|line1=1|left1=St. Andrew|right1=King
|line2=509|left2=Queens Quay
|line3=510|left3=Queens Quay
}}</nowiki>
|{{center|[[Module:Adjacent stations/TTC]]<br/>('''[[Union station (TTC)|Union station]]''')}}{{Adjacent stations
|system=TTC
|line1=1|left1=St. Andrew|right1=King
|line2=509|left2=Queens Quay
|line3=510|left3=Queens Quay
}}

|<nowiki>{{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
}}</nowiki>
|{{center|[[Module:Adjacent stations/London Underground]]<br/>('''[[Oxford Circus tube station]]''')}}{{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
}}

|<nowiki>{{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
}}</nowiki>
|{{center|[[Module:Adjacent stations/Walt Disney World Monorail]]<br/>('''[[Transportation and Ticket Center]]''')}}{{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
}}

|<nowiki>{{Adjacent stations
|system1=Taiwan High Speed Rail
|left1=Nangang|right1=Banqiao
|system2=Taiwan Railways
|line2=West Coast|left2=Songshan|right2=Wanhua
}}</nowiki>
|{{center|[[Module:Adjacent stations/Taiwan High Speed Rail]]<br/>[[Module:Adjacent stations/Taiwan Railways]]<br/>('''[[Taipei Main Station]]''')}}{{Adjacent stations
|system1=Taiwan High Speed Rail
|left1=Nangang|right1=Banqiao
|system2=Taiwan Railways
|line2=West Coast|left2=Songshan|right2=Wanhua
}}

|<nowiki>{{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
}}</nowiki>
|{{center|[[Module:Adjacent stations/RTA Rapid Transit]]<br/>('''[[Tower City 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
}}

|<nowiki>{{Adjacent stations
|system=MTR
|line1=Tung Chung|left1=Tsing Yi|right1=Tung Chung
|line2=Disneyland Resort|right2=Disneyland Resort
|line3=Airport Express|nonstop3=yes
}}</nowiki>
|{{center|[[Module:Adjacent stations/MTR]]<br/>('''[[Sunny Bay station]]''')}}{{Adjacent stations
|system=MTR
|line1=Tung Chung|left1=Tsing Yi|right1=Tung Chung
|line2=Disneyland Resort|right2=Disneyland Resort
|line3=Airport Express|nonstop3=yes
}}

|<nowiki>{{Adjacent stations
|system=Edmonton LRT
|line1=Capital|left1=Stadium|right1=Central
|line2=Metro|left2=MacEwan|right2=Central
|line3=Valley|left3=102 Street|right3=Quarters
}}</nowiki>
|{{center|[[Module:Adjacent stations/Edmonton LRT]]<br/>('''[[Churchill station (Edmonton)|Churchill station]]''')}}{{Adjacent stations
|system=Edmonton LRT
|line1=Capital|left1=Stadium|right1=Central
|line2=Metro|left2=MacEwan|right2=Central
|line3=Valley|left3=102 Street|right3=Quarters
}}
}}

== See also ==
* {{t|Sequence}} - a similarly formatted template for providing previous/next navigation to more general subjects
* {{clc|Pages using S-rail/lines that should be converted to Adjacent stations}}

==TemplateData==
{{TemplateData header}}
<templatedata>{
  "params": {
    "system1": {
      "label": "system1",
      "description": "The system to which line 1 belongs. This should correspond to a subpage of Module:Adjacent stations.",
      "type": "string",
      "required": false
    },
    "line1": {
      "label": "line1",
      "description": "The name of line 1. This should correspond to a key under \"lines\" in the data module.",
      "type": "string",
      "required": false
    },
    "left1": {
      "label": "left1",
      "description": "The name of the previous station for line1. Renders the formatted station name in the left cell as main text.",
      "type": "string",
      "required": false
    },
    "right1": {
      "label": "right1",
      "description": "The name of the previous station for line1. Renders the formatted station name in the right cell as main text.",
      "type": "string",
      "required": false
    },
    "to-left1": {
      "label": "to-left1",
      "description": "The left terminus name or alias for line1. Used to replace left terminus where it is non-default.",
      "type": "string",
      "required": false
    },
    "to-right1": {
      "label": "to-right1",
      "description": "The right terminus name or alias for line1. Used to replace right terminus where it is non-default.",
      "type": "string",
      "required": false
    },
    "to1": {
      "label": "to1",
      "description": "Terminus name or alias on either side for line1. Used to replace either terminus where it is non-default.",
      "type": "string",
      "required": false
    },
    "transfer1": {
      "label": "transfer1",
      "description": "The name of the transfer station for line1, at stations where an interchange with line1 at another nearby station is possible.",
      "type": "string",
      "required": false
    },
    "oneway-left1": {
      "label": "oneway-left1",
      "description": "If entered, 'One-way operation' is displayed in the left cell instead of the small text which indicates the line1 terminus.",
      "type": "string",
      "required": false
    },
    "oneway-right1": {
      "label": "oneway-right1",
      "description": "If entered, 'One-way operation' is displayed in the right cell instead of the small text which indicates the line1 terminus.",
      "type": "string",
      "required": false
    },
    "nonstop1": {
      "label": "nonstop1",
      "description": "If entered, instead of displaying previous and next stations, displays 'line does not stop here'.",
      "type": "string",
      "required": false
    },
    "header1": {
      "label": "header1",
      "description": "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.",
      "type": "string",
      "required": false
    },
    "noclear": {
      "label": "noclear",
      "description": "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.",
      "type": "string",
      "required": false
    }
  }
}</templatedata>

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Rail transport succession templates]]

}}</includeonly>