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 27515 - Last changes breake external references
Summary: Last changes breake external references
Status: RESOLVED WORKSFORME
Alias: None
Product: WHATWG
Classification: Unclassified
Component: URL (show other bugs)
Version: unspecified
Hardware: All All
: P2 normal
Target Milestone: Unsorted
Assignee: Anne
QA Contact: sideshowbarker+urlspec
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-12-04 14:07 UTC by Arkadiusz Michalski (Spirit)
Modified: 2015-06-02 11:21 UTC (History)
3 users (show)

See Also:


Attachments

Description Arkadiusz Michalski (Spirit) 2014-12-04 14:07:56 UTC
Hi, I see that last URL spec change a lot of ids, and potentialy may break some external references (like for MDN site). Of course no big deal and external references can always be corrected (if this form is more convenient for the URL specification). New solution looks better, I check this version: https://specs.webplatform.org/url/webspecs/develop/

But I noticed one strange change. Definitions for terms or algorithms now always use uppercase interface's name:

get the base >> #concept-URLUtils-get-the-base
update steps >> #concept-URLUtils-update
input >> #concept-URLUtils-input
url objects >> #concept-URLSearchParams-url-object
etc.

but all other things use always lowercase names and before change they were always lowercase (like urlutils or urlsearchparams). This applies to all interfaces. Other specifications always use lowercase names for interfaces. Maybe it's better to use a consistent convention?
Comment 2 Arkadiusz Michalski (Spirit) 2014-12-13 02:15:13 UTC
Back to this bug from:
https://www.w3.org/Bugs/Public/show_bug.cgi?id=27507#c5

So once again:

Last URL spec (WHATWG) break refers around API (https://url.spec.whatwg.org/#api), especialy for "6.3. URLUtils and URLUtilsReadOnly members".

Example of one that id:
#dom-urlutils-href (now)
#dom-url-href (before)

and other ids for attributes or methods like protocol, username, password etc. (but not algos and concepts << this are the same)...

So if other docs use them then aren't work now:
https://developer.mozilla.org/en-US/docs/Web/API/URLUtils.href#Specifications
https://developer.mozilla.org/en-US/docs/Web/API/URLUtils.host#Specifications
https://developer.mozilla.org/en-US/docs/Web/API/URLUtils.port#Specifications

But in my opinion this new wariant is better, all this stuff are definded for URLUtils and URLUtilsReadOnly, not for URL.

And in this document https://specs.webplatform.org/url/webspecs/develop/ you use two nested <dfn>, one for URLUtils and one for URLUtilsReadOnly, and make it more clear:
<dfn id="dom-urlutilsreadonly-href">
  <dfn id="dom-urlutils-href"><code>href</code></dfn>
</dfn>

===

But I caught another change; in IDL all ids for interface name have "dom-" prefix, so all old references break now:

Fetch spec refer to URLSearchParams
https://fetch.spec.whatwg.org/#bodyinit
https://fetch.spec.whatwg.org/#concept-bodyinit-extract

MDN
https://developer.mozilla.org/en-US/docs/Web/API/URLUtils#Specifications
https://developer.mozilla.org/en-US/docs/Web/API/URLUtilsReadOnly#Specifications

In other specs from WHATWG (including HTML, and some W3C snapshots) this "dom-" prefix in IDL never exist.

Old solution can be fast checked in this snapshot:
http://w3ctag.github.io/url/

External references can always be corrected but Anne asked me to open bug for this.
Comment 3 Sam Ruby 2014-12-14 00:30:03 UTC
First, sorry about this.  I developed the conversion to bikeshed in a separate branch and tried not to integrate it until it was ready.  Clearly it wasn't.

I've opened an issue on bikeshed which will account for a number of these differences:

https://github.com/tabatkins/bikeshed/issues/308

Once bikeshed has been updated, I'll circle back and try to address the remainder of these differences.
Comment 4 Anne 2015-05-09 09:35:34 UTC
I think the issues from comment 2 are now resolved. Anything left Arkadiusz?
Comment 5 Arkadiusz Michalski (Spirit) 2015-06-02 09:45:01 UTC
Probably correct links in MDN but this is job for people from Mozilla.

Btw., what is the future of this spec? Now we have two documents, WHATWAG/W3C and Web Platform Specs which slightly differ (second use railroad diagrams for parser). It's a bit confusing, I don't know which version is more recent and more forward-looking.
Comment 6 Anne 2015-06-02 11:20:34 UTC
The version at url.spec.whatwg.org is canonical.