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 18025 - Wiki documentation of Pragma directive requirements are unworkable as currently written
Summary: Wiki documentation of Pragma directive requirements are unworkable as current...
Status: RESOLVED MOVED
Alias: None
Product: WHATWG
Classification: Unclassified
Component: HTML (show other bugs)
Version: unspecified
Hardware: Other All
: P3 normal
Target Milestone: Unsorted
Assignee: Ian 'Hixie' Hickson
QA Contact: contributor
URL:
Whiteboard: registry
Keywords:
Depends on:
Blocks:
 
Reported: 2012-07-18 15:55 UTC by contributor
Modified: 2017-12-08 22:48 UTC (History)
6 users (show)

See Also:


Attachments

Description contributor 2012-07-18 15:55:04 UTC
This was was cloned from bug 17684 as part of operation convergence.
Originally filed: 2012-07-03 23:16:00 +0000
Original reporter: theimp@iinet.net.au

================================================================================
 #0   theimp@iinet.net.au                             2012-07-03 23:16:44 +0000 
--------------------------------------------------------------------------------
The HTML5 spec. (Meta/Other pragma directives) currently states:

> Extensions to the predefined set of pragma directives may, under certain conditions, be registered in the WHATWG Wiki PragmaExtensions page.

> Such extensions must use a name that is identical to an HTTP header registered in the Permanent Message Header Field Registry, and must have behavior identical to that described for the HTTP header.

This seems to be a problem, because there seems to be significant interest in “documenting reality”: put it in the wiki first, sort out conformance with the IANA later (ie. never). The argument goes that the ends justify the means; that conformance with the spec. (indeed, with any spec.) is relatively unimportant if you're a vendor, that developers are better off understanding how the real world works than how to play nice, and that documenting how to do things that you're not allowed to do is the ideal role of a specification.

The situation we have at this stage, is that people put whatever they want in the wiki, which the HTML5 spec. says is invalid (IANA registration is required before directives can be added to the wiki), but which it also says is valid (defer to the wiki for a list of valid directives).

[The preceding paragraph is, in essence, the totality of this bug.]

This might be a minor issue, except that attempts to reconcile the wiki with the spec. seem to spark edit/revert wars.

So, if the HTML5 spec. is to avoid contradicting itself, one, or both, of those requirements must change, or something else must change which will render the contradiction moot.

Apparently, there is agreement on that wiki, that this situation must indeed be resolved, and by changing this spec.; so, I have filed this bug so that the issue can be formally considered.

Possible resolutions include:

* Remove the IANA requirement requirements from that part of the HTML5 spec. Apparently dealing with the IANA “annoying”, and there is “No need to abide” with such annoyance (according to the Talk page on that wiki). Expect new pragma directives to flourish.

* Remove the wiki requirements from that part of the HTML5 spec. Just delegate to the IANA, as was done in the past. The spec. won't be wrong, but it apparently won't match reality.

* Remove all requirements from that part of the HTML5 spec. Let people check with the vendor as to what is required for compatibility with a given product, and decide for themselves what to do.

* Clarify in the spec. that non-IANA registered entries are permitted in the wiki for documentation purposes, but remain invalid for use without IANA registration. Then people can document reality all they like, while developers now have to check two registries to determine pragma validity.

* Create an additional "informative" wiki entry for adding known (invalid) pragma directives, for the purposes of documenting them. To satisfy developer curiosity, I presume, since they are invalid for use.

* Eliminate the registry, and update the spec. every time a new and important header enters widespread use (the “living document” argument).

* Do nothing, let edit wars rage on the wiki, requiring hourly updates to conformance checkers, and crush the hope out of anyone who wants to code their websites to the standard.

See also:
Bug 9530
http://wiki.whatwg.org/wiki/Talk:PragmaExtensions
================================================================================
Comment 1 Ian 'Hixie' Hickson 2012-10-02 19:29:50 UTC
Marking LATER as I'm not planning on doing the registry revamp in the near future. Will get back to this.
Comment 2 Domenic Denicola 2017-12-08 22:26:25 UTC
Going through old issues I found this issue and think we should be able to solve it relatively easily in the modern era. I think we should just update the spec if there are any valid http-equiv values that affect processing, and not use the wiki at all for http-equiv.

The only real remaining question is what to do about the sole entry on the wiki, "PICS-Label". It appears following the link that PICS has been replaced by something called POWDER. https://www.w3.org/2009/08/pics_superseded.html says that POWDER doesn't use http-equiv, but instead a standalone XML document.

As such, I'm inclined to just remove the extension point from the spec, and null out the wiki page. Does anyone have any objections or thoughts?
Comment 3 Domenic Denicola 2017-12-08 22:48:47 UTC
I'll mark this as moved to https://github.com/whatwg/html/pull/3279, my pull request for removing the wiki pointer from the standard. Feel free to still comment here if you wish, or comment there if GitHub is easier.