Dev:Guides: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
No edit summary
No edit summary
Line 7: Line 7:
!Target Group
!Target Group
!Category
!Category
!{{rml|Version(s)}}
|-
|-
|{{site|https://www.railml.org/en/developer/certification.html|Certification|inlang=silent}}
|{{site|https://www.railml.org/en/developer/certification.html|Certification|inlang=silent}}
Line 13: Line 14:
|Experienced users
|Experienced users
|Guide
|Guide
|
|- style="font-style: italic; color: green;"
|- style="font-style: italic; color: green;"
|[[Dev:Codelists]]
|[[Dev:Codelists]]
Line 19: Line 21:
|New users
|New users
|Concept
|Concept
|
|- style="font-style: italic; color: green;"
|- style="font-style: italic; color: green;"
|[[Dev:InfrastructureManagers]]
|[[Dev:InfrastructureManagers]]
Line 25: Line 28:
|New users
|New users
|Concept
|Concept
|
|- style="font-style: italic; color: green;"
|- style="font-style: italic; color: green;"
|[[Dev:Registers]]
|[[Dev:Registers]]
Line 31: Line 35:
|New users
|New users
|Concept
|Concept
|
|- style="font-style: italic; color: green;"
|- style="font-style: italic; color: green;"
|[[Dev:TrainClearanceGauges]]
|[[Dev:TrainClearanceGauges]]
Line 37: Line 42:
|New users
|New users
|Concept
|Concept
|
|- style="font-style: italic; color: green;"
|- style="font-style: italic; color: green;"
|[[Dev:TrainProtectionSystems]]
|[[Dev:TrainProtectionSystems]]
Line 43: Line 49:
|New users
|New users
|Concept
|Concept
|
|-
|-
|[[Dev:Coding XML Components]]
|[[Dev:Coding XML Components]]
Line 49: Line 56:
|Experienced users, railML schema developers
|Experienced users, railML schema developers
|Guide on how to develop railML schema
|Guide on how to develop railML schema
|
|-
|-
|[[Dev:CommonDataTypes]]
|[[Dev:CommonDataTypes]]
|colspan=4|deprecated
|colspan=4|deprecated
|
|-
|-
|[[Dev:Common Concepts]]
|[[Dev:Common Concepts]]
|colspan=4|deprecated
|colspan=4|deprecated
|
|-
|-
|[[Dev:Connection between tracks]]
|[[Dev:Connection between tracks]]
Line 61: Line 71:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Creating_instructions]]
|[[Dev:Creating_instructions]]
Line 67: Line 78:
|Experienced users, railML schema developers
|Experienced users, railML schema developers
|Guide on how to develop railML schema
|Guide on how to develop railML schema
|
|- style="font-style: italic; color: blue;"
|- style="font-style: italic; color: blue;"
|[[Dev:Defaults]]
|[[Dev:Defaults]]
Line 73: Line 85:
|New users, Wiki editors
|New users, Wiki editors
|Overview of pages, guide on how to edit Wiki contents
|Overview of pages, guide on how to edit Wiki contents
|
|- style="font-style: italic; color: blue;"
|- style="font-style: italic; color: blue;"
|[[Dev:How to join, edit and create the railML wiki]]
|[[Dev:How to join, edit and create the railML wiki]]
Line 79: Line 92:
|Experienced users, Wiki editors
|Experienced users, Wiki editors
|Guide, guide on how to edit Wiki contents
|Guide, guide on how to edit Wiki contents
|
|-  style="font-style: italic; color: blue;"
|-  style="font-style: italic; color: blue;"
|[[Dev:Special Wiki Markup]]
|[[Dev:Special Wiki Markup]]
Line 85: Line 99:
|Experienced users,  Wiki editors
|Experienced users,  Wiki editors
|Guide on how to edit Wiki contents
|Guide on how to edit Wiki contents
|
|- style="font-style: italic; color: blue;"
|- style="font-style: italic; color: blue;"
|[[Dev:Wiki Documentation Guidelines]]
|[[Dev:Wiki Documentation Guidelines]]
Line 91: Line 106:
|Experienced users, Wiki editors
|Experienced users, Wiki editors
|Guide on how to edit Wiki contents
|Guide on how to edit Wiki contents
|
|- style="font-style: italic; color: blue;"
|- style="font-style: italic; color: blue;"
|[[Dev:Units]]
|[[Dev:Units]]
Line 97: Line 113:
|New users, Wiki editors
|New users, Wiki editors
|Guide on how to edit Wiki contents
|Guide on how to edit Wiki contents
|
|-
|-
|[[Dev:Defining temporal availability of infrastructure elements and speed profiles]]
|[[Dev:Defining temporal availability of infrastructure elements and speed profiles]]
Line 103: Line 120:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Examples for a non-zero operating day offset at the first ocpTT of a train run]]
|[[Dev:Examples for a non-zero operating day offset at the first ocpTT of a train run]]
Line 109: Line 127:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Downloading and using railML]]
|[[Dev:Downloading and using railML]]
Line 115: Line 134:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Examples]]
|[[Dev:Examples]]
Line 121: Line 141:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Guideline for participating in the development process]]
|[[Dev:Guideline for participating in the development process]]
Line 127: Line 148:
|Experienced users
|Experienced users
|Guide
|Guide
|
|-
|-
|[[Dev:How To Reference Infrastructure]]
|[[Dev:How To Reference Infrastructure]]
Line 133: Line 155:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:How to define track usage of a train in stations]]
|[[Dev:How to define track usage of a train in stations]]
Line 139: Line 162:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Midnight overrun]]
|[[Dev:Midnight overrun]]
Line 145: Line 169:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Multiplicity]]
|[[Dev:Multiplicity]]
Line 151: Line 176:
|New users
|New users
|Concept
|Concept
|
|-
|-
|[[Dev:Reversing trains and formations]]
|[[Dev:Reversing trains and formations]]
Line 157: Line 183:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Semantic Constraints]]
|[[Dev:Semantic Constraints]]
Line 163: Line 190:
|New users
|New users
|Concept
|Concept
|
|-
|-
|[[Dev:Syntactic Guidelines]]
|[[Dev:Syntactic Guidelines]]
Line 169: Line 197:
|Experienced users, railML schema developers
|Experienced users, railML schema developers
|Guide on how to develop railML schema
|Guide on how to develop railML schema
|
|-
|-
|[[Dev:Train Coupling And Sharing]]
|[[Dev:Train Coupling And Sharing]]
Line 175: Line 204:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Types of ocps]]
|[[Dev:Types of ocps]]
Line 181: Line 211:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Use case example]]
|[[Dev:Use case example]]
Line 187: Line 218:
|Experienced users
|Experienced users
|Guide
|Guide
|
|-
|-
|[[Dev:Use cases]]
|[[Dev:Use cases]]
Line 193: Line 225:
|Experienced users
|Experienced users
|Guide
|Guide
|
|-
|-
|[[Dev:XMLtree]]
|[[Dev:XMLtree]]
Line 199: Line 232:
|All
|All
|misc
|misc
|
|-
|-
|[[Dev:attributeSyntax]]
|[[Dev:attributeSyntax]]
Line 205: Line 239:
|Experienced users
|Experienced users
|Guide on how to develop railML schema
|Guide on how to develop railML schema
|
|-
|-
|[[Dev:catalog]]
|[[Dev:catalog]]
Line 211: Line 246:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:categoryUsage]]
|[[Dev:categoryUsage]]
Line 217: Line 253:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:fileConventions]]
|[[Dev:fileConventions]]
Line 223: Line 260:
|New users
|New users
|Concept
|Concept
|
|-
|-
|[[Dev:identities]]
|[[Dev:identities]]
Line 229: Line 267:
|New users
|New users
|Concept
|Concept
|
|-
|-
|[[Dev:outsourcing]]
|[[Dev:outsourcing]]
Line 235: Line 274:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:usingAny]]
|[[Dev:usingAny]]
Line 241: Line 281:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:versioning]]
|[[Dev:versioning]]
|colspan=4|deprecated, redundant towards [[Dev:versions]]!!!
|colspan=4|deprecated, redundant towards [[Dev:versions]]!!!
|
|-
|-
|[[Dev:versions]]
|[[Dev:versions]]
Line 250: Line 292:
|Experienced users
|Experienced users
|Guide
|Guide
|
|-
|-
|[[Dev:Tracks within and between the station]]
|[[Dev:Tracks within and between the station]]
Line 256: Line 299:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Border between infrastructure managers and countries]]
|[[Dev:Border between infrastructure managers and countries]]
Line 262: Line 306:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Railway station ownership]]
|[[Dev:Railway station ownership]]
Line 268: Line 313:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Intersection of lines of different categories]]
|[[Dev:Intersection of lines of different categories]]
Line 274: Line 320:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Usage of the track between the stations]]
|[[Dev:Usage of the track between the stations]]
Line 280: Line 327:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Clearance gauge]]
|[[Dev:Clearance gauge]]
Line 286: Line 334:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Double-track line]]
|[[Dev:Double-track line]]
Line 292: Line 341:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Intermodal terminal]]
|[[Dev:Intermodal terminal]]
Line 298: Line 348:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Maintenance facility]]
|[[Dev:Maintenance facility]]
Line 304: Line 355:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Marshalling yard]]
|[[Dev:Marshalling yard]]
Line 310: Line 362:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Passenger station]]
|[[Dev:Passenger station]]
Line 316: Line 369:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Refueling facility]]
|[[Dev:Refueling facility]]
Line 322: Line 376:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Storage siding]]
|[[Dev:Storage siding]]
Line 328: Line 383:
|New users
|New users
|Guide
|Guide
|
|-
|-
|[[Dev:Timetable example]]
|[[Dev:Timetable example]]
Line 334: Line 390:
|New users
|New users
|Timetable
|Timetable
|
|-
|-
|colspan=4|'''Levels:''' ''new'' (newcomer) or ''exp'' (experienced)
|colspan=6|'''Levels:''' ''new'' (newcomer) or ''exp'' (experienced)
|}
|}


