This is an archived snapshot of W3C's public bugzilla bug tracker, decommissioned in April 2019. Please see the home page for more details.
This was was cloned from bug 13226 as part of operation convergence. Originally filed: 2011-07-12 20:05:00 +0000 Original reporter: Glenn Adams <glenn@skynav.com> ================================================================================ #0 Glenn Adams 2011-07-12 20:05:49 +0000 -------------------------------------------------------------------------------- At present, Index (Interfaces) only includes a "list of interfaces for elements" table. However, a number of interfaces are defined that do not correspond to elements and that are not listed in this index. Suggest that a separate, full (lexicographically) ordered table be provided in addition to the current list of all defined interfaces. This table should include (1) entries (links) to the following (defined) interfaces that are presently not in this index, and (2) entries (links) to those interfaces currently listed in the index (within list of interfaces for elements table): ApplicationCache AudioTrack AudioTrackList BarProp BeforeUploadEvent HashChangeEvent History HTMLAllCollection HTMLAnchorElement (supplemental) HTMLAppletElement HTMLAreaElement (supplemental) HTMLBaseFontElement HTMLBodyElement (supplemental) HTMLBRElement (supplemental) HTMLCollection HTMLDirectoryElement HTMLDivElement (supplemental) HTMLDListElement (supplemental) HTMLDocument HTMLDocument (supplemental) HTMLEmbedElement (supplemental) HTMLFontElement HTMLFormControlsCollection HTMLFrameElement HTMLFrameSetElement HTMLHeadingElement (supplemental) HTMLHRElement (supplemental) HTMLHtmlElement (supplemental) HTMLIFrameElement (supplemental) HTMLImageElement (supplemental) HTMLInputElement (supplemental) HTMLLegendElement (supplemental) HTMLLIElement (supplemental) HTMLLinkElement (supplemental) HTMLMarqueeElement HTMLMediaElement HTMLMenuElement (supplemental) HTMLMetaElement (supplemental) HTMLObjectElement (supplemental) HTMLOListElement (supplemental) HTMLOptionsCollection HTMLParagraphElement (supplemental) HTMLParamElement (supplemental) HTMLPreElement (supplemental) HTMLScriptElement (supplemental) HTMLTableCaptionElement (supplemental) HTMLTableCellElement HTMLTableCellElement (supplemental) HTMLTableColElement (supplemental) HTMLTableElement (supplemental) HTMLTableRowElement (supplemental) HTMLTableSectionElement (supplemental) HTMLUListElement (supplemental) HTMLUnknownElement DataTransfer DataTransferItem DataTransferItemList DOMHTMLImplementation DOMTokenList DOMSettableTokenList DOMStringMap External Function FunctionStringCallback Location MediaController MediaError MutableTextTrack Navigator NavigatorContentUtils NavigatorID NavigatorOnLine NavigatorStorageUtils PageTransitionEvent PopStateEvent RadioNodeList TextTrack TextTrackCue TextTrackCueList TimeRanges Transferable ValidityState VideoTrack VideoTrackList Window WindowBase64 WindowModel WindowTimers XMLDocumentLoader This comment is in reference to Editor's Draft of 11 July 2011. ================================================================================ #1 Ms2ger 2011-07-15 13:34:27 +0000 -------------------------------------------------------------------------------- I think the easiest way forward would be to attach such a table to this bug, ready to be inserted into the source of the spec. ================================================================================ #3 Ian 'Hixie' Hickson 2011-08-17 23:51:14 +0000 -------------------------------------------------------------------------------- Status: Did Not Understand Request Change Description: no spec change Rationale: If you really want this, please do as suggested in comment 1. However, this kind of thing is a maintenance nightmare and I'm not very enthusiastic about it. ================================================================================ #4 Glenn Adams 2011-11-20 18:16:36 +0000 -------------------------------------------------------------------------------- Please provide a reference (URL) to the source material for generating the Interface appendix, and I will prepare additional material to insert in that appendix in order to complete the index of defined Interfaces. ================================================================================ #5 Ms2ger 2011-11-20 20:22:28 +0000 -------------------------------------------------------------------------------- http://svn.whatwg.org/webapps/ ================================================================================ #6 Glenn Adams 2011-11-21 16:55:27 +0000 -------------------------------------------------------------------------------- Created attachment 1045 [details] Patch - Interfaces Index This patch, applied to revision 6831 of [1], does the following: * change heading of Interfaces index to read Interfaces of Elements * adds new Interfaces and Types index, which lists *all* defined interfaces and *all* normatively referenced external interfaces and types [1] http://svn.whatwg.org/webapps/source ================================================================================ #7 Ian 'Hixie' Hickson 2011-12-03 00:12:18 +0000 -------------------------------------------------------------------------------- That patch is incomplete (e.g. it doesn't include WebSockets, which would have to be included and marked as not applying to the W3C copy of the spec). However, I'm really not at all convinced this index would be in any way useful. What purpose does it serve? It's a maintenance nightmare (has to be updated every time we change the interfaces), and doesn't seem to summarise any information that anyone would ever need to quickly look up. ================================================================================ #8 Ian 'Hixie' Hickson 2011-12-07 20:04:18 +0000 -------------------------------------------------------------------------------- Status: Rejected Change Description: no spec change Rationale: see comment 7 ================================================================================ #9 Glenn Adams 2011-12-07 20:13:32 +0000 -------------------------------------------------------------------------------- If you choose to ignore this bug, and not add the additional full table of interfaces, then please change the title of the heading to "Interfaces (Partial)" and add a descriptive note to the following effect: "This index does not enumerate all interfaces defined by this specification." ================================================================================ #10 Ian 'Hixie' Hickson 2011-12-07 20:23:59 +0000 -------------------------------------------------------------------------------- I'm happy to change the title of the section to "Element Interfaces", which is what it lists. ================================================================================ #11 Glenn Adams 2011-12-07 20:29:49 +0000 -------------------------------------------------------------------------------- ok, i can accept that, but it still begs the question of the completeness of the index; the reason for having an index is so that the reader has a convenient place to find an enumeration of whatever; it would certainly be a service to the reader to have a full list of interfaces, and I spent some effort to create that list; i understand that, like any manually created index, it is challenging to update frequently; if you had a tool to automate that indexing, then it would reduce or remove that problem; e.g., would it be possible to use micro-syntax to label interface defs to easily extract an index that you could integrate into your production chain? ================================================================================ #12 Cameron McCormack 2011-12-07 23:04:16 +0000 -------------------------------------------------------------------------------- Why not merge the current Element Interfaces table into the Elements table? It seems the Elements table already has everything in the Element Interfaces table except for the list of inherited interfaces. I think having the Interfaces section list all interfaces in the spec would be useful. Whenever I need to look up an interface in the spec, I have to remember what section of the spec it is in (since I prefer to use the multipage version of the spec rather than the single page, where I would otherwise be able to just press Cmd+F). I don't think it should be that hard -- can I write you a Perl script to add this? ================================================================================ #13 Ian 'Hixie' Hickson 2012-01-31 22:36:55 +0000 -------------------------------------------------------------------------------- If you can write a script to automatically generate such an interface table, I would be more than happy to use it. Ping me on IRC if you're still interested in doing this. ================================================================================ #14 Ian 'Hixie' Hickson 2012-02-01 03:41:07 +0000 -------------------------------------------------------------------------------- (Reassigning to heycam for now; please reassign to me if you change your mind or do it.) ================================================================================ #15 Cameron McCormack 2012-02-12 08:53:16 +0000 -------------------------------------------------------------------------------- Created attachment 1078 [details] script to generate interface index I don't know what format you want the index in. This script takes the "index" file (the post-processed file) as input. It generates output like: <ul> <li><code><a href=#htmlanchorelement>HTMLAnchorElement</a></code>, <a href=#xxx1>partial</a> <li><code><a href=#htmlelement>HTMLElement</a></code> <li><code>XMLDocument</code>, <a href=#xmldocument>partial</a> </ul> where xxx1 is the id="" on the <a>HTMLAnchorElement</a> in the <pre> for its obsolete attributes, if you added one. Feel free to adapt as desired. It's probably quite sensitive to the exact formatting of the markup you seem to use. ================================================================================
For completeness, I think this was applied in http://html5.org/tools/web-apps-tracker?from=7256&to=7257 .