Documentation pages should start pre-scrolled

RESOLVED FIXED in 0.7

Status

Add-on SDK
General
RESOLVED FIXED
8 years ago
8 years ago

People

(Reporter: dietrich, Unassigned)

Tracking

unspecified

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(1 attachment)

(Reporter)

Description

8 years ago
if i scroll the page to see a module link, and click it while in that scrolled state, the module's docs load already scrolled down.

it should reset the scrolling, loading the page unscrolled.

Comment 1

8 years ago
Created attachment 461273 [details] [diff] [review]
patch

This patch makes it so that when you click a link in the sidebar, the window incrementally scrolls up to the top, the old content quickly fades out, and the new content fades in as it did before.  I played with different approaches and tweaks, and this one works well I think.

Also, when a module doesn't have documentation, we were hiding the nice "This module has no documentation" default text for some reason.  This patch corrects that, so when you click a module with no docs you get that text instead of a blank page.
Attachment #461273 - Flags: review?(warner-bugzilla)

Updated

8 years ago
OS: Linux → All
Hardware: x86 → All
Comment on attachment 461273 [details] [diff] [review]
patch

Patch looks good to me. Only two comments:
 * in the long run, it might be nice to have the sidebar table-of-contents scroll separately than the main right-hand docs window: for long docs, I have to scroll the whole window back up to the top anyways, just to find the buttons to move to different docs sections. (I was going to be worried about the fixed-speed auto-scrolling, and how long it would take to get back to the top of a long document, but it's kind of moot when you have to scroll up there just to see the buttons first). This might mean putting the docs window in a separate frame.. eww.
 * I'm not sure about the "We're working on it!" comment.. this message will be displayed for third-party doc-less packages that we won't, in fact, be working on, and it kind of reminds me of the old "This Site Under Construction" banners. Maybe "This module has no documentation, sorry!" ?

But it's fine to commit as-is. Thanks! This one was bugging me!
Attachment #461273 - Flags: review?(warner-bugzilla) → review+

Comment 3

8 years ago
(In reply to comment #2)
>  * in the long run, it might be nice to have the sidebar table-of-contents
> scroll separately than the main right-hand docs window:

I agree.  (For comparison, Ruby's documentation works that way: <http://www.ruby-doc.org/stdlib/>)

>  * I'm not sure about the "We're working on it!" comment..

Good point.  I removed that part of the patch.

http://hg.mozilla.org/labs/jetpack-sdk/rev/3a630419bec7
Status: NEW → RESOLVED
Last Resolved: 8 years ago
Resolution: --- → FIXED
Summary: documentation pages can start pre-scrolled → Documentation pages should start pre-scrolled
Target Milestone: -- → 0.7
The Add-on SDK is no longer a Mozilla Labs experiment and has become a big enough project to warrant its own Bugzilla product, so the "Add-on SDK" product has been created for it, and I am moving its bugs to that product.

To filter bugmail related to this change, filter on the word "looptid".
Component: Jetpack SDK → General
Product: Mozilla Labs → Add-on SDK
QA Contact: jetpack-sdk → general
Version: Trunk → unspecified
You need to log in before you can comment on or make changes to this bug.