Template:InheritProcessStatus: Difference between revisions
Jump to navigation
Jump to search
[unchecked revision] | [checked revision] |
(Created for use in several TT element documentation sites) |
(added deprecation note to match version changes) |
||
(7 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
* {{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. {{depr|2.5}} | ||
{{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 9: | Line 11: | ||
|notes_en = | |notes_en = | ||
|notes_de = | |notes_de = | ||
}} {{AddAnn|{{{processStatus|}}}|{{{processStatus_de|}}} }}<noinclude>[[Category:AttributeTemplate]]</noinclude> | }} {{AddAnn|{{{processStatus|}}}|{{{processStatus_de|}}} }}</includeonly><noinclude> | ||
==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== | |||
<pre>{{InheritProcessStatus|selfLink=ElementName}}</pre> | |||
delivers | |||
{{InheritProcessStatus|selfLink=ElementName}} | |||
<pre>{{InheritProcessStatus | |||
|selfLink=ElementName | |||
|processStatus=English comment | |||
|processStatus_de=Deutscher Kommentar | |||
}}</pre> | |||
delivers | |||
{{InheritProcessStatus | |||
|selfLink=ElementName | |||
|processStatus=English comment | |||
|processStatus_de=Deutscher Kommentar | |||
}} | |||
The template is employed by [[TT:train]], [[TT:trainPart]] and [[TT:trainGroup]]. | |||
[[Category:AttributeTemplate]]</noinclude> |
Latest revision as of 14:58, 30 November 2023
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. (deprecated with version 2.5)
|
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. (deprecated with version 2.5)
|
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.