Dev:Examples

From wiki.railML.org
Jump to: navigation, search

Examples

Like pictures, illustrative examples can say more than a thousand words. Therefore, they can be valuable to grasp the concepts of railML®.

The railML®-initiative tries to support you with helpful examples. To enrich our stock we highly appreciate if you share your examples with us.

To learn where to find, how to use and how to contribute use cases see Dev:Use cases. While use cases follow a top down approach, explaining the context, examples follow a bottom up approach, explaining a punctual sollution. Typical use cases are formulated narratively; the core of an example is railML® code.

Where to find examples

How to contribute examples

  • It is recommended to arrange your example in advance with the coordinators as to avoid futile efforts.
  • Please, only submit examples from certified applications. You can inform about the certification procedure here.
  • Generally, examples are more illustrative, if they have a real background.
  • As a general rule, minimal examples are more convenient to convey the principles of railML®. Comprehensive examples are appreciated too, as to test the limmitations of applications.
  • Good examples contain
    • a brief description (abstract)
    • information of the content (number, formats and functions of files)
    • a railML® file
    • a human readable presentation or visualisation
    • a comprehensive explanation
  • Please, submit your example either to the respective subschema coordinator, or to the railML® coordinator. For the contact details see https://www.railml.org/en/user/subschemes.html (link to the railML® website).
  • a list of good examples (in German; mostly without connection to railML®) can be found on http://irfp.de/beispiele.html (external link, German flag.png, visited on 2018-03-27; by Dirk Bräuer, iRFP Dresden)