Dev:How to join, edit and create the railML wiki

From railML 2 Wiki
Jump to navigation Jump to search
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.
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.

Principles

  • The working language of this wiki is Englisch. The complete content should be covered in English. Translations in German and French are welcome, but should not deliver additional content. Please, employ Template:Deu for German content and Template:Fra for french content, as to make the languages distinguishable at first glance.
  • As a small community we have a real name policy and give writing privileges only to registered Users. The registration procedure is explained below. Edits will become visible to the public only after review. If you decide not to register we will yet appreciate your feedback via e-mail.
  • Please, follow both the common rules of a beneficial coexistence and the Guidelines of this wiki.

How to join the Wiki

To obtain editing privileges on the railML® wiki you have to register with railML.org (link to the railML® website) and then ask for a wiki account. Please, understand that we have decided not to give writing privileges to everyone, as to avoid vandalism.

  • Register at http://www.railml.org/en/login-registration.html (link to the railML® website)
  • Send an e-mail to the coordinator (coordination ät raiML dot org). We appreciate you explaining us your position and motivation.
  • The coordinator will send you your login information via e-mail
  • log in here
  • Now you can start contributing

As a logged in user, you can set the interface language here.

How to contribute

As a registered User, you can edit the railML® wiki. Your contributions will be reviewed bevore becoming visible.

The principles of editing a wiki are explained here (external link).

Please, stick to our common templates to allow for a standardized documentation. Some essential templates are explained on railML markup templates. Especially, employ template:external for external links.

Edit a page

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

  • Log in cq register
  • Go to the certain wiki site
  • Choose "Edit"!
  • 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 (link to the railML® website).
Please be careful (especially with brackets), there are parameters to fill. Sometimes some surprise occurs after a preview.
  • Do the "preview" cycle. All fine?
  • Describe your changes with "Summary".
  • Submit your changes with "Save"
  • Done. Thank you for your contribution.

Edit element documentation sites

The railML® wiki should document the actual state of railML®.

Please, describe only elements that already exist! Don't start articles about elements that are only in discussion or in development! You can start describing new elements as soon as they are part of a release candidate version of railML®.

The core of this wiki are pages documenting single railML® elements. The framework for such pages is provided by template:ElementDocu. Please, stick to it as to ensure a corporate layout.

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

Support

We appreciate your interest to contribute to the railML® wiki and will try to support you.

  • A documentation for the mediawiki sofware which is the basis of this wiki can be found here (external link).
  • Please, follow our Wiki Documentation Guidelines.
  • Questions referring to the use of this wiki are welcome on the discussion page.
  • Please, be responsible with contacting the webmaster (webmaster ät railml dot org).