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 5437 - 5.1.1 Using the SML-IF Version Attribute
Summary: 5.1.1 Using the SML-IF Version Attribute
Status: RESOLVED FIXED
Alias: None
Product: SML
Classification: Unclassified
Component: Interchange Format (show other bugs)
Version: LC
Hardware: PC Windows XP
: P2 normal
Target Milestone: LC
Assignee: Valentina Popescu
QA Contact: SML Working Group discussion list
URL:
Whiteboard:
Keywords: resolved
Depends on:
Blocks:
 
Reported: 2008-01-29 03:27 UTC by Valentina Popescu
Modified: 2008-02-14 20:30 UTC (History)
0 users

See Also:


Attachments

Description Valentina Popescu 2008-01-29 03:27:27 UTC
There are a few issues with the current content

1. This sentence doesn't read well..

Therefore, a consumer of SML-IF document MUST NOT reject the document simply on the basis that it has a different version of the specification.

propose to change it to :
Therefore, an SML-IF Consumer MUST NOT reject the document simply on the basis that it has a different version of the specification.  

2. There is a typo on the Note section :

Non-normative note: The SMLIFVersion number may be useful when diagnosing failures >>>enountered<<< while processing SML-IF documents.   

3. To follow the document format, the note should read:

Note 
This note is non-normative.The SMLIFVersion number may be useful when diagnosing failures encountered while processing SML-IF documents. 


4. I think it would be better if the Note is actually moved under the non-normative section ( 4. Informal Description ), with an updated content:

"The SMLIFVersion number may be useful when diagnosing failures encountered while processing SML-IF documents.   E.g. if a document asserts conformance with SML-IF 1.1 and a human can see that it is not in fact conformant, then it is likely that the problem occurred during the production of the document. If the same document appears to humans to be conformant, then the focus of diagnosis might shift toward the consumer and its invocation parameters.

Requiring consumers to continue processing in the face of unknown version values makes it easier to deploy producers and documents that support future versions of SML-IF.
"

5. Propose updating the section title from 

Using the SML-IF Version Attribute
to
SML-IF Document Version
Comment 1 Valentina Popescu 2008-01-29 03:41:39 UTC
One more to add :

Move this section under 5.2.x where the rest of the document-level stuff lives. It is currently defined under the conformance section.
Comment 2 Valentina Popescu 2008-01-31 20:59:17 UTC
reviewed in 01/31 meeting; resolution to mark editorial 

require needsReview on completion 
Comment 3 Valentina Popescu 2008-02-02 00:16:08 UTC
Changes :

1. Section 'Using the SML-IF Version Attribute' renamed to 'SML-IF Document Version' and moved under the section 5.2 SML-IF Documents.
Updated content :

5.2.4 SML-IF Document Version

An SML-IF producer MAY specify the version of the SML-IF specification with which conformance is declared by including the version number of the relevant specification as the value of the SMLIFVersion attribute in the document's model element. This value MUST be 1.1 for documents conforming with the current specification. SML-IF Consumers MUST attempt to process an SML-IF document regardless of the value of the SMLIFVersion attribute. Therefore, an SML-IF Consumer MUST NOT reject the document simply on the basis that it has a different version of the specification.

Note:

This note is non-normative: Requiring consumers to continue processing in the face of unknown version values makes it easier to deploy documents that support future versions of this specification. 

http://dev.w3.org/cvsweb/~checkout~/2007/xml/sml/build/sml-if.html?content-type=text/html;%20charset=utf-8#smlif_version


2. New non-normative content created under 4.1 Packaging :

The SMLIFVersion attribute is defined on the model element and may be useful when diagnosing failures encountered while processing SML-IF documents. For example, if a document asserts conformance with version 1.1 of the SML-IF specification and a human can see that it is not in fact conformant, then it is likely that the problem occurred during the production of the document. If the same document appears to humans to be conformant, then the focus of diagnosis might shift toward the consumer and its invocation parameters.

http://dev.w3.org/cvsweb/~checkout~/2007/xml/sml/build/sml-if.html?content-type=text/html;%20charset=utf-8#Packaging



Comment 4 Kumar Pandit 2008-02-13 08:04:59 UTC
+1 for the changes.
Comment 5 John Arwe 2008-02-14 02:07:25 UTC
+1 too