Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On Wed, Aug 04, 2010 at 01:00:16AM -0400, Mark Lentczner wrote: The Haddock team has spent the last few months revamping the look of the generated output. We're pretty close to done, but we'd like to get the community's input before we put it in the main release. Please take a look, and then give us your feedback through a short survey Sample pages: http://www.ozonehouse.com/mark/snap-xhtml/index.html Frame version: http://www.ozonehouse.com/mark/snap-xhtml/frames.html Survey: http://spreadsheets.google.com/viewform?formkey=dHcwYzdMNkl5WER1aVBXdV9HX1l5U3c6MQ Short link to same survey: http://bit.ly/9Zvs9B Thanks! - Mark The framed layout has one very crippling disadvantage. It's is impossible to link sanely to individual pages or sections. If you copy the link to a particular page or anchor, you lose the frames. If you grab the URL from the address bar, you end up at the root level. Compare it with the horror that is the Boost.Serialization docs [1] or the C++ draft [2]. The survey seems to be inactive, by the way. [1] http://www.boost.org/doc/libs/1_43_0/libs/serialization/doc/index.html [2] http://www.open-std.org/jtc1/sc22/open/n2356/ -- Lars Viklund | z...@acc.umu.se ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
Hi Lars, On Mon, Aug 9, 2010 at 10:23 AM, Lars Viklund z...@acc.umu.se wrote: The survey seems to be inactive, by the way. It's because Mark already posted the results. :) Cheers, Johan ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On 06/08/10 03:15, Jeff Zaroyko wrote: On Thu, Aug 5, 2010 at 11:48 PM, Johan Tibelljohan.tib...@gmail.com wrote: On Thu, Aug 5, 2010 at 3:35 PM, Dino Morellid...@ui3.info wrote: On Wed, 4 Aug 2010, Mark Lentczner wrote: One thing I haven't seen anyone else comment on is the width of the new docs. I have a large (26) monitor and use the browser full-screen (with xmonad, so even more screen space). When I load these pages, particularly the non-frame one, something like 50% of my screen real-estate is empty whitespace on either side of the doc content. There is also wasted space in the frames version, just a little less of it. I wish the docs were using that space like the current Haddock does. Is the plan to use a fixed width like this? Yes. There's research suggesting that the line length should be between 65 and 75 characters per line. http://psychology.wichita.edu/surl/usabilitynews/42/text_length.htm http://psychology.wichita.edu/surl/usabilitynews/72/LineLength.asp This study examined the effects of line length on reading speed, comprehension, and user satisfaction of online news articles. I completely agree with the case of news articles, but not in the case of Haskell documentation, it's structured differently and different parts such as bold or larger typeface serve as points of reference when reading, in contrast to plain old paragraphs found in a news article. The current layout works very well for me, I don't like the additional whitespace in the proposed version. I feel the colour scheme is a step backwards from what we have already, which offers high visibility. Personally I think the way the current layout expands to the full width of the window makes it really hard to read with a wide browser, but since many sites suffer from the same problem I normally use a narrower browser window and fill up the rest of the screen space with IRC windows :-) The great thing about the Haddock redesign is that the content has been separated from the style. If opinions about the style are sufficiently divided we can provide a style switcher on the docs we ship with GHC, and make that the default for Cabal-generated docs. Although the opinions I've seen so far suggest that the majority of people prefer the new style. Cheers, Simon ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On Mon, Aug 9, 2010 at 10:55 AM, Simon Marlow marlo...@gmail.com wrote: The great thing about the Haddock redesign is that the content has been separated from the style. If opinions about the style are sufficiently divided we can provide a style switcher on the docs we ship with GHC, and make that the default for Cabal-generated docs. Although the opinions I've seen so far suggest that the majority of people prefer the new style. I agree. The most important thing about this change is that it allows people to play with styling more easily. As a bonus we get a new default style that looks more modern than the old style. My personal preference would be for the style to have a left hand menu, like the Python docs. It's now possible for me to play with that idea and, if the result is convincing enough, try to convince other Haskellers that it should be the default. If I can't convince others, I can always use a browser style switcher to have the docs render the way I want in my own browser. Cheers, Johan ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On Sat, Aug 7, 2010 at 7:54 AM, Magnus Therning mag...@therning.org wrote: jokeWouldn't the docs be unusable if it were in French even if Haddock handled unicode characters correctly?/joke Joke aside, for software to be released, a French documentation indeed wouldn't be of much use. The langage of technology and science and les internets is English, and I'm fine with that. I would only document software in French that is written for my company, and isn't supposed to be released. I hope we're not hijacking the thread here :) David. ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On Thu, Aug 5, 2010 at 2:35 PM, Dino Morelli d...@ui3.info wrote: One thing I haven't seen anyone else comment on is the width of the new docs. I have a large (26) monitor and use the browser full-screen (with xmonad, so even more screen space). When I load these pages, particularly the non-frame one, something like 50% of my screen real-estate is empty whitespace on either side of the doc content. There is also wasted space in the frames version, just a little less of it. I wish the docs were using that space like the current Haddock does. Is the plan to use a fixed width like this? Please say no, it's a disappointing trend that you see everywhere. Like Twitter's web interface, for instance, very narrow. Yeah, I wrote about this in my survey response. It seems to me that if I find text in a narrow page more readable, I can easily just resize my browser window, this doesn't need to be enforced by the webpage itself. I'm also not so enthusiastic about tabbed synposis. I'm not convinced you can easily use the synopsis and doc text simultaneously, so I don't see any reason for it to be apart from the text body. Simplicity is a virtue :) I do think that in terms of colours, fonts etc. it's prettier, but the fixed max width and kind of gimmicky synopsis tab are steps backward in my opinion. ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On Fri, 6 Aug 2010, Ben Millwood wrote: On Thu, Aug 5, 2010 at 2:35 PM, Dino Morelli d...@ui3.info wrote: One thing I haven't seen anyone else comment on is the width of the new docs. I have a large (26) monitor and use the browser full-screen (with xmonad, so even more screen space). When I load these pages, particularly the non-frame one, something like 50% of my screen real-estate is empty whitespace on either side of the doc content. There is also wasted space in the frames version, just a little less of it. I wish the docs were using that space like the current Haddock does. Is the plan to use a fixed width like this? Please say no, it's a disappointing trend that you see everywhere. Like Twitter's web interface, for instance, very narrow. Yeah, I wrote about this in my survey response. It seems to me that if I find text in a narrow page more readable, I can easily just resize my browser window, this doesn't need to be enforced by the webpage itself. Agreed, it's like a premature optimization for the Haddock page build to decide and enforce width without knowing my needs, hardware or windowing situation. I'm also not so enthusiastic about tabbed synposis. I'm not convinced you can easily use the synopsis and doc text simultaneously, so I don't see any reason for it to be apart from the text body. Simplicity is a virtue :) The more I play with it, the more I'm not that thrilled with the sliding synopsys thing as well. I think moving away from static pages is making the docs less usable. There was a period of time when the simple static alphabetic function index was replaced with some dynamic JavaScript filtering that responded to keystrokes in the edit control. It performed really terribly on even my very modern systems with Firefox. I was happy when it went away. I appreciate the idea, but it pays to be very very conservative with reference material. I do think that in terms of colours, fonts etc. it's prettier, but the fixed max width and kind of gimmicky synopsis tab are steps backward in my opinion. I can agree with this too. I like the existing higher-contrast coloring more, which was also mentioned by a couple of the other responses in this thread. -- Dino Morelli email: d...@ui3.info web: http://ui3.info/d/ irc: dino- pubkey: http://ui3.info/d/dino-4AA4F02D-pub.gpg twitter: dino8352 ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
I prefer the new look. That being said, I'd rather like haddock handling unicode characters in comments, at the moment it's unusable if I want to write comments in French. ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On Sat, Aug 7, 2010 at 01:00, David Virebayre dav.vire+hask...@gmail.com wrote: I prefer the new look. That being said, I'd rather like haddock handling unicode characters in comments, at the moment it's unusable if I want to write comments in French. jokeWouldn't the docs be unusable if it were in French even if Haddock handled unicode characters correctly?/joke Seriously though, it would be useful for Haddock to handle unicode, if for nothing else just to allow developers to have their names showing properly. /M -- Magnus Therning (OpenPGP: 0xAB4DFBA4) magnus＠therning．org Jabber: magnus＠therning．org http://therning.org/magnus identi.ca|twitter: magthe ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On Wed, 4 Aug 2010, Mark Lentczner wrote: The Haddock team has spent the last few months revamping the look of the generated output. We're pretty close to done, but we'd like to get the community's input before we put it in the main release. Please take a look, and then give us your feedback through a short survey Sample pages: http://www.ozonehouse.com/mark/snap-xhtml/index.html Frame version: http://www.ozonehouse.com/mark/snap-xhtml/frames.html One thing I haven't seen anyone else comment on is the width of the new docs. I have a large (26) monitor and use the browser full-screen (with xmonad, so even more screen space). When I load these pages, particularly the non-frame one, something like 50% of my screen real-estate is empty whitespace on either side of the doc content. There is also wasted space in the frames version, just a little less of it. I wish the docs were using that space like the current Haddock does. Is the plan to use a fixed width like this? Please say no, it's a disappointing trend that you see everywhere. Like Twitter's web interface, for instance, very narrow. -- Dino Morelli email: d...@ui3.info web: http://ui3.info/d/ irc: dino- pubkey: http://ui3.info/d/dino-4AA4F02D-pub.gpg twitter: dino8352 ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On Thu, Aug 5, 2010 at 3:35 PM, Dino Morelli d...@ui3.info wrote: On Wed, 4 Aug 2010, Mark Lentczner wrote: The Haddock team has spent the last few months revamping the look of the generated output. We're pretty close to done, but we'd like to get the community's input before we put it in the main release. Please take a look, and then give us your feedback through a short survey Sample pages: http://www.ozonehouse.com/mark/snap-xhtml/index.html Frame version: http://www.ozonehouse.com/mark/snap-xhtml/frames.html One thing I haven't seen anyone else comment on is the width of the new docs. I have a large (26) monitor and use the browser full-screen (with xmonad, so even more screen space). When I load these pages, particularly the non-frame one, something like 50% of my screen real-estate is empty whitespace on either side of the doc content. There is also wasted space in the frames version, just a little less of it. I wish the docs were using that space like the current Haddock does. Is the plan to use a fixed width like this? Yes. There's research suggesting that the line length should be between 65 and 75 characters per line. http://psychology.wichita.edu/surl/usabilitynews/42/text_length.htm ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On Thu, Aug 5, 2010 at 10:48 AM, Johan Tibell johan.tib...@gmail.com wrote: One thing I haven't seen anyone else comment on is the width of the new docs. I have a large (26) monitor and use the browser full-screen (with xmonad, so even more screen space). When I load these pages, particularly the non-frame one, something like 50% of my screen real-estate is empty whitespace on either side of the doc content. There is also wasted space in the frames version, just a little less of it. I wish the docs were using that space like the current Haddock does. Is the plan to use a fixed width like this? Yes. There's research suggesting that the line length should be between 65 and 75 characters per line. http://psychology.wichita.edu/surl/usabilitynews/42/text_length.htm Perhaps on large monitors the Synopsis could auto-open to use the available space? My 2 cents, ;) -- Felipe. ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On Thu, 5 Aug 2010, Johan Tibell wrote: On Thu, Aug 5, 2010 at 3:35 PM, Dino Morelli d...@ui3.info wrote: One thing I haven't seen anyone else comment on is the width of the new docs. I have a large (26) monitor and use the browser full-screen (with xmonad, so even more screen space). When I load these pages, particularly the non-frame one, something like 50% of my screen real-estate is empty whitespace on either side of the doc content. There is also wasted space in the frames version, just a little less of it. I wish the docs were using that space like the current Haddock does. Is the plan to use a fixed width like this? Yes. There's research suggesting that the line length should be between 65 and 75 characters per line. I understand, I've read that too in the context of publishing with long paragraph style material. But I think the majority of generated programming API docs are not done with fixed width. Here are several examples: JavaDoc at Sun: http://download.oracle.com/javase/7/docs/api/ Scala API docs, very recently redesigned for 2.8.x: http://www.scala-lang.org/api/current/index.html Google Android API docs: http://developer.android.com/reference/packages.html Erlang docs: http://www.erlang.org/doc/ Microsoft F# lang and API docs: http://msdn.microsoft.com/library/dd233154%28VS.100%29.aspx The Python Standard Library: http://docs.python.org/library/ Ruby-doc: http://www.ruby-doc.org/core/ I did find one that uses fixed width though, this Perl5 documentation site: http://perldoc.perl.org/perlapi.html -- Dino Morelli email: d...@ui3.info web: http://ui3.info/d/ irc: dino- pubkey: http://ui3.info/d/dino-4AA4F02D-pub.gpg twitter: dino8352___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
OT Re: [Haskell-cafe] Preview the new haddock look and take a short survey
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 8/5/10 09:35 , Dino Morelli wrote: Please say no, it's a disappointing trend that you see everywhere. Like Twitter's web interface, for instance, very narrow. Twitter's web interface isn't really intended for serious use, IMO. Tweetdeck for desktops, tweetgrid/hootsuite/etc. for browser based. - -- brandon s. allbery [linux,solaris,freebsd,perl] allb...@kf8nh.com system administrator [openafs,heimdal,too many hats] allb...@ece.cmu.edu electrical and computer engineering, carnegie mellon university KF8NH -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.10 (Darwin) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iEYEARECAAYFAkxa2PgACgkQIn7hlCsL25UUtACggsp0tOxK9GqPU6qZYunpuFq0 egEAoKjqmjOGlCgkVJTGHE98MX9+HvoZ =PhUs -END PGP SIGNATURE- ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On 5 August 2010 23:35, Dino Morelli d...@ui3.info wrote: On Wed, 4 Aug 2010, Mark Lentczner wrote: One thing I haven't seen anyone else comment on is the width of the new docs. I have a large (26) monitor and use the browser full-screen (with xmonad, so even more screen space). When I load these pages, particularly the non-frame one, something like 50% of my screen real-estate is empty whitespace on either side of the doc content. There is also wasted space in the frames version, just a little less of it. I wish the docs were using that space like the current Haddock does. Is the plan to use a fixed width like this? I too thought this at first, but found it very useable. Also, it doesn't seem to be a fixed width: if you increase font size/zoom in, then the width increases as well (unlike most sites where the font size is increased but the width of the column it's in doesn't). -- Ivan Lazar Miljenovic ivan.miljeno...@gmail.com IvanMiljenovic.wordpress.com ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On Thu, Aug 5, 2010 at 11:48 PM, Johan Tibell johan.tib...@gmail.com wrote: On Thu, Aug 5, 2010 at 3:35 PM, Dino Morelli d...@ui3.info wrote: On Wed, 4 Aug 2010, Mark Lentczner wrote: One thing I haven't seen anyone else comment on is the width of the new docs. I have a large (26) monitor and use the browser full-screen (with xmonad, so even more screen space). When I load these pages, particularly the non-frame one, something like 50% of my screen real-estate is empty whitespace on either side of the doc content. There is also wasted space in the frames version, just a little less of it. I wish the docs were using that space like the current Haddock does. Is the plan to use a fixed width like this? Yes. There's research suggesting that the line length should be between 65 and 75 characters per line. http://psychology.wichita.edu/surl/usabilitynews/42/text_length.htm http://psychology.wichita.edu/surl/usabilitynews/72/LineLength.asp This study examined the effects of line length on reading speed, comprehension, and user satisfaction of online news articles. I completely agree with the case of news articles, but not in the case of Haskell documentation, it's structured differently and different parts such as bold or larger typeface serve as points of reference when reading, in contrast to plain old paragraphs found in a news article. The current layout works very well for me, I don't like the additional whitespace in the proposed version. I feel the colour scheme is a step backwards from what we have already, which offers high visibility. Jeff ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On Wed, Aug 4, 2010 at 06:00, Mark Lentczner ma...@glyphic.com wrote: The Haddock team has spent the last few months revamping the look of the generated output. We're pretty close to done, but we'd like to get the community's input before we put it in the main release. Please take a look, and then give us your feedback through a short survey Sample pages: http://www.ozonehouse.com/mark/snap-xhtml/index.html I really like it, especially the synopsis tab on the right. Brilliant! The TOC is nice too! The over-all impression is that it doesn't look as auto-generated as the old style. Frame version: http://www.ozonehouse.com/mark/snap-xhtml/frames.html Also very good looking. Does the current stable version of Haddock really create a frame version? I've never seen one before... /M -- Magnus Therning (OpenPGP: 0xAB4DFBA4) magnus＠therning．org Jabber: magnus＠therning．org http://therning.org/magnus identi.ca|twitter: magthe ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
2010/8/4 Mark Lentczner ma...@glyphic.com: The Haddock team has spent the last few months revamping the look of the generated output. We're pretty close to done, but we'd like to get the community's input before we put it in the main release. Please take a look, and then give us your feedback through a short survey Sample pages: http://www.ozonehouse.com/mark/snap-xhtml/index.html Frame version: http://www.ozonehouse.com/mark/snap-xhtml/frames.html Survey: http://spreadsheets.google.com/viewform?formkey=dHcwYzdMNkl5WER1aVBXdV9HX1l5U3c6MQ Short link to same survey: http://bit.ly/9Zvs9B I think there is a typo in the question about the looks 3) and 4) (the -alt and non-alt version). The -alt is the one with the titles and the non-alt deosn't have them. But the question states the opposite. The rendering is really great, thanks for it. Cheers, Thu ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
Magnus Therning mag...@therning.org writes: On Wed, Aug 4, 2010 at 06:00, Mark Lentczner ma...@glyphic.com wrote: The Haddock team has spent the last few months revamping the look of the generated output. We're pretty close to done, but we'd like to get the community's input before we put it in the main release. Please take a look, and then give us your feedback through a short survey Sample pages: http://www.ozonehouse.com/mark/snap-xhtml/index.html I really like it, especially the synopsis tab on the right. Brilliant! The TOC is nice too! The over-all impression is that it doesn't look as auto-generated as the old style. Agreed; I'm also glad that the usage of a middle column isn't a fixed width but resizes as the text resizes (the lack of this is something that annoys me to no end on some websites). Frame version: http://www.ozonehouse.com/mark/snap-xhtml/frames.html Also very good looking. Does the current stable version of Haddock really create a frame version? I've never seen one before... There is, but I for one don't use it (and there was an email sent out in May asking if anyone did: http://www.mail-archive.com/haskell-cafe@haskell.org/msg75269.html ). I quite like this new approach, however, but with one caveat: the empty frame on the bottom left at default. Especially with my weird firefox setup (which has almost grown organically over the years and should really be wiped), it doesn't display too well; is it possible to have _something_ there by default just to make it look more interesting (Haskell logo, a message saying stuff will appear here when you click on something above, etc.) ? However, I would still be highly tempted to use the framed version by default with that new layout. -- Ivan Lazar Miljenovic ivan.miljeno...@gmail.com IvanMiljenovic.wordpress.com ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
Ivan Lazar Miljenovic ivan.miljeno...@gmail.com writes: On Wed, Aug 4, 2010 at 06:00, Mark Lentczner ma...@glyphic.com wrote: Frame version: http://www.ozonehouse.com/mark/snap-xhtml/frames.html I quite like this new approach Dammit, I just realised as I went to do the survey that the old framed approach is almost identical to the new framed approach :s For some reason I thought it was different... :s -- Ivan Lazar Miljenovic ivan.miljeno...@gmail.com IvanMiljenovic.wordpress.com ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On Aug 4, 2010, at 5:11 AM, Magnus Therning wrote: Does the current stable version of Haddock really create a frame version? I've never seen one before... Yes it does. For example, the standaed GHC book packages doc has the frames version here: http://www.haskell.org/ghc/docs/6.12.2/html/libraries/frames.html Documentation on Hackage doesn't seems to be missing two of the generated files to enable the frames version to work for each package. - Mark ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
Great! I like it a lot, but a couple of minor suggestions regarding the tree view of modules. I think it would be more attractive (and space-efficient) to have them indent a little less and to provide some sort of visual link, in the form of even subtle branches, from parents to children. A bit like http://origin.arstechnica.com/journals/linux.media/300/dolphin_tree_view.pngor similar. On Wed, Aug 4, 2010 at 7:00 AM, Mark Lentczner ma...@glyphic.com wrote: The Haddock team has spent the last few months revamping the look of the generated output. We're pretty close to done, but we'd like to get the community's input before we put it in the main release. Please take a look, and then give us your feedback through a short survey Sample pages: http://www.ozonehouse.com/mark/snap-xhtml/index.html Frame version: http://www.ozonehouse.com/mark/snap-xhtml/frames.html Survey: http://spreadsheets.google.com/viewform?formkey=dHcwYzdMNkl5WER1aVBXdV9HX1l5U3c6MQ Short link to same survey: http://bit.ly/9Zvs9B Thanks! - Mark Mark Lentczner http://www.ozonehouse.com/mark/ irc: MtnViewMark ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On 4 August 2010 10:11, Magnus Therning mag...@therning.org wrote: On Wed, Aug 4, 2010 at 06:00, Mark Lentczner ma...@glyphic.com wrote: The Haddock team has spent the last few months revamping the look of the generated output. We're pretty close to done, but we'd like to get the community's input before we put it in the main release. Please take a look, and then give us your feedback through a short survey Sample pages: http://www.ozonehouse.com/mark/snap-xhtml/index.html I really like it, especially the synopsis tab on the right. Brilliant! The TOC is nice too! The over-all impression is that it doesn't look as auto-generated as the old style. Frame version: http://www.ozonehouse.com/mark/snap-xhtml/frames.html Also very good looking. Does the current stable version of Haddock really create a frame version? I've never seen one before... Yes, I added it two years ago, but we never advertised it much, because of a problem on Firefox. You had to press the back button twice, which was annoying. I've just found a fix, though, so it should work fine in the next release. It already works fine in Chrome, though. /M -- Magnus Therning (OpenPGP: 0xAB4DFBA4) magnus＠therning．org Jabber: magnus＠therning．org http://therning.org/magnus identi.ca|twitter: magthe ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe -- If it looks like a duck, and quacks like a duck, we have at least to consider the possibility that we have a small aquatic bird of the family Anatidae on our hands. ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
Mark Lentczner wrote: The Haddock team... Please take a look, and then give us your feedback Very very nice. I took the survey, but here are some comments I left out. I like the idea of the Snappy style the best, but there are two serious problems with it, at least in my browser (Safari): 1. The black on dark blue of the Snap Packages title makes it nearly unreadable for me. 2. The wide fonts stretch things out so far on my screen that the page becomes almost unusable. The other styles are fine, I would use them instead. Here is a comment I'll repeat from the survey because of its importance: Please add a collapse all button for the tree on the contents page. For me, that is perhaps the most urgent thing missing in all of Haddock. It would make that tree so much more usable. Thanks for the great work, Yitz ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
A few points, * The text in Synopsis part is typically wide. (See http://www.ozonehouse.com/mark/snap-xhtml/heist/Text-Templating-Heist.htmlwith Ocean style) I think it would be more *usable *if it was at the bottom of the page (again with a similar button and open/close toggling effect) * On my browser (firefox on a mac) if I select any of the two styles other than Ocean, module pages seem like they do not apply any style. And also they still reference ocean.css. A cookie problem or something like that? * Opening the synopsis frame (either at its current position or at the bottom of the page) might be better if it was implemented as a preference. Namely, if I open the synopsis frame in a module page, I'd possibly like to see it in the next modules page as well. Carrying that information to the same extend as preferred style information sounds like a better idea to me. Thanks for the work! Best, On 4 August 2010 06:00, Mark Lentczner ma...@glyphic.com wrote: The Haddock team has spent the last few months revamping the look of the generated output. We're pretty close to done, but we'd like to get the community's input before we put it in the main release. Please take a look, and then give us your feedback through a short survey Sample pages: http://www.ozonehouse.com/mark/snap-xhtml/index.html Frame version: http://www.ozonehouse.com/mark/snap-xhtml/frames.html Survey: http://spreadsheets.google.com/viewform?formkey=dHcwYzdMNkl5WER1aVBXdV9HX1l5U3c6MQ Short link to same survey: http://bit.ly/9Zvs9B Thanks! - Mark Mark Lentczner http://www.ozonehouse.com/mark/ irc: MtnViewMark ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe -- Ozgur Akgun ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
I really like the color scheme and the Javadoc looking frames. One suggestion I can make is to have the index show all the functions with type signatures without having to pick a letter. A lot of times I'll be looking for a function of a certain signature as opposed to a name. Indeed an index of type signatures would great! I remember wishing I had this when trying the understand the Parsec package. -deech On Wed, Aug 4, 2010 at 8:55 AM, Yitzchak Gale g...@sefer.org wrote: Mark Lentczner wrote: The Haddock team... Please take a look, and then give us your feedback Very very nice. I took the survey, but here are some comments I left out. I like the idea of the Snappy style the best, but there are two serious problems with it, at least in my browser (Safari): 1. The black on dark blue of the Snap Packages title makes it nearly unreadable for me. 2. The wide fonts stretch things out so far on my screen that the page becomes almost unusable. The other styles are fine, I would use them instead. Here is a comment I'll repeat from the survey because of its importance: Please add a collapse all button for the tree on the contents page. For me, that is perhaps the most urgent thing missing in all of Haddock. It would make that tree so much more usable. Thanks for the great work, Yitz ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On 4 August 2010 15:44, aditya siram aditya.si...@gmail.com wrote: I really like the color scheme and the Javadoc looking frames. One suggestion I can make is to have the index show all the functions with type signatures without having to pick a letter. A lot of times I'll be looking for a function of a certain signature as opposed to a name. Indeed an index of type signatures would great! I remember wishing I had this when trying the understand the Parsec package. -deech Wouldn't hoogle be better for this kind of use case? The index can become very large already. More direct hoogle/hayoo integration (at least on Hackage) sounds like a worthwhile goal, though. Noted. On Wed, Aug 4, 2010 at 8:55 AM, Yitzchak Gale g...@sefer.org wrote: Mark Lentczner wrote: The Haddock team... Please take a look, and then give us your feedback Very very nice. I took the survey, but here are some comments I left out. I like the idea of the Snappy style the best, but there are two serious problems with it, at least in my browser (Safari): 1. The black on dark blue of the Snap Packages title makes it nearly unreadable for me. 2. The wide fonts stretch things out so far on my screen that the page becomes almost unusable. The other styles are fine, I would use them instead. Here is a comment I'll repeat from the survey because of its importance: Please add a collapse all button for the tree on the contents page. For me, that is perhaps the most urgent thing missing in all of Haddock. It would make that tree so much more usable. Thanks for the great work, Yitz ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe -- If it looks like a duck, and quacks like a duck, we have at least to consider the possibility that we have a small aquatic bird of the family Anatidae on our hands. ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
This is something I've wanted for a long time, but I always intended to just submit a patch since it would be trivial, but maybe other people have an opinion about it too: I've always wanted a button to collapse or maybe toggle all expanded branches. Once a library gets large, it's easier to navigate when things are closed by default. I used to have to re-close giant things I didn't care about, like the open gl modules, all the time. And if I hit the back button to go back to the toc, it's forgotten which branches I had closed. Of course, since the stdlib has been broken up a lot this is less of a problem than it used to be, but as my own project gets bigger it's since become a problem there. In fact, without an easy way of closing everything, the fact that sub-packages are collapsable at all doesn't seem very useful, unless you use frame view and keep the page open for a long time. ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
Great work! I'm sure you're already aware of http://sphinx.pocoo.org/ which is used to generate the Python docs. A lot of good ideas there. One thing which would be great would be to integrate their javascript in-browser text search engine. Obviously not a priority but it might be nice. Best, B Message: 14 Date: Wed, 4 Aug 2010 15:56:58 +0100 From: Thomas Schilling nomin...@googlemail.com Subject: Re: [Haskell-cafe] Preview the new haddock look and take a short survey To: aditya siram aditya.si...@gmail.com Cc: haddock hadd...@projects.haskell.org, haskell-cafe@haskell.org Message-ID: aanlktincl6ousuj6hfdi+3-uao2bqmrx-p8dvrzym...@mail.gmail.com Content-Type: text/plain; charset=ISO-8859-1 On 4 August 2010 15:44, aditya siram aditya.si...@gmail.com wrote: I really like the color scheme and the Javadoc looking frames. One suggestion I can make is to have the index show all the functions with type signatures without having to pick a letter. A lot of times I'll be looking for a function of a certain signature as opposed to a name. Indeed an index of type signatures would great! I remember wishing I had this when trying the understand the Parsec package. -deech Wouldn't hoogle be better for this kind of use case? The index can become very large already. More direct hoogle/hayoo integration (at least on Hackage) sounds like a worthwhile goal, though. Noted. On Wed, Aug 4, 2010 at 8:55 AM, Yitzchak Gale g...@sefer.org wrote: Mark Lentczner wrote: The Haddock team... Please take a look, and then give us your feedback Very very nice. I took the survey, but here are some comments I left out. I like the idea of the Snappy style the best, but there are two serious problems with it, at least in my browser (Safari): 1. The black on dark blue of the Snap Packages title makes it nearly unreadable for me. 2. The wide fonts stretch things out so far on my screen that the page becomes almost unusable. The other styles are fine, I would use them instead. Here is a comment I'll repeat from the survey because of its importance: Please add a collapse all button for the tree on the contents page. For me, that is perhaps the most urgent thing missing in all of Haddock. It would make that tree so much more usable. Thanks for the great work, Yitz ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe -- If it looks like a duck, and quacks like a duck, we have at least to consider the possibility that we have a small aquatic bird of the family Anatidae on our hands. ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On Wed, Aug 4, 2010 at 1:00 AM, Mark Lentczner ma...@glyphic.com wrote: The Haddock team has spent the last few months revamping the look of the generated output. We're pretty close to done, but we'd like to get the community's input before we put it in the main release. Please take a look, and then give us your feedback through a short survey Sample pages: http://www.ozonehouse.com/mark/snap-xhtml/index.html Frame version: http://www.ozonehouse.com/mark/snap-xhtml/frames.html Survey: http://spreadsheets.google.com/viewform?formkey=dHcwYzdMNkl5WER1aVBXdV9HX1l5U3c6MQ Short link to same survey: http://bit.ly/9Zvs9B Thanks! - Mark Mark Lentczner http://www.ozonehouse.com/mark/ irc: MtnViewMark The index page is not rendered properly on Firefox 3.0.18 on 64-bit Ubuntu: http://imgur.com/Ez6Ki.jpg. Note that the package name a module comes from is not aligned with the module. The synopsis pull-out box is also not rendered properly: http://imgur.com/Ez6KicfdfMl. The `Synopsis' tab is raised an inch or so above the box, long type signatures are truncated, and the nested scroll bar is obscured. I also really dislike nested scroll bars in web pages. Best, Brad ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On 10-08-04 01:00 AM, Mark Lentczner wrote: Sample pages: http://www.ozonehouse.com/mark/snap-xhtml/index.html On the Contents page, among the collapsable trees: when I click on a link that is also a parent, such as Snap.Http.Server and Text.Templating.Heist, it has the undesirable side effect of collapsing the subtree (or expanding the subtree). (Firefox 3.6.8 as provided by current Ubuntu 32-bit.) When I click on a link, my intention --- and I'm sure most people's intention too --- is to jump to the linked page only. No side effects unrelated to the jump. No messing with the tree state. Another thing. In Safari in iOS 4 in iPod Touch 2nd generation, when a tree is collapsed, the [+] doesn't show. (Haha I'm an impossible reviewer. iPod Touch?!) ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
On Wed, Aug 4, 2010 at 2:11 AM, Magnus Therning mag...@therning.org wrote: On Wed, Aug 4, 2010 at 06:00, Mark Lentczner ma...@glyphic.com wrote: The Haddock team has spent the last few months revamping the look of the generated output. We're pretty close to done, but we'd like to get the community's input before we put it in the main release. Please take a look, and then give us your feedback through a short survey Sample pages: http://www.ozonehouse.com/mark/snap-xhtml/index.html I really like it, especially the synopsis tab on the right. Likewise, although I notice that the synopsis tab closes if I click on a link inside it, which seems unfortunate. Mark, thanks for the great work! ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
Re: [Haskell-cafe] Preview the new haddock look and take a short survey
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 8/4/10 05:11 , Magnus Therning wrote: Also very good looking. Does the current stable version of Haddock really create a frame version? I've never seen one before... http://www.haskell.org/ghc/docs/current/html/libraries/frames.html - -- brandon s. allbery [linux,solaris,freebsd,perl] allb...@kf8nh.com system administrator [openafs,heimdal,too many hats] allb...@ece.cmu.edu electrical and computer engineering, carnegie mellon university KF8NH -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.10 (Darwin) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iEYEARECAAYFAkxaLBUACgkQIn7hlCsL25XhhQCgs9SZ2kGZNLl76Pu4qQnGjkkw rqwAn3pVaRj5+eTwW4W3LU+n2Jnc1Meq =JfAa -END PGP SIGNATURE- ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
[Haskell-cafe] Preview the new haddock look and take a short survey
The Haddock team has spent the last few months revamping the look of the generated output. We're pretty close to done, but we'd like to get the community's input before we put it in the main release. Please take a look, and then give us your feedback through a short survey Sample pages: http://www.ozonehouse.com/mark/snap-xhtml/index.html Frame version: http://www.ozonehouse.com/mark/snap-xhtml/frames.html Survey: http://spreadsheets.google.com/viewform?formkey=dHcwYzdMNkl5WER1aVBXdV9HX1l5U3c6MQ Short link to same survey: http://bit.ly/9Zvs9B Thanks! - Mark Mark Lentczner http://www.ozonehouse.com/mark/ irc: MtnViewMark ___ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe
