Main Page: Difference between revisions
Jump to navigation
Jump to search
| [checked revision] | [checked revision] |
m (formatting) |
|||
| (45 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{navi}} | {{navi}} | ||
=== Welcome to the {{rml}} wiki / {{Deu| Willkommen im {{rml}}-Wiki}} === | |||
{| class="wikitable toptextcells" style="text-align:left vertical-align:top" | {| class="wikitable toptextcells" style="text-align:left vertical-align:top" | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|style="width: | |style="width:45%" | {{rml}} ('''rail'''way '''M'''arkup '''L'''anguage) is an open, {{wiki|XML}} based data exchange format for data interoperability of railway applications. For further information please visit the [https://www.railML.org official project website] or {{wikipedia|railML|the Wikipedia {{rml}} article}}. | ||
| | This wiki is dedicated to all versions of {{rml|2}}. A separate wiki for {{rml|3}} is available {{wiki3|2=here}}. This wiki should support you in the development of {{rml}} interfaces and inform you about the basic elements and modelling concepts of the {{rml}} schema. | ||
{{Deu| | This wiki is being kept in English. Some information is provided additionally also in {{Deu|German}}. You are invited to contribute to this wiki and to the development of the {{rml}} schema. Please, see our guideline "''[[dev:How_to_join,_edit_and_create_the_railML_wiki#How_to_join_the_Wiki|How to join the railML wiki]]''" to get to know the standards of railML's wiki and the procedure for getting a writer's account. You can find further guidelines on {{rml}} in section [[#Users_and_Developers_Guides]]. | ||
|style="width:*" | {{Deu|{{rml}} ('''rail'''way '''M'''arkup '''L'''anguage) ist ein offenes, {{wiki|XML}}-basiertes Datenaustauschformat zur gegenseitigen Benützbarkeit der Daten von Anwendungen im Eisenbahnbereich. Für weitere Informationen besuchen Sie bitte die [https://www.railML.org offizielle Projektwebsite] oder {{wikipedia|railML|den Wikipedia-Artikel über {{rml}}|de}}.}} | |||
{{ | {{Deu|Dieses Wiki ist sämtlichen Versionen von {{rml|2}} gewidmet. Ein separates wiki für {{rml|3}} finden Sie {{wiki3|hier}}. Ziel dieses Wikis ist, Sie bei der Entwicklung von {{rml}}-Schnittstellen zu unterstützen und Sie über die grundlegenden Elemente und Modellierungskonzepte des {{rml}}-Schemas zu informieren.}} | ||
{{ | {{Deu|Dieses Wiki wird auf}} Englisch {{Deu|geführt. Einzelne Informationen stellen wir außerdem auf Deutsch zur Verfügung. Sie sind herzlich eingeladen, sich an der Entwicklung dieses Wikis sowie des {{rml}}-Schemas zu beteiligen. Lesen Sie dazu bitte unseren Leitfaden ''„[[dev:How_to_join,_edit_and_create_the_railML_wiki#How_to_join_the_Wiki|How to join the {{rml}} wiki]]“'', um sich mit den Standards des {{rml}}-Wikis vertraut zu machen und die Vorgangsweise zur Erteilung eines Autorenaccounts kennenzulernen. Weitere Leitfäden, die {{rml}} betreffen, finden Sie im Abschnitt [[#Users_and_Developers_Guides]].}} | ||
}} | |||
|} | |} | ||
== Current {{rml}} subschemas == | == Current {{rml|2}} subschemas == | ||
There are three subschemas for productive use: Infrastructure (IS), Timetable and Rostering (TT) and Rollingstock (RS). Elements that are needed by all subschemas or do not fit into this structure are subsumed in the class Common (CO). Please contact the coordinator of the respective schema (see {{site|https://www.railML.org/en/user/subschemes.html}}) for questions and enquiries. Additional subschemas will be developed only in the {{rml|3}} domain. Please, frame the regarding suggestions and contributions to this end. | |||
=== Infrastructure (IS) === | === Infrastructure (IS) === | ||
{{main|Infrastructure}} | {{main|Infrastructure}} | ||
The | The {{rml}} [[Infrastructure|Infrastructure subschema]] is focused on the description of the railway network infrastructure including all its various facets that are needed by the data exchange applications. In particular, the {{rml}} infrastructure schema contains the following information: | ||
the railway network infrastructure including all its various facets that | |||
are needed by the data exchange applications. In particular, the | |||
infrastructure schema contains the following information: | |||
* Topology. The track network is described as a topological node edge model. | * Topology. The track network is described as a topological node edge model. | ||
* Coordinates. All railway infrastructure elements can be located in an arbitrary 2- or 3-dimensional coordinate system, e.g. the WGS84 that is widely used by today's navigation software. | * Coordinates. All railway infrastructure elements can be located in an arbitrary 2- or 3-dimensional coordinate system, e.g. the {{wiki|World_Geodetic_System#WGS84}}that is widely used by today's navigation software. | ||
* Geometry. The track geometry can be described in terms of radius and gradient. | * Geometry. The track geometry can be described in terms of radius and gradient. | ||
* Railway infrastructure elements enclose a variety of railway relevant assets that can be found on, under, over or next to the railway track, e.g. | * Railway infrastructure elements enclose a variety of railway relevant assets that can be found on, under, over or next to the railway {{IS:Tag|track}}, e.g. {{IS:Tag|balise}}s, {{IS:Tag|platformEdge}}s, and {{IS:Tag|levelCrossing}}s. | ||
* Further located elements encompass elements that are closely linked with the railway infrastructure, but that "cannot be touched", e.g. | * Further located elements encompass elements that are closely linked with the railway infrastructure, but that "cannot be touched", e.g. {{IS:Tag|speedProfile}} and {{IS:Tag|trackCondition}}s. | ||
=== Rollingstock (RS) === | === Rollingstock (RS) === | ||
{{main|Rollingstock}} | {{main|Rollingstock}} | ||
The [[rollingstock|rollingstock subschema]] is part of the complete [https://www.railML.org | The [[rollingstock|rollingstock subschema]] is part of the complete [https://www.railML.org {{rml}}] schema providing a data structure in {{wiki|XML}} language for the exchange of railway specific data. | ||
The rollingstock schema provides container for all data about any kind of | The rollingstock schema provides a container for all data about any kind of railway vehicle including locomotives, multiple units, passenger and freight wagons. The second part of the schema enables the combination of single vehicles to formations as a fixed composition within a train or an entire train. It is intended to use this data schema for vehicle management as well as for detailed run-time calculations. | ||
The Rollingstock schema comprises the following features: | The Rollingstock schema comprises the following features: | ||
| Line 69: | Line 42: | ||
* possible specification of vehicle families and individual vehicles using the common features of the family | * possible specification of vehicle families and individual vehicles using the common features of the family | ||
* different level of detail for data | * different level of detail for data | ||
** vehicles as black boxes (with respect to dynamic characteristics) with only mean values | |||
** vehicles as black boxes (with respect to dynamic characteristics) with curves for particular values being variable within the operating range | |||
** vehicles as white boxes with details about the internal propulsion system | |||
* vehicles with motive power, for passenger or freight use | * vehicles with motive power, for passenger or freight use | ||
* combination of vehicles to formations, i.e. train parts or complete trains | * combination of vehicles to formations, i.e. train parts or complete trains | ||
=== | === Timetable and Rostering (TT) === | ||
{{main| | {{main|Timetable|Timetable and Rostering}} | ||
The [[ | The [[timetable|timetable subschema]] is part of the complete [https://www.railML.org {{rml}}] schema providing a data structure in {{wiki|XML}} for the exchange of railway specific data. It is the subschema that is most widely used. | ||
The subschema is | The timetable subschema is used for all data necessary to exchange any kind of timetable for operational or conceptional purposes including the following information: | ||
* {{TT:Tag|operatingPeriod}}: The operating days for train services or rostering. | |||
* {{TT:Tag|trainPart}}: The basic parts of a train with the same characteristics such as formation and operating period. The train part includes the actual information regarding the path of the train as a sequence of operation or control points together with the corresponding schedule information. | |||
* {{TT:Tag|train}}: One or more train parts make up a train and represent either the operational or the commercial view of the train run. | |||
* Connections: The relevant connections/associations between trains at a particular operation or control point. | |||
* {{TT:Tag|rostering}}: Train parts can be linked to form the circulations necessary for rostering (rolling stock schedules). | |||
=== Common (CO) === | === Common (CO) === | ||
{{main|Common}} | {{main|Common}} | ||
The [[Common]] class shall cover all topics, which affect all other | The [[Common]] class shall cover all topics, which affect all other {{rml}} schemas alike. | ||
The | The currently planned tasks and enhancements can be found {{site|https://development.railml.org/railml/version2/-/issues|in the {{rml|2}} ticketing system}}. | ||
== Codelists == | |||
{{main|dev:codelists|Codelists}} | |||
Certain attributes require a choice from a vast, highly standardized but shifting set of values. For instance, there are many regional {{external|https://en.wikipedia.org/wiki/Loading_gauge|clearance gauge standards}}. As to facilitate the usage and update of the sets, this Information is outsourced into [[dev:codelist|codelists]] outside the {{rml}} schema. | |||
The codelists are identically available for {{rml|2}} and {{rml|3}}. | |||
==Versions== | ==Versions== | ||
The current {{rml}} version is | The current {{rml}}2 version is {{current}}. For more details see {{site|https://www.railml.org/en/developer/version-timeline.html|our version timeline}}. An overview of the regarding licenses can be found under {{site|https://www.railml.org/en/user/licence.html}}. To learn about the version history and the changes between the respective versions see [[Dev:changes]]. | ||
== Users and Developers Guides == | == Users and Developers Guides == | ||
{{main|Dev:Guides}} | {{main|Dev:Guides}} | ||
===Using and developing {{rml}}=== | ===Using and developing {{rml}}=== | ||
* [[ | * complete {{rml|2}} trees with links to the corresponding wiki pages: | ||
**[[Dev:XMLtree|The {{rml|2.5}} tree]] (current) | |||
**[[Dev:XMLtree/2.4|The {{rml|2.4}} tree]] | |||
**[[Dev:XMLtree/2.3|The {{rml|2.3}} tree]] | |||
* [[:category:concept|Basic {{rml}} Concepts]] | * [[:category:concept|Basic {{rml}} Concepts]] | ||
* [[Dev:example|{{rml}} example files]] | * [[Dev:example|{{rml}} example files]] | ||
* [[Dev:Downloading and using railML®|Downloading and using {{rml}}]] | * [[Dev:Downloading and using railML®|Downloading and using {{rml}}]] | ||
* [[Dev:Syntactic_Guidelines | Syntactic guidelines for a corporate code base]] | * [[Dev:Syntactic_Guidelines | Syntactic guidelines for a corporate code base]] | ||
* [[Dev:Coding_XML_Components | Coding styles for XML components in | * [[Dev:Coding_XML_Components | Coding styles for XML components in {{rml}} schemas]] | ||
* [[Dev:Guideline for participating in the development process|Guideline for participating in the development process]] | * [[Dev:Guideline for participating in the development process|Guideline for participating in the development process]] | ||
* [[Dev:Creating_instructions|Creating instructions for new {{rml}} elements]] | * [[Dev:Creating_instructions|Creating instructions for new {{rml}} elements]] | ||
* [[Dev:Use_cases|Guideline on Use cases]] — what is a use case, where to find them and how to contribute to them. | * [[Dev:Use_cases|Guideline on Use cases]] — what is a use case, where to find them and how to contribute to them. | ||
* | * {{site|https://www.railml.org/en/developer/certification.html|Certification guideline|inlang=silent}} | ||
* [[Dev:Semantic Constraints]] | * [[Dev:Semantic Constraints|How to deal with Semantic Constraints]] | ||
===Improving the Wiki=== | ===Improving the Wiki=== | ||
| Line 117: | Line 96: | ||
* [[dev:How_to_join,_edit_and_create_the_railML_wiki#How_to_join_the_Wiki|How to join the {{rml}} wiki]] | * [[dev:How_to_join,_edit_and_create_the_railML_wiki#How_to_join_the_Wiki|How to join the {{rml}} wiki]] | ||
* [[:category:template|Wiki-Templates]] | * [[:category:template|Wiki-Templates]] | ||
* [[Special:PopularPages|Access statistics]] | |||
==Contact== | ==Contact== | ||
Feel free to direct any comments, questions or remarks to the coordinators of {{rml}}. | Feel free to direct any comments, questions or remarks to the {{site|https://www.railml.org/en/subschemes.html|coordinators of {{rml}}}}. | ||
For our contact information see ''[[wiki.railML.org:Contact|Contact]]'' | For our contact information see ''[[wiki.railML.org:Contact|Contact]]'' | ||
<hr> | <hr> | ||
Enjoy the Wiki! | Enjoy the Wiki! | ||
{{interwiki}} | |||
Latest revision as of 13:17, 9 October 2024
| ||||||||
| ||||||||
| railML® 3 Wiki – RailTopoModel® Wiki |
Welcome to the railML® wiki / Willkommen im railML®-Wiki
railML® (railway Markup Language) is an open, XML ( ) based data exchange format for data interoperability of railway applications. For further information please visit the official project website or the Wikipedia railML® article ().
This wiki is dedicated to all versions of railML® 2. A separate wiki for railML® 3 is available here. This wiki should support you in the development of railML® interfaces and inform you about the basic elements and modelling concepts of the railML® schema. This wiki is being kept in English. Some information is provided additionally also in German. You are invited to contribute to this wiki and to the development of the railML® schema. Please, see our guideline "How to join the railML wiki" to get to know the standards of railML's wiki and the procedure for getting a writer's account. You can find further guidelines on railML® in section #Users_and_Developers_Guides. |
railML® (railway Markup Language) ist ein offenes, XML ()-basiertes Datenaustauschformat zur gegenseitigen Benützbarkeit der Daten von Anwendungen im Eisenbahnbereich. Für weitere Informationen besuchen Sie bitte die offizielle Projektwebsite oder den Wikipedia-Artikel über railML® ( 🇩🇪).
Dieses Wiki ist sämtlichen Versionen von railML® 2 gewidmet. Ein separates wiki für railML® 3 finden Sie hier. Ziel dieses Wikis ist, Sie bei der Entwicklung von railML®-Schnittstellen zu unterstützen und Sie über die grundlegenden Elemente und Modellierungskonzepte des railML®-Schemas zu informieren. Dieses Wiki wird auf Englisch geführt. Einzelne Informationen stellen wir außerdem auf Deutsch zur Verfügung. Sie sind herzlich eingeladen, sich an der Entwicklung dieses Wikis sowie des railML®-Schemas zu beteiligen. Lesen Sie dazu bitte unseren Leitfaden „How to join the railML® wiki“, um sich mit den Standards des railML®-Wikis vertraut zu machen und die Vorgangsweise zur Erteilung eines Autorenaccounts kennenzulernen. Weitere Leitfäden, die railML® betreffen, finden Sie im Abschnitt #Users_and_Developers_Guides. |
Current railML® 2 subschemas
There are three subschemas for productive use: Infrastructure (IS), Timetable and Rostering (TT) and Rollingstock (RS). Elements that are needed by all subschemas or do not fit into this structure are subsumed in the class Common (CO). Please contact the coordinator of the respective schema (see https://www.railML.org/en/user/subschemes.html (link to the railML® website)) for questions and enquiries. Additional subschemas will be developed only in the railML® 3 domain. Please, frame the regarding suggestions and contributions to this end.
Infrastructure (IS)
- →Main Article: Infrastructure
The railML® Infrastructure subschema is focused on the description of the railway network infrastructure including all its various facets that are needed by the data exchange applications. In particular, the railML® infrastructure schema contains the following information:
- Topology. The track network is described as a topological node edge model.
- Coordinates. All railway infrastructure elements can be located in an arbitrary 2- or 3-dimensional coordinate system, e.g. the World_Geodetic_System#WGS84 ()that is widely used by today's navigation software.
- Geometry. The track geometry can be described in terms of radius and gradient.
- Railway infrastructure elements enclose a variety of railway relevant assets that can be found on, under, over or next to the railway <track>, e.g. <balise>s, <platformEdge>s, and <levelCrossing>s.
- Further located elements encompass elements that are closely linked with the railway infrastructure, but that "cannot be touched", e.g. <speedProfile> and <trackCondition>s.
Rollingstock (RS)
- →Main Article: Rollingstock
The rollingstock subschema is part of the complete railML® schema providing a data structure in XML () language for the exchange of railway specific data.
The rollingstock schema provides a container for all data about any kind of railway vehicle including locomotives, multiple units, passenger and freight wagons. The second part of the schema enables the combination of single vehicles to formations as a fixed composition within a train or an entire train. It is intended to use this data schema for vehicle management as well as for detailed run-time calculations.
The Rollingstock schema comprises the following features:
- separate parts for vehicles and for train parts or complete trains
- possible specification of vehicle families and individual vehicles using the common features of the family
- different level of detail for data
- vehicles as black boxes (with respect to dynamic characteristics) with only mean values
- vehicles as black boxes (with respect to dynamic characteristics) with curves for particular values being variable within the operating range
- vehicles as white boxes with details about the internal propulsion system
- vehicles with motive power, for passenger or freight use
- combination of vehicles to formations, i.e. train parts or complete trains
Timetable and Rostering (TT)
- →Main Article: Timetable and Rostering
The timetable subschema is part of the complete railML® schema providing a data structure in XML () for the exchange of railway specific data. It is the subschema that is most widely used.
The timetable subschema is used for all data necessary to exchange any kind of timetable for operational or conceptional purposes including the following information:
- <operatingPeriod>: The operating days for train services or rostering.
- <trainPart>: The basic parts of a train with the same characteristics such as formation and operating period. The train part includes the actual information regarding the path of the train as a sequence of operation or control points together with the corresponding schedule information.
- <train>: One or more train parts make up a train and represent either the operational or the commercial view of the train run.
- Connections: The relevant connections/associations between trains at a particular operation or control point.
- <rostering>: Train parts can be linked to form the circulations necessary for rostering (rolling stock schedules).
Common (CO)
- →Main Article: Common
The Common class shall cover all topics, which affect all other railML® schemas alike.
The currently planned tasks and enhancements can be found in the railML® 2 ticketing system (link to the railML® website).
Codelists
- →Main Article: Codelists
Certain attributes require a choice from a vast, highly standardized but shifting set of values. For instance, there are many regional clearance gauge standards (external link). As to facilitate the usage and update of the sets, this Information is outsourced into codelists outside the railML® schema.
The codelists are identically available for railML® 2 and railML® 3.
Versions
The current railML®2 version is 2.5. For more details see our version timeline (link to the railML® website). An overview of the regarding licenses can be found under https://www.railml.org/en/user/licence.html (link to the railML® website). To learn about the version history and the changes between the respective versions see Dev:changes.
Users and Developers Guides
- →Main Article: Dev:Guides
Using and developing railML®
- complete railML® 2 trees with links to the corresponding wiki pages:
- Basic railML® Concepts
- railML® example files
- Downloading and using railML®
- Syntactic guidelines for a corporate code base
- Coding styles for XML components in railML® schemas
- Guideline for participating in the development process
- Creating instructions for new railML® elements
- Guideline on Use cases — what is a use case, where to find them and how to contribute to them.
- Certification guideline
- How to deal with Semantic Constraints
Improving the Wiki
- Guidelines to enhance the wiki documentation
- How to join the railML® wiki
- Wiki-Templates
- Access statistics
Contact
Feel free to direct any comments, questions or remarks to the coordinators of railML® (link to the railML® website).
For our contact information see Contact
Enjoy the Wiki!