Main Page

From railML 2 Wiki
Revision as of 13:04, 23 January 2014 by RailML Superseded Users (talk | contribs) (→‎FAQ: New entry "Handling identities" added)
Jump to navigation Jump to search

New to railML Wiki / Neu im railML-Wiki

Welcome to the railML.org Wiki / Willkommen im railML.org-Wiki

RailML® is not the finished development of a central group. Instead, railML grows through the joint work of the partners and is steadily being extended. We invite you to participate on this future-oriented project and to take advantage of these standardized interfaces. Our Forum is meant to help coordinate the joint work of the development partners and provides an open discussion platform.

This wiki should supporting the development of railML-schemes. It allows users to create new content and edit existing articles, and setup a comprehensive knowledge database to the railML standard.

All articles must be created in English. Additional German comments are welcomed. The language of the user interface can be changed after login.

In order to ensure a corporate layout, please use the railML markup templates in your edits. Please refer to the user manual (external link to a different wiki - not railML) for help to edit the wiki.

RailML® lebt von der Mitarbeit der Nutzer des Standards. Sie können an der Entwicklung teilhaben und Ihre Bedürfnisse und Erfahrungen in zukünftige railML-Teilschemen einbringen. Unser Diskussionsforum steht Ihnen für allgemeine Fragen zum Projekt oder zu den einzelnen Teilschemen zur Verfügung.
Mit Hilfe dieses Wikis soll der Einstieg in die Entwicklung der railML-Teilschemen erleichtert werden. Es ermöglicht den Benutzern neue Inhalte zu schaffen, sowie vorhandene Beiträge zu bearbeiten und damit eine umfassende Wissensdatenbank zum railML-Standard aufzubauen.
Alle Einträge des Wikis sind in Englisch zu verfassen und gern mit deutschen Hinweisen zu ergänzen. Die Sprache der Benutzeroberfläche lässt sich nach dem Login anpassen.
Um ein einheitliches Layout zu erreichen, nutzen Sie bitte die railML Auszeichnungsvorlagen. Hilfe zum Bearbeiten des Wikis finden Sie im Benutzerhandbuch (externer Link zu einem anderen Wiki - nicht railML).

How to join the Wiki

Joining the Wiki is very easy and only a matter of seconds.

  1. Go to the login page
    • In the upper right corner of this page, you find a link to sign in to this Wiki. If you currently use the German layout of this Wiki, the link is called "Anmelden".
    • Follow that link to get to the login page.
  2. Choose a user name and a password
    • The first two text fields of the login page ask you to enter a user name and a password. The username can be arbitrary, but should be the first letter of your first name followed by a dot and your complete last name (like V.Knollmann for example).
    • Since you are new to Wiki, you must re-enter you password, enter your email address and your real name. That what the lower three text fields are for.
    • Now you can request a new account ("Neues Nutzerkonto anlegen") and are instantly able to work with the Wiki!
  3. Confirm your mail address
    • Immediately after creating a new account, an email is sent to you which contains a link. Click that link to confirm that the mail address you've entered above is really yours.
  4. That's it!
    • You are ready to contribute to the Wiki!
    • If you like to, you can enter some information about you on your personal page. Your personal page's name is Benutzer:Username (like Benutzer:V.Knollmann).

How to contribute

Edit element documentation sites

In most cases the element documentation sites are already defined. If not, have a look at the Developers Guide for new element documentation sites.

In the case you want to change or extend some content on a certain element documentation site, do the following:

  1. Go to the certain wiki site
  2. Choose "Edit" or Bearbeiten!
  3. Extend or change the content by deploying the railML markup templates. Please respect others work and publish changements prior to the edit in the appropriate Forum. Please be careful (especially with brackets), there are parameters to fill. Sometimes some surprise occurs after a preview.
  4. Do the "preview" cycle. All fine?
  5. Describe your changes with "Summary" or Zusammenfassung
  6. Submit your changes with "Save" or Speichern
  7. Done. Thank you for your contribution.

Edit or create FAQ sites

Sometimes more general topics should be summarized covering a bunch of elements. That's a good point to start a FAQ page in the appropriate sub-schema.

  1. Define the wiki page name in the browser URL:
    http://www.wiki.railml.org/index.php?title=<sub-schema-prefix>:<page-name-with-underscores>
    example: http://www.wiki.railml.org/index.php?title=Dev:Wiki_Documentation_Guidelines results in http://www.wiki.railml.org/index.php?title=Dev:Wiki_Documentation_Guidelines
  2. You get a blank page with the possibility to "Edit".
    Choose "Edit" or Bearbeiten!
  3. Insert the content you may contribute by deploying the railML markup templates
  4. Do the "preview" cycle. All fine?
  5. Describe your changes with "Summary" or Zusammenfassung
  6. Submit your changes with "Save" or Speichern
  7. Done. Thank you for your contribution.

Current railML subschema

Infrastructure (IS)

General Information

