W3C home > Mailing lists > Public > public-webapps@w3.org > January to March 2013

Re: [webcomponents] writing some pages that use webcomponents, and blogging along the way

From: Charles McCathie Nevile <chaals@yandex-team.ru>
Date: Thu, 28 Mar 2013 20:38:57 +0100
To: "Mike Kamermans" <nihongo@gmail.com>, "Scott Miles" <sjmiles@google.com>
Cc: public-webapps <public-webapps@w3.org>
Message-ID: <op.wun0i7p7y3oazb@chaals.local>
On Wed, 27 Mar 2013 23:16:11 +0100, Scott Miles <sjmiles@google.com> wrote:

> This is great stuff Mike, thanks for making it available. I think we are
> all #facepalm at the notion of self-documenting component files, very
> clever.

Hmm. We built the BEM framework for templating with multiple technologies,  
and one of its features is allowing multiple technology - CSS, JS, HTML,  
XSLT, etc, which we use to provide self-documentation with markdown for  
wikis. But I still didn't get far enough into this to connect those dots.  
With a bit of luck I can get someone from the front-end team who does this  
by reflex to have a look, because they might have some more help to add.

>>> making things that use components and custom elements is proving
>>> extremely fun =)
>
> Music to my ears.

Yeah, it's nice when the stuff we do turns out to be useful in the real  
world :) Which mostly implies props to the folks who did the hard work...

cheers

Chaals

> Scott
>
>
> On Tue, Mar 26, 2013 at 11:48 AM, Mike Kamermans <nihongo@gmail.com>  
> wrote:
>
>> Hey all,
>>
>> I've been playing with web components and custom elements for a bit,
>> blogging about my understanding of it at
>> http://pomax.nihongoresources.com/index.php?entry=1364168314 and
>> writing a demo for the Mozilla "webmaker" dev group to see what we can
>> do with them, which is hosted at
>> http://pomax.github.com/WebComponentDemo/
>>
>> This demo has a stack of custom elements that all "tack onto" a media
>> element on the page, if there is one, with two pages, one with a media
>> element, the other with an image instead, but identical code outside
>> of that difference, using the components defined in
>> http://pomax.github.com/WebComponentDemo/webmaker-components.html
>>
>> One thing we're wondering about how to play with is self-documenting
>> components. Was there already work done on this, or has anyone else
>> already played with that idea? Right now we've hardcoded the
>> documentation as plain HTML, trying to come up with a nice way of
>> autogenerating it by having some JS that checks whether the components
>> were loaded as "the document itself" and if so, generate the
>> documentation from the <element> definitions, but finding a clean way
>> to include a general description as well as attribute documentation is
>> tricky. If anyone has good ides for doing this, I'd be delighted to
>> hear from you!
>>
>> Also, if there's anything on those pages that we did "wrong", or that
>> can be done better, I'd also love to hear from you. These things feel
>> like game-changers, and making things that use components and custom
>> elements is proving extremely fun =)
>>
>> - Mike "Pomax" Kamermans
>>
>>


-- 
Charles McCathie Nevile - Consultant (web standards) CTO Office, Yandex
       chaals@yandex-team.ru         Find more at http://yandex.com
Received on Thursday, 28 March 2013 16:39:33 UTC

This archive was generated by hypermail 2.3.1 : Thursday, 28 March 2013 16:39:33 UTC