Template:InheritSpeed

From railML 2 Wiki
Revision as of 18:19, 24 February 2016 by RailML Coord Documentation (talk | contribs) (Documentation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Usage

This template lists five attributes and comments on most of them by default: trainCategory, status, vMax, trainrelation and signalised. Optional English and German comments can be added for the first three of them.

Arguments

The template allows for six optional arguments:

  • trainCategory: English comment on trainCategory
  • trainCategory_de: German comment on trainCategory
  • status: English comment on status
  • status_de: German comment on status
  • vMax: English comment on vMax
  • vMax_de: German comment on vMax

Dependencies

The template depends on Template:Attr, Template:TT:Tag, Template:AddAnn and Templat:Intro. No other templates build on it.

Examples

{{InheritSpeed}}

delivers

  • trainCategory This is a category name for trains. Don't confuse with <category>!
  • status
  • vMax
  • trainRelation (introduced with version 2.2) Reference to the part of the train from where the speed change is valid. Normally, a speed change with a speed that is higher than the permitted speed in the section before will be valid only after the end of the train has passed the speed change. On the contrary, a speed change with a speed value that is lower than the permitted speed in the section before applies already when the head of train passes the speedChange. This is the default value; define this attribute only if your train relation differs from this rule. See notes for further information.
  • signalised (introduced with version 2.2) Indicates whether the speed aspect is shown next to the track by a signal or panel (=true/1) or not (=false/0). For speed changes which are printed in a "Driver's timetable" only but not shown at track-site, use false/0. This is aimed to be used to create special caution for speed changes which are not shown at track-side by special 'highlighting' e. g. in the Driver's timetable. In the meaning of 'on the safe side' this may also apply to speed changes with no proper pre-signalisation (since the pre-signalisation is normally more important than the signalisation at the actual beginning of a speed restriction). A speed change is treated as not pre-signalised if there is at least one route at which a train can pass the speed change decreasing and did not pass any pre-signalisation for the speed reduction a proper braking distance before.
{{InheritSpeed
|trainCategory=English comment on trainCategory
|trainCategory_de=German comment on trainCategory
|status=English comment on status
|status_de=German comment on status
|vMax=English comment on vMax
|vMax_de=German comment on vMax
}}

delivers

  • trainCategory This is a category name for trains. Don't confuse with <category>!
    English comment on trainCategory
    German comment on trainCategory
  • status
    English comment on status
    German comment on status
  • vMax
    English comment on vMax
    German comment on vMax
  • trainRelation (introduced with version 2.2) Reference to the part of the train from where the speed change is valid. Normally, a speed change with a speed that is higher than the permitted speed in the section before will be valid only after the end of the train has passed the speed change. On the contrary, a speed change with a speed value that is lower than the permitted speed in the section before applies already when the head of train passes the speedChange. This is the default value; define this attribute only if your train relation differs from this rule. See notes for further information.
  • signalised (introduced with version 2.2) Indicates whether the speed aspect is shown next to the track by a signal or panel (=true/1) or not (=false/0). For speed changes which are printed in a "Driver's timetable" only but not shown at track-site, use false/0. This is aimed to be used to create special caution for speed changes which are not shown at track-side by special 'highlighting' e. g. in the Driver's timetable. In the meaning of 'on the safe side' this may also apply to speed changes with no proper pre-signalisation (since the pre-signalisation is normally more important than the signalisation at the actual beginning of a speed restriction). A speed change is treated as not pre-signalised if there is at least one route at which a train can pass the speed change decreasing and did not pass any pre-signalisation for the speed reduction a proper braking distance before.

The template is employed by IS:speed and IS:speedChange.