Template:InheritProcessStatus: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
No edit summary
No edit summary
Line 1: Line 1:
<includeonly>* {{Attr|processStatus}}: It describes the {{{selfLink|FIXME}}} status in relation to a working process. Possible values are:
<includeonly>* {{Attr|processStatus}}: It describes the {{{selfLink|FIXME}}} status in relation to a working process.
{{note|The semantics of the attribute values for {{@|processStatus}} have not been fully defined in the past. In general the attribute shall describe a state of the process supported by {{rml}}. Therefore the precise semantics shall be clarified between data provider and the data consumer.<br>'''Examples:'''<br>If an updated version of a timetable is transferred, the {{@|processStatus}} is used by some systems to indicate if a train was changed compared to the previous data transfer by providing {{@|processStatus}}=changed.<br>For the [[UC:TT:SlotOrdering|use case slot ordering]] the attribute is used with the value {{enum|planned}} by some systems to describe that a train has been planned in the scheduling tool, but hasn’t been taken into account for the slot ordering process.}}
Possible values are:
:* {{Enum|planned}}
:* {{Enum|planned}}
:* {{Enum|actual}}
:* {{Enum|actual}}
Line 26: Line 28:
delivers
delivers


{|border="1"
{{InheritProcessStatus|selfLink=ElementName}}
|
* {{Attr|processStatus}}: It describes the ElementName status in relation to a working process. Possible values are:
:* {{Enum|planned}}
:* {{Enum|actual}}
:* {{Enum|calculated}}
:* {{Enum|toBeChecked}}
:* {{Enum|changed}}
:* {{Enum|imported}}
:* {{OtherEnum
|notes_en =
|notes_de =
}} {{AddAnn|| }}
|}


<pre>{{InheritProcessStatus
<pre>{{InheritProcessStatus
Line 49: Line 38:
delivers
delivers


{|border="1"
{{InheritProcessStatus
|
|selfLink=ElementName
* {{Attr|processStatus}}: It describes the ElementName status in relation to a working process. Possible values are:
|processStatus=English comment
:* {{Enum|planned}}
|processStatus_de=Deutscher Kommentar
:* {{Enum|actual}}
}}
:* {{Enum|calculated}}
:* {{Enum|toBeChecked}}
:* {{Enum|changed}}
:* {{Enum|imported}}
:* {{OtherEnum
|notes_en =
|notes_de =
}} {{AddAnn|English comment|Deutscher Kommentar }}
|}


The template is employed by [[TT:train]], [[TT:trainPart]] and [[TT:trainGroup]].
The template is employed by [[TT:train]], [[TT:trainPart]] and [[TT:trainGroup]].


[[Category:AttributeTemplate]]</noinclude>
[[Category:AttributeTemplate]]</noinclude>

Revision as of 10:55, 19 August 2019

Usage

This template displays the attribute processStatus and lists the possible values planned, actual, calculated, toBeChecked, imported and other:anything (see CO:usingAny#New enumeration value). The attribute can be commented on both in English and in German.

Arguments

The template has an obligatory and two optional arguments:

  • Obligatory:
    • selfLink: the name of the described element
  • Optional:
    • processStatus: English comment
    • processStatus_de: German comment

Dependencies

The template depends on Template:Attr, Template:Enum, Template:OtherEnum and Template:AddAnn. No other templates build on it.

Examples

{{InheritProcessStatus|selfLink=ElementName}}

delivers

  • processStatus: It describes the ElementName status in relation to a working process.
🗒️ {{{1}}}

Possible values are:

  • planned
  • actual
  • calculated
  • toBeChecked
  • changed
  • imported
  • other:anything: Any value that does not fit any value from the previous enumeration list, fulfilling the constraint: at minimum two characters, whitespace is not allowed. Please, apply Dev:usingAny accordingly.
{{InheritProcessStatus
|selfLink=ElementName
|processStatus=English comment
|processStatus_de=Deutscher Kommentar
}}

delivers

  • processStatus: It describes the ElementName status in relation to a working process.
🗒️ {{{1}}}

Possible values are:

  • planned
  • actual
  • calculated
  • toBeChecked
  • changed
  • imported
  • other:anything: Any value that does not fit any value from the previous enumeration list, fulfilling the constraint: at minimum two characters, whitespace is not allowed. Please, apply Dev:usingAny accordingly.
    English comment
    Deutscher Kommentar

The template is employed by TT:train, TT:trainPart and TT:trainGroup.