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 1345 - Please add RFC 3023 in the reference section
Summary: Please add RFC 3023 in the reference section
Status: CLOSED FIXED
Alias: None
Product: XPath / XQuery / XSLT
Classification: Unclassified
Component: XQueryX 1.0 (show other bugs)
Version: Last Call drafts
Hardware: PC Windows XP
: P2 minor
Target Milestone: ---
Assignee: Jim Melton
QA Contact: Mailing list for public feedback on specs from XSL and XML Query WGs
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-05-11 03:23 UTC by Felix Sasaki
Modified: 2006-05-12 21:27 UTC (History)
0 users

See Also:


Attachments

Description Felix Sasaki 2005-05-11 03:23:15 UTC
http://www.w3.org/International/2005/02/xqueryx-review.html Comment: 2
Comment 1 Felix Sasaki 2005-05-18 18:59:57 UTC
(In reply to comment #0)
> http://www.w3.org/International/2005/02/xqueryx-review.html Comment: 2

concerning various subsections. Editorial: Please add RFC 3023 in the reference
section (Appendix A).
Comment 2 Jim Melton 2005-06-02 19:52:48 UTC
Thank you for your comment.  We will add the new reference as suggested. 
Comment 3 C. M. Sperberg-McQueen 2006-04-27 00:18:25 UTC
Pardon me for reopening this bug report -- somehow it seems thriftier
than opening a new one and using up another integer.  We wouldn't want
to run out.

In the Candidate Recommendation version of the XQueryX spec, the fix
for this bug appears to be not quite complete.  At least, I think the
reference would be clearer if the reference to RFC 3023 among the
references in appendix A (http://www.w3.org/TR/xqueryx/#biblio)
actually included the string "RFC 3023".  Specifically, I propose that
the bibliographic label be changed from "XML Media Types" to "RFC
3023" to match the usage in the reference RFC 2119 immediately
preceding.  Personally, I also think it would be useful to include the
RFC number in the body of the bibliographic entry (e.g. after the
title?), but that's probably best left to editorial discretion.  If
you don't use 'RFC 3023' as the short-form bibliographic label, then
you really must find someplace in the body of the reference to give
the number explicitly; otherwise it's too easy to overlook.  (I was
halfway toward clicking 'Submit' on a bug report saying this bug
hadn't actually been fixed before I noticed the reference.)

Also, note that none of the references to RFC 3023 in appendix C.2 are
successfully hyperlinked to the reference (perhaps because they use
the short form 'XMLMIME' rather than 'XML Media Types').

And finally, since it has been on my mind: RFC 3023 was published in
January 2001, and while I do not find an expiration date in the text,
it is subject to obsolescence and replacement by a newer RFC, and
indeed a new version of the RFC is in preparation.  I understand from
Chris Lilley that the materials are now ready for a slightly wider
public review:

  http://www.w3.org/2006/02/son-of-3023/draft-murata-kohn-lilley-xml-02.html
  http://www.w3.org/2006/02/son-of-3023/draft-murata-kohn-lilley-xml-02.xml
  http://www.w3.org/2006/02/son-of-3023/draft-murata-kohn-lilley-xml-02.txt

  See also the directory http://www.w3.org/2006/02/son-of-3023/ for
  diffs of the xml (wrt -01.xml) and the html (wrt -01.html).

Under the circumstances, I think that in the References section the
reference should be given a note to say that the normative reference
is to RFC 3023 or its successor(s), e.g.

  The version cited was current at the time this specification
  was published.  If it is succeeded by other documents, the later
  versions should be used.

(I use the word 'should' here advisedly; this wording should be
considered carefully, whatever the WGs decide.)

In the text, perhaps the references in C.2 should be to RFC 3023 "or
its successor(s)" -- I think at least the one in C.2.10 should be.
Comment 4 Jim Melton 2006-04-27 14:45:45 UTC
Thanks for the additional suggestions.  We have changed the way in which two of the three RFCs are referenced (and appear in the bibliography) to use the convention that RFC 2119 references used.  We have also added the phrase "or its successors" to the bibliography entry for RFC 3023.  In addition, we fixed the incorrect reference text to RFC 3023 in Appendix C.  We have not adopted the suggestion to insert the more generic caution ("The version cited was current at the time this specification was published.  If it is succeeded by other documents, the later versions should be used.") because we believe that this sort of caution should be applied uniformly to all bibliographic entries in all XQuery/XPath-related documents and not only to XQueryX, making it a much broader WG issue. 

We are (re)marking this bug as FIXED.  If you agree with this resolution, we would be grateful if you would mark it CLOSED.  If you do not agree, then please REOPEN the bug again.