W3C home > Mailing lists > Public > public-webplatform@w3.org > November 2012

Re: Creating API pages

From: Julee Burdekin <julee@adobe.com>
Date: Tue, 13 Nov 2012 09:29:10 -0800
To: Alex Komoroske <komoroske@google.com>, Scott Rowe <scottrowe@google.com>
CC: David Gash <dgash@google.com>, "public-webplatform@w3.org" <public-webplatform@w3.org>
Message-ID: <CCC7C335.3292C%julee@adobe.com>
Yes, we have a conference number now!

W3C_DOCS
Wednesday, 14 November 17:00-18:00 UTC
<http://www.timeanddate.com/worldclock/fixedtime.html?month=11&day=14&year=2
012&hour=17&min=00&sec=0&p1=0>  (12:00pm-1:00pm Boston local)
Zakim Bridge +1.617.761.6200 <tel:+1.617.761.6200>

conference 3627 ("DOCS")

Talk with you tomorrow.

Julee

From:  Alex Komoroske <komoroske@google.com>
Date:  Tuesday, November 13, 2012 8:12 AM
To:  Scott Rowe <scottrowe@google.com>
Cc:  David Gash <dgash@google.com>, "public-webplatform@w3.org"
<public-webplatform@w3.org>
Subject:  Re: Creating API pages

Awesome! Before you do too much work, I think it makes sense to discuss this
proposal at the Content Architecture call (which, if I recall correctly, is
tomorrow).

On Mon, Nov 12, 2012 at 12:06 PM, Scott Rowe <scottrowe@google.com> wrote:
> Thanks Dave! Be sure to share any issues you encounter on this thread.
> +Scott
> 
> 
> 
> On Mon, Nov 12, 2012 at 11:16 AM, David Gash <dgash@google.com> wrote:
>> Scott / all,
>> 
>> I'm starting to document the web audio API. Based on Scott's proposal doc and
>> the W3C specs, the first few topics' URLs will be structured thus:
>> 
>> apis/webaudio
>> 
>> apis/webaudio/objects/AudioContext/properties/destination
>> apis/webaudio/objects/AudioContext/properties/sampleRate
>> apis/webaudio/objects/AudioContext/properties/currentTime
>> apis/webaudio/objects/AudioContext/properties/listener
>> apis/webaudio/objects/AudioContext/properties/activeSourceCount
>> apis/webaudio/objects/AudioContext/methods/createBuffer
>> apis/webaudio/objects/AudioContext/methods/decodeAudioData
>> apis/webaudio/objects/AudioContext/methods/createBufferSource
>> apis/webaudio/objects/AudioContext/methods/. . . etc.
>> 
>> apis/webaudio/objects/AudioNode/properties/context
>> apis/webaudio/objects/AudioNode/properties/numberOfInputs
>> apis/webaudio/objects/AudioNode/properties/numberOfOutputs
>> apis/webaudio/objects/AudioNode/methods/connect
>> apis/webaudio/objects/AudioNode/methods/disconnect
>> 
>> apis/webaudio/objects/. . . etc.
>> 
>> There are a lot more objects, properties, and methods in this API, of course,
>> but Scott has reviewed this plan and, barring any objections, that's the path
>> structure I'll be following.
>> 
>> I plan to outline the entire set before creating any pages, then create all
>> the stubs, then go back and fill in.
>> 
>> Cheers,
>> Dave
>> 
>> 
>> 
>> On Thu, Nov 8, 2012 at 12:03 PM, Scott Rowe <scottrowe@google.com> wrote:
>>> When I sat down to document the process for creating API pages, using the
>>> WebRTC documentation as the poster child, I found more questions than
>>> answers. I realized that we did not have a good story here, so I did my best
>>> to fill in the holes with a methodology that attempts to solve the problems
>>> I found.
>>> 
>>> You find this methodology described in WPD:Creating_API_pages
>>> <http://docs.webplatform.org/wiki/WPD:Creating_API_pages> .
>>> 
>>> Note that it started out as a how-to for contributors, but quickly became a
>>> proposal. So parts of it will read either way. Don't be alarmed. The purpose
>>> of the document is to provide you with a methodology to try on as you do
>>> what I did - test it out with your own API pages.
>>> 
>>> As you do, please don't update the methodology in that page - let's discuss
>>> it first. We can use this thread for the discussion.
>>> 
>>> Thanks for your help!
>>> 
>>> +Scott
>>> 
>> 
> 
Received on Tuesday, 13 November 2012 17:30:17 UTC

This archive was generated by hypermail 2.3.1 : Wednesday, 8 May 2013 19:57:35 UTC