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

Re: [restyle] Questionnaire wrt Redesign of the W3C Spec Templates

From: Robin Berjon <robin@w3.org>
Date: Tue, 14 Oct 2014 12:03:48 +0200
Message-ID: <543CF504.9030904@w3.org>
To: David Singer <singer@apple.com>, fantasai <fantasai.lists@inkedblade.net>
CC: chairs@w3.org, spec-prod <spec-prod@w3.org>
On 13/10/2014 19:53 , David Singer wrote:
> For a spec. of any size, I think we could do much better at providing
> (automatically) navigation help etc.  Perhaps that includes the
> multi-page/one-page choices.  For me it also includes (a) knowing
> where anchors are, so I can point at them from the outside (if they
> are not part of the index, it’s not evident they are there).
>
> Something that is probably more than ReSpec and is surely more than
> styling would be to make it much easier to know where concepts are
> used — ‘backlinks’ (this anchor is referred to from X, Y, Z), and so
> on.

About a year ago I spent some time hacking on a small script called 
"specstatic":

     https://github.com/darobin/specstatic

I haven't had time to pursue it properly, but the goal was to offer out 
of the box enhancements for all specs (not just ReSpec generated, 
anything that relies on some minimal conventions), including:

   - Built-in dialog to submit new bugs
   - Make all headers easily linkable with a permalink indicator (though 
that might be best supported by generators directly)
   - Make <dfn> popup a list of places where the definition is used.
   - Make bibrefs link back to their usage instances.
   - Inject a more readable style than what is used on TR that people 
could optionally turn on (and that would stick through a cookie).
   - Highlight other instances of a variable in an algorithm when one is 
hovered.

And likely a bunch of other niceties that I forget about. I will 
probably return to it at some point, in the meantime feel free to grab, 
fork, dissect, replace, etc. if you think it's useful.

-- 
Robin Berjon - http://berjon.com/ - @robinberjon
Received on Tuesday, 14 October 2014 10:04:00 UTC

This archive was generated by hypermail 2.3.1 : Tuesday, 6 January 2015 20:42:21 UTC