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

Re: sample CSS property page: font-size

From: Jonathan Garbee <jonathan@garbee.me>
Date: Mon, 21 Jan 2013 19:57:42 -0500
Message-ID: <CANQy2y0PYX7yoryDM2BH_q_VAz3LNZ8kby21Njr60M99WzZDsQ@mail.gmail.com>
To: "public-webplatform@w3.org" <public-webplatform@w3.org>
I think as far as content this page is good as-is. Tutorial information
does not belong in this part of the docs. Related Articles would be the
place to link off to related tutorial information if available.

Although, the usage and compatibility sections should be floated up before
the example. They are targets for going to this page, people shouldn't need
to scroll to reach the information they seek.


On Mon, Jan 21, 2013 at 4:02 PM, PhistucK <phistuck@gmail.com> wrote:

> A standalone tutorial usually covers several topics (properties) and not a
> single property.
> I guess it should be a more detailed summary of some sort, or a short
> tutorial, like you mentioned.
> Usually something that starts with, "Use this to...".
> So, I guess, something like -
> Use this property to set the font size for text. Font size can be defined
> using absolute and relative values, among others.
>
> It should be a more verbal, yet more detailed (than the summary)
> explanation that comes before the highly technical syntax/values section.
>
> I am not strongly opposed to not having an overview, but I think it makes
> the article more complete. Maybe it is just a conservative approach.
>
> ☆*PhistucK*
>
>
> On Mon, Jan 21, 2013 at 10:48 PM, Mike Sierra <
> letmespellitoutforyou@gmail.com> wrote:
>
>> Can you give me a more detailed overview of what you mean by a
>> "detailed overview"?  ;-)  What kind of info do you think belongs on
>> each prop page rather than in a tutorial? Not that that's necessarily
>> a better idea; just trying to form an idea of where the line between
>> expository & reference should fall.
>>
>> I did avoid some of the more detailed info in the spec on suggested
>> scaling guidelines for keywords, and how they map to headings, but I
>> figured that's more appropriate for implementors.
>>
>> Good point on tables for the compatibility notes & relevant specs; will
>> fix.
>>
>> Re the tables merging desktop/mobile browsers, I figure the two
>> classes of browser are much closer together these days, with a great
>> deal more shared code, especially true for CSS prop's.
>>
>> FYI, that weird animation delay only occurs in webkit, which I filed
>> as bug #107315. I left it in the demo because I figured any weirdness
>> is worth knowing about.
>>
>> --Mike Sierra
>>
>>
>>
>> On Mon, Jan 21, 2013 at 2:44 PM, PhistucK <phistuck@gmail.com> wrote:
>> > Even though it is pretty self explanatory, there is no detailed
>> overview of
>> > the property, there are only notes and examples.
>> > I believe there should be an overview.
>> > The summary is concise, maybe too concise (I do not have ideas)? hehe.
>> >
>> > The compatibility notes are not formatted the way they are currently
>> > supposed to be (a table), which I think is more helpful (the current
>> way,
>> > not you way) for distinguishing the note for every version/edition.
>> > The standards information is also not formatted in a table. Not sure
>> which
>> > is better, though.
>> >
>> > Mixing mobile browsers and desktop browsers at the same line/section is
>> also
>> > not a good idea, in my opinion.
>> >
>> > The example feels a little weird for me, due the first section
>> > growing/shrinking after a delay.
>> >
>> > But, overall, great work!
>> >
>> > ☆PhistucK
>> >
>> >
>> > On Mon, Jan 21, 2013 at 8:21 PM, Mike Sierra
>> > <letmespellitoutforyou@gmail.com> wrote:
>> >>
>> >> In last Thursday's meeting I had an action item to mock together an
>> >> ideal CSS property page for authors to refer to, along with the
>> >> guidance to feel free to reorganize & throw out anything that didn't
>> >> work well. I found it quite difficult to wrestle with the site's
>> >> template system to get what I wanted, so I mirrored it & hacked on the
>> >> page here:
>> >>
>> >> http://letmespellitoutforyou.com/x/webplatform/font_size.html
>> >>
>> >> As you can see, I also mucked with the design a bit to compress the
>> >> page wherever possible, and added an <iframe> to a simple tool showing
>> >> what the CSS actually does. I think all CSS property pages should have
>> >> a similar demo feature, especially once you head towards the
>> >> difficult-to-understand ones like font-size-adjust. (I hope dabblet
>> >> will allow direct embedding & can be modified with option lists for
>> >> CSS keyword property values.)
>> >>
>> >> Any suggestions — content or formatting — please let me know. Thanks,
>> >>
>> >> --Mike Sierra
>> >>
>> >
>>
>
>
Received on Tuesday, 22 January 2013 00:58:09 UTC

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