Dev:Guides: Difference between revisions
Jump to navigation
Jump to search
[checked revision] | [checked revision] |
No edit summary |
No edit summary |
||
Line 5: | Line 5: | ||
!Outline | !Outline | ||
!Related Subschemas | !Related Subschemas | ||
! | !Target Group | ||
|- | |- | ||
|{{site|https://www.railml.org/en/developer/certification.html|certification|inlang=silent}} | |{{site|https://www.railml.org/en/developer/certification.html|certification|inlang=silent}} | ||
|Reference to the certification procedure | |Reference to the certification procedure | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:Codelists]] | |[[Dev:Codelists]] | ||
|Outline of the {{rml}} codelist concept | |Outline of the {{rml}} codelist concept | ||
|All | |All | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Coding XML Components]] | |[[Dev:Coding XML Components]] | ||
|How to code XML elements, attributes and types | |How to code XML elements, attributes and types | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:CommonDataTypes]] | |[[Dev:CommonDataTypes]] | ||
Line 28: | Line 28: | ||
|Common concepts to all {{rml}} schemas | |Common concepts to all {{rml}} schemas | ||
|All | |All | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Connection between tracks]] | |[[Dev:Connection between tracks]] | ||
|Basic infrastructure modelling Concepts | |Basic infrastructure modelling Concepts | ||
|IS | |IS | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Creating_instructions]] | |[[Dev:Creating_instructions]] | ||
|Creating instructions for the {{rml}} XML schema in the scope of the [[Dev:Guideline for participating in the development process|development of {{rml}}]] | |Creating instructions for the {{rml}} XML schema in the scope of the [[Dev:Guideline for participating in the development process|development of {{rml}}]] | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:Defaults]] | |[[Dev:Defaults]] | ||
|List of pages with defaults | |List of pages with defaults | ||
|All | |All | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Defining temporal availability of infrastructure elements and speed profiles]] | |[[Dev:Defining temporal availability of infrastructure elements and speed profiles]] | ||
|Representation of general time restrictions using newly introduced attributes in {{rml}} 2.4 | |Representation of general time restrictions using newly introduced attributes in {{rml}} 2.4 | ||
|IS | |IS | ||
| | |New users | ||
|- | |- | ||
|[[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]] | ||
|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 | |TT | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Downloading and using railML]] | |[[Dev:Downloading and using railML]] | ||
|Guideline to help you through the first steps in downloading and using {{rml}} | |Guideline to help you through the first steps in downloading and using {{rml}} | ||
|All | |All | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Examples]] | |[[Dev:Examples]] | ||
|Where to find, how to use and how to contribute examples | |Where to find, how to use and how to contribute examples | ||
|All | |All | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Guideline for participating in the development process]] | |[[Dev:Guideline for participating in the development process]] | ||
|Guideline for participating in the development process | |Guideline for participating in the development process | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:How To Reference Infrastructure]] | |[[Dev:How To Reference Infrastructure]] | ||
|Basic concepts of referencing infrastructure within the timetable subschema | |Basic concepts of referencing infrastructure within the timetable subschema | ||
|TT, IS | |TT, IS | ||
| | |New users | ||
|- | |- | ||
|[[Dev:How to define track usage of a train in stations]] | |[[Dev:How to define track usage of a train in stations]] | ||
|How to define track usage of a train in stations | |How to define track usage of a train in stations | ||
|TT, IS | |TT, IS | ||
| | |New users | ||
|- | |- | ||
|[[Dev:How to join, edit and create the railML wiki]] | |[[Dev:How to join, edit and create the railML wiki]] | ||
|Dev:How to join, edit and create the {{rml}} wiki | |Dev:How to join, edit and create the {{rml}} wiki | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:InfrastructureManagers]] | |[[Dev:InfrastructureManagers]] | ||
|Outline of the InfrastructureManagers codelist | |Outline of the InfrastructureManagers codelist | ||
|All | |All | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Midnight overrun]] | |[[Dev:Midnight overrun]] | ||
|This article explains, how to handle midnight overruns within the timetable subschema | |This article explains, how to handle midnight overruns within the timetable subschema | ||
|TT | |TT | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Multiplicity]] | |[[Dev:Multiplicity]] | ||
|How many instances of an element are possible/required? | |How many instances of an element are possible/required? | ||
|All | |All | ||
| | |New users | ||
|- | |- | ||
|[[Dev:RailTopoModel]] | |[[Dev:RailTopoModel]] | ||
|Outline of the topologic foundations of {{rml}} 3 | |Outline of the topologic foundations of {{rml}} 3 | ||
|IS | |IS | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:Registers]] | |[[Dev:Registers]] | ||
|The [[dev:codelist|codelist]] '''Registers''' contains registers, databases, handbooks etc. | |The [[dev:codelist|codelist]] '''Registers''' contains registers, databases, handbooks etc. | ||
|CO | |CO | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Reversing trains and formations]] | |[[Dev:Reversing trains and formations]] | ||
|Basic concepts of how to handle reversing trains and formations within the timetable subschema | |Basic concepts of how to handle reversing trains and formations within the timetable subschema | ||
|TT | |TT | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Semantic Constraints]] | |[[Dev:Semantic Constraints]] | ||
|How to handle rules that do not fit into XSD | |How to handle rules that do not fit into XSD | ||
|All | |All | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Special Wiki Markup]] | |[[Dev:Special Wiki Markup]] | ||
|templates for referring to a certain {{rml}} element documentation page | |templates for referring to a certain {{rml}} element documentation page | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:Subversion Guidelines]] | |[[Dev:Subversion Guidelines]] | ||
|Subversion Guidelines | |Subversion Guidelines | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:Syntactic Guidelines]] | |[[Dev:Syntactic Guidelines]] | ||
|Syntactic Guidelines for developing the {{rml}} schema | |Syntactic Guidelines for developing the {{rml}} schema | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:TrainClearanceGauges]] | |[[Dev:TrainClearanceGauges]] | ||
|The [[dev:codelists|codelist]] '''TrainClearaneGauges''' collects clearance gauge standards. | |The [[dev:codelists|codelist]] '''TrainClearaneGauges''' collects clearance gauge standards. | ||
|CO | |CO | ||
| | |New users | ||
|- | |- | ||
|[[Dev:TrainProtectionSystems]] | |[[Dev:TrainProtectionSystems]] | ||
|The [[dev:codelists|codelist]] '''TrainProtectionSystems''' comprises of train protection systems | |The [[dev:codelists|codelist]] '''TrainProtectionSystems''' comprises of train protection systems | ||
|CO | |CO | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Train Coupling And Sharing]] | |[[Dev:Train Coupling And Sharing]] | ||
|Basic concepts of coupling and sharing trains | |Basic concepts of coupling and sharing trains | ||
|TT | |TT | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Types of ocps]] | |[[Dev:Types of ocps]] | ||
|How to encode different types of stations in "macro" infrastructure models | |How to encode different types of stations in "macro" infrastructure models | ||
|IS | |IS | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Units]] | |[[Dev:Units]] | ||
|Principles about units of attribute values | |Principles about units of attribute values | ||
|All | |All | ||
| | |New users | ||
|- | |- | ||
|[[Dev:Use case example]] | |[[Dev:Use case example]] | ||
|Shows and explains the structure of a good use case | |Shows and explains the structure of a good use case | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:Use cases]] | |[[Dev:Use cases]] | ||
|How to contribute to writing good {{rml}}-[[UC:Use cases|Use Cases]] | |How to contribute to writing good {{rml}}-[[UC:Use cases|Use Cases]] | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:Wiki Documentation Guidelines]] | |[[Dev:Wiki Documentation Guidelines]] | ||
|Guidelines for editing and developing this Wiki | |Guidelines for editing and developing this Wiki | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:XMLtree]] | |[[Dev:XMLtree]] | ||
|Visualization of the complete {{rml}} schema | |Visualization of the complete {{rml}} schema | ||
|All | |All | ||
| | |New users | ||
|- | |- | ||
|[[Dev:XMLtree/2.3]] | |[[Dev:XMLtree/2.3]] | ||
|Visualization of the schema of the older, but still supported {{rml}} version 2.3 | |Visualization of the schema of the older, but still supported {{rml}} version 2.3 | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:attributeSyntax]] | |[[Dev:attributeSyntax]] | ||
|Correct Syntax for XML attributes | |Correct Syntax for XML attributes | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:catalog]] | |[[Dev:catalog]] | ||
|Rules for XML catalogs within {{rml}} | |Rules for XML catalogs within {{rml}} | ||
|CO | |CO | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:categoryUsage]] | |[[Dev:categoryUsage]] | ||
|Basic concepts of train categorization | |Basic concepts of train categorization | ||
|TT | |TT | ||
| | |New users | ||
|- | |- | ||
|[[Dev:changes]] | |[[Dev:changes]] | ||
|Schema changes by topic that influence the XML output | |Schema changes by topic that influence the XML output | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:changes/2.1]] | |[[Dev:changes/2.1]] | ||
|{{rml}} schema changes between {{rml}} 2.0 and {{rml}} 2.1 | |{{rml}} schema changes between {{rml}} 2.0 and {{rml}} 2.1 | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:changes/2.1/diff]] | |[[Dev:changes/2.1/diff]] | ||
|''diff'' output between {{rml}} 2.0 and {{rml}} 2.1 | |''diff'' output between {{rml}} 2.0 and {{rml}} 2.1 | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:changes/2.2]] | |[[Dev:changes/2.2]] | ||
|{{rml}} schema changes between {{rml}} 2.1 and {{rml}} 2.2 | |{{rml}} schema changes between {{rml}} 2.1 and {{rml}} 2.2 | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:changes/2.2/diff]] | |[[Dev:changes/2.2/diff]] | ||
|''diff'' output between {{rml}} 2.1 and {{rml}} 2.2 | |''diff'' output between {{rml}} 2.1 and {{rml}} 2.2 | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:changes/2.3]] | |[[Dev:changes/2.3]] | ||
|{{rml}} schema changes between {{rml}} 2.2 and {{rml}} 2.3 | |{{rml}} schema changes between {{rml}} 2.2 and {{rml}} 2.3 | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:changes/2.3/diff]] | |[[Dev:changes/2.3/diff]] | ||
|''diff'' output between {{rml}} 2.2 and {{rml}} 2.3 | |''diff'' output between {{rml}} 2.2 and {{rml}} 2.3 | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:changes/2.4]] | |[[Dev:changes/2.4]] | ||
|{{rml}} schema changes between {{rml}} 2.3 and {{rml}} 2.4 | |{{rml}} schema changes between {{rml}} 2.3 and {{rml}} 2.4 | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:changes/2.4/diff]] | |[[Dev:changes/2.4/diff]] | ||
|''diff'' output between {{rml}} 2.3 and {{rml}} 2.4 | |''diff'' output between {{rml}} 2.3 and {{rml}} 2.4 | ||
|All | |All | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:fileConventions]] | |[[Dev:fileConventions]] | ||
|Which file name extension shall a {{rml}} file get? | |Which file name extension shall a {{rml}} file get? | ||
|CO | |CO | ||
| | |New users | ||
|- | |- | ||
|[[Dev:identities]] | |[[Dev:identities]] | ||
|How to handle {{attr|id}}-attributes | |How to handle {{attr|id}}-attributes | ||
|All | |All | ||
| | |New users | ||
|- | |- | ||
|[[Dev:outsourcing]] | |[[Dev:outsourcing]] | ||
|How to handle ''xml:base'' | |How to handle ''xml:base'' | ||
|All | |All | ||
| | |New users | ||
|- | |- | ||
|[[Dev:usingAny]] | |[[Dev:usingAny]] | ||
|On extending the officially published railML schemas by own needs, e.g. elements, attributes and enumeration values | |On extending the officially published railML schemas by own needs, e.g. elements, attributes and enumeration values | ||
|All | |All | ||
| | |New users | ||
|- | |- | ||
|[[Dev:versioning]] | |[[Dev:versioning]] | ||
|Redundant towards [[Dev:versions]]!!! | |Redundant towards [[Dev:versions]]!!! | ||
|CO | |CO | ||
| | |Experienced users | ||
|- | |- | ||
|[[Dev:versions]] | |[[Dev:versions]] | ||
|Everything about our versioning system | |Everything about our versioning system | ||
|CO | |CO | ||
| | |Experienced users | ||
|- | |- | ||
|colspan=4|'''Levels:''' ''new'' (newcomer) or ''exp'' (experienced) | |colspan=4|'''Levels:''' ''new'' (newcomer) or ''exp'' (experienced) |
Revision as of 17:05, 15 December 2022
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 |
---|---|---|---|
certification | Reference to the certification procedure | All | Experienced users |
Dev:Codelists | Outline of the railML® codelist concept | All | New users |
Dev:Coding XML Components | How to code XML elements, attributes and types | All | Experienced users |
Dev:CommonDataTypes | deprecated | ||
Dev:Common Concepts | Common concepts to all railML® schemas | All | New users |
Dev:Connection between tracks | Basic infrastructure modelling Concepts | IS | New users |
Dev:Creating_instructions | Creating instructions for the railML® XML schema in the scope of the development of railML® | All | Experienced users |
Dev:Defaults | List of pages with defaults | All | New users |
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 |
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 |
Dev:Downloading and using railML | Guideline to help you through the first steps in downloading and using railML® | All | New users |
Dev:Examples | Where to find, how to use and how to contribute examples | All | New users |
Dev:Guideline for participating in the development process | Guideline for participating in the development process | All | Experienced users |
Dev:How To Reference Infrastructure | Basic concepts of referencing infrastructure within the timetable subschema | TT, IS | New users |
Dev:How to define track usage of a train in stations | How to define track usage of a train in stations | TT, IS | New users |
Dev:How to join, edit and create the railML wiki | Dev:How to join, edit and create the railML® wiki | All | Experienced users |
Dev:InfrastructureManagers | Outline of the InfrastructureManagers codelist | All | New users |
Dev:Midnight overrun | This article explains, how to handle midnight overruns within the timetable subschema | TT | New users |
Dev:Multiplicity | How many instances of an element are possible/required? | All | New users |
Dev:RailTopoModel | Outline of the topologic foundations of railML® 3 | IS | Experienced users |
Dev:Registers | The codelist Registers contains registers, databases, handbooks etc. | CO | New users |
Dev:Reversing trains and formations | Basic concepts of how to handle reversing trains and formations within the timetable subschema | TT | New users |
Dev:Semantic Constraints | How to handle rules that do not fit into XSD | All | New users |
Dev:Special Wiki Markup | templates for referring to a certain railML® element documentation page | All | Experienced users |
Dev:Subversion Guidelines | Subversion Guidelines | All | Experienced users |
Dev:Syntactic Guidelines | Syntactic Guidelines for developing the railML® schema | All | Experienced users |
Dev:TrainClearanceGauges | The codelist TrainClearaneGauges collects clearance gauge standards. | CO | New users |
Dev:TrainProtectionSystems | The codelist TrainProtectionSystems comprises of train protection systems | CO | New users |
Dev:Train Coupling And Sharing | Basic concepts of coupling and sharing trains | TT | New users |
Dev:Types of ocps | How to encode different types of stations in "macro" infrastructure models | IS | New users |
Dev:Units | Principles about units of attribute values | All | New users |
Dev:Use case example | Shows and explains the structure of a good use case | All | Experienced users |
Dev:Use cases | How to contribute to writing good railML®-Use Cases | All | Experienced users |
Dev:Wiki Documentation Guidelines | Guidelines for editing and developing this Wiki | All | Experienced users |
Dev:XMLtree | Visualization of the complete railML® schema | All | New users |
Dev:XMLtree/2.3 | Visualization of the schema of the older, but still supported railML® version 2.3 | All | Experienced users |
Dev:attributeSyntax | Correct Syntax for XML attributes | All | Experienced users |
Dev:catalog | Rules for XML catalogs within railML® | CO | Experienced users |
Dev:categoryUsage | Basic concepts of train categorization | TT | New users |
Dev:changes | Schema changes by topic that influence the XML output | All | Experienced users |
Dev:changes/2.1 | railML® schema changes between railML® 2.0 and railML® 2.1 | All | Experienced users |
Dev:changes/2.1/diff | diff output between railML® 2.0 and railML® 2.1 | All | Experienced users |
Dev:changes/2.2 | railML® schema changes between railML® 2.1 and railML® 2.2 | All | Experienced users |
Dev:changes/2.2/diff | diff output between railML® 2.1 and railML® 2.2 | All | Experienced users |
Dev:changes/2.3 | railML® schema changes between railML® 2.2 and railML® 2.3 | All | Experienced users |
Dev:changes/2.3/diff | diff output between railML® 2.2 and railML® 2.3 | All | Experienced users |
Dev:changes/2.4 | railML® schema changes between railML® 2.3 and railML® 2.4 | All | Experienced users |
Dev:changes/2.4/diff | diff output between railML® 2.3 and railML® 2.4 | All | Experienced users |
Dev:fileConventions | Which file name extension shall a railML® file get? | CO | New users |
Dev:identities | How to handle id-attributes | All | New users |
Dev:outsourcing | How to handle xml:base | All | New users |
Dev:usingAny | On extending the officially published railML schemas by own needs, e.g. elements, attributes and enumeration values | All | New users |
Dev:versioning | Redundant towards Dev:versions!!! | CO | Experienced users |
Dev:versions | Everything about our versioning system | CO | Experienced users |
Levels: new (newcomer) or exp (experienced) |