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 5499 - Explanation of notation for { } and [ ]
Summary: Explanation of notation for { } and [ ]
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: CR
Assignee: James Lynn
QA Contact: SML Working Group discussion list
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-02-21 20:52 UTC by Kirk Wilson
Modified: 2008-06-19 18:22 UTC (History)
2 users (show)

See Also:


Attachments

Description Kirk Wilson 2008-02-21 20:52:32 UTC
Add text in the Notation section of both documents explaining use of curly brackets, {}, and square brackets, [].  Usage MUST be consistent with the usage of this notation in XML Schema: i.e., {} designate properties of schema components, [] designate properties of information item.

No further changes are required in the Core spec.  However, usage of this notation should be reviewed in SML-IF.  In particular, in SML-IF "{aliases}" are defined (in section 5.3.3) to be a property of documents; however documents are not schema components.  If the <document> element is intended, then this property should be in square brackets.

Also, in Appendix B of SML-IF, are the following phrases:
  the {namespace name} URI information of the sml:locid attribute. . ., and
  The {local part} information of the sml:locid attribute. . .

Since sml:locid is an information element, the square brackets should be used.
Comment 1 James Lynn 2008-05-22 14:28:47 UTC
http://www.w3.org/Bugs/Public/show_bug.cgi?id=5499
Added text describing {} and [] notation.
Made suggested changes to existing braces to brackets.
Comment 3 Virginia Smith 2008-06-05 19:32:51 UTC
Per 5/5 meeting: Change paragraph in section 2.1 in both core and IF specs using as a start the following text:
"Proposal: References to properties of schema components are links to the relevant definition, set off with curly braces, for instance {example property}. This is the same convention as that used in the XML schema specification [ XML Schema Structures ]. References to properties of information items as defined in [ XML Information Set ] are notated as links to the relevant section thereof, set off with square brackets, for example [children]."
The sense of the working group is that we want the text to be 'true' whether or not any such notations are present in the spec.

Mark needsReview when done.
Comment 4 James Lynn 2008-06-18 01:47:48 UTC
Changed text in both specs to:

"This specification follows the same conventions for schema components as those used in the XML schema specification [XML Schema Structures]. For example, references to properties of schema components are links to the relevant definition, set off with curly braces, for instance {example property}. References to properties of information items as defined in [XML Information Set] are notated as links to the relevant section thereof, set off with square brackets, for example [children]. "

After reviewing the original wording, I came up with the above wording to reflect what I believe was the a more general intention about following the conventions of the XML Schema spec, of which these are two specific examples. This requires review and agreement by the WG.
Comment 5 John Arwe 2008-06-18 13:31:00 UTC
+1
Comment 6 Virginia Smith 2008-06-18 16:01:26 UTC
+1 with following editorial change:
- removal of "For example, " in second sentence or replace it with "That is, "
Comment 7 Kumar Pandit 2008-06-19 06:14:01 UTC
+1
I agree with comment# 6
Comment 8 Kirk Wilson 2008-06-19 15:04:34 UTC
+1
Agree with comment #6
Comment 9 Virginia Smith 2008-06-19 18:17:05 UTC
Resolution in 6/19 meeting: Fix per 2nd suggestion in comment #6 (use "That is"). No need to review.
Comment 10 James Lynn 2008-06-19 18:22:21 UTC
Changed according to Comment #6