Reworked Scaladoc Filter Panel

On 06/18/2011 03:00 AM, Rüdiger Keller wrote:
> Therefore I decided to show you the current work in progress. You can
> see that the whole filter panel moved to a bar at the bottom. But be
> warned it is still buggy and the linearization is still missing. I was
> planning to make the bottom bar expandable via another small toggle
> button for this.

This is pretty minor, but would it make more sense to have the search
bar at the top of the page? The package search is at the top and it
feels slightly inconsistent to have the filter panel at the bottom.

>
> Also, I somewhat changed the HTML structure to simplify and speed up
> the filter operations. Typing in the filter input field should be
> noticeably smoother that with the Scaladocs of the 2.9.0 release. At
> least, it is on my system with Firefox 4.

It's definitely seems snappier on my system as well, nice work!

Derek

I still prefer things at the top, but I must say it is looking good. I
see you implemented the multiple words as alternative patterns search
too.

On Sat, Jun 18, 2011 at 06:00, Rüdiger Keller
wrote:
> Hello Gilles,
> Hello list,
>
> I did some work on an improved filter panel on the Scaladoc pages.
> Unfortunately since three weeks ago I didn't really have time to
> continue this.
>
> Therefore I decided to show you the current work in progress. You can
> see that the whole filter panel moved to a bar at the bottom. But be
> warned it is still buggy and the linearization is still missing. I was
> planning to make the bottom bar expandable via another small toggle
> button for this.
>
> Also, I somewhat changed the HTML structure to simplify and speed up
> the filter operations. Typing in the filter input field should be
> noticeably smoother that with the Scaladocs of the 2.9.0 release. At
> least, it is on my system with Firefox 4.
>
> You can find the WIP here, but please note that Seq is the only class
> accessible:
>
> http://dl.dropbox.com/u/21541067/710683725952432684189/index.html#scala....
>
>
> Please tell me what you think about it and whether it's worth to
> continue working on.
>
> Regards,
> Rüdiger
>

2011/6/18 Daniel Sobral :
> I still prefer things at the top, but I must say it is looking good. I
> see you implemented the multiple words as alternative patterns search
> too.

Yes, I did, thanks to your idea.

Btw. putting the filter bar at the top should not be a problem.

I will give it a try once I resume working on this.

Regards,
Rüdiger

On Sat, Jun 18, 2011 at 11:00 AM, Rüdiger Keller
wrote:
> http://dl.dropbox.com/u/21541067/710683725952432684189/index.html#scala....

Nice work. I've got no special preference whether the bar should be at
the top or the bottom. However, what I find always confusing is when
somethings which looks like a button contains a state description, in
this particular case, "Private Hidden", "Alphabetic Order" etc.
IMO this should be changed either to a text which describes the state
_change_ a button press will make or give some visual clues that the
text describes the current state.

I agree about the button labels. I was unsure how to do it, maybe it
would be better to change them as you suggest. I wanted to preserve
the display of the current state, but the buttons might not be the
right place for that. Unfortunately, I think that the space is too
limited to display it elsewhere, though.

Regards,
Rüdiger

2011/6/19 Johannes Rudolph :
> On Sat, Jun 18, 2011 at 11:00 AM, Rüdiger Keller
> wrote:
>> http://dl.dropbox.com/u/21541067/710683725952432684189/index.html#scala....
>
> Nice work. I've got no special preference whether the bar should be at
> the top or the bottom. However, what I find always confusing is when
> somethings which looks like a button contains a state description, in
> this particular case, "Private Hidden", "Alphabetic Order" etc.
> IMO this should be changed either to a text which describes the state
> _change_ a button press will make or give some visual clues that the
> text describes the current state.
>
> --
> Johannes
>
> -----------------------------------------------
> Johannes Rudolph
> http://virtual-void.net
>

Maybe this is just me but I disagree with the naming of the buttons "private shown" and "private hidden" on the member filter. 
A button is an action and any text should describe what will happen if you take that action. In my opinion the text as it is is confusing. For example when the button says "private shown", does it mean that the private members are shown now, or will be shown if I press the button? I assume it is the former due to the present tense but I think this is not clear/unambiguous and should be renamed to "Show only Public" and "Show All" respectively.

> From: ruediger.keller@rk42.de
> Date: Sat, 18 Jun 2011 21:16:10 +0200
> Subject: Re: [scala-internals] Reworked Scaladoc Filter Panel
> To: scala-internals@googlegroups.com; dcsobral@gmail.com
> CC: gilles.dubochet@epfl.ch
>
> 2011/6/18 Daniel Sobral <dcsobral@gmail.com>:
> > I still prefer things at the top, but I must say it is looking good. I
> > see you implemented the multiple words as alternative patterns search
> > too.
>
> Yes, I did, thanks to your idea.
>
> Btw. putting the filter bar at the top should not be a problem.
>
> I will give it a try once I resume working on this.
>
> Regards,
> Rüdiger