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 11228 - minor editorial improvement : definition of particles
Summary: minor editorial improvement : definition of particles
Status: CLOSED FIXED
Alias: None
Product: XML Schema
Classification: Unclassified
Component: Structures: XSD Part 1 (show other bugs)
Version: 1.1 only
Hardware: All All
: P2 minor
Target Milestone: ---
Assignee: David Ezell
QA Contact: XML Schema comments list
URL:
Whiteboard:
Keywords: resolved
Depends on:
Blocks:
 
Reported: 2010-11-05 00:35 UTC by Mukul Gandhi
Modified: 2011-02-01 00:58 UTC (History)
1 user (show)

See Also:


Attachments

Description Mukul Gandhi 2010-11-05 00:35:01 UTC
The latest editor's draft of XML Schema 1.1 spec (ref, http://www.w3.org/XML/Group/2004/06/xmlschema-1/structures.omni.20101029.html) says in the section "3.9.2 XML Representation of Particle Schema Components":

<quote>
Particles correspond to all three elements (<element> not immediately within <schema>, <group> not immediately within <schema> and <any>)
</quote>

The phrase "all three elements" confuses me a bit (word *elements* in "three elements" confuses me with say a formal term "element declaration" in the XSD spec. It seems to me that the intent of the editors here is to denote "three elements" to the XML tags specified in the bracket just after that; but this confuses me). 

I think if the above cited phrase is changed to a text like following, then the meaning of the cited phrase would be more obvious to readers:

<new>
Particles correspond to all three schema instructions (<element> not immediately within <schema>, <group> not immediately within <schema> and <any>)
</new>

i.e I would propose a phrase like "schema instructions" as replacement of text "three elements" in this section of the spec.
Comment 1 David Ezell 2010-11-05 09:31:35 UTC
In Lyon:

The WG discussed this issue (section 3.9.2), and agrees that this paragraph needs to be rewritten.  Among the additional problems the WG sees are:

- there are other elements that allow minOccurs and maxOccurs
- "the appropriate mapping is" should be "the appropriate mappings are"

Thank you for the comment.
Comment 2 C. M. Sperberg-McQueen 2011-01-12 03:55:07 UTC
Proposal:  in section 3.9.2, replace the paragraph 

    Particles correspond to all three elements (<element> not
    immediately within <schema>, <group> not immediately within
    <schema> and <any>) which allow minOccurs and maxOccurs
    attributes. These in turn correspond to two components in each
    case, a particle and its {term}. The appropriate mapping is
    described in XML Representation of Element Declaration Schema
    Components (§3.3.2), XML Representation of Model Group Schema
    Components (§3.8.2) and XML Representation of Wildcard Schema
    Components (§3.10.2) respectively.

with the paragraph 

    Particles in the schema correspond to several different kinds of
    element information items that can bear minOccurs and maxOccurs
    attributes in the schema document:

      - Local <element>, see XML Representation of Element
        Declaration Schema Components (§3.3.2)

      - Model groups <all>, <sequence>, and <choice>, see XML
        Representation of Model Group Schema Components (§3.8.2)

      - Group references <group>, see XML Representation of Model
        Group Definition Schema Components (§3.7.2)

      - Wildcard <any>, see XML Representation of Wildcard Schema
        Components (§3.10.2)
Comment 3 C. M. Sperberg-McQueen 2011-01-12 23:40:52 UTC
Sandy Gao and I have discussed this and come to an agreement that two minor additions are desirable: 

(1) After the first word, insert "typically", so the paragraph begins "Particles typically correspond ..."

(2) Optionally, after the bulleted list insert the sentence 

    There are situations where particles do not correspond to any of 
    these elements. For example, when complex types are extended 
    particle are sometimes synthesized whose function is to contain 
    both the content model of the base type and the particles 
    specified in the extension.

If we can shorten or simplify that closing sentence, it would be good.  Its main purpose is to explain to the inquisitive reader why "typically" has been used in the introduction; it is not to explain the details of complex type extension or anything else, but I am finding it hard to hit the right level of specificity without inviting the reader off on a pointless excursion through XSD minutiae.
Comment 4 C. M. Sperberg-McQueen 2011-01-28 17:47:39 UTC
On 28 January 2011 the WG discussed the proposal given in comment 2 and amended in comment 3.  We agreed on several further amendments:

- The opening should read "Particles in the schema typically ..." not "Particles typically ..."

- Delete the words "several different kinds of".

- Accept the optional addition mentioned in comment 2.

- In the addition, replace the second sentence with "For example, particles may be synthesized in complex type extension."

- In the addition, replace "There are situations where particles" with "Sometimes particles".

So the final change is to replace the paragraph beginning "Particles correspond ..." with


    Particles in the schema typically correspond to element 
    information items that can bear minOccurs and maxOccurs
    attributes in the schema document:

      - Local <element>, see XML Representation of Element
        Declaration Schema Components (§3.3.2)

      - Model groups <all>, <sequence>, and <choice>, see XML
        Representation of Model Group Schema Components (§3.8.2)

      - Group references <group>, see XML Representation of Model
        Group Definition Schema Components (§3.7.2)

      - Wildcard <any>, see XML Representation of Wildcard Schema
        Components (§3.10.2)

    Sometimes particles do not correspond to any of these elements.  
    For example, particles may be synthesized in complex type 
    extension.

The WG adopted the proposal as amended.  I'm marking this issue as decided; the next step is to integrate it into the status-quo documents maintained by the working group.
Comment 5 C. M. Sperberg-McQueen 2011-01-31 23:20:09 UTC
The change outlined in comment 4 has now been integrated into the WG's working copy of the spec and I'm marking the issue resolved.

An email notification of this change should go automatically to Mukul Gandhi, as the originator of the issue.  It would assist us if you would indicate whether you are satisfied with the resolution of this issue by either closing it or reopening it with an explanation of what's wrong.   Thank you!
Comment 6 Mukul Gandhi 2011-02-01 00:58:30 UTC
Thanks for the resolution of this issue. I'm happy with the resolution, therefore
I'm marking the issue closed.

Thanks.