Re: Referencing IDL members in ReSpec

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 UTC