W3C home > Mailing lists > Public > spec-prod@w3.org > October to December 2010

Re: Referencing IDL members in ReSpec

From: Robin Berjon <robin@berjon.com>
Date: Wed, 20 Oct 2010 13:36:05 +0200
Cc: spec-prod@w3.org
Message-Id: <B30B32B2-DC24-40B8-8DA9-AFAA7450CEF0@berjon.com>
To: Cameron McCormack <cam@mcc.id.au>
On Oct 19, 2010, at 01:25 , Cameron McCormack wrote:
> What’s the proper way to reference IDL members from prose?  Say I have
> 
>  <dl title='interface A' class=idl>
>    <dt>attribute DOMString blah</dt>
>    <dd>Oh yeah</dd>
>  </dl>
> 
> and I want to say “The blah attribute is used for all kinds of things”,
> how should I mark up “blah” so that it links to the definition?

Currently you use <a href='#whatever-id-got-generated-for-blah">blah</a>. I'd be very happy with any improvement over this. Maybe <a data-idl='A.blah'></a> (generates the content unless specified). Better regularity in the way that IDs are generated for WebIDL (i.e. taking into account interface and modules) would also be desirable, right now it's simplistic and does lead to the occasional clash.

-- 
Robin Berjon - http://berjon.com/
Received on Wednesday, 20 October 2010 11:36:34 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Saturday, 10 March 2012 06:19:17 GMT