Dev:Wiki Documentation Guidelines

Text flow templates

Attributes

The following template may be used at every wiki page for a corporate layout for attributes and attribute values:

{{Attr | <attribute-name>}}

example: {{Attr | axleSequence}} results in axleSequence

Generic documentation links for railML elements

The following templates may be used at every wiki page for refering to a certain railML element documentation site.

Link in angle brackets

The link is shown in angle brackets: <...>. It looks like an XML element.

• Elements without parent inheritance

  {{<sub-schema-prefix>:Tag|<element-name>}}

  example: {{RS:Tag|fourQuadrantChopper}} results in <fourQuadrantChopper>
• Elements with parent inheritance

  {{<sub-schema-prefix>:Tag|<element-name>|<parent-element-name>}}

example: {{RS:Tag|additionalName|vehicle}} results in <additionalName>

Pure link

The link is shown pure without any characters around. This is better for reading a text flow.

• Elements without parent inheritance

  {{<sub-schema-prefix>:Doc|<element-name>}}

  example: {{RS:Doc|fourQuadrantChopper}} results in fourQuadrantChopper
• Elements with parent inheritance

  {{<sub-schema-prefix>:Doc|<element-name>|<parent-element-name>}}

example: {{RS:Doc|additionalName|vehicle}} results in additionalName

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 a new element with a new line at the appropriate position, if necessary
   Only insert one line for each different element no matter how often it may occur at this certain position in the XML instance document.
   • Start with the appropriate number of stars "*" indicating the depth in the XML tree.
   • Choose the appropriate wiki documentation link in angle brackets
   • Add all possible attributes deploying the Attribute template, 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)
     No matter, if the attributes are optional or mandatory.
   example:

   ***{{TT:Tag|train}} {{Attr|type}}, {{Attr|trainNumber}}, {{Attr|additionalTrainNumber}}, {{Attr|scope}}, {{Attr|processStatus}}, {{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.