Using a standard custom data attribute for notes ?

[tanusoft]

I really like the concept of this little wireframing framework, and we (the web designers in our team) have been using it in our projects for a few weeks.

But something has always been bugging me : the fact that it requires adding an invalid "note" attribute to the HTML elements. It's something that most HTML editors will flag as warnings, if not errors (indeed, the W3C validator DOES flag them as errors).

There is an easy fix for that, using a "data-" prefix on this custom attribute ::

http://www.w3.org/html/wg/drafts/html/master/dom.html#custom-data-attribute
http://ejohn.org/blog/html-5-data-attributes/

Just using "data-note" instead of "note" would fix this issue. You could even go as far as using a vendor identifier prefix, like "data-metaframe-note", although maybe this would increase the clutter in the HTML files beyond necessary (but could come handy in case people need to use metaframe along other frameworks that use a "data-note" annotation). Maybe allowing both "data-note" and "data-metaframe-note" would give people maximum flexibility.

[texburgher]

Hey, thanks! Glad you like it, and thrilled you're using it.

And thanks for your note! Note? Communiqué? Input? Anyway...

Good call. We talked about it this morning, and I think we're going to include support for "note", "data-note", and "data-metaframe-note" in our next update.

Thanks again,
Geoff

On Jul 2, 2013, at 5:14 AM, tanusoft notifications@github.com wrote:

I really like the concept of this little wireframing framework, and we (the web designers in our team) have been using it in our projects for a few weeks.

But something has always been bugging me : the fact that it requires adding an invalid "note" attribute to the HTML elements. It's something that most HTML editors will flag as warnings, if not errors (indeed, the W3C validator DOES flag them as errors).

There is an easy fix for that, using a "data-" prefix on this custom attribute ::

http://www.w3.org/html/wg/drafts/html/master/dom.html#custom-data-attribute
http://ejohn.org/blog/html-5-data-attributes/

Just using "data-note" instead of "note" would fix this issue. You could even go as far as using a vendor identifier prefix, like "data-metaframe-note", although maybe this would increase the clutter in the HTML files beyond necessary (but could come handy in case people need to use metaframe along other frameworks that use a "data-note" annotation). Maybe allowing both "data-note" and "data-metaframe-note" would give people maximum flexibility.

—
Reply to this email directly or view it on GitHub.

Geoff Barnes
Elliance, Inc.

412-586-1480 x643

gbarnes@elliance.com

www.elliance.com

Web. Search. Social. Mobile.

[eaton]

+1 on this, and on using a data attribute for the flag that marks an element as "having a note" as well. I've been using data attributes for this on other projects, and found it to be a lot more reliable than overloading classes. Especially on designs where there was a legitimate need for a "note" classname. ;-)