RE: hierarchical libraries documentation index
On 29 July 2004 14:16, Martin Sjögren wrote:
I think it would be nice to have the docs split up per-package. I.e. one page for haskell98, one for base, one for unix etc. Of course, there could be a complete page of everything too, but I find it's a pain to navigate it because it's so long...
Are you talking about splitting up the contents, or the index? Up until the last release, both of these pages used to be per-package. But we found that this was bad because someone looking for a particular module didn't know which package to look in, and the package boundaries are kind of arbitrary. In the future, when an installation probably has lots of 3rd-party packages installed, each with their own documentation, we'll probably need to re-generate the contents and index page each time a new package is installed. If you find it a pain to navigate the combined contents page, then I think the solution is not to split it up, but to make it easier to navigate (a bit of dynamic HTML goes a long way...). Cheers, Simon
--- Simon Marlow
If you find it a pain to navigate the combined contents page, then I think the solution is not to split it up, but to make it easier to navigate (a bit of dynamic HTML goes a long way...).
I also think that navaigation through the Contents page is painful. It could be useful to use dynamic expandable tree using DHTML. Another solution is to use specialized browsers for Html Help. Under Windows the right solution is to use Microsoft Html Help and under Linux there is DevHelp browser from GNOME. I already have implemented MSHelp 1.2 and MSHelp 2.0 support for Haddock. I wouldn't so hard to add DevHelp. The best way is to combine both solutions. I can play a bit with the Contents page. Cheers, Krasimir __________________________________ Do you Yahoo!? Yahoo! Mail is new and improved - Check it out! http://promotions.yahoo.com/new_mail
On Thu, Jul 29, 2004 at 03:17:21PM +0100, Simon Marlow wrote:
If you find it a pain to navigate the combined contents page, then I think the solution is not to split it up, but to make it easier to navigate (a bit of dynamic HTML goes a long way...).
and thinning out the top level will help with that.
On Thu, 29 Jul 2004 15:17:21 +0100, Simon Marlow
On 29 July 2004 14:16, Martin Sjögren wrote:
I think it would be nice to have the docs split up per-package. I.e. one page for haskell98, one for base, one for unix etc. Of course, there could be a complete page of everything too, but I find it's a pain to navigate it because it's so long...
Are you talking about splitting up the contents, or the index? Up until the last release, both of these pages used to be per-package. But we found that this was bad because someone looking for a particular module didn't know which package to look in, and the package boundaries are kind of arbitrary.
If by "contents" you mean the list of modules, then that's what I mean. For example, I've never used the OpenGL or GLUT packages, most of what I use is in base, and if it's not in base I find it's good to be reminded of that since it will pull in extra dependencies.
If you find it a pain to navigate the combined contents page, then I think the solution is not to split it up, but to make it easier to navigate (a bit of dynamic HTML goes a long way...).
Well, I'd like to have both... Both a complete view and a per-package view. /Martin
participants (4)
-
Krasimir Angelov -
Martin Sjögren -
Ross Paterson -
Simon Marlow