Need Schema for osim files

[aymanhab]

The XML files we use in OpenSim are called "Well-formed" that is, they don't have a way to validate them. This option is flexible but leaves users at a loss as to what can be in the file. We should create and publish a schema for built in types that users can disable if extending classes/format.

[chrisdembia]

+1 !!! I've worked on this. I'd say I'm 80% done with having a complete schema. With a complete schema, we can also provide autocompletion in an XML text editor.

Here's the code: https://github.com/opensim-org/opensim-core/tree/xmlschema

Want to work on this (with me)?

The big issue I've run into is that I don't think it's valid XML to have :: in a tag name, since : is used for xml namespaces, or something like that. Therefore, there's an issue with HuntCrossleyForce::ContactParameters, etc (nested types). Either we have to have an alias for :: when writing to XML, an alias for each individual nested type, or we need to avoid registering nested types.

A smaller issue that I'm confused about is where we would host the schemas (online? in the installation?).

We can actually automatically generate a new schema for people who extend classes (with plugins), so long as they register their new types.

[aymanhab]

Awesome, sure would love to work on it. I'd host it on confluence or github
for standalone validation. I thought Sherm used something else for :: in
class names, I have this on an issue somewhere.
On Feb 18, 2016 3:12 PM, "Christopher Dembia" notifications@github.com
wrote:

+1 !!! I've worked on this. I'd say I'm 80% done with having a complete
schema. With a complete schema, we can also provide autocompletion in an
XML text editor.

Here's the code:
https://github.com/opensim-org/opensim-core/tree/xmlschema

Want to work on this (with me)?

The big issue I've run into is that I don't think it's valid XML to
have :: in a tag name, since : is used for xml namespaces, or something
like that. Therefore, there's an issue with
HuntCrossleyForce::ContactParameters, etc (nested types). Either we have
to have an alias for :: when writing to XML, an alias for each individual
nested type, or we need to avoid registering nested types.

A smaller issue that I'm confused about is where we would host the schemas
(online? in the installation?).

We can actually automatically generate a new schema for people who extend
classes (with plugins), so long as they register their new types.

—
Reply to this email directly or view it on GitHub
#775 (comment)
.

[chrisdembia]

I talked to him about it and I forgot what came of it...He writes ::'s to his upcoming state xml files. @sherm1

[chrisdembia]

Oh, the other issue is that single-value Object properties can be written in two different ways, and it maybe that only one of these ways can be easily accomodated by a schema. See #707 for a description and a related bug.

[sherm1]

I don't use class names as tags for the State serialization stuff. The class names are attributes, e.g. <Value type="Some::Type::SubType"> blah </Value>. Everything is allowed in attributes, although I substitute {} for <> because XML is weird about angle brackets.

[chrisdembia]

Oh okay. That helps.

[aseth1]

Is this a need for the 4.0 GUI? Would the GUI provide XML editing where it could be validated against the schema?

[jenhicks]

This issues is in the "Next Release" milestone, so not in consideration for 4.0 release. As you are looking through issues, the ones to look at are those already in the OpenSim 4.0 milestone and those that have no assigned milestone.