# வார்ப்புரு:Adjacent stations/doc



*Adjacent stations* is a specialised template that links adjacent station articles, along with the termini of one or more lines or services. It is a Lua version of (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 , you can also use 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. <code>system2</code>, <code>line2</code>). Parameters without a number suffix are treated as group 1.  

### Parameters
| 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 and 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. |
| <small><var>n</var></small> | The name of the previous station. Renders the formatted station name in the cell as main text. | Renders *Terminus* in the cell as main text. |  |
| <small><var>n</var></small> | The name of the next station. Renders the formatted station name in the cell as main text. | Renders *Terminus* in the cell as main text. |  |
| to-<small><var>n</var></small> | The terminus name or alias. Used to replace terminus where it is non-default. | Uses default terminus. | Uses un-formatted name if terminus is absent in data. |
| to-<small><var>n</var></small> | The terminus name or alias. Used to replace terminus where it is non-default. | Uses default 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-<small><var>n</var></small> | If entered, 'One-way operation' is displayed in the 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-<small><var>n</var></small> | If entered, 'One-way operation' is displayed in the 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-<small><var>n</var></small> | A note, displayed below the (previous) station's name. |  |  |
| note-mid<small><var>n</var></small> | A note, displayed below the line name. |  |  |
| note-<small><var>n</var></small> | A note, displayed below the (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-<small><var>n</var></small> | The through line for the cell only (primarily for compatibility purposes). |  |  |
| through-<small><var>n</var></small> | The through line for the 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-<small><var>n</var></small> | The same for the cell only (primarily for compatibility purposes). |  |  |
| reverse-<small><var>n</var></small> | The same for the cell only (primarily for compatibility purposes). |  |  |
| noclear | Prevents the template from inserting the equivalent of 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 's parameter. | The equivalent of 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 -series templates). This can be semi-automated using regular expressions in AWB and other tools:  

**Replacement for 's and parameters.**

| 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

## Examples