Difference between revisions of "User:Ferri Leberl/Autodoku/Spezifikationen"

From wiki.railML.org
Jump to: navigation, search
(Parameter)
(Parameter)
Line 72: Line 72:
 
|-
 
|-
 
|parent
 
|parent
|Beistrichgetrennte Liste von Vorlagenaufrufen der Form {{parent|subschema=|element=}}
+
|Halo Welt!
 
|{{parent|subschema=timetable|name=blockPartSequence}}, {{parent|subschema=timetable|name=timetable}}''
 
|{{parent|subschema=timetable|name=blockPartSequence}}, {{parent|subschema=timetable|name=timetable}}''
 
|-
 
|-

Revision as of 16:07, 18 October 2017

Spezifikationen

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.

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>:<elementname> gefüllt, sondern mit user:robot/<versionsnummer>/<subschema>:<elementname>. Diese Seiten sind also Unterseiten der Seite user:robot/<versionsnummer>
    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:Elementdoku.
  • Prinzipiell haben die Vorlagen die selben, auch gleich benannten, Parameter. Nur Parameter Interwiki ist bei den Roboterseiten nicht notwendig.

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

Parameter

template:docBase template:schemaexport
  • element
  • comment
  • subschema
  • parent
  • children
  • attributes
  • obligatory
  • interwiki
  • version
  • element
  • comment
  • subschema
  • parent
  • children
  • attributes
  • obligatory
  • version
     
Parameter Inhalt Beispiel
element Elementname z.B. blockPartRef
comment Inhalt des documentation-Tag
subschema (ausgeschrieben) timetable
parent Halo Welt! subschema=timetable|name=blockPartSequence}}, {{parent|subschema=timetable|name=timetable}}
children subschema=|element=}} subschema=timetable|name=blockPartSequence}}, {{child|subschema=timetable|name=timetable}}
attributes name=|pflicht=|kommentar=|typ=}} — wenn es keinen Kommentar gibt sollte der Kommentarparameter nicht vorkommen (nicht leer, sondern kein zweiter Horizontalstrich) name=ref|pflicht=1}}
obligatory 1 für obligatorisch
interwiki Ein allfälliger analoger Artikel im 2er-Wiki TT:blockPartRef
version Die railML®-Version version=3.0

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.