Jump to content

Template:S-rail-national/doc

From Wikipedia, the free encyclopedia


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]
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:S-rail-national in articles based on its TemplateData.

TemplateData for S-rail-national

A specialised succession box for rail lines on the British National Rail system.

Template parameters

ParameterDescriptionTypeStatus
previousprevious

The name of the previous station, should correspond to a specific template name

Stringoptional
nextnext

The name of the next station, should correspond to a specific template name

Stringoptional
systemsystem

The system to which the line belongs, Defaults to 'National Rail'.

Stringoptional
Train operating companytoc

Train operating company

Stringrequired
statusstatus

Can be either 'Disused' or 'Historical'. system should also be set in this case.

Stringoptional
routeroute

The route of a line e.g. 'Thameslink'.

Stringoptional
typetype

The left-hand line branch

Stringoptional
type2type2

The right-hand line branch

Stringoptional
notenote

Information about the left-hand line branch

Stringoptional
notemidnotemid

Information about the station itself

Stringoptional
note2note2

Information about the right-hand line branch

Stringoptional
oneway1oneway1

Indicates that trains do not operate towards the Previous station

Stringoptional
oneway2oneway2

Indicates that trains do not operate towards the Next station

Stringoptional
through1through1

Allows, instead of a previous station, service passing to another line on the system.

Stringoptional
through2through2

Allows, instead of a next station, service passing to another line on the system.

Stringoptional
county1county1

The county of a station. Useful for disambiguation.

Stringoptional
county2county2

The county of a station. Useful for disambiguation.

Stringoptional
transfertransfer

Used to show lines available by direct transfer at an adjoining station.

Stringoptional
round1round1

If set displays 'Reverses direction' in left cell

Stringoptional
round2round2

If set displays 'Reverses direction' in right cell

Stringoptional
circularcircular

Stringoptional
circular1circular1

Stringoptional
circular2circular2

Stringoptional
rows1rows1

Number of rows for left hand column

Stringoptional
rowsmidrowsmid

Number of rows for center hand column

Stringoptional
rows2rows2

Number of rows for right hand column

Stringoptional
hide1hide1

Hides the previous station, used when a previous row has 'rows1' set

Stringoptional
hidemidhidemid

Hides this station, used when a previous row has 'rowsmid' set

Stringoptional
hide2hide2

Hides the next station, used when a previous row has 'rows2' set

Stringoptional