dfn-design-pattern - Revision history

Heribert: /* Usage in the wild */

2009-01-14T14:23:35Z

Usage in the wild

← Older revision		Revision as of 14:23, 14 January 2009
Line 58:		Line 58:
	* [http://juicystudio.com/article/jargon-busting-with-the-definition-element.php Juicy Studios: Jargon Busting with the Definition Element]		* [http://juicystudio.com/article/jargon-busting-with-the-definition-element.php Juicy Studios: Jargon Busting with the Definition Element]
	* [http://alistapart.com/articles/hattrick A List Apart: The Accessibility Hat Trick: Getting Abbreviations Right]		* [http://alistapart.com/articles/hattrick A List Apart: The Accessibility Hat Trick: Getting Abbreviations Right]
			* [http://www.arthrogryposis.de/iga/iga-ev/schirmherr German Arthrogryposis Support Group] (medical terms checked against a glossary)
	* ...		* ...

JamesCraig: /* Assistive Technology */

2008-01-06T06:07:07Z

Assistive Technology

← Older revision		Revision as of 06:07, 6 January 2008
Line 50:		Line 50:
	===Assistive Technology===		===Assistive Technology===

	The proposed dfn design pattern assumes that screen readers don't treat <code>dfn</code> as a special case like <code>abbr</code> or <code>acronym</code>. Is this actually the case? Please ~~create a page for~~ [[assistive-technology-~~dfn~~-results\|assistive technology ~~dfn~~ results]] ~~and add the results of testing there~~.		The proposed dfn design pattern assumes that screen readers don't treat <code>dfn</code> as a special case like <code>abbr</code> or <code>acronym</code>. Is this actually the case? Please note results of testing on that item in the [[assistive-technology-abbr-results\|assistive technology results]] page.

	===Usage in the wild===		===Usage in the wild===

Brian: /* Semantics */

2007-08-21T09:40:15Z

Semantics

← Older revision		Revision as of 09:40, 21 August 2007
Line 36:		Line 36:

	Is the <code>dfn</code> element equally appropriate as the <code>abbr</code> for information such as datetimes and geo or is this stretching the semantic meaning of the element beyond a reasonable limit?		Is the <code>dfn</code> element equally appropriate as the <code>abbr</code> for information such as datetimes and geo or is this stretching the semantic meaning of the element beyond a reasonable limit?

			====HTML5====
			In HTML5, the [http://www.w3.org/html/wg/html5/#the-dfn\|DFN element semantics] have completely changed and would be incompatable with this pattern.

	===Parsers===		===Parsers===

Adactio: /* Usage in the wild */

2007-08-17T10:45:40Z

Usage in the wild

← Older revision		Revision as of 10:45, 17 August 2007
Line 55:		Line 55:
	* [http://juicystudio.com/article/jargon-busting-with-the-definition-element.php Juicy Studios: Jargon Busting with the Definition Element]		* [http://juicystudio.com/article/jargon-busting-with-the-definition-element.php Juicy Studios: Jargon Busting with the Definition Element]
	* [http://alistapart.com/articles/hattrick A List Apart: The Accessibility Hat Trick: Getting Abbreviations Right]		* [http://alistapart.com/articles/hattrick A List Apart: The Accessibility Hat Trick: Getting Abbreviations Right]
			* ...

	==Alternatives==		==Alternatives==

AndyMabbett: Alternatives

2007-08-16T23:19:01Z

Alternatives

← Older revision		Revision as of 23:19, 16 August 2007
Line 55:		Line 55:
	* [http://juicystudio.com/article/jargon-busting-with-the-definition-element.php Juicy Studios: Jargon Busting with the Definition Element]		* [http://juicystudio.com/article/jargon-busting-with-the-definition-element.php Juicy Studios: Jargon Busting with the Definition Element]
	* [http://alistapart.com/articles/hattrick A List Apart: The Accessibility Hat Trick: Getting Abbreviations Right]		* [http://alistapart.com/articles/hattrick A List Apart: The Accessibility Hat Trick: Getting Abbreviations Right]

			==Alternatives==
			*[[title-trigger]]
			*...

	==See Also==		==See Also==

Adactio: /* Usage in the wild */

2007-08-16T11:55:10Z

Usage in the wild

← Older revision		Revision as of 11:55, 16 August 2007
Line 54:		Line 54:

	* [http://juicystudio.com/article/jargon-busting-with-the-definition-element.php Juicy Studios: Jargon Busting with the Definition Element]		* [http://juicystudio.com/article/jargon-busting-with-the-definition-element.php Juicy Studios: Jargon Busting with the Definition Element]
	* [http://alistapart.com/articles/hattrick A List Apart: The Accessibility Hat Trick: Getting Abbreviations Right		* [http://alistapart.com/articles/hattrick A List Apart: The Accessibility Hat Trick: Getting Abbreviations Right]

	==See Also==		==See Also==

Adactio at 11:41, 16 August 2007

2007-08-16T11:41:14Z

New page

=Dfn design pattern=

Important: this is currently a proposal: it is not a finalised design pattern.

This page is intended for discussion and exploration of a design pattern to complement the [[abbr-design-pattern|abbr design pattern]] while addressing the [[abbr-design-pattern-issues|abbr design pattern issues]], particularly the [[accessibility-issues#abbr-design-pattern|accessibility issues]].

__TOC__

==Purpose==

The [[abbr-design-pattern|abbr design pattern]] is used in several microformats to enclose standardised data such as the [[datetime-design-pattern|datetime design pattern]] in the <code>title</code> attribute. However some [[assistive-technology|assistive technology]] will expose this data directly to the user, which is often undesirable.
See also [[assistive-technology-abbr-results|assistive technology abbr results]].

This problem arises because the <code>title</code> attribute has a different semantic meaning when it is attached to an <code>abbr</code> or <code>acronym</code> than it does on other elements. Usually [http://www.w3.org/TR/html4/struct/global.html#h-7.4.3 the <code>title</code> attribute] is used to provide provide advisory information. But for <code>abbr</code> or <code>acronym</code> the <code>title</code> is used to provide an expanded form of the text contained between the opening and closing tags. This is why the <code>abbr</code> element was chosen to contain datetime information: the ISO format is an expanded form of the human-readable text contained within the element. Because screen readers can be configured to treat <code>abbr</code> and <code>acronym</code> elements as special cases, the <code>title</code> attribute is sometimes read aloud.

==Proposal==

Rather than expand the [[abbr-design-pattern|abbr design pattern]] to any element (or to a semantically neutral element such as <code>span</code>), it would be better to use an element that has semantic value but which isn't treated as a special case by assistive technology.

===dfn===

The [http://www.w3.org/TR/html4/struct/text.html#h-9.2.1 dfn element] indicates the defining instance of the enclosed term. This element is not widely used but where it used, it is often used in a similar way to the <code>abbr</code> element. Although the <code>title</code> is not required for the <code>dfn</code> element, it is often used to provide expanded information.

The semantic meaning of <code>dfn</code>, as it is currently used, is potentially similar enough to <code>abbr</code> element to allow it to be used as an alternative:

<pre><nowiki>
<abbr class="dtstart" title="2007-08-16T22:00:00">10pm on August 16th</abbr>
<dfn class="dtstart" title="2007-08-16T22:00:00">10pm on August 16th</dfn>
</nowiki></pre>

==Issues==

===Semantics===

The <code>dfn</code> is not intended for definitions; it is intended for defining instances. Does this mean that it must always be used for the first instance of a term (such as a date)?

Is the <code>dfn</code> element equally appropriate as the <code>abbr</code> for information such as datetimes and geo or is this stretching the semantic meaning of the element beyond a reasonable limit?

===Parsers===

Existing microformats parsers (such as the Operator extension to Firefox) would need to be updated to handle this proposed alternative to the abbr design pattern. However, this is true of any proposed alternatives.

===Complexity===

Microformats are intended to be easy to publish. The number of design patterns should be kept to a minimum. Every new design pattern is potentially a new barrier to entry for publishers.

===Assistive Technology===

The proposed dfn design pattern assumes that screen readers don't treat <code>dfn</code> as a special case like <code>abbr</code> or <code>acronym</code>. Is this actually the case? Please create a page for [[assistive-technology-dfn-results|assistive technology dfn results]] and add the results of testing there.

===Usage in the wild===

This design pattern is built on the assumption that, although the <code>dfn</code> is not widely used, where it used, it is most often used in conjunction with the <code>title</code> attribute. Please document examples and references here:

* [http://juicystudio.com/article/jargon-busting-with-the-definition-element.php Juicy Studios: Jargon Busting with the Definition Element]
* [http://alistapart.com/articles/hattrick A List Apart: The Accessibility Hat Trick: Getting Abbreviations Right

==See Also==

* [[abbr-design-pattern|abbr design pattern]]
* [[abbr-design-pattern-issues|abbr design pattern issues]]
* [[accessibility-issues#abbr-design-pattern|accessibility issues]]
* [[assistive-technology-abbr-results|assistive technology abbr results]]
* [[datetime-design-pattern|datetime design pattern]]