Dev:versioning: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
({{mirror}})
m (typo)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{mirror}}
{{navi}}
{{Outdated|date=2022|topic=SVN is not longer in use; {{rml}}'s Gitlab structure is different|user=[[User:Coordination|Coordination]] ([[User talk:Coordination|talk]]) 11:37, 26 September 2022 (CEST)}}
{{note|The subject of this article is accessing, setting and naming developer versions. To learn about published {{rml}} versions and about our release policy, see [[dev:versions]].}}
=== Current stable release ===
 
In order to get the current stable {{rml}} package, go to {{site|https://www.railml.org/en/download.html|the Download section}} whilst logged on.
 
'''Current stable releases are {{rml}} {{current|2}} and {{rml}} {{current|3}} respectively.'''
 
=== Exchange a {{rml}} file based on unstable schemas ===
 
The following XML fragment shows how to exchange {{rml}} files using unstable {{rml}} schemas.
 
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<railml version="2.1r416"
  xmlns="https://www.railml.org/schemas/2011"
  xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="https://www.railml.org/schemas/2011 https://svn.railml.org/export/416/trunk/schema/railML.xsd">
  ...
</railml>
</pre>
 
* Use the last released version number plus the current SVN number: {{Attr|version<nowiki>=</nowiki>"2.1r416"}}
* Use the last released namespace
** as default namespace: {{Attr|xmlns<nowiki>="https://www.railml.org/schemas/2011"</nowiki>}}
** as prefixed namespace: {{Attr|xmlns:rail<nowiki>="https://www.railml.org/schemas/2011</nowiki>"}} (not shown above)
* Use the appropriate web-based Schema location at railML.org: {{Attr|xsi:schemaLocation<nowiki>="https://www.railml.org/schemas/2011 https://svn.railml.org/export/416/trunk/schema/railML.xsd"</nowiki>}}
 
For local validation purposes, see [[dev:catalog|Local versus web-based validation (XML catalogs and XML namespaces)]]
 
For more information on how to use version numbers and namespaces, see [[dev:versions|Recommendations on version numbers]].
 
==Note on legacy SVN commits==
{{note|1=In 2021 the {{rml}} development was migrated from {{wiki|Apache Subversion|SVN}} to {{wiki|GitLab}}. Identical commits have different numbers on SVN and GitLab respectively. [[Template:SVN]] still allows to find SVN commit numbers in GitLab via the search function. For instance SVN commit 416 corresponds to GitLab commit 5f735749. You will be directed to a search page, where the (usually unique) hit can be clicked or the commitment number can be copied. E.g. <nowiki>{{SVN|416|2}}</nowiki> [https://development.railml.org/search?project_id=4&scope=commits&search=%40416 <nowiki>[</nowiki>416<nowiki>]</nowiki>] will present a page linking to the page of GitLab commit <nowiki>{{commit|5f735749}}</nowiki> {{commit|5f735749}}.
}}
 
[[Category:GeneralDescription]]
[[category:Common Concept]]

Latest revision as of 10:42, 13 March 2024

RailML Trademark RGB V2.png
XML Railway exchange format
https://railML.org
Latest release: 2.5
(September 1st, 2021)
 
Main Menu
 
Subschemas
XML tree
UML diagrams
Use cases
Versions & Changes
Outdated.png Part of the article content is outdated since 2022. SVN is not longer in use; railML®'s Gitlab structure is different. Please update this article to reflect recent events or newly available information. Possibly, you will find further details on the discussion pageCoordination (talk) 11:37, 26 September 2022 (CEST)
🗒️ The subject of this article is accessing, setting and naming developer versions. To learn about published railML® versions and about our release policy, see dev:versions.

Current stable release

In order to get the current stable railML® package, go to the Download section (link to the railML® website) whilst logged on.

Current stable releases are railML® 2.5 and railML® 3.2 respectively.

Exchange a railML® file based on unstable schemas

The following XML fragment shows how to exchange railML® files using unstable railML® schemas.

<?xml version="1.0" encoding="UTF-8"?>
<railml version="2.1r416"
  xmlns="https://www.railml.org/schemas/2011" 
  xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="https://www.railml.org/schemas/2011 https://svn.railml.org/export/416/trunk/schema/railML.xsd">
  ...
</railml>
  • Use the last released version number plus the current SVN number: version="2.1r416"
  • Use the last released namespace
    • as default namespace: xmlns="https://www.railml.org/schemas/2011"
    • as prefixed namespace: xmlns:rail="https://www.railml.org/schemas/2011" (not shown above)
  • Use the appropriate web-based Schema location at railML.org: xsi:schemaLocation="https://www.railml.org/schemas/2011 https://svn.railml.org/export/416/trunk/schema/railML.xsd"

For local validation purposes, see Local versus web-based validation (XML catalogs and XML namespaces)

For more information on how to use version numbers and namespaces, see Recommendations on version numbers.

Note on legacy SVN commits

🗒️ In 2021 the railML® development was migrated from SVN (Wiki banner.png) to GitLab (Wiki banner.png). Identical commits have different numbers on SVN and GitLab respectively. Template:SVN still allows to find SVN commit numbers in GitLab via the search function. For instance SVN commit 416 corresponds to GitLab commit 5f735749. You will be directed to a search page, where the (usually unique) hit can be clicked or the commitment number can be copied. E.g. {{SVN|416|2}} [416] will present a page linking to the page of GitLab commit {{commit|5f735749}} [5f735749].