Home » railML newsgroups » railml.common » [railML3] Strategy of documentation at wiki.railML.org (Impulse for a discussion: how should railML3 be documented?)
Re: [railML3] Strategy of documentation at wiki.railML.org [message #1450 is a reply to message #1421] Tue, 22 November 2016 14:42 Go to previous messageGo to previous message
Ferri Leberl is currently offline  Ferri Leberl
Messages: 24
Registered: September 2016
Junior Member
Dear Readers,

Let me summarize the current state of work for the automatic wiki page generation. The process shall include the following steps:

  • Extract essential information on each element (element name, element required/optional, element documentation, subschema, parent element, children, attributes, attributes required/optional, attributes documentation) from the XSD and collect it in a table
  • Employ a script to build a wiki page for every line of the table (every element) as a starting point. These pages should be developed further manually and contain ...
  • ... templates to include the essentials of the element. These template pages are generated with another, similar script, and they are not supposed to be changed and developed manually, but actualized with every change of the schema automatically.

I have meanwhile written scripts that solve the latter part of the path: employing the table to generate wiki pages for either purpose.

I ask you for help to solve the first part of the puzzle: reading the railML schema files and deriving a table presenting the structure of the XSD. These are the requirements for the table:

  • The table should have one line for each element.
  • The table should have, as mentioned above, a column for each element property we consider (element name, element required/optional, element documentation, subschema, parent element, children, attributes, attributes required/optional, attributes documentation).
  • It should be a tab separated list, and where there may be several entries within a column (an element may have several children and several attributes), these entries should be separated by a semicolon.

Are there any obstacles we did not see?
Do you need any further information from our side?
Is there anybody in this forum who has the capacity to solve this part?

Thank you in advance for your opinions, your contributions and your help.

Yours,
Mag. Ferri Leberl

[Updated on: Mon, 28 November 2016 10:07]

Report message to a moderator

 
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Previous Topic: To use or not to use? - default values in XSDs
Next Topic: Child elements with one value vs. attributes
Goto Forum:
  


Current Time: Thu Mar 28 22:14:10 CET 2024