| [railML2] Inconsistent examples in the wiki for <category> [message #2838] |
Thu, 14 October 2021 12:49  |
Christian Rößiger
Messages: 60
Registered: March 2015
|
Member |
|
|
Hello all,
While making additions for railML2.5 in the wiki, I noticed an awkward inconsistency in the designation of a <category>: In the example on the page https://wiki2.railml.org/wiki/TT:category, the abbreviated designation ("IC") is given in the attribute "name", the full name ("InterCity") in "description".
On the linked page https://wiki2.railml.org/wiki/Dev:categoryUsage, on the other hand, the abbreviation is given in the attribute "code", the full name in "name". The attribute "description" is used here for a more detailed description of the <category>.
Before I add more examples to the wiki, it would be good if we could agree on a consistent description.
Personally, I would prefer the second variant in (https://wiki2.railml.org/wiki/Dev:categoryUsage), since the full name of the <category> is not really a "description" and additionally the exchange of a more detailed description is possible. However, the attribute "code" is intended for machine-readable identifiers and these must also be unique ( https://wiki2.railml.org/wiki/Dev:identities#Differentiation _from_other_indications). At least the latter would not be the case for the abbreviation of a <category>.
Any Suggestions?
Best regards
Christian
============================================================ ===================================================
Hallo zusammen,
beim Ergänzen von Änderungen für railML2.5 im Wiki, ist mir eine unschöne Inkonsistenz bei der Bezeichnung einer <category> aufgefallen: Im Beispiel auf der Seite https://wiki2.railml.org/wiki/TT:category wird die abgekürzte Bezeichnung ("IC") im Attribut "name" angegeben, die ausgeschriebene Bezeichnung ("InterCity") in "description".
Auf der verlinkten Seite https://wiki2.railml.org/wiki/Dev:categoryUsage hingegen wird die Abkürzung im Attribut "code" angegeben, der ausgeschriebene Name in "name". Das Attribut "description" wird hier für eine ausführlichere Beschreibung der <category> genutzt.
Bevor ich weitere Beispiele im Wiki ergänze, wäre es gut, wenn wir uns auf eine einheitliche Beschreibung einigen könnten.
Persönlich würde ich die zweite Variante in (https://wiki2.railml.org/wiki/Dev:categoryUsage) bevorzugen, da der ausgeschriebene Name der <category> nicht wirklich eine "description" ist und zusätzlich der Austausch einer ausführlicheren Beschreibung ermöglicht wird. Allerdings ist das Attribut "code" für maschinen-lesbare Identifier vorgesehen und diese müssen auch eindeutig sein ( https://wiki2.railml.org/wiki/Dev:identities#Differentiation _from_other_indications). Zumindest letzteres wäre für die Abkürzung einer <category> nicht der Fall.
Was wäre Euer Vorschlag?
Viele Grüße
Christian
|
|
|
|
| Re: [railML2] Inconsistent examples in the wiki for <category> [message #2845 is a reply to message #2838] |
Mon, 08 November 2021 19:06  |
Milan Wölke
Messages: 139
Registered: April 2007
|
Senior Member |
|
|
Hi Christian,
Thank you very much for your comments. I would agree with you and prefer option 2. So, to stay with your example, name would be "InterCity", description would be an explanatory text and code would possibly be "IC". I also don't see that the uniqueness criterion would really be broken. The specification for code speaks of "use case specific uniqueness requirements". With this in mind, it would make sense.
----------------
Vielen Dank für deine Anmerkungen. Ich würde dir zustimmen und Variante 2 vorziehen. Also, um bei deinem Beispiel zu bleiben, name wäre „InterCity", description wäre ein erklärender Text und code wäre u. U. „IC". Ich sehe auch nicht, dass das Eindeutigkeitskriterium wirklich durchbrochen werden würde. Als Anforderung für code wird ja von „use case specific uniqueness requirements" gesprochen. In diesem Sinne würde das schon Sinn ergeben.
Best regards, Milan
Milan Wölke – Timetable scheme coordinator
railML.org (Registry of Associations: VR 5750)
Altplauen 19h; 01187 Dresden; Germany www.railML.org
|
|
|
|
Members
Search
Help
Login
Home
