Re: 3.12.8 dfn automatic cross-referencing

On Wed, 23 Apr 2008, Ben Boyle wrote:
> 
> On Wed, Apr 23, 2008 at 10:46 AM, Ian Hickson <ian@hixie.ch> wrote:
> 
> >  > <p>The <dfn>Garage Door Opener (<abbr>GDO</abbr>)</dfn>
> >
> >  The term being defined is "Garage Door Opener", so I'd say the right
> >  markup is:
> >
> >    <p>The <dfn>Garage Door Opener</dfn> (GDO) is...
> 
> Be great to see an example like this in the spec: how to markup a
> common writing technique.

Added.

> >  Right now the rule is basically "use <abbr> if you're giving an
> >  expansion", but this may change, as people seem to want to mark up
> >  abbreviations even without expansions. I'm not sure what advice to give,
> >  though. Any suggestions? As far as I can tell it's:
> >
> >   * Definitely mark up any abbreviation you want to give an expansion for.
> >
> >   * Mark up abbreviations and give expansions for them if they're terms
> >    that your readers may not know.
> >
> >   * Mark up other abbreviations if you need them semantically annotated
> >    (e.g. because you want to style abbreviations).
> >
> >  Would that be enough?
> 
> Yep, that's pretty good. Maybe clarify the second point to more 
> explicitly suggest mark up for terms that are invented on that website 
> (e.g. by the company/person the site represents).

Ok, added the above.


> Might be worth throwing something in to say the dfn and/or abbr tags may 
> be used with "acronyms" and other specialised "shortened forms" 
> (initialisms, contractions, ...). Had enough needless debates over that, 
> would like to just point at the spec and say "see, it is ok. we won't be 
> hurting anyone".

Are the examples in the <dfn> section and <abbr> section enough?

-- 
Ian Hickson               U+1047E                )\._.,--....,'``.    fL
http://ln.hixie.ch/       U+263A                /,   _.. \   _\  ;`._ ,.
Things that are impossible just take longer.   `._.-(,_..'--(,_..'`-.;.'

Received on Wednesday, 26 November 2008 23:15:33 UTC