The Infrastructure subschema contains a data structure for the storage of

  • tracks, switches and the topology of a line
  • various operations and control elements (e. g. signals along the track)
  • tunnels, bridges
  • any kind of "border" (owner change, gauge change, axle load change, electrification, ...)
  • visualization data for displaying a net

Please visit the railML-Website for more detailed information about the Infrastructure subschema or send an email to the coordinator of the subschema.

There is also a "historic" collection of new features for the Infrastructer subschema. It was developed in the preparation works of railML version 1.1. Some of the suggestions are already implemented in the stable railML 2.0 release. Other extensions wait for users with strong needs for them.

Documentation

The following lists provide links to Infrastructure Documentation sites:

FAQ

Some general questions about infrastructure related aspects in railML files are summerized on the following wiki-sites:

Timetable and Rostering (TT)

General Information

The timetable subschema is part of the complete railML schema providing a data structure in XML language for the exchange of railway specific data.

The timetable schema provides container for all data about any kind of timetables for operational or conceptional purposes. A flexible description of operating periods, which are important elements while dealing with timetables, is also included in the schema.

The root element is always <railml>, thus it is even possible to combine data of timetable with those of other RailML schemas within one file. The main element for this schema is <timetable>, which is the root for data about any timetable.

With the new branch of <rosterings> it is intended to use this data schema as well for conceptional rolling stock schedules.

Please visit the railML-Website for more detailed information about the Timetable subschema or send an email to the coordinator of the subschema.

Documentation

The following lists provide links to Timetable Documentation sites:

FAQ

Some general questions about timetable related aspects in railML files are summerized on the following wiki-sites:

Rollingstock (RS)

General Information

The rollingstock subschema is part of the complete railML schema providing a data structure in XML language for the exchange of railway specific data.

The rollingstock schema provides container for all data about any kind of rail vehicles including locomotives, multiple units, passenger and freight wagons. The second part of the schema enables the combination of single vehicles to formations as a fixed composition within a train or an entire train. The root element is always <railml>, thus it is even possible to combine data of rolling stock with those of other RailML schemes within one file. The main element for this schema is <rollingstock>, which is the root for data about any rolling stock.

It is intended to use this data schema for vehicle management as well as for detailed run-time calculations. Depending on the purpose only the <vehicles> branch of the data tree may be populated or the <formations> branch appears or both of them. The <vehicles> branch contains all data related to single vehicles. However, there are data, which are mainly used in relation to a composition of vehicles. Therefore the <formations> branch is used to reflect the characteristics an entire train or a composition of vehicles within a train.

The Rollingstock schema comprises the following features:

  • separate parts for vehicles and for train parts or complete trains
  • possible specification of vehicle families and individual vehicles using the common features of the family
  • different level of detail for data
  1. vehicle as black box (with respect to dynamic characteristics) with only mean values
  2. vehicle as black box (with respect to dynamic characteristics) with curves for particular values being variable within the operating range
  3. vehicle as white box with details about the internal propulsion system
  • vehicles with motive power, for passenger or freight use
  • combination of vehicles to formations, i.e. train parts or complete trains

Please visit the railML-Website for more detailed information about the Rollingstock subschema or send an email to the coordinator of the subschema.

Documentation

The following lists provide links to Timetable Documentation sites:

Common (CO)

General Information

This subschema shall cover all topics, which affect all other railML-schemas alike.

Please visit the railML-Website for more detailed information about the Common subschema or send an email to the coordinator of the subschema.

The actual planned tasks and enhancements can be found at Trac-Tickets of the railML development space.

There is also a "historic" collection of proposed Data Types for the Common subschema. It was developed in the preparation works of railML version 1.1. Some of the suggestions are already implemented in the stable railML 2.0 release. Other extensions wait for users with strong needs for them.

Documentation

The following lists provide links to Common Documentation sites:

FAQ

Some general questions about handling railML files are summerized on the following wiki-sites:

Developers Guides

Proposed railML subschema

Interlocking (IXL)

General Information

This subschema shall store information about typical interlocking data like:

  • train and shunting routes
  • dependencies between signals, blocks and routes
  • switches and derailers affected by a route
  • overlappings

The Interlocking subschema doesn't exist yet but is currently being developed. The discussion related to the development is held in the infrastructure forum (or click here for access via HTTP).

A new phase has started for the development of a railML interlocking subschema. The railML events homepage hosts the presentations of the participants of workgroup meetings. A first XML schema is drafted.

Documentation

The first attempt for documentation is provided at the railML IXL glossary.

An intended features list is stored in the Wiki.

All topics, that are covered by the current developments, will be removed from this features list and described at the glossary instead. Later on, the typical railML documentation with wiki sites for each element will be provided.

Shift planning

Additional to (vehicle) rosterings, there are ideas for implementing (personnel) shift planning.

It should be discussed in the timetable forum (or click here for access via HTTP).


Feel free to direct any comments, questions or remarks via email to the webmaster of railML.

Enjoy the Wiki!