Home » railML newsgroups » railml.misc » Where to place a "comment" value? (Where do you place comments on individual elements in railML?)
Where to place a "comment" value? [message #1554] Tue, 25 April 2017 09:54 Go to previous message
Torben Brand is currently offline  Torben Brand
Messages: 24
Registered: March 2016
Junior Member
Where do you place comments on individual elements in railML?
As part of the use case capacity planning we need to comment on the elements. This is part of the workflow where we need to describe tasks that needs to be done or has been done and we like to emphasize. Currently this is either a separate list or annotations (comment bubble) on a schematic representation of the railML model (schematic track plan). But embedding it in the railML file is more efficient and less error prone. Comments could be any comment not only connected to the described workflow.

Example 1: In a railML file describing the current infrastructure state, on the element speedChange the comment "Check if this speed is correct"
Example 2: In a railML file describing a planned infrastructure state, on the element switch the comment "We need to move this switch outwards 50 meters and increase the deflecting speed/size of the switch".

I suggest for railML 2 using the generally for all elements available attribute @description. The wiki defines @description as "This is a more detailed description as addition to the short name. It shall allow a short overview or hints to the contents of this data set." Comments could be interpreted as "hints to the contents of this data set".

I suggest for railML 3 a separate attribute @comment available for all elements . This as the comments not usually describe the element directly.
 
Read Message
Read Message
Read Message
Previous Topic: what about compressed RailML files?
Next Topic: To use or not to use? - default values in XSDs
Goto Forum:
  


Current Time: Tue Jun 27 00:35:20 CEST 2017