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 5653 - Final vocabulary clean-up
Summary: Final vocabulary clean-up
Status: RESOLVED FIXED
Alias: None
Product: SML
Classification: Unclassified
Component: Core+Interchange Format (show other bugs)
Version: LC
Hardware: PC Windows XP
: P2 normal
Target Milestone: ---
Assignee: Virginia Smith
QA Contact: SML Working Group discussion list
URL:
Whiteboard:
Keywords: resolved
Depends on:
Blocks:
 
Reported: 2008-04-22 14:52 UTC by Kirk Wilson
Modified: 2008-08-14 15:53 UTC (History)
2 users (show)

See Also:


Attachments

Description Kirk Wilson 2008-04-22 14:52:12 UTC
The documents use three terms: "validator", "consumer" and "processor" and the justification for using one term rather than another is not always clear to the reader.

SML: principal term is "validator": a validator performs SML model validation.
However, section 4.1.3 Note and Appendix F refer to "consumers".  And, 4.2.5 and 5.4.2.3 refer explicitly or implicitly to "model processors".  (Also section 8 refers to "schema-aware processor"--I'm not sure whether that is referring to an XML Schema processor or a SML model validator that must be schema-aware or to a general SML processor that is aware of the PSVI.)  Intuitively, it would seem that "consumer"/"processor" connotes doing something more with the SML model then simply validating it, like actualizing it in an IT environment.   We should either make this additional connotation for "consumer"/"processor" explicit esp. to justify the use of "consumer" in the SML-IF spec.

SML-IF: For some reason the SML-IF spec switches to "SML-IF Consumer" even through it seems that the SML-IF Consumer performs (only - ??) interchange model validation.  First point: the fact that "SML-IF Consumers" perform interchange model validation is not explicitly stated until section 5.1.  This association needs to be made explicit earlier in the text.  Second point: some indication/justification should be given as to why this validator is a "consumer".  Is it a "consumer" because interchange model validation consists of additional processing above SML model validation?  If so we, then the vocabulary developed in SML does not support the vocabulary in SML-IF. 

SML-IF also has some minor, editorial issues:

1. There is a classic case of a dangling participle in section 4.4: "When performing interchange model validation..., association between XML Schema definition documents...."  The associations do not perform interchange model validation.
2.  Section 4.4 item #1 uses "processor" (only time this word is used in SML-IF); clearly, this should be changed to "consumer" if that is our choosen term for this spec.
Comment 1 Kumar Pandit 2008-05-01 19:00:23 UTC
resolution in conf call (5/1/08): mark needsAgreement
Comment 2 John Arwe 2008-06-18 17:49:03 UTC
Proposal 
--------------------------------------
(1) accept the changes made in http://www.w3.org/Bugs/Public/show_bug.cgi?id=5715 as resolving part of this bug, since draft text is already available for this.  http://www.w3.org/Bugs/Public/show_bug.cgi?id=5715#c4 addresses the consumer issue specifically.

--------------------------------------
(2) insert the word 'model', to align with the term defined in 5715
from: assessed by a conforming schema-aware       processor 
to  : assessed by a conforming schema-aware model processor 

Which address the following point(s):
Also section 8 refers to "schema-aware processor"--I'm not sure whether that is
referring to an XML Schema processor or a SML model validator that must be
schema-aware or to a general SML processor that is aware of the PSVI.

In the current editor's draft, a contextual excerpt is:
A conforming SML model is valid if and only if it satisfies all of the following conditions:
   1.      In each instance document in the model, the [validity] property of the root element and all of its attributes and descendants MUST NOT be "invalid" when schema validity is assessed by a conforming schema-aware processor with respect to the referenced XML Schema documents in the model's definition documents. [XML Schema Structures]

--------------------------------------
(3) define SML-IF Producer and SML-IF consumer in section 2 Terminology, as we did with model processor in SML, using text from SMLIF's conformance section 5
SML-IF Producer 
   A SML-IF Producer is a program able to generate a SML-IF Document from a SML model [Conformance].
SML-IF Consumer 
   A SML-IF Consumer is a program able to process a SML-IF Document using, in whole or part, semantics defined by this specification.  It MAY perform interchange set validation [Conformance].

Which address the following point(s):
First point: the fact that "SML-IF Consumers" perform
interchange model validation is not explicitly stated until section 5.1.  This
association needs to be made explicit earlier in the text. 

--------------------------------------
(4) do nothing

The proposed definition above (and, for me, the existing Conformance text) makes it clear that "SMLIF consumer" is a broad class of implementations, of which those performing interchange set validation are a subset.

The submittor may have been confused in this case by the use of (unqualified, i.e. not qualified with "SML-IF") term "consumer" in SMLIF, assuming it meant the same as "consumer" in SML (which, assuming all of 5715 is accepted), would no longer be a source of confusion (with SML).

The editors may wish to search for unqualified "consumer" uses that readers would find ambiguous.  There are at least a few unqualified uses in normative sections of the current editor's draft.

Which address the following point(s):
Second point: some
indication/justification should be given as to why this validator is a
"consumer".  Is it a "consumer" because interchange model validation consists
of additional processing above SML model validation?  If so we, then the
vocabulary developed in SML does not support the vocabulary in SML-IF. 

--------------------------------------
(5) insert 'XML schema' to clarify the meaning
from: allows            processor  latitude
to  : allows XML Schema processors latitude

This becomes more important now that 5715 has defined in SML a "model processor" that could be confused with this unqualified use of "processor".

Current editor's draft excerpt:
The XML Schema specification provides more flexibility in constructing the schema used for assessment than is appropriate for the semantics defined by SML and SML-IF for  interchange model validation.
   1.      It allows processor latitude

Which address the following point(s):
SMLIF minor, editorial issues: 
2.  Section 4.4 item #1 uses "processor"

--------------------------------------
(6) do nothing
(or receive a concrete proposal for change from the submittor, as I don't see anything obviously wrong in the latest draft)

Current editor's draft excerpt:
When performing interchange model validation over the SML model packaged in an SML-IF instance, associations between XML Schema definition documents and instance documents need to be drawn, both to completely validate XML Schema documents themselves and to establish the schema-validity of the instance documents.

Which address the following point(s):
SMLIF minor, editorial issues: 
1. There is a classic case of a dangling participle in section 4.4
Comment 3 John Arwe 2008-06-24 15:40:10 UTC
F2F consensus on proposal in comment 2

- item 1: accepted
- item 2: revised to remove "by a conforming schema-aware processor" so it reads

In each instance document in the model, the [validity] property of the root element and all of its attributes and descendants MUST NOT be "invalid" when schema validity is assessed by a conforming schema-aware processor with respect to the referenced XML Schema documents in the model's definition documents. [XML Schema Structures]

- item 3: revised to

SML-IF Producer 
   A SML-IF Producer is a program that generates a SML-IF Document from a SML
model.

SML-IF Consumer 
   A SML-IF Consumer is a program that processes a SML-IF Document using, in
whole or part, semantics defined by this specification.  It may or may not perform
interchange set validation.

- item 4: revised to

The editors to search for unqualified "consumer" uses that readers
would find ambiguous.  There are at least a few unqualified uses in normative
sections of the current editor's draft.

- item 5: (SMLIF 4.4 item 1) accepted as proposed

- item 6: revised during meeting with a concrete proposal, namely:

When performing interchange model validation over the SML model packaged in an
SML-IF instance, an SML-IF consumer must draw associations between XML Schema definition documents and
instance documents, both to completely validate XML Schema
documents themselves and to establish the schema-validity of the instance
documents.

No need for further wg review expressed.
Comment 5 John Arwe 2008-08-14 15:53:27 UTC
+1