Dev:Special Wiki Markup
|
Generic documentation links for railML elements
The following templates may be used at every wiki page for referring to a certain railML® element documentation page.
Link in angle brackets
The link is shown in angle brackets: <...>. It looks like an XML element.
Please, employ Template:Tag:
- Elements without parent inheritance
{{Tag|<sub-schema-prefix>|<element-name>}}example:{{Tag|RS|fourQuadrantChopper|wiki=2}}results in Template:RS:Tag - Elements with parent inheritance
{{Tag|<sub-schema-prefix>|<element-name>|<parent-element-name>}}example:
{{Tag|<sub-schema-prefix>|additionalName|vehicle|wiki=2}}results in Template:RS:Tag
Pure link
The link is shown pure without any characters around. This is better for reading a text flow.
Please, employ Template:Doc.
- Elements without parent inheritance
{{Doc|<sub-schema-prefix>|<element-name>}}example:{{Doc|RS|fourQuadrantChopper|wiki=2}}results in Template:Doc - Elements with parent inheritance
{{Doc|<sub-schema-prefix>|<element-name>|<parent-element-name>}}example:
{{Doc|RS|additionalName|vehicle|wiki=2}}results in Template:Doc
Generic links for types
The following templates may be used at every wiki page for refering to a certain simple type constraint.
railML types
It shows a link to the basic W3C XML schema type https://www.w3.org/TR/xmlschema-2 W3C XML schema type re-used by railML for a certain reason. It does not cover complex types or enumeration lists.
{{RailMLType|<type-name>}}
example: {{RailMLType|tGenericRef}} results in Template:RailMLType
Pure XML Schema types
It shows a link to the basic W3C XML schema type https://www.w3.org/TR/xmlschema-2 W3C XML schema type.
{{XsdType|<type-name>}}
example: {{XsdType|string}} results in Template:XsdType
Version management
The current wiki does not support version management itself. That's the reason for the templates explained in the following sections.
New objects
In railML® 2, if new objects are introduced with some official version number, use the following template for showing it:
{{Intro | <version-number>}}
example: {{Intro | 2.1}} results in Template:Intro
There is no difference in handling between elements, attributes, enumeration values, occurence changes...
In railML® 3, the template will generally not be used, as the differences between versions should be apparent from the automatic pages.
Deprecated objects
Vice versa, if objects are declared "deprecated" in railML® 2, they are kept until the next major release.
{{Depr | <version-number>}}
example: {{Depr | 2.1}} results in Template:Depr
There is no difference in handling between elements, attributes, enumeration values, occurence changes...
Attributes
The following template may be used at every wiki page for a corporate layout for attributes:
{{Attr | <attribute-name>}}
example: {{Attr | axleSequence}} results in Template:Attr
Enumeration values
The following template may be used at every wiki page for a corporate layout for enumeration values:
{{Enum | <enumeration-value>}}
example: {{Enum | mechanical}} results in Template:Enum
German layout (de: Deutsche Auszeichnung)
It's a good practice to translate some paragraphs and/or words into German since there are many German railML users. In order to offer a flexible layout, please use the following template:
{{Deu | <deutscher-text>}}
example: {{Deu | Deutsche Erläuterung}} results in Deutsche Erläuterung
Logo
Please, use Template:rml for displaying the railML® logo. {{rml}} produces railML®. It is consens, that the initial letter r should allways be written small, and that the superscript ® should always be displayed. Both is granted for by the template. Don't use the superscript ® in URLs — such links cannot be processed! Instead, use railML in the URL and employ the vertical bar | to display an appropriate link text, e.g. [[Dev:How to join, edit and create the railML wiki|How to join, edit and create the {{rml}} wiki]] for How to join, edit and create the railML® wiki.