Dev:versioning: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
m (Template changed: Update --> Outdated)
m (typo)
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Download railML ==
{{navi}}
{{Outdated}}
{{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 ===
=== Current stable release ===


In order to get the current stable railML package, click ''Download released version'' on the [http://www.railml.org/ railML homepage].
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.


The package consists of an zip archive containing:
'''Current stable releases are {{rml}} {{current|2}} and {{rml}} {{current|3}} respectively.'''


* XML Schema files in <tt>schema</tt> folder
=== Exchange a {{rml}} file based on unstable schemas ===
* XML example files in <tt>examples</tt> folder
* HTML documentation in <tt>documentation</tt> folder


Current stable release is railML 2.2.
The following XML fragment shows how to exchange {{rml}} files using unstable {{rml}} schemas.
 
=== Older stable releases ===
 
Older officially released railML versions are archived at the [http://www.railml.org/ railML homepage]. Click ''Development > Download > archives'' or [http://www.railml.org/index.php/download-archive.html this direct link].
 
All downloads are zip archived.
 
=== Developer unstable releases ===
 
Since railML 1.1 the development of railML can be publicly supervised through the public subversion repository located at [https://svn.railml.org|railML's SVN].
Please note: The old server at [http://www.assembla.com/spaces/railML/ www.assembla.com] is not longer in use since March 2014.
 
[http://subversion.apache.org/ Subversion] is an open source version control system. All code changes are registered with date and time together with its commiter and a commit log message.
 
==== Regularly downloads ====
 
If you want to keep track of all code commits, you should use an subversion client. Until a new user management tool is installed at [http://www.railML.org|railML's website], the access at [https://svn.railml.org railML's SVN] is possible only for the railML coordinators.
 
* Change to your local railML folder.
* First time: checkout the current repository (all changes since version 1.1 - lasted 45 seconds up to revision 611).
*:<pre>svn co https://svn.railml.org/</pre>
* Further: update your local repository copy as often as you want (all recent changes since last svn update).
*:<pre>svn up https://svn.railml.org/</pre>
 
You get railML files according to its [[#Subversion_repository_folders | repository folders]].
 
==== Most recent snapshot ====
 
If you don't run an subversion client, you can nevertheless get a copy of the most recent developer version.
 
Simply click ''Developer version'' on the [http://www.railml.org/ railML homepage] to download an zip archive of repositories' [[#trunk | <tt>trunk</tt> folder]].
 
The zip archive contains:
 
* Current XML Schema files in <tt>schema</tt> folder
* Current XML example files in <tt>examples</tt> folder
* Current defect XML sample files for semantic validation purposes in <tt>defectSamples</tt> folder
* blank <tt>documentation</tt> folder
 
==== Exchange a railML file based on unstable schemas ====
 
The following XML fragment shows how to exchange railML files using unstable railML schemas.


<pre>
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<railml version="2.1r416"
<railml version="2.1r416"
   xmlns="http://www.railml.org/schemas/2011"  
   xmlns="https://www.railml.org/schemas/2011"  
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://www.railml.org/schemas/2011 https://svn.railml.org/export/416/trunk/schema/railML.xsd">
   xsi:schemaLocation="https://www.railml.org/schemas/2011 https://svn.railml.org/export/416/trunk/schema/railML.xsd">
   ...
   ...
</railml>
</railml>
Line 67: Line 24:
* Use the last released version number plus the current SVN number: {{Attr|version<nowiki>=</nowiki>"2.1r416"}}
* Use the last released version number plus the current SVN number: {{Attr|version<nowiki>=</nowiki>"2.1r416"}}
* Use the last released namespace
* Use the last released namespace
** as default namespace: {{Attr|xmlns<nowiki>="http://www.railml.org/schemas/2011"</nowiki>}}
** as default namespace: {{Attr|xmlns<nowiki>="https://www.railml.org/schemas/2011"</nowiki>}}
** as prefixed namespace: {{Attr|xmlns:rail<nowiki>="http://www.railml.org/schemas/2011</nowiki>"}} (not shown above)
** 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 Assembla: {{Attr|xsi:schemaLocation<nowiki>="http://www.railml.org/schemas/2011 https://svn.railml.org/export/416/trunk/schema/railML.xsd"</nowiki>}}
* 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 [[CO:catalog|Local versus web-based validation (XML catalogs and XML namespaces)]]
 
For more information on how to use version numbers and namespaces, see [[CO:versions|Recommendations on version numbers]].
 
== Supervise current development without download ==
 
The public web-based Subversion repository offers public supervision of current development without downloading files.
 
=== List of recent code changes ===
 
[to be written]
 
=== Browse the source files ===
 
[to be written]
 
=== Revision log ===
 
[to be written]
 
== Subversion repository folders ==
 
=== trunk ===
 
The /trunk/ directory contains the source files that the next public and stable project release is based on.
 
=== tags ===


The /tags/ directory contains snapshots of public and stable project versions that have been released.
For local validation purposes, see [[dev:catalog|Local versus web-based validation (XML catalogs and XML namespaces)]]


=== branches ===
For more information on how to use version numbers and namespaces, see [[dev:versions|Recommendations on version numbers]].


The /trunk/ directory contains the source files that the next public and stable project release is based on.  
==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}}.
}}


Back to [[Hauptseite#Common_.28CO.29| Common overview]]
[[Category:GeneralDescription]]
[[Category:GeneralDescription]]
[[category:Common Concept]]

Latest revision as of 09: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
railML® 3 Wiki – RailTopoModel® Wiki
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 page. Coordination (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].
Retrieved from "https://wiki2.railml.org/index.php?title=Dev:versioning&oldid=15417"