[x3d-public] [x3d] Spec Comment by brutzman on 19775-1: Abstract X3D Definitions - V3.3 [Mantis 1174]

[Roy Walmsley]

Hi Don,

Thank you for submitting the comment included below. I have raised Mantis issue 1174 to cover this. The issue is accessible to Web3D members at http://www.web3d.org/member-only/mantis/view.php?id=1174.

All the best,

Roy

-----Original Message-----
From: x3d [mailto:x3d-bounces at web3d.org] On Behalf Of Spec Feedback
Sent: 09 September 2017 20:10
To: x3d at web3d.org
Subject: [x3d] Spec Comment by brutzman on 19775-1: Abstract X3D Definitions - V3.3

-- Submitter indicates that this comment may be public: *Yes* --

Comment on 19775-1: Abstract X3D Definitions - V3.3
7.2.5.1 Organization
http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#AbstractX3DStructure

-----------------
Subject: Abstract specification does not clearly define comments

Problem: Comments are occasionally mentioned in the specification, but are not defined as a term.

One mention is 7.2.5.2 Header statement, "d. optional comments that may apply to the file."

Suggest moving this statement to the preceding section (7.2.5.1 Organization) so that it applies to an entire model.  Example paragraph:
"Comments may appear at various places throughout an X3D model, with syntax varying according to file encoding and programming-language bindings.
Comments have no effect on scene functionality.  Comments are not X3D nodes and not X3D statements."

Suggest adding glossary term:
3 Terms, definitions, acronyms, and abbreviations 3.1.16.5, comment, provides optional author information that has no effect on scene functionality"

Suggest adding to Core component:
7.2.1 Overview of the core
"Support for optional comments is considered part of Core component level 1 functionality."

with a corresponding addition to the bottom of Table 7.2 — Core component support levels http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#t-Coresupportlevels

Further review of the abstract specification is warranted to see if other clarifications and corrections are needed.

Of note is that clear definition is also necessary for proper specification of the X3D Unified Object Model.

These clarifications are not expected to break any existing X3D model content or implementations.
-----------------

Submitted on Saturday, 2017,  September 9 - 12:09pm by brutzman (brutzman )
IP: 205.155.65.226

See: http://www.web3d.org/node/1694/submission/1461


_______________________________________________
x3d mailing list
x3d at web3d.org
http://web3d.org/mailman/listinfo/x3d_web3d.org