[Haskell-cafe] Re: Is anyone using Haddock's support for frames?

[Thomas Schilling]

Ok, I think I should clarify.

I believe that the framed view with a long list of modules on the left
and the haddocks on the right is still useful.  What I don't mind
getting rid off is the third frame which shows the contents of the
mini_* files.  I would have preferred to have something similar in the
regular haddock (instead of the synopsis or the contents) make it less
obtrusive by using a small font and make it float: right.  That will
be possible with the new HTML backend so I'm all for removing the
mini_* stuff.

The long list of modules should ideally be grouped by package, but
that can be added later.  I don't think it took longer than a few days
to implement, so it shouldn't be much of an issue to port it over to a
new backend.

On 5 May 2010 10:34, Tristan Allwood <tora at zonetora.co.uk> wrote:
> +1 to keep it until equivalent functionality is made mainline
>
> I've had tinyurl.com/haskelldoc aliased to the main frame page
> (http://www.haskell.org/ghc/docs/6.12.2/html/libraries/frames.html) and
> used it extensively on a daily basis for GHC libraries and GHC API
> browsing.  Navigating the current non-framed, disparate, seperate
> documetation feels painful and slow.  I would note though that the
> frames pages arn't currently working on hackage:
> e.g. http://hackage.haskell.org/packages/archive/text/0.7.1.0/doc/html/frames.html).
>
> BTW, I would point out the two best documentation systems I've seen in
> other languages (javadoc[1] and rubydock[2]) are frame based and (IMO)
> very easy to navigate.
>
> [1] http://java.sun.com/javase/6/docs/api/
> [2] http://www.ruby-doc.org/core/
>
> Cheers,
>
> Tris
>
>
> On Tue, May 04, 2010 at 08:19:45PM +0200, David Waern wrote:
>> Hi
>>
>> Since version 2.4.0 Haddock has generated HTML output that uses frames
>> (index-frames.html) in addition to the normal output. We'd like to
>> deprecate this feature unless there is a significant amount of users.
>> The reason is two-fold:
>>
>>   * We probably want to replace the frames with something more modern
>> (like a sidebar on the same page) in the future
>>
>>   * We are rewriting the HTML backend and it would be nice to avoid
>> unnecessary work
>>
>> So if you're using this feature and want to keep it, please speak up!
>>
>> cc:ing cvs-ghc@ in case they have any users of the frames due to the
>> size of the GHC code base. (This might have been the the original
>> motivation for the feature).
>>
>> Thanks,
>> David
>>
>> _______________________________________________
>> Cvs-ghc mailing list
>> Cvs-ghc at haskell.org
>> http://www.haskell.org/mailman/listinfo/cvs-ghc
>
> _______________________________________________
> Cvs-ghc mailing list
> Cvs-ghc at haskell.org
> http://www.haskell.org/mailman/listinfo/cvs-ghc
>



-- 
Push the envelope.  Watch it bend.