Dev:Wiki Documentation Guidelines

Start a new railML Wiki page for a new railML element

Adjust the XML tree

1. Go to the XML tree wiki page
2. Press "Edit" or Bearbeiten
3. Crawl to the right position in the railML tree
   Instead of scrolling there, it's easier to "search" for the parent element
4. Insert the new element
   
   • Start with the appropriate number of stars "*" indicating the depth in the XML tree.
   • Define the wiki link page with the appropriate syntax (see other element page links as examples)
     example: ******{{RS:Tag|fourQuadrantChopper}}
     Be careful with "generic" sub-elements, they get an additional link part for the parent element
     example: ****{{RS:Tag|additionalName|vehicle}}
   • Add all possible attributes, separated by comma
     The inherited ones come at least (that's for some quick validation purposes of this page, that may be roughly generated by an XQuery search)
     example: {{Attr|startDate}}, {{Attr|endDate}}, {{Attr|id}}, {{Attr|code}}, {{Attr|name}}, {{Attr|description}}, {{Attr|xml:lang}}
5. Describe your changes with "Summary" or Zusammenfassung
6. Check your changes with "Preview" or Vorschau
   Adjust the page text where needed
7. Submit your changes with "Save" or Speichern
8. Done. Thank you for your contribution.