Add an index of methods and IDL attributes
Open
Nobody has claimed this yet.
spec tooling
- Dominant language
- HTML
- Stars
- 9.4k
- Forks
- 3.2k
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 38
Description
See https://www.w3.org/Bugs/Public/show_bug.cgi?id=17898
#0 contributor@whatwg.org 2011-08-24 09:09:47 +0000
--------------------------------------------------------------------------------
Specification: http://www.whatwg.org/specs/web-apps/current-work/complete/timers.html
Multipage: http://www.whatwg.org/C#custom-handlers
Complete: http://www.whatwg.org/c#custom-handlers
Comment:
Make "registerProtocolHandler" and "registerContentHandler" appear in the TOC
Posted from: 88.131.66.80 by simonp@opera.com
User agent: Opera/9.80 (Macintosh; Intel Mac OS X 10.5.8; U; en) Presto/2.9.168 Version/11.50
================================================================================
#1 Ian 'Hixie' Hickson 2011-10-12 19:04:44 +0000
--------------------------------------------------------------------------------
Why? Or even, how? The section title would be really long if it included both
those method names, not to mention the other method names defined in that section...
================================================================================
#2 Simon Pieters 2011-10-13 05:02:04 +0000
--------------------------------------------------------------------------------
Why? To make it easier to find (some sections have the relevant API in the ToC,
e.g. designMode). But I guess that applies to any method. Maybe we should have
an index of APIs as an appendix or something.
================================================================================
#3 Ian 'Hixie' Hickson 2011-10-24 18:20:13 +0000
--------------------------------------------------------------------------------
An index would make a lot of sense.
An IDL index would be something we can completely automate. The IDL blocks are
computer-readable, and for each IDL field there's a corresponding <dfn>. If someone
can hack together a quick script that just scans all the IDL blocks and extracts out
all the methods and fields and forms an alphabetical index of them, I'd be happy to
add that script to my publishing pipeline.
================================================================================
#4 Ian 'Hixie' Hickson 2011-10-25 05:13:43 +0000
--------------------------------------------------------------------------------
(Please reassign to me if you have such a script.)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Check the publishing pipeline and the IDL blocks referenced in the discussion; start by determining how those blocks and their corresponding elements are processed. Done means a script can extract methods and fields and produce an alphabetical API index suitable for the publishing pipeline.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100