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

RE: JS content plan

From: Julee Burdekin <jburdeki@adobe.com>
Date: Tue, 12 Nov 2013 22:40:09 -0800
To: Eliot Graff <Eliot.Graff@microsoft.com>, WebPlatform Public List <public-webplatform@w3.org>
Message-ID: <34l2w1g85ow4oqq8wynujnsx.1384324805603@email.android.com>
Hi, Eliot!

I hope I'm answering your questions, here.

Max has broken down the reference into the 9 top-level categories.[1] In that list, is an implied granularity. So, that's what'll be imported in. We may want to break down some of these more (separate pages for each error type, for instance), but this is the starting point for the page-level granularity. So we should review the pages and determine if a special template is needed: for example, the reserved word page doesn't need it's own template, right?

But we do need new templates for some JS language elements, right? For example, the Object template would need the following semantic fields:

* Summary (currently non-existent, appears in non-titled first section of content)

* Syntax (currently non-existent, appears in non-titled first section of content; derived content)

* Parameters

* Usage (currently part of "Remarks" section)

* Examples (currently part of "Remarks" section)

* Properties (derived content)

* Functions (derived content)

* Methods (derived content)

* Specification link (currently in "Requirements")

* Compatibility (currently in "Requirements")

* Attribution (currently non-existent)

* See also (currently non-existent)

Is that the kind of thing you're looking for? What do you think?


[1] http://docs.webplatform.org/wiki/WPD:Projects/javascript#Top-level_pages

Sent from my "smart" phone... go figure...

-------- Original message --------
From: Eliot Graff
Date:11/12/2013 8:04 PM (GMT-08:00)
To: Julee Burdekin ,WebPlatform Public List
Subject: RE: JS content plan

Hi Julee.

Thank you so much for doing this.

How granular do you think we need to go on the templates for the reference page? Do we need a separate template for functions, operators, objects, etc.? At the last Seattle doc sprint, people were looking for guidance like that for HTML elements, attributes, at the more granular level. I know for CSS we really just had the one Font property page as the exemplar. But that may be a different animal.



From: Julee Burdekin [mailto:jburdeki@adobe.com]
Sent: Wednesday, November 13, 2013 10:06 AM
To: WebPlatform Public List
Subject: JS content plan

Hi, folks:

Iíve started a content plan for the JavaScript import.[1] Please feel free to add to it, or send feedback my way.


[1] http://docs.webplatform.org/wiki/WPD:Projects/javascript/content

Received on Wednesday, 13 November 2013 06:40:54 UTC

This archive was generated by hypermail 2.4.0 : Friday, 17 January 2020 19:13:55 UTC