W3C home > Mailing lists > Public > public-webapi@w3.org > April 2006

Re: [comment] XMLHttpRequest Object - version of reference technologies

From: Karl Dubost <karl@w3.org>
Date: Wed, 26 Apr 2006 13:39:25 +0900
Message-Id: <55CC1BA4-9131-4047-B1F5-DA8075C4EA3D@w3.org>
Cc: "Web APIs WG (public)" <public-webapi@w3.org>
To: Anne van Kesteren <annevk@opera.com>


Le 06-04-22 à 17:09, Anne van Kesteren a écrit :
> On Wed, 12 Apr 2006 08:44:51 +0200, Karl Dubost <karl@w3.org> wrote:
>> Please be sure to check and/or mention the version of the  
>> technology when you
>> 	- give an example.
>> 	- give a normative reference.
>>
>> [...]
>>
>> In XMLHttpRequest document itself, the WG mentionned that there  
>> might be changes, it's true for other technologies, it's always  
>> better to give the version you are referring too.
>
> It's not entirely clear to me what you mean with this comment.  
> Could you be more specific?

As a general rule for the document, when you give a reference to a  
specification, a language, another technology gives the exact version  
you are referring to.

In this particular case, Ecmascript? Which version?

The text in the specification

[[[
In ECMAScript, an instance of XMLHttpRequest  can be created using
the XMLHttpRequest()  constructor:
]]]
-- The XMLHttpRequest Object
http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060405/#xmlhttprequest
Wed, 05 Apr 2006 17:02:33 GMT


… could become

****
In ECMAScript 262 [ECMA-262], an instance of XMLHttpRequest  can be  
created using
the XMLHttpRequest()  constructor:
****

Specifically if there's a dependence on the version of the language.  
For example, talking about HTTP in general, or a specific feature of  
HTTP. The semantics of a specific feature might have changed since  
the first version, so it's good to know to which one you are  
referring to and you don't know if the semantics of the future  
versions will change.


If you didn't know as well, there's an handy tool to generate your  
reference section.
http://www.w3.org/2002/01/tr-automation/tr-biblio-ui

For example
http://www.w3.org/2000/06/webdata/xslt?xslfile=http%3A%2F%2Fwww.w3.org 
%2F2002%2F01%2Ftr-automation%2Ftr-biblio.xsl&xmlfile=http%3A%2F% 
2Fwww.w3.org%2F2002%2F01%2Ftr-automation%2Ftr-logs.rdf&uris=http%3A%2F 
%2Fwww.w3.org%2FTR%2FDOM-Level-3-Core%2F%0D%0A


-- 
Karl Dubost - http://www.w3.org/People/karl/
W3C Conformance Manager, QA Activity Lead
   QA Weblog - http://www.w3.org/QA/
      *** Be Strict To Be Cool ***
Received on Wednesday, 26 April 2006 04:40:51 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Tuesday, 8 January 2008 14:18:55 GMT