Dev:Guides: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
(-railVIVID)
No edit summary
Line 10: Line 10:
|Reference to the certification procedure
|Reference to the certification procedure
|All
|All
|exp
|experienced
|-
|-
|[[Dev:Codelists]]
|[[Dev:Codelists]]
Line 20: Line 20:
|How to code XML elements, attributes and types
|How to code XML elements, attributes and types
|All
|All
|exp
|experienced
|-
|-
|[[Dev:CommonDataTypes]]
|[[Dev:CommonDataTypes]]
Line 38: Line 38:
|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
|exp
|experienced
|-
|-
|[[Dev:Defaults]]
|[[Dev:Defaults]]
Line 68: Line 68:
|Guideline for participating in the development process
|Guideline for participating in the development process
|All
|All
|exp
|experienced
|-
|-
|[[Dev:How To Reference Infrastructure]]
|[[Dev:How To Reference Infrastructure]]
Line 83: Line 83:
|Dev:How to join, edit and create the {{rml}} wiki
|Dev:How to join, edit and create the {{rml}} wiki
|All
|All
|exp
|experienced
|-
|-
|[[Dev:InfrastructureManagers]]
|[[Dev:InfrastructureManagers]]
Line 103: Line 103:
|Outline of the topologic foundations of {{rml}} 3
|Outline of the topologic foundations of {{rml}} 3
|IS
|IS
|exp
|experienced
|-
|-
|[[Dev:Registers]]
|[[Dev:Registers]]
Line 123: Line 123:
|templates for referring to a certain {{rml}} element documentation page
|templates for referring to a certain {{rml}} element documentation page
|All
|All
|exp
|experienced
|-
|-
|[[Dev:Subversion Guidelines]]
|[[Dev:Subversion Guidelines]]
|Subversion Guidelines
|Subversion Guidelines
|All
|All
|exp
|experienced
|-
|-
|[[Dev:Syntactic Guidelines]]
|[[Dev:Syntactic Guidelines]]
|Syntactic Guidelines for developing the {{rml}} schema
|Syntactic Guidelines for developing the {{rml}} schema
|All
|All
|exp
|experienced
|-
|-
|[[Dev:TrainClearanceGauges]]
|[[Dev:TrainClearanceGauges]]
Line 163: Line 163:
|Shows and explains the structure of a good use case
|Shows and explains the structure of a good use case
|All
|All
|exp
|experienced
|-
|-
|[[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
|exp
|experienced
|-
|-
|[[Dev:Wiki Documentation Guidelines]]
|[[Dev:Wiki Documentation Guidelines]]
|Guidelines for editing and developing this Wiki
|Guidelines for editing and developing this Wiki
|All
|All
|exp
|experienced
|-
|-
|[[Dev:XMLtree]]
|[[Dev:XMLtree]]
Line 183: Line 183:
|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
|exp
|experienced
|-
|-
|[[Dev:attributeSyntax]]
|[[Dev:attributeSyntax]]
|Correct Syntax for XML attributes
|Correct Syntax for XML attributes
|All
|All
|exp
|experienced
|-
|-
|[[Dev:catalog]]
|[[Dev:catalog]]
|Rules for XML catalogs within {{rml}}
|Rules for XML catalogs within {{rml}}
|CO
|CO
|exp
|experienced
|-
|-
|[[Dev:categoryUsage]]
|[[Dev:categoryUsage]]
Line 203: Line 203:
|Schema changes by topic that influence the XML output
|Schema changes by topic that influence the XML output
|All
|All
|exp
|experienced
|-
|-
|[[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
|exp
|experienced
|-
|-
|[[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
|exp
|experienced
|-
|-
|[[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
|exp
|experienced
|-
|-
|[[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
|exp
|experienced
|-
|-
|[[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
|exp
|experienced
|-
|-
|[[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
|exp
|experienced
|-
|-
|[[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
|exp
|experienced
|-
|-
|[[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
|exp
|experienced
|-
|-
|[[Dev:fileConventions]]
|[[Dev:fileConventions]]
Line 268: Line 268:
|Redundant towards [[Dev:versions]]!!!
|Redundant towards [[Dev:versions]]!!!
|CO
|CO
|exp
|experienced
|-
|-
|[[Dev:versions]]
|[[Dev:versions]]
|Everything about our versioning system
|Everything about our versioning system
|CO
|CO
|exp
|experienced
|-
|-
|colspan=4|'''Levels:''' ''new'' (newcomer) or ''exp'' (experienced)
|colspan=4|'''Levels:''' ''new'' (newcomer) or ''exp'' (experienced)

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