Template:S-line/doc
{{Documentation subpage}}
{{High-use}}
{{notice|For new systems and systems in need of maintenance, consider using the newer {{tl|Adjacent stations}} instead.}}
{{notice|This template is called by {{tl|s-rail-national}}; an alias. If a change is made which alters/adds parameters names that template must be updated to reflect the new situation.}}
{{notice|If you want to disambiguate a station link but don't want to edit the sub-templates, use the parameters {{para|link1|page name}} (left side) and {{para|link2|page name}} (right side) to temporarily add the correct link. Another editor should correct the relevant succession templates afterwards, and remove the temporary links.}}
S-line is a specialised succession box template that links railway station articles.
Note: this template is called by {{tl|s-rail-national}}; an alias. If a change is made which alters/adds parameters names that template must be updated to reflect the new situation.
Usage
S-line must be encased within {{tl|s-rail-start}} and {{tl|s-end}}. The use of {{tl|s-rail}} is highly recommended but not required.
S-line has the following parameters:
| class="wikitable"
!Parameter!!Description!!Notes | ||
| system | The system to which the line belongs | This should correspond to an entry in :Template:S-rail/lines |
| line | The name of the line | This should be obvious shorthand (e.g. Orange for Orange Line) |
| previous | The name of the previous station | |
| next | The name of the next station | |
| type | The left-hand line branch | Optional |
| type2 | The right-hand line branch | Optional |
| note | Information about the left-hand line branch | Optional |
| note2 | Information about the right-hand line branch | Optional |
| notemid | Information about the station itself | Optional |
| oneway1 | Indicates that trains do not operate towards the Previous station | Optional |
| oneway2 | Indicates that trains do not operate towards the Next station | Optional |
| rows1, hide1 | Used to have the Previous Station box cover multiple lines. See below for details. | Optional |
| rows2, hide2 | Used to have the Next Station box cover multiple lines. See below for details. | Optional |
| rowsmid, hidemid | Used to have the middle (Line) box cover multiple lines. See below for details. | Optional |
| transfer | Used to show lines available by direct transfer at an adjoining station. See below for details. | Optional |
| branch | Used to denote specific line branch information, in lieu of or in addition to the type parameters. | Optional |
| state1, state2 | Allows the passing of an additional station parameter. Useful for disambiguation. | Optional |
| through1, through2 | Allows, instead of a next station, service passing to another line on the system. | Optional |
=Styles=
The style template allows the modification, at a system level, of display parameters for inter-related templates, including :Template:Infobox Station.
| class="wikitable"
!Parameter!!Description!!Notes | ||
| lang | Which version of English to output display in. Specify GB for British; the default is US. If GB is specified, the boxes will say "towards" (station). If US is specified, the boxes will say "toward" (station). | Optional; S-line only |
| name_format | Formatting for the {{{name}}} parameter itself | Optional; Infobox Station only |
| showterm | A "No" value suppresses the display of termini information | Optional; S-line only |
| stop_noun | Type of stop (e.g. station, tram stop); default is "station" | Optional; S-rail only |
| thcolor | Font color for table headings | Optional; Infobox Station only |
| thbgcolor | Background color for table headings | Optional; Infobox Station only |
| title_nowrap | If "yes", will apply the nowrap style to s-rail headings. Not recommended for use within Infobox Station | Optional; S-rail only |
TemplateData
{{TemplateData header}}
{
"description": "S-line is a specialised succession box template that links railway station articles",
"params": {
"system": {
"label": "system",
"description": "The system to which the line belongs",
"type": "string",
"required": true
},
"line": {
"label": "line",
"description": "The name of the line",
"type": "string",
"required": true
},
"previous": {
"label": "previous",
"description": "The name of the previous station, should correspond to a specific template name",
"type": "string",
"required": false
},
"next": {
"label": "next",
"description": "The name of the next station, should correspond to a specific template name",
"type": "string",
"required": false
},
"type": {
"label": "type",
"description": "The left-hand line branch",
"type": "string",
"required": false
},
"type2": {
"label": "type2",
"description": "The right-hand line branch",
"type": "string",
"required": false
},
"note": {
"label": "note",
"description": "Information about the left-hand line branch",
"type": "string",
"required": false
},
"notemid": {
"label": "notemid",
"description": "Information about the station itself",
"type": "string",
"required": false
},
"note2": {
"label": "note2",
"description": "Information about the right-hand line branch",
"type": "string",
"required": false
},
"oneway1": {
"label": "oneway1",
"description": "Indicates that trains do not operate towards the Previous station",
"type": "string",
"required": false
},
"oneway2": {
"label": "oneway2",
"description": "Indicates that trains do not operate towards the Next station",
"type": "string",
"required": false
},
"through1": {
"label": "through1",
"description": "Allows, instead of a previous station, service passing to another line on the system.",
"type": "string",
"required": false
},
"through2": {
"label": "through2",
"description": "Allows, instead of a next station, service passing to another line on the system.",
"type": "string",
"required": false
},
"state1": {
"label": "state1",
"description": "Allows the passing of an additional station parameter. Useful for disambiguation.",
"type": "string",
"required": false
},
"state2": {
"label": "state2",
"description": "Allows the passing of an additional station parameter. Useful for disambiguation.",
"type": "string",
"required": false
},
"branch": {
"label": "branch",
"description": "Can be used to describe a subset of a line.",
"type": "string",
"required": false
},
"transfer": {
"label": "transfer",
"description": "Used to show lines available by direct transfer at an adjoining station. ",
"type": "string",
"required": false
},
"round1": {
"label": "round1",
"description": "If set displays 'Reverses direction' in left cell",
"type": "string",
"required": false
},
"round2": {
"label": "round2",
"description": "If set displays 'Reverses direction' in right cell",
"type": "string",
"required": false
},
"circular": {
"label": "circular",
"description": "If set hides 'toward' of both sides",
"type": "string",
"required": false
},
"circular1": {
"label": "circular1",
"description": "If set hides 'toward' of left cell only",
"type": "string",
"required": false
},
"circular2": {
"label": "circular2",
"description": "If set hides 'toward' of right cell only",
"type": "string",
"required": false
},
"rows1": {
"label": "rows1",
"description": "Number of rows for left hand column",
"type": "string",
"required": false
},
"rowsmid": {
"label": "rowsmid",
"description": "Number of rows for center hand column",
"type": "string",
"required": false
},
"rows2": {
"label": "rows2",
"description": "Number of rows for right hand column",
"type": "string",
"required": false
},
"hide1": {
"label": "hide1",
"description": "Hides the previous station, used when a previous row has 'rows1' set",
"type": "string",
"required": false
},
"hidemid": {
"label": "hidemid",
"description": "Hides this station, used when a previous row has 'rowsmid' set",
"type": "string",
"required": false
},
"hide2": {
"label": "hide2",
"description": "Hides the next station, used when a previous row has 'rows2' set",
"type": "string",
"required": false
}
}
}
See also
- {{tiw|s-rail-start}}
- {{tiw|s-rail}}
- {{tiw|s-rail-next}}
- {{tiw|s-note}}
- {{tiw|s-end}}
Category:Rail transport succession templates
}}