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 5388 - Definition of "Reference"
Summary: Definition of "Reference"
Status: RESOLVED FIXED
Alias: None
Product: SML
Classification: Unclassified
Component: Core+Interchange Format (show other bugs)
Version: unspecified
Hardware: PC Windows XP
: P2 normal
Target Milestone: LC
Assignee: Virginia Smith
QA Contact: SML Working Group discussion list
URL:
Whiteboard:
Keywords: resolved
Depends on:
Blocks:
 
Reported: 2008-01-17 14:11 UTC by Kirk Wilson
Modified: 2008-02-07 21:07 UTC (History)
0 users

See Also:


Attachments

Description Kirk Wilson 2008-01-17 14:11:32 UTC
Section 2.2 of SML defines the single term "Reference".  However, this term is ambiguous in SML: it may refer to either an SML reference (the element) or a reference scheme.  I suspect the definition of "Reference" given in 2.l2 is actually the definition of "reference scheme".  There needs to be an explicit definition of "reference scheme" because the notion is used in section 4 with no explanation.  (Besides, the word "scheme" also has two radically meanings: reference scheme and XPointer scheme, and the text should highlight this fact for the benefit of the reader, esp. where they occur rignt next to each other as in 4.3.1 and 4.3.1.1.)

The use of "reference" vs. "SML Reference" seems to be almost arbitrary in the text.  Suggestions:
1.  Section 2.2 should contain two additions (something like):
SML Reference: An element providing the means to link to another element.  The means is called a reference scheme.  An SML reference may specify multiple such means.
2.  Reference scheme: current definition of "Reference".
Review the text and use "SML reference" in all places where this concept is being referred to.  Use "reference" only where the context is clearly generic.
Comment 1 Virginia Smith 2008-01-17 19:49:05 UTC
Resolution: 
Define 2 terms - SML Reference (currently "Reference" in the terminology section) and SML Reference scheme (definition should indicate that it is different from xpath schemes)
Review all uses of unqualified "reference" and fix if necessary. Also review uses of "scheme".
Comment 2 Virginia Smith 2008-01-17 19:50:28 UTC
change 'xpath' to 'xpointer' in previous comment.
Comment 3 Virginia Smith 2008-01-29 01:55:37 UTC
The 2 definitions are as follows:

SML Reference
    A link from one element in an SML model to another element from the same model. 

SML Reference Scheme
    A representation of an SML reference. An SML reference may be represented by multiple, different SML reference schemes. This specification specifies how an SML reference scheme must be defined [4.3 SML Reference Schemes] and also specifies one such reference scheme, the SML URI Reference Scheme [4.3.1 SML URI Reference Scheme]. Whenever "reference scheme" occurs in this specification, it should be assumed to mean "SML reference scheme" unless otherwise noted. An SML reference scheme is unrelated to XPointer schemes.


======
Reviewed both specs and revised to be clear when reference and reference scheme is used.
See SML and SML-IF diffs at:

http://dev.w3.org/cvsweb/2007/xml/sml/build/sml.html.diff?r1=1.146&r2=1.147&f=h
http://dev.w3.org/cvsweb/2007/xml/sml/build/sml-if.html.diff?r1=1.97&r2=1.98&f=h
Comment 4 Virginia Smith 2008-02-07 21:01:27 UTC
Resolution: mark as fixed with one change:

SML Reference
    A link from one element in an SML model to another element *in* the same
model.
Comment 5 Virginia Smith 2008-02-07 21:07:53 UTC
Made change per comment #4. Marked as fixed.