<div dir="auto">For example, here’s some JSONBuddy documentation on the JSON schema Roy and I created:</div><div dir="auto"><br></div><div dir="auto"><div><a href="https://github.com/Clemens-U/jsonbuddy/blob/main/JSON%20Schema%20Documentation%20samples/x3d-4.0-JSONSchema.html">https://github.com/Clemens-U/jsonbuddy/blob/main/JSON%20Schema%20Documentation%20samples/x3d-4.0-JSONSchema.html</a></div><br></div><div dir="auto">If you’re on your iPhone, I recommend the Share button instead of downloading.</div><div dir="auto"><br></div><div dir="auto">Maybe you already know that.</div><div dir="auto"><br></div><div dir="auto">John</div><div><br><div class="gmail_quote gmail_quote_container"><div dir="ltr" class="gmail_attr">On Fri, Oct 10, 2025 at 10:35 PM John Carlson <<a href="mailto:yottzumm@gmail.com">yottzumm@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="auto">Don,</div><div dir="auto"><br></div><div dir="auto">Just like XML Schema has “keywords,” so does JSON schema.  But I know we were able to put in:</div><div dir="auto"><br></div><div dir="auto"><div>"$comment": "SFFloat initializeOnly",</div><br></div><div dir="auto">successfully, so I know we could put in properties similar to that.</div><div dir="auto"><br></div><div dir="auto">Obviously, people have documented JSON schemas before, so I’m asking about “standard” practices, such that I can convert JSON schema to documentation without a lot of development work.  I’m pretty sure you do that on a regular basis for XML, so you have a more confident approach.  If you build a small prototype that works in one case, I would have more confidence that such things could work on a larger scale.  I am reluctant to add extra documentation to JSON schema for performance reasons.</div><div dir="auto"><br></div><div dir="auto">John</div><div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Fri, Oct 10, 2025 at 2:55 PM Don Brutzman <<a href="mailto:don.brutzman@gmail.com" target="_blank">don.brutzman@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;padding-left:1ex;border-left-color:rgb(204,204,204)"><div dir="ltr"><div>John, the X3D XML Schema includes the same appinfo and documentation attributes that are found in X3DUOM.  Indeed they are generated from the same place.</div><div><ul><li>X3D SXML Schema x3d-4.0.xsd Documentation</li><li><a href="https://www.web3d.org/specifications/X3dSchemaDocumentation4.0/x3d-4.0.html" target="_blank">https://www.web3d.org/specifications/X3dSchemaDocumentation4.0/x3d-4.0.html</a></li><li>select node, node type, or field to find appinfo/documentation values for most cases</li></ul></div><div>So in our future work on X3D JSON Schema, I would expect to apply the same values.  It is the same X3D scene graph and architecture in each case.</div><div><br>Additional documentation for X3DJSAIL Java and X3DPSAIL Python software builds is inserted using X3D Tooltips.</div><div><ul><li>Extensible 3D (X3D) 4.0 Tooltips</li><li>X3D Tooltips provide authoring hints for each node and field found in X3D Architecture version 4 International Specification (IS).</li><li><a href="https://www.web3d.org/x3d/content/X3dTooltips.html" target="_blank">https://www.web3d.org/x3d/content/X3dTooltips.html</a></li><li><a href="https://www.web3d.org/x3d/tooltips/x3d-4.0.profile.xml" target="_blank">https://www.web3d.org/x3d/tooltips/x3d-4.0.profile.xml</a> (source)</li></ul></div><div><div dir="ltr" class="gmail_signature" data-smartmail="gmail_signature"><div dir="ltr"><div style="color:rgb(34,34,34)"><span style="font-family:monospace">all the best, Don</span></div><div style="color:rgb(34,34,34)"><font face="monospace" style="font-family:monospace;color:rgb(34,34,34)">-- </font></div><div style="color:rgb(34,34,34)"><font face="monospace" style="font-family:monospace;color:rgb(34,34,34)">X3D Graphics, Maritime Robotics, Distributed Simulation</font></div><div style="color:rgb(34,34,34)"><font face="monospace" style="font-family:monospace;color:rgb(34,34,34)">Relative Motion Consulting  <a href="https://RelativeMotion.info" style="font-family:monospace" target="_blank">https://RelativeMotion.info</a></font></div></div></div></div><br></div><br><div class="gmail_quote"></div><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Thu, Oct 9, 2025 at 9:42 PM John Carlson via X3D-Ecosystem <<a href="mailto:x3d-ecosystem@web3d.org" target="_blank">x3d-ecosystem@web3d.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;padding-left:1ex;border-left-color:rgb(204,204,204)">Apparently, JSON schema has a “description” property for describing schema objects.<div dir="auto"><br></div><div dir="auto">My question is, would it be best to place appinfo or documentation attributes from X3DUOM in schema objects (schema properties, for example)?  Or some other combination?</div><div dir="auto"><br></div><div dir="auto">Some samples of documented schemas.</div><div dir="auto"><br></div><div dir="auto"></div><div><a href="https://github.com/Clemens-U/jsonbuddy/tree/main/JSON%20Schema%20Documentation%20samples" target="_blank">https://github.com/Clemens-U/jsonbuddy/tree/main/JSON%20Schema%20Documentation%20samples</a></div><div dir="auto"><div><a href="https://github.com/Clemens-U/jsonbuddy/tree/main" target="_blank"></a></div><div dir="auto"><br></div><div dir="auto">My thought is to create a “no-use” schema for documentation purposes, and a performance schema for downloads and processing.</div><div dir="auto"><br></div><div dir="auto">What do people in general about these approaches?</div><div dir="auto"><br></div><div dir="auto">John </div><br></div>
-- <br>
X3D-Ecosystem mailing list<br>
<a href="mailto:X3D-Ecosystem@web3d.org" target="_blank">X3D-Ecosystem@web3d.org</a><br>
<a href="http://web3d.org/mailman/listinfo/x3d-ecosystem_web3d.org" rel="noreferrer" target="_blank">http://web3d.org/mailman/listinfo/x3d-ecosystem_web3d.org</a><br>
</blockquote></div>
</blockquote></div></div>
</blockquote></div></div>