[[Category:GeneralDescription|!]]
[[Category:GeneralDescription|!]]
{{interwiki}}
{{interwiki}}

Revision as of 16:32, 3 March 2025

Guides and Developer Pages
 
This page provides an overview over pages from the Dev-namespace that offer User Guides, information for developers and connected issues.

Title Outline Related Subschemas Target Group Category railML® Version(s)
Certification Reference to the certification procedure All Experienced users Guide
Dev:Codelists Outline of the railML® codelist concept All New users Concept
Dev:InfrastructureManagers Outline of the InfrastructureManagers codelist All New users Concept
Dev:Registers The codelist Registers contains registers, databases, handbooks etc. CO New users Concept
Dev:TrainClearanceGauges The codelist TrainClearaneGauges collects clearance gauge standards. CO New users Concept
Dev:TrainProtectionSystems The codelist TrainProtectionSystems comprises of train protection systems CO New users Concept
Dev:Coding XML Components How to code XML elements, attributes and types All Experienced users, railML schema developers Guide on how to develop railML schema
Dev:CommonDataTypes deprecated
Dev:Common Concepts deprecated
Dev:Connection between tracks Basic infrastructure modelling Concepts IS New users Guide
Dev:Creating_instructions Instructions on how to create e.g. elements in the railML® XML schema in the scope of the development of railML® All Experienced users, railML schema developers Guide on how to develop railML schema
Dev:Defaults List of pages with defaults All New users, Wiki editors Overview of pages, guide on how to edit Wiki contents
Dev:How to join, edit and create the railML wiki Dev:How to join, edit and create the railML® wiki All Experienced users, Wiki editors Guide, guide on how to edit Wiki contents
Dev:Special Wiki Markup templates for referring to a certain railML® element documentation page All Experienced users, Wiki editors Guide on how to edit Wiki contents
Dev:Wiki Documentation Guidelines Guidelines for editing and developing this Wiki All Experienced users, Wiki editors Guide on how to edit Wiki contents
Dev:Units Principles about units of attribute values All New users, Wiki editors Guide on how to edit Wiki contents
Dev:Defining temporal availability of infrastructure elements and speed profiles Representation of general time restrictions using newly introduced attributes in railML® 2.4 IS New users Guide
Dev:Examples for a non-zero operating day offset at the first ocpTT of a train run Examples for a non-zero operating day offset at the first ocpTT of a train run TT New users Guide
Dev:Downloading and using railML Guideline to help you through the first steps in downloading and using railML® All New users Guide
Dev:Examples Where to find, how to use and how to contribute examples All New users Guide
Dev:Guideline for participating in the development process Guideline for participating in the development process All Experienced users Guide
Dev:How To Reference Infrastructure Basic concepts of referencing infrastructure within the timetable subschema TT, IS New users Guide
Dev:How to define track usage of a train in stations How to define track usage by a train in stations TT, IS New users Guide
Dev:Midnight overrun This article explains, how to handle midnight overruns within the timetable subschema TT New users Guide
Dev:Multiplicity How many instances of an element are possible/required? All New users Concept
Dev:Reversing trains and formations Basic concepts of how to handle reversing trains and formations within the timetable subschema TT New users Guide
Dev:Semantic Constraints How to handle rules that do not fit into XSD All New users Concept
Dev:Syntactic Guidelines Syntactic Guidelines for developing the railML® schema All Experienced users, railML schema developers Guide on how to develop railML schema
Dev:Train Coupling And Sharing Basic concepts of coupling and sharing trains TT New users Guide
Dev:Types of ocps How to encode different types of stations in "macro" infrastructure models IS New users Guide
Dev:Use case example Shows and explains the structure of a good use case All Experienced users Guide
Dev:Use cases How to contribute to writing good railML®-Use Cases All Experienced users Guide
Dev:XMLtree Visualization of the complete railML® schema All All misc
Dev:attributeSyntax Correct Syntax for XML attributes, railML schema developers All Experienced users Guide on how to develop railML schema
Dev:catalog Rules for XML catalogs within railML®, how to validate railML file syntactically depending on the tool CO New users Guide
Dev:categoryUsage Basic concepts of train categorization TT New users Guide
Dev:fileConventions Which file name extension shall a railML® file get? CO New users Concept
Dev:identities How to handle id-attributes All New users Concept
Dev:outsourcing How to handle xml:base, inception cross-references in railML2 file All New users Guide
Dev:usingAny On extending the officially published railML® schemas by own needs, e.g. elements, attributes and enumeration values All New users Guide
Dev:versioning deprecated, redundant towards Dev:versions!!!
Dev:versions Everything about our versioning system CO Experienced users Guide
Dev:Tracks within and between the station a way to differentiate between tracks within and between stations using railML2 IS New users Guide
Dev:Border between infrastructure managers and countries Point marking a border between two infrastructure managers IS New users Guide
Dev:Railway station ownership A way to link infrastructure manager with the railway station IS New users Guide
Dev:Intersection of lines of different categories railway stations with tracks between the stations corresponding to lines of different categories IS New users Guide
Dev:Usage of the track between the stations a way to say that primarily passenger trains go on a track between stations IS New users Guide
Dev:Clearance gauge IS New users Guide
Dev:Double-track line a way to model a double-track line at the microscopic and macroscopic levels of aggregation IS New users Guide
Dev:Intermodal terminal IS New users Guide
Dev:Maintenance facility IS New users Guide
Dev:Marshalling yard IS New users Guide
Dev:Passenger station IS New users Guide
Dev:Refueling facility IS New users Guide
Dev:Storage siding IS New users Guide
Dev:Timetable example Draft IS New users Timetable
Levels: new (newcomer) or exp (experienced)