abbr-design-pattern

(Difference between revisions)

Jump to: navigation, search
(Alternative presentations: fixes, hyphens)
(Discussion)
Line 99: Line 99:
<p>Welcome to the <abbr title="World Wide Web">WWW</abbr>!</p>
<p>Welcome to the <abbr title="World Wide Web">WWW</abbr>!</p>
</pre>
</pre>
 +
 +
=== Accessibility Discussion ===
 +
Article and discussion about why some instances of the [http://www.webstandards.org/2007/04/27/haccessibility/ abbr-design-pattern may be bad for accessibility].
== See Also ==
== See Also ==

Revision as of 01:18, 29 April 2007

Contents

Abbr design pattern

Purpose

How to use it

Example

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

Before:

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

After:

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>

Discussion

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 Discussion

Article and discussion about why some instances of the abbr-design-pattern may be bad for accessibility.

See Also

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

Views