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

Re: In-sentence bib references with ReSpec

From: Robin Berjon <robin@berjon.com>
Date: Wed, 20 Oct 2010 13:33:13 +0200
Cc: spec-prod@w3.org
Message-Id: <2E753707-E62A-4080-9E7E-EFE3CA6F7A62@berjon.com>
To: Cameron McCormack <cam@mcc.id.au>
Hi Cameron,

On Oct 19, 2010, at 00:28 , Cameron McCormack wrote:
> I want some shorthand to generate the citation link.  Something like:
>  <p>You really SHOULD read [[#RFC2119]] before throwing MUST around.
>  [[!RFC2119]]
> But Iím happy to hear a suggestion on a different shorthand format.

I'm open to suggestions (and implementations) but one design "rule" I've tended to follow is to stay away from inventing yet another wiki-like markup that ends up being just as complicated to remember as the HTML it's supposed to replace. That's why there are very few text-based syntactical constructs and they all tend to look a lot like what you'd do in plain text anyway.

Caveats aside, the above seems reasonable, but will hit into the issue that the references aren't available in a format that makes that easy. An overall improvement of the referencing system has been mentioned several times, but hasn't taken off yet. ReSpec v2 also uses different plugins to identify references and to generate the biblio list at the end ó not sure if this would be a problem, but I thought I'd flag it.

Either way, if you have the tuits, we take patches!

Robin Berjon - http://berjon.com/
Received on Wednesday, 20 October 2010 11:33:42 UTC

This archive was generated by hypermail 2.4.0 : Friday, 17 January 2020 19:55:15 UTC