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

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
Line 26: Line 26:


== How to contribute ==
== How to contribute ==
As a registered User, you can edit the railML<sup>®</sup> wiki. Your contributions will be reviewed bevore becoming visible.


=== Edit element documentation sites ===
The principles of editing a wiki are explained {{external|https://meta.wikimedia.org/wiki/Help:Editing_FAQ|here}}.
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 [[CO:Special_Wiki_Markup| railML markup templates]] in your edits. Please refer to the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide user manual] (external link to a different wiki - not railML) for help to edit the wiki.<br>
{{Deu|Um ein einheitliches Layout zu erreichen, nutzen Sie bitte die [[CO:Special_Wiki_Markup| railML Auszeichnungsvorlagen]]. Hilfe zum Bearbeiten des Wikis finden Sie im [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide Benutzerhandbuch] (externer Link zu einem anderen Wiki - nicht railML).}}
 
In most cases the [[:Category:RailML_Documentation | element documentation sites]] are already defined. If not, have a look at the [[Dev:Wiki_Documentation_Guidelines#Start_a_new_railML_Wiki_page_for_a_new_railML_element | Developers Guide for new element documentation sites]].


Please, stick to our common templates to allow vor a standardized documentation. Some essential templates are explained on [[CO:Special_Wiki_Markup|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 [[:Category:RailML_Documentation | element documentation site]], do the following:
In the case you want to change or extend some content on a certain [[:Category:RailML_Documentation | element documentation site]], do the following:


<ol>
*Log in cq register
<li>Go to the certain wiki site</li>
*Go to the certain wiki site
*Choose "Edit"!
*Extend or change the content by deploying the [[CO:Special_Wiki_Markup| railML markup templates]].
:Please respect others work and publish changements prior to the edit in the appropriate {{site|http://forum.railml.org|Forum}}.
:Please be careful (especially with brackets), there are parameters to fill. Sometimes some surprise occurs after a preview.</li>
*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 core of this wiki are pages documenting single railML<sup>®</sup> elements. The framework for such pages is provided by [[template:ElementDocu]]. Please, stick to it as to ensure a corporate layout.


<li>Choose "Edit" or {{Deu | Bearbeiten}}!</li>
In most cases the [[:Category:RailML_Documentation | element documentation sites]] are already defined. If not, have a look at the [[Dev:Wiki_Documentation_Guidelines#Start_a_new_railML_Wiki_page_for_a_new_railML_element | Developers Guide for new element documentation sites]].
 
<li>Extend or change the content by deploying the [[CO:Special_Wiki_Markup| railML markup templates]].
 
Please respect others work and publish changements prior to the edit in the appropriate [http://forum.railml.org Forum].
 
Please be careful (especially with brackets), there are parameters to fill. Sometimes some surprise occurs after a preview.</li>
 
<li>Do the "preview" cycle. All fine?</li>
 
<li>Describe your changes with "Summary" or {{Deu|Zusammenfassung}}</li>
 
<li>Submit your changes with "Save" or {{Deu|Speichern}}</li>
 
<li>Done. Thank you for your contribution.</li>
</ol>
 
=== 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.
 
<ol>
<li>Define the wiki page name in the browser URL:
 
<pre>http://www.wiki.railml.org/index.php?title=<sub-schema-prefix>:<page-name-with-underscores></pre>
 
example: <code><nowiki>http://www.wiki.railml.org/index.php?title=Dev:Wiki_Documentation_Guidelines</nowiki></code> results in http://www.wiki.railml.org/index.php?title=Dev:Wiki_Documentation_Guidelines</li>
 
<li>You get a blank page with the possibility to "Edit".<br>
 
Choose "Edit" or {{Deu | Bearbeiten}}!</li>
<li>Insert the content you may contribute by deploying the  [[CO:Special_Wiki_Markup| railML markup templates]]</li>
 
<li>Do the "preview" cycle. All fine?</li>
 
<li>Describe your changes with "Summary" or {{Deu|Zusammenfassung}}</li>
 
<li>Submit your changes with "Save" or {{Deu|Speichern}}</li>
 
<li>Done. Thank you for your contribution.</li>
</ol>


==Support==
==Support==

Revision as of 11:14, 11 February 2016

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 sight.
  • 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.
  • Please, follow both the common rules of a beneficial coexistence ant the Guidelines of this wiki.

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 full real name (first name(s) followed by your complete last name, like Philip Wobst for example). Nicknames or company names are not accepted.
    • 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 after confirmation by a railML admin you'll 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:Philip_Wobst).

As a registered 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 vor 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 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).