[x3d-public] jupyter notebook; X3DOM syntax for including X3D within HTML

Brutzman, Donald (Don) (CIV) brutzman at nps.edu
Mon Jun 10 06:34:12 PDT 2019

Again thanks Andreas.  This is very important conceptual progress because it provides an excellent path forward for mixed-case spelling and singleton (self-closing) tags when X3D is included in an HTML file.

Primary motivation remains to not encourage or allow the creation of X3D models in HTML5 documents that cannot be recovered in a valid form.

Suggested syntax patterns:
- Mixed/irregular case allowed, mispelled elements are not allowed
- Paired empty opening/closing tags allowed for singleton elements

Suggested tool support:
- X3D Tidy performs cleanup to normalize such content
- X3dToDom and X3dToHtml stylesheets are given an option to produce paired tags for empty elements
- X3dToDom and X3dToHtml stylesheets perform cleanup to normalize such content
- X3DJSAIL X3DLoaderDOM class also  performs cleanup to normalize such content

Suggested tuneups:
- X3DOM documentation for example scenes gets checked/fixed (it is very irregular) and verified OK

Suggested X3D specification changes:
- we have a handful of X3D attributes that have same/similar spelling but differing capitalization.  That needs to be normalized.
- good prose in X3Dv4 specification describes what is allowed
- may need further prose for X3D Canonical Form (C14N) in X3D Compressed Binary Encoding (CBE) specification
- Cross check with HTML5 latest specification and XML Schema (XSD) v1.1 Post Schema Validation Infoset for compatible consistency.

Anything else?  All feedback welcome.

Good topic for this week's X3D Working Group teleconference.  Will then create a Mantis issue to track these changes.

