W3C home > Mailing lists > Public > public-webplatform@w3.org > December 2013

Re: Automatic stubs for JavaScript APIs

From: Renoir Boulanger <renoir@w3.org>
Date: Tue, 3 Dec 2013 11:27:29 -0500
Cc: List WebPlatform public <public-webplatform@w3.org>, Max Polk <maxpolk@gmail.com>
Message-Id: <1AE2F661-1EEB-4F9B-BBF4-4A861976E1D4@w3.org>
To: Dominique Hazael-Massieux <dom@w3.org>
Hi all,

On that aspect, Dom, I heard from Mike during TPAC that hed also like us to maintain/expose current HTML language reference [0]. 

I think that this documentation is quite relevant for our content and audience.

@Dom, do you think we could use your utility for it?

  [0]: http://sideshowbarker.github.io/htmlr/


On Nov 17, 2013, at 2:16 PM, Max Polk <maxpolk@gmail.com> wrote:

> We have an initiative to add pages about JavaScript the language, a kind of language reference:
>     http://docs.webplatform.org/wiki/javascript
> A separate existing area is dedicated to APIs:
>     http://docs.webplatform.org/wiki/apis
> Then there are just popular JavaScript libraries.  The latter may also fall into APIs, but doesn't necessarily need to.  It might be better to separate what's built in and standardized versus the latest jQuery, maybe popular libraries would be under wiki/libraries just to be distinct and be so clear about what I get by default versus what I get by loading a third-party library.
> On Fri, Nov 15, 2013 at 4:44 AM, Dominique Hazael-Massieux <dom@w3.org> wrote:
> Hi,
> I chatted with Eliott this week on a potentially useful tool I've built
> that could be used to generate stubs for JavaScript API pages, based on
> how they're defined in specs (using WebIDL).
> As some of you may know, browser JavaScript APIs are described in a
> formal language called WebIDL that lets spec authors describe which
> properties and methods a given JavaScript interface exposes.
> As part of my (irregular) work on the W3C cheatsheet:
> http://www.w3.org/2009/cheatsheet/
> I built a ad-hoc workflow that takes an spec written in HTML, extracts
> the WebIDL fragments, and turn them into (somewhat) human-readable
> content that can then be displayed in the said cheatsheet.
> I won't get into the details of that workflow, but the most motivated
> readers can try to pull the pieces together from:
> https://github.com/dontcallmedom/w3c-cheatsheet/ esp.
> https://github.com/dontcallmedom/w3c-cheatsheet/commit/090e9b929e081fcfd444094a2174f8f5b5d3c861
> I could reasonably easily adapt that workflow to make it generate
> mediawiki markup, which could be used as stubs for a large number of
> APIs.
> I understand that for the most popular APIs, the preferred approach will
> be to import existing content, but hopefully such an automatic approach
> could help bootstrap the work on the APIs in which no or little content
> already exists.
> Is this of interest? If so, what is the best way to proceed with that
> idea?
> Dom
Received on Tuesday, 3 December 2013 16:27:38 UTC

This archive was generated by hypermail 2.3.1 : Tuesday, 6 January 2015 21:20:56 UTC