User:RailML Coord Documentation/Autodoku/Spezifikationen

🗒️ This page is mirrored from page RailML3_Wiki:Autodoku/Spezifikationen in The railML® 3 wiki.

Spezifikationen

Testwiki: https://wikitest.railml.org/index.php?title=Common:railML

Wenn man eine Seite mit dem Namen Hallo Welt! und dem einzigen Inhalt Hallo Welt! exportiert, dann sieht die Datei so aus.

Die minimale Datei, die meine Mediawikiinstallation frisst, sieht, wenn wir bei Hallo Welt bleiben, so aus.

Seitenadressen

Die Elementseiten werden jeweils unter dem Titel <subschema_slug>:<elementname> untergebracht.

Da in railML^® 3.1 drei Elemente mit gleicher Bezeichnung, jedoch unterschiedlicher Definition vorkommen, werden diese drei Seiten ausnahmsweise unter dem Titel <subschema_slug>:<elementname>:<parent>. abgelegt. Diese Notwendigkeit sollte durch die Codingregeln für die Zukunft ausgeschlossen sein.

Handseiten

Die Handseiten bestehen nur aus einem Aufruf der Vorlage docBase:

<!-- 
This page has been created automatically, employing a template. Please, expand the template before editing the page: replace “docBase” by “subst:docBase”.!
After expanding template docBase, please delete this comment. -->{{docBase
|element=blockPartRef
|subschema=timetable
|parent={{parent|subschema=timetable|name=blockPartSequence}}
|attributes={{attribut|name=ref}}
|interwiki=TT:blockPartRef
|version=3.0}}

Eine minimale Datei mit einer Handseite sähe so aus.

Roboterseiten

Roboterseiten untescheiden sich von Handseiten durch drei Dinge:

• Das title-Tag wird nicht mit <subschema_slug>:<elementname> gefüllt, sondern mit <subschema_slug>:<elementname>/<versionsnummer>. Diese Seiten sind also Unterseiten der jeweiligen Handseite
  Am Montag sprach ich davon, den Speicherort aus dem Skript rauszulassen und dies beim Hochladen zu regeln. Ich habe jedoch beim praktischen Versuch festgestellt, dass ein einfacher Bedienfehler dazu führen kann, dass die Handseiten überschrieben werden — das würde aufwändige Korrekturen erfordern.
• Es wird Vorlage:Schemaexport aufgerufen, statt vorlage:docBase.
• Es werden andere Parameter aufgerufen

Die Roboterseite der Seite blockPartRef, Version 3.0, könnte also so aussehen.

Parameter

template:docBase	template:schemaexport
element subschema subschema_slug	element documentation subschema subschema_slug parent children attributes multiplicity version gml dc

Parameter	Inhalt	Beispiel
element	Elementname	z.B. blockPartRef
documentation	Inhalt des documentation-Tag
subschema	(ausgeschrieben)	timetable
subschema_slug	(CO, IL, IS, RS, TT, RAILML, GML4RAILML, RTM, XS)	IS
parent	Beistrichgetrennte Liste von Vorlagenaufrufen der Form {{parent|subschema=|element=|name=|multiplicity=}}	{{parent|subschema=timetable|name=blockPartSequence|multiplicity=[1..∞]}}, {{parent|subschema=timetable|name=timetable|multiplicity=[1..1]}}
children	Beistrichgetrennte Liste von Vorlagenaufrufen der Form {{child|subschema=|element=}}	{{child|subschema=timetable|name=blockPartSequence}}, {{child|subschema=timetable|name=timetable}}
attributes	Liste von Aufrufen der Form {{attribut|name=|pflicht=|documentation=|typ=|werte=|minExclusive=|minInclusive=| maxExclusive=|maxInclusive=|totalDigits=|fractionDigits=| length=|minLength=|maxLength=|whiteSpace=|patterns=}}. Wenn es keine Documentation gibt sollte der documentation-Parameter nicht vorkommen (nicht leer, sondern kein zweiter Horizontalstrich). Beim Attribut any wird documentation={{anyDoc}} übergeben, um einen standardisierte Verweis auf einen entsprechenden Artikel zu erzeugen. Werte ist wiederum eine Liste von Aufrufen der form {{wert|name=|documentation=}}. pflicht=0 und das Weglassen des pflicht-Parameters werden gleich behandelt als optional typ steht für base; werte fasst alle enumerations; diese werden mit template:wert übergeben; patterns umfasst alle Patterns; diese werden mit template:pattern übergeben. Wenn es keine festgelegten Werte gibt, sollte der Parameter werte nicht vorkommen.	{{attribut|name=ref|pflicht=1}} Beispiel für RS:pantograph#controlType: {{attribut|name=controlType|typ=string|documentation=the way of controlling the pantograph drive|werte={{wert|name=cable|documentation=The pantograph is activated/de-activated by means of a rope or cable.}}{{wert|name=spring|documentation=The pantograph is activated/de-activated by means of a spring.}}{{wert|name=air|documentation=The pantograph is activated/de-activated by means of pressurised air.}}{{wert|name=other:anything|documentation=Any value that does not fit any value from the previous enumeration list, fulfilling the constraint: at minimum two characters, whitespace is not allowed.}}}}
multiplicity	Ein String, der direkt ausgegeben wird	Verworfen, da dies im Parent definiert wird. Stattdessen Übergabe beim Parameter parent in template:parent.
interwiki	Ein allfälliger analoger Artikel im 2er-Wiki	TT:blockPartRef
version	Die railML®-Version	version=3.0
dc	Bei Dublin-Core-Elementen wird die DC-Version mitgeliefert. Da der Parameter geliefert wird handelt es sich um ein DC-Element, das besonders dokumentiert werden muss Der Klarheit halber wird auch die DC-Version mitgeliefert	dc=1.1
gml	Bei GML-Elementen wird die GML-Version mitgeliefert. Da der Parameter geliefert wird handelt es sich um ein GML-Element, das besonders dokumentiert werden muss Der Klarheit halber wird auch die GML-Version mitgeliefert	gml=3.2.1

Die Parameter element, subschema und version wird es immer geben. Bei allen anderen gilt: Wenn sie keinen Inhalt haben, dann sollen sie einfach nicht vorkommen. Die Vorlage wertet dann das Nichtvorhandensein aus und wird je nach Kontext z.B. einen Missing-Information-Baustein setzen, wenn es um docu-Tags geht ein None melden, wenn es um Kinder geht oder einfach nichts tun, wenn es keinen interwiki-Artikel gibt.