Template:Change: Difference between revisions
Jump to navigation
Jump to search
[checked revision] | [checked revision] |
No edit summary |
(railML→{{rml}}) |
||
(14 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<includeonly> | <includeonly>{{#if:{{{trac|}}}|{{#vardefine:ticket|{{{trac}}}}}}}<noinclude> | ||
</noinclude>{{#if:{{{ticket|}}}|{{#vardefine:ticket|{{{ticket}}}}}}}<noinclude> | |||
</noinclude>{{#if:{{{svn|}}}|{{#vardefine:commit|{{{svn}}}}}}}<noinclude> | |||
</noinclude>{{#if:{{{commit|}}}|{{#vardefine:commit|{{{commit}}}}}}} | |||
{| | {| | ||
{{#if:{{{fact|}}}| | {{#if:{{{fact|}}}| | ||
Line 12: | Line 15: | ||
}} | }} | ||
{{#if:{{{recomendation|}}}| | {{#if:{{{recomendation|}}}| | ||
{{!}}style="vertical-align:top"{{!}} | {{!}}style="vertical-align:top"{{!}}Recommendation:[[category:FIXME]] | ||
{{!}}style="vertical-align:top"{{!}}{{{recomendation}}} | {{!}}style="vertical-align:top"{{!}}{{{recomendation}}} | ||
{{!}}- | {{!}}- | ||
}} | }} | ||
{{#if:{{{ | {{#if:{{{recommendation|}}}| | ||
{{!}}style="vertical-align:top"{{!}}Recommendation: | |||
{{!}}style="vertical-align:top"{{!}}{{{recommendation}}} | |||
{{!}}- | |||
}} | |||
{{#if:{{#var:ticket|}}| | |||
{{!}}style="vertical-align:top"{{!}}Related Development Tickets: | {{!}}style="vertical-align:top"{{!}}Related Development Tickets: | ||
{{!}}style="vertical-align:top"{{!}}{{ | {{!}}style="vertical-align:top"{{!}}{{#var:ticket}} | ||
{{!}}- | {{!}}- | ||
}} | }} | ||
{{#if:{{ | {{#if:{{#var:commit|}}| | ||
{{!}}style="vertical-align:top"{{!}}Related | {{!}}style="vertical-align:top"{{!}}Related Commits: | ||
{{!}}style="vertical-align:top"{{!}}{{ | {{!}}style="vertical-align:top"{{!}}{{#var:commit}} | ||
{{!}}- | {{!}}- | ||
}} | }} | ||
Line 54: | Line 62: | ||
{{!}}style="vertical-align: top;border-top: 1px solid darkgray;"{{!}}Updated element(s): | {{!}}style="vertical-align: top;border-top: 1px solid darkgray;"{{!}}Updated element(s): | ||
{{!}}style="border-top: 1px solid darkgray;"{{!}}{{{uelem}}} | {{!}}style="border-top: 1px solid darkgray;"{{!}}{{{uelem}}} | ||
{{!}}- | |||
}} | |||
{{#if:{{{nsemcon|}}}| | |||
{{!}}style="vertical-align: top;border-top: 1px solid darkgray;"{{!}}New semantic constraint(s): | |||
{{!}}style="border-top: 1px solid darkgray;"{{!}}{{{nsemcon}}} | |||
{{!}}- | |||
}} | |||
{{#if:{{{usemcon|}}}| | |||
{{!}}style="vertical-align: top;border-top: 1px solid darkgray;"{{!}}New semantic constraint(s): | |||
{{!}}style="border-top: 1px solid darkgray;"{{!}}{{{usemcon}}} | |||
{{!}}- | {{!}}- | ||
}} | }} | ||
Line 64: | Line 82: | ||
*reason: an explanation of why and how the change has been implemented. | *reason: an explanation of why and how the change has been implemented. | ||
*recomendation: any recommendations | *recomendation: any recommendations | ||
* | *ticket: a list of related development tickets (formerly organized via trac; now via GITLab). Please, employ [[Template:Ticket]]. | ||
* | *commit: a list of related svn commits. Please, employ [[template:commit]], or, for vintage tickets, [[Template:SVN]]. | ||
*example: An example, usually a code snippet. | *example: An example, usually a code snippet. | ||
*xsd: updated XSD-files | *xsd: updated XSD-files | ||
Line 72: | Line 90: | ||
*nelem: new Elements | *nelem: new Elements | ||
*uelem: updated Elements | *uelem: updated Elements | ||
*nsemcon: New semantic constraints | |||
*usemcon: Updated semantic constraints | |||
==Empty Template== | ==Empty Template== | ||
Line 78: | Line 98: | ||
|fact= | |fact= | ||
|reason= | |reason= | ||
| | |recommendation= | ||
| | |ticket= | ||
| | |commit= | ||
|example= | |example= | ||
|xsd= | |xsd= | ||
Line 87: | Line 107: | ||
|nelem= | |nelem= | ||
|uelem= | |uelem= | ||
|nsemcon= | |||
|usemcon= | |||
}} | }} | ||
</pre> | </pre> | ||
Line 95: | Line 117: | ||
|fact={{Attr|@abbrevation}} and {{attr|@number}} in the {{IS:Tag|ocp}} element have been declared deprecated. {{attr|@parentOcpRef}} and {{IS:Tag|designator}} have been introduced. {{IS:Doc|additionalName|ocp}} has been expanded by [[IS:additionalName_ocp#type|{{attr|@type}}]]. | |fact={{Attr|@abbrevation}} and {{attr|@number}} in the {{IS:Tag|ocp}} element have been declared deprecated. {{attr|@parentOcpRef}} and {{IS:Tag|designator}} have been introduced. {{IS:Doc|additionalName|ocp}} has been expanded by [[IS:additionalName_ocp#type|{{attr|@type}}]]. | ||
|reason=There are multiple different abbreviations and numbers for single operation or control points. They can't be defined with one attribute. Use, depending on context, {{IS:Tag|designator}} or {{IS:Doc|additionalName|ocp}} instead. {{attr|@parentOcpRef}} allows for grouping ocps. {{IS:Tag|designator}} allows for more codes than the depricated {{attr|@code}}, plus it can establish a relation with the [[dev:codelists|codelist]] ''Registers.xml''. {{IS:Doc|additionalName|ocp}}/{{attr|@type}} allowes to declare the context of a name: is it valid under operational or traffic aspects, or as a local name? | |reason=There are multiple different abbreviations and numbers for single operation or control points. They can't be defined with one attribute. Use, depending on context, {{IS:Tag|designator}} or {{IS:Doc|additionalName|ocp}} instead. {{attr|@parentOcpRef}} allows for grouping ocps. {{IS:Tag|designator}} allows for more codes than the depricated {{attr|@code}}, plus it can establish a relation with the [[dev:codelists|codelist]] ''Registers.xml''. {{IS:Doc|additionalName|ocp}}/{{attr|@type}} allowes to declare the context of a name: is it valid under operational or traffic aspects, or as a local name? | ||
| | |recommendation=Use the new {{IS:Tag|tsi}} and/or {{IS:Tag|designator}} elements instead. | ||
| | |ticket={{ticket|112}}, {{ticket|153}} | ||
| | |commit={{svn|335}}, {{svn|439}} | ||
|example=Old sample ( | |example=Old sample ({{rml|2.1}}): | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<ocp ... name="Passau Hbf." abbrevation="NPA"/> | <ocp ... name="Passau Hbf." abbrevation="NPA"/> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
New sample ( | New sample ({{rml|2.2}}): | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<ocp ... name='Passau Hbf.' ...> | <ocp ... name='Passau Hbf.' ...> | ||
Line 117: | Line 139: | ||
delivers: | delivers: | ||
{{change | |||
{ | |fact={{Attr|@abbrevation}} and {{attr|@number}} in the {{IS:Tag|ocp}} element have been declared deprecated. {{attr|@parentOcpRef}} and {{IS:Tag|designator}} have been introduced. {{IS:Doc|additionalName|ocp}} has been expanded by [[IS:additionalName_ocp#type|{{attr|@type}}]]. | ||
|reason=There are multiple different abbreviations and numbers for single operation or control points. They can't be defined with one attribute. Use, depending on context, {{IS:Tag|designator}} or {{IS:Doc|additionalName|ocp}} instead. {{attr|@parentOcpRef}} allows for grouping ocps. {{IS:Tag|designator}} allows for more codes than the depricated {{attr|@code}}, plus it can establish a relation with the [[dev:codelists|codelist]] ''Registers.xml''. {{IS:Doc|additionalName|ocp}}/{{attr|@type}} allowes to declare the context of a name: is it valid under operational or traffic aspects, or as a local name? | |||
|recommendation=Use the new {{IS:Tag|tsi}} and/or {{IS:Tag|designator}} elements instead. | |||
|ticket={{ticket|112}}, {{ticket|153}} | |||
|commit={{svn|335}}, {{svn|439}} | |||
|example=Old sample ({{rml|2.1}}): | |||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<ocp ... name="Passau Hbf." abbrevation="NPA"/> | <ocp ... name="Passau Hbf." abbrevation="NPA"/> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
New sample ( | New sample ({{rml|2.2}}): | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<ocp ... name='Passau Hbf.' ...> | <ocp ... name='Passau Hbf.' ...> | ||
Line 176: | Line 161: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
}} | }} | ||
[[Category:ContentTemplate]] | [[Category:ContentTemplate]] |
Latest revision as of 21:30, 22 January 2024
Usage
This template is suposed to standardize the depiction of changes between railML® versions. It is used in certain subpages of Changes.
Arguments
The template has five optional arguments:
- fact: a prompt of the change, e.g. Element X has been extended by attribute Y.
- reason: an explanation of why and how the change has been implemented.
- recomendation: any recommendations
- ticket: a list of related development tickets (formerly organized via trac; now via GITLab). Please, employ Template:Ticket.
- commit: a list of related svn commits. Please, employ template:commit, or, for vintage tickets, Template:SVN.
- example: An example, usually a code snippet.
- xsd: updated XSD-files
- nattr: new attributes
- uattr: updated attributes
- nelem: new Elements
- uelem: updated Elements
- nsemcon: New semantic constraints
- usemcon: Updated semantic constraints
Empty Template
{{change |fact= |reason= |recommendation= |ticket= |commit= |example= |xsd= |nattr= |uattr= |nelem= |uelem= |nsemcon= |usemcon= }}
Example
{{change |fact={{Attr|@abbrevation}} and {{attr|@number}} in the {{IS:Tag|ocp}} element have been declared deprecated. {{attr|@parentOcpRef}} and {{IS:Tag|designator}} have been introduced. {{IS:Doc|additionalName|ocp}} has been expanded by [[IS:additionalName_ocp#type|{{attr|@type}}]]. |reason=There are multiple different abbreviations and numbers for single operation or control points. They can't be defined with one attribute. Use, depending on context, {{IS:Tag|designator}} or {{IS:Doc|additionalName|ocp}} instead. {{attr|@parentOcpRef}} allows for grouping ocps. {{IS:Tag|designator}} allows for more codes than the depricated {{attr|@code}}, plus it can establish a relation with the [[dev:codelists|codelist]] ''Registers.xml''. {{IS:Doc|additionalName|ocp}}/{{attr|@type}} allowes to declare the context of a name: is it valid under operational or traffic aspects, or as a local name? |recommendation=Use the new {{IS:Tag|tsi}} and/or {{IS:Tag|designator}} elements instead. |ticket={{ticket|112}}, {{ticket|153}} |commit={{svn|335}}, {{svn|439}} |example=Old sample ({{rml|2.1}}): <syntaxhighlight lang="xml"> <ocp ... name="Passau Hbf." abbrevation="NPA"/> </syntaxhighlight> New sample ({{rml|2.2}}): <syntaxhighlight lang="xml"> <ocp ... name='Passau Hbf.' ...> <tsi country="80"/> <designator register='RL100' entry='NPA'/> <designator register='ENEE' entry='80-26506-6'/> <designator register='PLC' entry='DE18274'/> <designator register='IBNR' entry='8000298'/> <designator register='DB640' entry='Pa'/> </ocp> </syntaxhighlight> }}
delivers:
Fact: | @abbrevation and @number in the <ocp> element have been declared deprecated. @parentOcpRef and <designator> have been introduced. additionalName has been expanded by @type. |
Reason: | There are multiple different abbreviations and numbers for single operation or control points. They can't be defined with one attribute. Use, depending on context, <designator> or additionalName instead. @parentOcpRef allows for grouping ocps. <designator> allows for more codes than the depricated @code, plus it can establish a relation with the codelist Registers.xml. additionalName/@type allowes to declare the context of a name: is it valid under operational or traffic aspects, or as a local name? |
Recommendation: | Use the new <tsi> and/or <designator> elements instead. |
Related Development Tickets: | #112, #153 |
Related Commits: | [335] (Note on legacy SVN commits), [439] (Note on legacy SVN commits) |
Example: | Old sample (railML® 2.1):
<ocp ... name="Passau Hbf." abbrevation="NPA"/> New sample (railML® 2.2): <ocp ... name='Passau Hbf.' ...> <tsi country="80"/> <designator register='RL100' entry='NPA'/> <designator register='ENEE' entry='80-26506-6'/> <designator register='PLC' entry='DE18274'/> <designator register='IBNR' entry='8000298'/> <designator register='DB640' entry='Pa'/> </ocp> |