This is an archived snapshot of W3C's public bugzilla bug tracker, decommissioned in April 2019. Please see the home page for more details.

Bug 4818 - Reword the last sentence of 3.2 from \"appears as a child of a document element \" to more clearly cover the cases where the child element is not in an embedded document
Summary: Reword the last sentence of 3.2 from \"appears as a child of a document eleme...
Status: RESOLVED FIXED
Alias: None
Product: SML
Classification: Unclassified
Component: Interchange Format (show other bugs)
Version: unspecified
Hardware: PC Windows XP
: P2 normal
Target Milestone: FPWD
Assignee: Virginia Smith
QA Contact: SML Working Group discussion list
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-06-27 23:13 UTC by Bassam Tabbara
Modified: 2007-07-26 19:05 UTC (History)
0 users

See Also:


Attachments

Description Bassam Tabbara 2007-06-27 23:13:46 UTC
 
Comment 1 Virginia Smith 2007-07-25 04:16:36 UTC
reworded section 3.3:

Each document in the interchange set MUST be represented in an SML-IF document by a separate document element as follows:

    *      Each definition document [Ed. note: insert link to definition] in the interchange set MUST appear as a child of a document element that is a child of the definitions element of the SML-IF document. The order of the document children is not significant.
    *      Each model instance document [Ed. note: insert link to definition] in the interchange set MUST appear as a child of a document element that is a child of the instances element of the SML-IF document. The order of the document children is not significant.

Documents may be included in the SML-IF document either as an embedded document (where the octet stream representing the SML model document to be included is physically embedded in the SML-IF document) or as a document reference.

3.3.1 Embedded Documents

If a document is to be physically embedded in the SML-IF document, the octet stream representing it MUST first be processed as follows:

    *      The XML declaration and document type declaration (DTD) are removed.
    *      The stream is converted to the encoding of the SML-IF document into which it will be packaged.

Note:

If the SML-IF document uses UTF-8 encoding, the octet-stream result of XML Canonicalization [Canonical XML] is more than sufficient to accomplish this processing.

The resulting octet stream MUST be embedded as the content of the data child of the corresponding document element in the SML-IF document.

3.3.2 Document References

If a document is to be referred to rather than embedded, a reference to it MUST placed in the locator child of the corresponding document element.

SML-IF specifies one way such references may be constructed, the documentURI element, however any representation the producer and consumer agree on may be used. [Ed. note: the previous statement is not very portable!]
Comment 2 Kirk Wilson 2007-07-25 14:53:53 UTC
The statement regarding the placement of the model instance document, "Each model instance document...MUST appear as a child of a document element that is a child of the instances element...", appears to be garbled.  The model instance doc is a child of the <instance> element and not the child of a <document> element.  The final clause then seems to get everything into an infinite recursion.  (There might have been a copy/paste error from the preceding statement, and the wrong words were mistaken changed.  Note the <instance> is on the same level as the <document> element.  I believe the statement should read: Each model instance document...MUST appear as a child of a INSTANCE element that is a child of the DEFINITIONS element....) 
Comment 3 Kirk Wilson 2007-07-26 19:05:13 UTC
(In reply to comment #2)
> The statement regarding the placement of the model instance document, "Each
> model instance document...MUST appear as a child of a document element that is
> a child of the instances element...", appears to be garbled.  The model
> instance doc is a child of the <instance> element and not the child of a
> <document> element.  The final clause then seems to get everything into an
> infinite recursion.  (There might have been a copy/paste error from the
> preceding statement, and the wrong words were mistaken changed.  Note the
> <instance> is on the same level as the <document> element.  I believe the
> statement should read: Each model instance document...MUST appear as a child of
> a INSTANCE element that is a child of the DEFINITIONS element....) 

I WAS SUFFERING FROM ANGLE BRACKET DYSLEXIA.  THE TEXT IS CORRECT AS PROPOSED.