Revision as of 11:42, 19 May 2007 by Gazza (Talk | contribs)
(diff) ←Older revision | Current revision (diff) | Newer revision→ (diff)

Jump to: navigation, search

Abbr design pattern



How to use it


The datetime-design-pattern formally encodes (the notoriously unparsable) datetimes into an abbr element.


The party is at 10 o'clock on the 10th.


The party is at 
<abbr class="dtstart" title="20051010T10:10:10-0100">10 o'clock on the 10th</abbr>.

Alternative presentations

Note that the following are all equivalent, to a microformat parser:

<span class="dtstart">20070501</span>

<span class="dtstart">2007-05-01</span>

<abbr class="dtstart" title="20070501">1 May 2007</abbr>

<abbr class="dtstart" title="2007-05-01">1 May 2007</abbr>

<abbr class="dtstart" title="20070501">1st May 2007</abbr>.

<abbr class="dtstart" title="20070501">May 1st 2007</abbr>.

<abbr class="dtstart" title="20070501">The first of May, 2007</abbr>.

<abbr class="dtstart" title="20070501">2007-05-01</abbr>.

<abbr class="dtstart" title="20070501">Tuesday, 1 May 2007</abbr>

<abbr class="dtstart" title="20070501">2007, day 121</abbr>

<abbr class="dtstart" title="20070501">May Day, 2007</abbr>

<abbr class="dtstart" title="20070501" lang="FR">1er mai, 2007</abbr>

<abbr class="dtstart" title="20070501" lang="ES">1 de mayo, 2007</abbr>

and the following may be used in, say, a list, table, or page, headed "2007":

<abbr class="dtstart" title="20070501">1 May</abbr>


This discussion is culled from here. Consider two possible uses for the abbr-design-pattern:

  1. using ABBR to encode machine readable data around human readable data
    <abbr class="dtstart" title="20051010T10:10:10-0100">10 o'clock on the 10th</abbr>
  2. using ABBR to encode more formal human data around something less formal
    <abbr class="author" title="Danny Ayers">Danny</abbr> 

Use #1 is encouraged if there's a reasonable need for it. Use #2 is discouraged under the Don't Repeat Yourself principle, as: "#2 is a case of *more* information being invisibly present, namely, the last name in this case. If someone is not willing to make some information visible, then we shouldn't be encouraging them to store that information invisibly, for all the same reasons that invisible metadata is bad/futile in the first place."

I'd like to delete this below, as the points are covered above

<p>Sugar is commonly sold in 5 <abbr title="pound">lb.<abbr> bags.</p>
<p>Welcome to the <abbr title="World Wide Web">WWW</abbr>!</p>

Accessibility issues

Ironically, this pattern while machine readable for browsers compatible with microformats is not accessible for screenreaders when referring to a date. Therefore:

we have a party in 
<abbr class="dtstart" title="20070312T1700-06">
 March 12, 2007 at 5 PM

would be read by Jaws as

we have a party at Twenty million seventy-thousand three-hundred twelve tee seventeen-hundred dash zero six. 

The accessibility task force from recommends:

<span class="dtstart" title="20070312T1700-06">
 March 12, 2007 at 5 PM, Central Standard Time


<span class="dtstart">
 March 12, 2007 at 5 PM, Central Standard Time
 <span class="value" title="20070312T1700-06"></span>

see more at abbr-design-pattern-issues and [1]

See Also

abbr-design-pattern was last modified: Wednesday, December 31st, 1969