User:RailML Coord Documentation/Autodoku: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
'''Unterstützung der {{rml}}-Dokumentation durch Skripte''' | |||
==Motivation== | |||
Es ist beabsichtigt, die Wiki-Dokumentation von {{rml}}3 teilweise zu automatisieren. Informationen, die aus dem Schema ableitbar sind, sollen ausgewertet und automatisch in das Wiki eingepflegt werden. Dies betrifft zwei Phasen: | |||
#Erstellung eines Grundstockes: Für jedes {{rml}}-Element soll eine Seite mit den ''Eckdaten'' erstellt werden, die händisch als Text weitergepflegt wird. Hierbei wird die Seite mit einem Vorlagenaufruf analog zu [[Template:elementDocu]] gefüllt, mit den Parameterwerten, die das jeweilige Element repräsentieren. Dazu dient [[User:Ferri Leberl/Template:Grundstock]] | |||
#Laufende Präsentation des aktuellen Standes: In jede Elementseite soll eine Vorlage eingebunden sein, die in Tabellenform die ''Eckdaten'' der jeweils aktuellen Version darlegt. Hierbei ist im Moment die angelegte Vorgangsweise, dass ein ''User:Roboter'' angelegt wird, in dessen Benutzernamensraum die Daten geparkt werden. Zu Seite CO:railml gäbe es dann eine Seite ''User:Roboter/CO:railml'', die eine Vorlage mit imprinzip den Werten von #1 aufruft, nur mit dem Stand der jeweils aktuellen Version. Hierfür ist Dazu dient [[User:Ferri Leberl/Template:Schemaexport]] vorgesehen. | |||
Aus dem Schema ableitbare daten sind: | |||
*Elementname | |||
*Dokumentation (das zum Element gehörige <documentation>-Tag) | |||
*Subschema | |||
*Parent(s) (identische Namen sollen konsolidiert werden) | |||
*Children | |||
*Attribute | |||
*Sind Attribute verpflichtend? | |||
*Attributdokumentationen (das zum Attribut gehörige <documentation>-Tag) | |||
==Skizze== | |||
*Motivation | *Motivation | ||
| Line 14: | Line 30: | ||
**Grundstock | **Grundstock | ||
**Aktueller Stand | **Aktueller Stand | ||
*Einpflegen in das Wiki | |||
**Vorlagen | |||
*Was sieses System nicht kann | |||
**Neue Elemente müssen händisch eingepflegt werden, ihre Roboterseite ''meldet sich nicht'. | |||
**Verworfene Elemente werden nicht automatisch ausgepflegt. ihre Roboterseite wird nicht gelöscht sondern bleibt mit veraltetem Stand erhalten | |||
**Bislang können unsere Lösungen nicht mit any-Elementen sowie any-Attributen umgehen | |||
Revision as of 14:20, 15 September 2017
Unterstützung der railML®-Dokumentation durch Skripte
Motivation
Es ist beabsichtigt, die Wiki-Dokumentation von railML®3 teilweise zu automatisieren. Informationen, die aus dem Schema ableitbar sind, sollen ausgewertet und automatisch in das Wiki eingepflegt werden. Dies betrifft zwei Phasen:
- Erstellung eines Grundstockes: Für jedes railML®-Element soll eine Seite mit den Eckdaten erstellt werden, die händisch als Text weitergepflegt wird. Hierbei wird die Seite mit einem Vorlagenaufruf analog zu Template:elementDocu gefüllt, mit den Parameterwerten, die das jeweilige Element repräsentieren. Dazu dient User:Ferri Leberl/Template:Grundstock
- Laufende Präsentation des aktuellen Standes: In jede Elementseite soll eine Vorlage eingebunden sein, die in Tabellenform die Eckdaten der jeweils aktuellen Version darlegt. Hierbei ist im Moment die angelegte Vorgangsweise, dass ein User:Roboter angelegt wird, in dessen Benutzernamensraum die Daten geparkt werden. Zu Seite CO:railml gäbe es dann eine Seite User:Roboter/CO:railml, die eine Vorlage mit imprinzip den Werten von #1 aufruft, nur mit dem Stand der jeweils aktuellen Version. Hierfür ist Dazu dient User:Ferri Leberl/Template:Schemaexport vorgesehen.
Aus dem Schema ableitbare daten sind:
- Elementname
- Dokumentation (das zum Element gehörige <documentation>-Tag)
- Subschema
- Parent(s) (identische Namen sollen konsolidiert werden)
- Children
- Attribute
- Sind Attribute verpflichtend?
- Attributdokumentationen (das zum Attribut gehörige <documentation>-Tag)
Skizze
- Motivation
- Pipeline
- Schema
- entchoicen
- Eclipe: Beispiel-XML — mit welchen Einstellungen? Wie anlegen?
- Auswerten mit code.xsl
- putzen mit tabkopf
- R-Skript
- Doppelte Elemente zusammenführen
- Doku-Tags dazuführen
- Pipelineteilung
- Grundstock
- Aktueller Stand
- Einpflegen in das Wiki
- Vorlagen
- Was sieses System nicht kann
- Neue Elemente müssen händisch eingepflegt werden, ihre Roboterseite meldet sich nicht'.
- Verworfene Elemente werden nicht automatisch ausgepflegt. ihre Roboterseite wird nicht gelöscht sondern bleibt mit veraltetem Stand erhalten
- Bislang können unsere Lösungen nicht mit any-Elementen sowie any-Attributen umgehen