On 5/31/2019 5:56 PM, Andreas Plesch wrote:
> Well, if it was xhtml we were talking about you would be correct.
> But, it is html without the x which is expected by the HTML renderer
> in Jupyter. There is no XHTML renderer since the Jupyter notebook
> itself is a HTML document.
> And html allows singleton tags only for certain tags, at least in how
> all browser parse the markup, and probably also as defined in the
> HTML5 spec. These certain tags may include all known HTML elements
> which do not use their text content. Unfortunately, the X3D tags are
> considered Unknown Elements by html and they seem to require the
> explicit end tag.
> x3dom does not use any HTML parsing libraries but completely relies on
> the web browser to do the parsing. And the browsers get confused,
> because they do not understand the singleton x3d tags in a html
> document.
> Alas, if the xml serializing library in X3DJSAIL does not have an
> option to generate full tags (they would be still legal XML, no?), we
> would need to settle for xhtml IFrames which can also be included in a
> Jupyter notebook (but not tested yet), or, as another option, wrap the
> xml X3D into an Inline since x3dom always uses the browser XML parser
> for Inlines. Would x3d.toStringX3DInline(filename) be considered too
> extravagant ? It would generate an xml X3D document string with a
> single Inline node, and also the content X3D in the file filename.
> x3d.toFileX3DInline(x3dFileName, inlineFileName) would generate two
> files.
> Perhaps Python has an option to serialize out the full tags, perhaps
> as HTMLFragments. Then a x3d.toStringFullTags() could be included
> outside of X3DJSAIL, and with X3DPSAIL.
> To consider X_ITE and x3dom together it would be first necessary get
> X_ITE to work at all with Jupyter locally generated content. It may be
> possible since X_ITE works with remote URLs in Jupyter.
> -Andreas
> ---on the phone---
> On Fri, May 31, 2019, 5:14 PM <x3d-public-request at web3d.org wrote:
>> Send x3d-public mailing list submissions to
>>          x3d-public at web3d.org
>> To subscribe or unsubscribe via the World Wide Web, visit
>>          http://web3d.org/mailman/listinfo/x3d-public_web3d.org
>> or, via email, send a message with subject or body 'help' to
>>          x3d-public-request at web3d.org
>> You can reach the person managing the list at
>>          x3d-public-owner at web3d.org
>> When replying, please edit your Subject line so it is more specific
>> than "Re: Contents of x3d-public digest..."
>> Today's Topics:
>>     1. Re: jupyter notebook; X3DOM syntax for including X3D within
>>        HTML/XHTML (Brutzman, Donald (Don) (CIV))
>> ----------------------------------------------------------------------
>> Message: 1
>> Date: Fri, 31 May 2019 10:14:05 +0000
>> From: "Brutzman, Donald (Don) (CIV)" <brutzman at nps.edu>
>> To: "x3d-public at web3d.org" <x3d-public at web3d.org>
>> Subject: Re: [x3d-public] jupyter notebook; X3DOM syntax for including
>>          X3D within HTML/XHTML
>> Message-ID: <b6c49fa9-6afc-34fe-ee57-59f0ad5fc99d at nps.edu>
>> Content-Type: text/plain; charset="utf-8"
>> thanks for great progress.
>> On 5/28/2019 12:12 PM, Andreas Plesch wrote:
>>> - x3dom has a problem with generated X3D outside of an Inline because
>>> the serialized XML output uses self-closing tags such as <Material />
>>> which is not HTML compatible.
>> HTML allows singleton elements, i.e. self-closing tags.
>> Similarly, element CamelCaseElementNames are legal, so we should not have to rename <Material/> to <material></material> simply because of similarity to another language's naming patterns.
>> i think root of this problem likely lies in how X3DOM uses the accompanying DOM libraries - not sure of those details.
>> Note that I got *all* of the X_ITE and X3DOM examples to work with HTML by assigning scenes to .html and .xhtml respectively.
>> http://www.web3d.org/x3d/content/examples/X3dResources.html#Examples
>> http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter01TechnicalOverview/HelloWorldIndex.html
>> http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter01TechnicalOverview/HelloWorldX3dom.xhtml
>> http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter01TechnicalOverview/HelloWorldX_ITE.html
>>> So the suggestion would be to provide a method, say
>>> x3d.toStringX3DClosingTags(), which generates explicit closing tags:
>>> <Material></Material>
>> I don't think it is good to propagate a side-effect fix (which encourages mysterious improper practices and hides path towards fixes).
>> Rather it is more desirable to isolate and fix the actual problem.  If someone can figure out why X3DOM runs differently when included within .xhtml and .html pages, that may reveal whatever idiosyncrasy is actually occurring.
>> Finally we want to match the same patterns in X_ITE and X3DOM so that choice of player is independent of source-model syntax when using X3D version 4.  So this is a worthy mismatch to figure out and fix.  Hopefully we can get closer to sorting things out fully.
>> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
>> Meanwhile: found and fixed several errors in online X3DOM .xhtml examples:
>> - corrected url to match changed release address:
>>     https://x3dom.org/release/x3dom.css
>>     https://x3dom.org/release/x3dom-full.js
>> - fixed bug in X3dToX3dom.xslt code logic in order to include function toggleFullscreen ()
>> - using XHTML Transitional (vice Strict) DTD in order for anchor target attribute to pass validation
>>     https://stackoverflow.com/questions/4666523/xhtml-strict-1-0-target-blank-not-valid
>> X3dToX3dom.xslt stylesheet correction checked in, X3DOM example pages updated and uploaded.  Having fun with X3DOM!  8)
>> all the best, Don
>> --
>> Don Brutzman  Naval Postgraduate School, Code USW/Br       brutzman at nps.edu
>> Watkins 270,  MOVES Institute, Monterey CA 93943-5000 USA   +1.831.656.2149
>> X3D graphics, virtual worlds, navy robotics http://faculty.nps.edu/brutzman
>> ------------------------------
>> Subject: Digest Footer
>> _______________________________________________
>> x3d-public mailing list
>> x3d-public at web3d.org
>> http://web3d.org/mailman/listinfo/x3d-public_web3d.org
>> ------------------------------
>> End of x3d-public Digest, Vol 122, Issue 137
>> ********************************************
> _______________________________________________
> x3d-public mailing list
> x3d-public at web3d.org
> http://web3d.org/mailman/listinfo/x3d-public_web3d.org

all the best, Don
Don Brutzman  Naval Postgraduate School, Code USW/Br       brutzman at nps.edu
Watkins 270,  MOVES Institute, Monterey CA 93943-5000 USA   +1.831.656.2149
X3D graphics, virtual worlds, navy robotics http://faculty.nps.edu/brutzman

More information about the x3d-public mailing list