Difference between revisions of "X3D JSON Encoding"
From Web3D.org
(→Conversion Issues) |
(→Conversion Issues) |
||
| Line 4: | Line 4: | ||
** Initial message [http://web3d.org/pipermail/x3d-public_web3d.org/2014-July/002854.html] | ** Initial message [http://web3d.org/pipermail/x3d-public_web3d.org/2014-July/002854.html] | ||
** July's thread listing [http://web3d.org/pipermail/x3d-public_web3d.org/2014-July/thread.html] | ** July's thread listing [http://web3d.org/pipermail/x3d-public_web3d.org/2014-July/thread.html] | ||
| − | == Conversion | + | == Conversion Considerations == |
Primary design criterion: round-trippable lossless representation of X3D scene. | Primary design criterion: round-trippable lossless representation of X3D scene. | ||
| − | Conversion approach of greatest interest: XML to/from JSON. Issues: | + | Conversion approach of greatest practical interest: XML to/from JSON. Issues: |
# How to convert attribute names to distinguish them from child elements | # How to convert attribute names to distinguish them from child elements | ||
| Line 15: | Line 15: | ||
# Both X3D and JSON can include comments, and so need an option for inclusion (by default) or removal (optional) of comments in order to ensure 100% round-trip conversion capabilities. | # Both X3D and JSON can include comments, and so need an option for inclusion (by default) or removal (optional) of comments in order to ensure 100% round-trip conversion capabilities. | ||
# Support for singleton (self-closing) XML tags also needs to be considered | # Support for singleton (self-closing) XML tags also needs to be considered | ||
| − | # Inclusion | + | # Inclusion and preservation of embedded XML namespace information in an XML (.x3d) document |
== Discussion points == | == Discussion points == | ||
Revision as of 15:36, 10 September 2014
Preliminary notes on the creation of an X3D JSON encoding.
- This page is to understand the conversion process so that a high-quality encoding definition can be created
- Don Brutzman started a thread on the X3D-Public list.
Conversion Considerations
Primary design criterion: round-trippable lossless representation of X3D scene.
Conversion approach of greatest practical interest: XML to/from JSON. Issues:
- How to convert attribute names to distinguish them from child elements
- JSON handling of container elements to preserve parent/child relationships, distinguishing child elements from attributes
- Creation of JSON elements with datatypes appropriate to content (e.g., integer, float, strings, etc.)
- Both X3D and JSON can include comments, and so need an option for inclusion (by default) or removal (optional) of comments in order to ensure 100% round-trip conversion capabilities.
- Support for singleton (self-closing) XML tags also needs to be considered
- Inclusion and preservation of embedded XML namespace information in an XML (.x3d) document
Discussion points
Here are suggested discussion points for the X3D teleconference and future followups.
- What are the use cases for having X3D JSON available in JavaScript? It would be good to spell them out and understand them well.
- Is there a good/consistent way for X3DOM to utilize such capabilities?
- Is there a way for Three.js or other javascript libraries to utilize such capabilities?
- Is there a single authoritative reference for JSON itself? and for JSON-XML conversions?
- Compare compression of a TestMesh.x3d.json.gz to TestMesh.x3db and TestMesh.x3d.exi (EXI will likely win because it includes data typing)
- Once a canonical form for X3D as JSON is established, add conversion capabilities to X3D-Edit and also autoconvert, test and publish JSON for all of the 3800+ scenes in the X3D Examples Archives
- Decide if this capability needs to be defined in one of the X3D standards, or perhaps as an X3D best practice.
- Probably lots more... What else?
Contributors
- LD - Leonard Daly
- DPB - Don Brutzman
References
- XML to JSON Converter (provides option to assign a prefix to JSON attributes, default is @ character) [3]
- Apache Camel, XML JSON Data Format (camel-xmljson) [4]
- JSON Markup Language (JsonML) [5]
- XSLTJSON: Transforming XML to JSON using XSLT [6]
- Converting Between XML and JSON [7]
- XML/JSON Perl Converter [8]
- IBM's PHP converter [9]
- Java Converter [10]
- Google Code Library [11]
