W3C home > Mailing lists > Public > public-webplatform@w3.org > July 2014

Re: More compact display for inherited properties and methods in DOM object pages

From: Austin William Wright <aaa@bzfx.net>
Date: Sun, 27 Jul 2014 10:59:19 -0700
Message-ID: <CANkuk-W7hCt+Jx_fghMF0hexokUCeQL3HnGeWpaXtT3z6uGnng@mail.gmail.com>
To: Amelia Bellamy-Royds <amelia.bellamy.royds@gmail.com>
Cc: List WebPlatform public <public-webplatform@w3.org>, Renoir Boulanger <renoir@w3.org>
I really like this. I imagine if I wanted to see the properties of e.g.
HTMLElement, I probably would have visited that page instead, so just
saying "Hey here's other properties that are relevant, they're described on
another page" is nice.

Austin Wright.


On Fri, Jul 25, 2014 at 5:38 PM, Amelia Bellamy-Royds <
amelia.bellamy.royds@gmail.com> wrote:

> Feedback needed!
>
> Working through the QA review of DOM pages, I was finding that the
> endless, near-identical tables of inherited properties/methods/events
> distracted from the main content of the page.  You have to scroll down
> quite a ways to reach examples and compatibility.
>
> I've come up with a more compact template and have got some sample pages
> in the test wiki.  I'd appreciate feedback before rolling this out on the
> main wiki.
>
> I've got three pages in the test wiki set up to use that template, with
> different amounts of content.  Please *don't* edit these pages using the
> forms, as it will over-write the custom template call.
>
>    - http://docs.webplatform.org/test/dom/HTMLTableCellElement
>    - http://docs.webplatform.org/test/dom/HTMLTableElement
>    - http://docs.webplatform.org/test/dom/HTMLElement
>
> Compare with how the same pages currently look on the main wiki:
>
>    - http://docs.webplatform.org/wiki/dom/HTMLTableCellElement
>    - http://docs.webplatform.org/wiki/dom/HTMLTableElement
>    - http://docs.webplatform.org/wiki/dom/HTMLElement
>
> Ignore differences in which pages show up as links and the fact that most
> don't have summaries in the test wiki; the focus is on the layout.
>
>    - Is the compact display *too* compact?  In-between options, such as a
>    multi-column bulleted list, are also possible.
>    - Does the organization make sense (grouping by
>    methods/properties/events instead of grouping by the interface they are
>    inherited from)?
>    - Should there be different number of results before the results lists
>    gets truncated with "More.."?
>    - Is the "More..." link obvious enough, or does it need stronger
>    formatting? (see the HTMLElement page)  The default table has this link in
>    a table footer, but I don't think that can be done with the custom
>    templates, since it is always added *after* the footer template.
>    - Any other concerns / suggestions / aspects you find confusing?
>
> The new template, for those interested in such things, is at
> http://docs.webplatform.org/test/Template:API_Object_new
>
> P.S.  Thanks to Renoir for rolling back his single-sign-on test so that I
> could use the test wiki.
>
> Amelia BR
>
Received on Sunday, 27 July 2014 17:59:47 UTC

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