Template:S-rail-national/doc
This is a documentation subpage for Template:S-rail-national. It may contain usage information, categories and other content that is not part of the original template page. |
This template is an alias of {{s-line}}, with several parameters renamed to conform with usage on the British National Rail system. Changes to the underlying functionality of {{s-line}} should be made to that template and not this one.
Usage
[edit]The renamed parameters are as follows:
|county1=
instead of|state1=
|county2=
instead of|state2=
|route=
instead of|branch=
|toc=
instead of|line=
In addition, the parameter |system=
is optional, and if omitted, defaults to |system=National Rail
This template takes one special parameter that {{s-line}} does not: |status=
. By specifying either |status=Disused
or |status=Historical
, you make invoke those sets of templates instead of the templates for active lines.
TemplateData
[edit]TemplateData for S-rail-national
A specialised succession box for rail lines on the British National Rail system.
Parameter | Description | Type | Status | |
---|---|---|---|---|
previous | previous | The name of the previous station, should correspond to a specific template name | String | optional |
next | next | The name of the next station, should correspond to a specific template name | String | optional |
system | system | The system to which the line belongs, Defaults to 'National Rail'. | String | optional |
Train operating company | toc | Train operating company | String | required |
status | status | Can be either 'Disused' or 'Historical'. system should also be set in this case. | String | optional |
route | route | The route of a line e.g. 'Thameslink'. | String | optional |
type | type | The left-hand line branch | String | optional |
type2 | type2 | The right-hand line branch | String | optional |
note | note | Information about the left-hand line branch | String | optional |
notemid | notemid | Information about the station itself | String | optional |
note2 | note2 | Information about the right-hand line branch | String | optional |
oneway1 | oneway1 | Indicates that trains do not operate towards the Previous station | String | optional |
oneway2 | oneway2 | Indicates that trains do not operate towards the Next station | String | optional |
through1 | through1 | Allows, instead of a previous station, service passing to another line on the system. | String | optional |
through2 | through2 | Allows, instead of a next station, service passing to another line on the system. | String | optional |
county1 | county1 | The county of a station. Useful for disambiguation. | String | optional |
county2 | county2 | The county of a station. Useful for disambiguation. | String | optional |
transfer | transfer | Used to show lines available by direct transfer at an adjoining station. | String | optional |
round1 | round1 | If set displays 'Reverses direction' in left cell | String | optional |
round2 | round2 | If set displays 'Reverses direction' in right cell | String | optional |
circular | circular | String | optional | |
circular1 | circular1 | String | optional | |
circular2 | circular2 | String | optional | |
rows1 | rows1 | Number of rows for left hand column | String | optional |
rowsmid | rowsmid | Number of rows for center hand column | String | optional |
rows2 | rows2 | Number of rows for right hand column | String | optional |
hide1 | hide1 | Hides the previous station, used when a previous row has 'rows1' set | String | optional |
hidemid | hidemid | Hides this station, used when a previous row has 'rowsmid' set | String | optional |
hide2 | hide2 | Hides the next station, used when a previous row has 'rows2' set | String | optional |