User:P.A./Panel-based Download Manager: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
No edit summary
(The final overview of the feature is now available at http://mikeconley.ca/blog/2013/04/02/downloading-stuff-in-firefox-its-better-now/)
 
(37 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{FeatureStatus
{{FeatureStatus
|Feature name=Panel-based Download Manager
|Feature name=Panel-based Download Manager
|Feature stage=Development
|Feature stage=Landed
|Feature status=In progress
|Feature status=Complete
|Feature version=Firefox 9
|Feature version=Firefox 20
|Feature health=OK
|Feature health=OK
|Feature status note=In beta, go to release.
}}
}}
{{FeatureTeam
{{FeatureTeam
|Feature product manager=Asa Dotzler
|Feature product manager=Asa Dotzler
|Feature feature manager=Marco Bonardo
|Feature feature manager=Marco Bonardo
|Feature lead engineer=Paolo Amadini, Jared Wein
|Feature lead engineer=Paolo Amadini, Mike Conley
|Feature qa lead=Simona Badau
|Feature qa lead=Simona Badau
|Feature ux lead=Alexander Limi
|Feature ux lead=Alexander Limi
|Feature additional members=Sinchan Banerjee, Stephen Horlander, Shawn Wilsher, Mehdi Mulani
|Feature additional members=Sinchan Banerjee, Stephen Horlander, Shawn Wilsher, Mehdi Mulani, Jared Wein
}}
}}
{{FeaturePageBody
{{FeaturePageBody
|Feature overview=This is a page I'm using to track the current status of the [[User:P.A./Download_user_experience_improvements#Panel-based_Download_Manager|Panel-based Download Manager]] feature at a level of detail I'm comfortable working with. This feature is part of the [[User:P.A./Download_user_experience_improvements|download user experience improvements]].
|Feature overview=<div style="margin: 1em 0px; border: 2px solid orange; padding: 1em; background-color: #FFC; text-align: center; font-size: large;">
THE DOWNLOADS PANEL HAS BEEN RELEASED IN FIREFOX 20.


<div style="margin: 1em 0px; border: 2px solid orange; padding: 1em; background-color: #FFC; text-align: center;">'''FEEDBACK'''
YOU CAN READ MORE ABOUT THE FEATURE IN THE '''[http://mikeconley.ca/blog/2013/04/02/downloading-stuff-in-firefox-its-better-now/ INTRODUCTORY BLOG POST]'''.</div>
<div style="font-size:x-small"><p>If you have questions (or better, answers!) the best way to provide feedback is to add a comment to the [[#Bugs_list_and_patch_queue|relevant bug]].</p><p>I'll update this page periodically to reflect the current status and make sure that all the relevant items are tracked.</p></div></div>


I've read all bug comments, and updated this page accordingly, up to this point:
This is the detailed technical [[Features/Planning_and_Tracking|feature page]] for the [[User:P.A./Download_user_experience_improvements#Panel-based_Download_Manager|Downloads Panel]]. This feature is part of the [[User:P.A./Download_user_experience_improvements|download user experience improvements]].
* [https://bugzilla.mozilla.org/show_bug.cgi?id=564934#c285 Bug 564934, comment 285].
 
It's possible that some of the latest comments are not yet reflected in this page. See below for detailed tracking of individual items.
 
----


The current Download Manager user interface is not optimized for several common use cases, and is not yet integrated with the latest Firefox user experience design. Integrating this interface with the latest design is the first step to improve the downloads user experience.
The current Download Manager user interface is not optimized for several common use cases, and is not yet integrated with the latest Firefox user experience design. Integrating this interface with the latest design is the first step to improve the downloads user experience.
Line 47: Line 43:
* '''Any other improvement already defined as [[User:P.A./Download_user_experience_improvements|download user experience improvements]].'''
* '''Any other improvement already defined as [[User:P.A./Download_user_experience_improvements|download user experience improvements]].'''
** ''For example, streamlining the entire download process.''
** ''For example, streamlining the entire download process.''
|Feature ux design=We'll reach the stated goals by moving the interface for handling current downloads in a panel, anchored to a status indicator in the main browser window, and adding a new '''Downloads''' predefined folder to the Library window.
|Feature ux design=We'll reach the stated goals by adding a panel for handling the most recent downloads, anchored to a status indicator in the main browser window, and moving the interface for handling all downloads to a new '''Downloads''' predefined folder in the Library window.


In the following sections, entries are marked with these indicators:
In the following sections, entries are marked with these indicators:
Line 58: Line 54:
Provides a status overview, visible during normal browsing when there are download notifications.
Provides a status overview, visible during normal browsing when there are download notifications.


* {{done|Only shown when there are download items in the panel, either active or completed.}}
* {{done|Always visible by default, located on the navigation bar, between the search bar and the home button.}}
** <span style="color: orange; font-size: 80%; font-weight: bold">[INPUT]</span> Maybe, also shown after the last download is removed from the panel, giving access to downloads history only.
* {{done|When there are no active downloads, shows the classic button icon (downwards arrow).}}
* {{done|When there are no active downloads, shows the classic button icon (downwards arrow).}}
* {{done|When there are active downloads, shows the number of active downloads.}}
* {{done|When there are active downloads, shows a progress bar and a compact indication of the remaining time, if known.}}
* {{done|Has a progress bar.}}


Provides visual indication of new downloads or completed downloads.
Provides visual indication of new downloads or completed downloads.


* {{done|New downloads make the indicator flash or glow until the panel is displayed.}}
* {{done|New downloads are notified with a brief animation near the indicator.}}
* {{done|Finished or failed downloads make the indicator flash or glow until the panel is displayed.}}
* {{done|Finished or failed downloads make the indicator glow until the panel is displayed.}}
* {{done|If the indicator is removed from the toolbars, or moved to an invisible toolbar, the usual screen-level notification is shown when all downloads are completed.}}
* {{done|The usual screen-level notification is shown when all downloads are completed.}}
** Note that this is shown even when the indicator is visible.


Provides the anchor for the panel.
Provides the anchor for the panel.


* {{done|Located in the tab bar by default, which by default is always visible, except in Panorama mode.}}
* {{done|If the indicator is removed from the toolbars, or is located in an invisible toolbar, the panel will never be displayed.}}
* {{done|If the indicator is removed from the toolbars, or moved to an invisible toolbar, we show it temporarily in the default tab bar position or in the navigation bar when the panel is opened, until the panel is closed.}}
** {{done|In this case, the full download management interface will be shown when a new download is started.}}
* If we need to show the panel and both the tab bar and the navigation bar are invisible, then:
* {{done|User-initiated requests to show downloads will always open the Downloads view in the Library window, regardless of indicator visibility.}}
** {{done|For user-initiated requests (like the Downloads menu item), show the panel without the anchor, near the default anchor position.}}
** {{done|For user-initiated requests, if there is no browser window open (like clicking a screen-level notification, or the Downloads menu item on OSX), open a new browser window and show the panel there.}}
** {{done|For background-initiated requests, do nothing.}}


=== Downloads panel ===
=== Downloads panel ===
Line 85: Line 77:
The panel works as follows:
The panel works as follows:


* {{done|The panel should be shown automatically for the first download of the browsing session.}}
* {{done|The panel should be shown automatically for the first download after the feature is enabled, for discoverability.}}
* {{done|The panel can be fixed-width.}}
* {{done|Only a few recent downloads are shown in the panel, thus not all the current downloads can be managed from the panel.}}
** Resizeability is not as much of an issue with the downloads panel as it is with the bookmarks panel, because the downloads panel is less of a "management" interface. The full title of a download is shown in a tooltip.
** This must ensure that the panel does not expand to the full screen height when opened in a maximized window.
* {{done|Notifications are sorted by start time, most recent first.}}
* {{done|Notifications are sorted by start time, most recent first.}}
** It's consistent with notification sorting in other platforms, and the order doesn't change unexpectedly while the panel is open.
** It's consistent with notification sorting in other platforms, and the order doesn't change unexpectedly while the panel is open.
** Another option is to show first the items on which an action is more likely, i.e. completed downloads first, then failed, then running downloads.
* {{done|The panel contains a link to the full list of downloads.}}
* {{done|The panel is fixed-width.}}
** Resizeability is not as much of an issue with the downloads panel as it is with the bookmarks panel, because the downloads panel is less of a "management" interface. The full title of a download is shown in a tooltip.
* {{done|When there are no download items, the panel's width can be smaller.}}


Individual notifications have the following behavior:
Individual notifications have the following behavior:


* Notifications should disappear as soon as the user is done with them. We can't know the exact moment, so we use a set of heuristics.
* Notifications should disappear as soon as the user is done with them. We can't know the exact moment, so we use a set of heuristics.
** {{done|Opening the target file or folder makes the notification disappear.}}
** {{done|Completed downloads are removed from the list when the last browser window is closed.}}
** {{done|Canceling a running download makes the notification disappear.}}
*** Active downloads are never removed from the list automatically, though they can be hidden by most recent downloads.
** {{done|Completed downloads are removed from the list when the session ends, but are restored when the session is restored.}}
*** Completed downloads are not restored if the previous session is restored. They can still be accessed from the Downloads view in the Library window.
*** Active downloads have no session boundary. When the browser is closed and reopened, they're paused and resumed automatically whenever possible.
** {{done|Canceling a running download does not make the notification disappear.}}
** {{done|Manually removing a download from the list is possible, but not a top-level interaction.}}
** {{done|Manually removing a download from the list is possible, but not a top-level interaction.}}
*** <span style="color: orange; font-size: 80%; font-weight: bold">[INPUT]</span> Sinchan to follow-up with quick user studies to understand if we might want a top-level remove button for completed downloads, that would be the same button that cancels running downloads.
* There are no actions that make sense on more than one notification at a time.
* There are no actions that make sense on more than one notification at a time.
* {{done|The height of each notification does not change when its state changes.}}


The layout of a notification includes a main area with the download's distinctive details, and an optional action button. In some states of the download, the main area can be clicked. Double-clicking the main area, instead, is not a supported interaction.
The layout of a notification includes a main area with the download's distinctive details, and an optional action button. In some states of the download, the main area can be clicked. Double-clicking the main area, instead, is not a supported interaction.


A context menu for the item can always be displayed, though it never contains commands already available through a top-level interaction.
A context menu for the item can always be displayed. It may contain commands already available through a top-level interaction for consistency.


* {{done|When the main area can be clicked, a link-style mouse cursor is displayed on hover.}}
* {{done|When the main area can be clicked, a link-style mouse cursor is displayed on hover.}}
* When the download is ongoing [not paused or finished or canceled]:
* When the download is ongoing [not paused or finished or canceled]:
** {{done|The button cancels the download.}}
** {{done|The button cancels the download.}}
** <span style="color: orange; font-size: 80%; font-weight: bold">[INPUT]</span> Clicking the main area might indicate to open the download when it's finished, however this could be surprising.
** {{done|The context menu has commands to pause, open containing folder, go to download page, copy download link.}}
** {{done|The context menu has commands to pause, open containing folder, go to download page, copy download link.}}
* When the download is paused:
* When the download is paused:
** {{done|The button resumes the download.}}
** {{done|The button cancels the download.}}
** {{done|The context menu has commands to cancel, open containing folder, go to download page, copy download link.}}
** {{done|The context menu has commands to resume, open containing folder, go to download page, copy download link.}}
* When the download is failed or canceled:
** {{done|The button retries the download. Often, the download will resume from where it stopped, if supported by the server.}}
** {{done|The context menu has commands to remove from list, go to download page, copy download link.}}
* When the download has finished:
* When the download has finished:
** {{done|Clicking the main area opens the file.}}
** {{done|Clicking the main area opens the file.}}
*** {{ok|If the target file is missing, the main area should not be clickable. The existence detection should happen in the background.}}
** {{done|The button opens the containing folder.}}
** {{done|The button opens the containing folder.}}
** {{done|The context menu has commands to remove from list, go to download page, copy download link.}}
** {{done|The context menu has commands to remove from list, go to download page, copy download link.}}
There are additional items in the context menu that act on all downloads:
** {{done|A context menu item is available for removing completed downloads from the list, without closing the last browser window.}}


=== Library window ===
=== Library window ===


The Library window allows the user to find and open previous downloads.
The Library window allows the user to see the full list of downloads. The user can control ongoing downloads, as well as finding and opening previous downloads.
 
'''The interaction with ongoing downloads is different from the standalone Downloads window.''' The interaction will be more similar to the Downloads Panel.


* {{done|Items can be found by source location or original target file name.}}
* {{done|When the user selects the Downloads folder, the list of history pages is replaced with a different view for handling current downloads.}}
** Note that downloaded entries can be mixed with normal pages in history results, and a normal web page can be downloaded locally.
* The Downloads view shows both ongoing downloads and download history.
* {{ok|You can see the full target path of the download.}}
** <span style="color: orange; font-size: 80%; font-weight: bold">[INPUT]</span> Items are sorted based on the current criteria, selected by the user.
* <span style="color: orange; font-size: 80%; font-weight: bold">[INPUT]</span> In all history views, we want to visually mark those entries that are downloads and whose target file exists, unless the entry was also visited as a normal page.
** {{done|Items can be found at least by source location or original target file name.}}
** {{ok|Double-clicking those entries opens the target file instead of navigating to the source URL.}}
** {{done|Most ongoing downloads should also be present in the browsing history, in which case they are shown in the same position as the history item.}}
** In other words, we open the file in those cases where we expect that double-clicking the history entry would make the download dialog appear.
*** If there is no specific matching history item, ongoing downloads might be shown in no particular order.
* {{ok|In the Downloads view, the size of file, and time should be there too.}}
** {{done|History items with no matching current download behave in the same way as completed downloads.}}
* {{done|Download items have an interaction similar to the Downloads Panel items.}}
** {{done|The items contain the same elements as the panel items, based on the current download state.}}
** The interaction will also be different from history items in other Library views.
|Feature implementation notes===== Bugs list and patch queue ====
|Feature implementation notes===== Bugs list and patch queue ====
Patches on the following bugs are required, in order, to complete the feature:


<table class="fullwidth-table">
'''Feature tracking bug:'''
<tr>
 
<td style="font-weight: bold; background: #ddd;">Bug number</td>
* {{bug|564934}} (see also the [[/Status|status]] page)
<td style="font-weight: bold; background: #ddd;">Description</td>
 
<td style="font-weight: bold; background: #ddd;">Status</td>
'''Relevant patches that are available in nightly builds:'''
</tr>
 
<tr>
The feature is now available in standard release trains. Key implementation bugs are:
<td>{{bug|672254}}</td>
 
<td>The arrow panel's height should be limited by the screen height.</td>
* {{bug|726444}}: Implement the Downloads Panel.
<td>Active</td>
* {{bug|675902}}: New Downloads view for Places Library.
</tr>
 
<tr>
'''Additional patches needed to test the feature:'''
<td>{{bug|591289}}</td>
 
<td>Save chosen download file name and other metadata in Places history.</td>
* None. The feature is now available in standard release trains.
<td>On hold</td>
</tr>
<tr>
<td>{{bug|564900}}</td>
<td>Add folder to Library sidebar specifically for downloads.</td>
<td>Active</td>
</tr>
<tr>
<td>{{bug|669905}}</td>
<td>Searching in the new Downloads folder should limit the search to downloads.</td>
<td>Active</td>
</tr>
<tr>
<td>{{bug|564934}}</td>
<td>Implement new Download Manager UI for browser.</td>
<td>Active</td>
</tr>
<tr>
<td>{{bug|663772}}</td>
<td>Implement new Download Manager status indicator for browser.</td>
<td>Active</td>
</tr>
<tr>
<td>{{bug|675902}}</td>
<td>Additional interaction with downloads in the Library.</td>
<td>On hold</td>
</tr>
</table>


==== Open tasks and questions ====
'''Work required to release and enable the feature for everyone:'''
<table class="fullwidth-table sortable">
<tr>
<td style="font-weight: bold; background: #ddd;">Description</td>
<td style="font-weight: bold; background: #ddd;">References</td>
<td style="font-weight: bold; background: #ddd;">Difficult?</td>
<td style="font-weight: bold; background: #ddd;">Blocking?</td>
<td style="font-weight: bold; background: #ddd;">People</td>
</tr>
<tr>
<td>Theming the downloads panel for all the supported platforms.</td>
<td></td>
<td class="yes">Yes</td>
<td class="yes">Yes</td>
<td>ui=Stephen</td>
</tr>
<tr>
<td>Theming and XBL review.</td>
<td>[https://bugzilla.mozilla.org/show_bug.cgi?id=564934#c280 Bug 564934, comment 280]</td>
<td class="no">No</td>
<td class="yes">Yes</td>
<td>r=Frank?,Dão?</td>
</tr>
<tr>
<td>Port the relevant automated regression tests from the Download Manager.</td>
<td></td>
<td class="yes">Yes</td>
<td class="yes">Yes</td>
<td>d=Paolo, r=Marco</td>
</tr>
<tr>
<td>Define the behavior when the target file is removed from disk, and understand at which point we should detect the condition.</td>
<td></td>
<td class="maybe">Maybe</td>
<td class="yes">Yes</td>
<td>ui=Sinchan</td>
</tr>
<tr>
<td>Accessibility review</td>
<td>[https://bugzilla.mozilla.org/show_bug.cgi?id=564934#c258 Bug 564934, comment 258] and [https://bugzilla.mozilla.org/show_bug.cgi?id=564934#c276 comment 276]</td>
<td class="yes">Yes</td>
<td class="yes">Yes</td>
<td>d=Paolo, r=?</td>
</tr>
<tr>
<td>Where to put the manual testing procedures, for example those for toolbar migration?</td>
<td>[https://bugzilla.mozilla.org/show_bug.cgi?id=564934#c85 Bug 564934, comment 85]</td>
<td class="no">No</td>
<td class="no">No</td>
<td></td>
</tr>
<tr>
<td>How to migrate users with many downloads in the database to use the Library?</td>
<td></td>
<td class="maybe">Maybe</td>
<td class="maybe">Maybe</td>
<td>ui=Sinchan</td>
</tr>
<tr>
<td>Understand if the two makefiles in the patch can be checked in and retain public domain status</td>
<td>[https://bugzilla.mozilla.org/show_bug.cgi?id=564934#c272 Bug 564934, comment 272]</td>
<td class="no">No</td>
<td class="no">No</td>
<td>Gerv</td>
</tr>
</table>


* Bugs listed as blocking {{bug|747422}} (completed).


==== Follow-ups ====
==== Follow-ups ====
Line 268: Line 181:
<td>Move original <tt>nsDownloadManagerUI.js</tt> to <tt>mozapps/downloads</tt>.</td>
<td>Move original <tt>nsDownloadManagerUI.js</tt> to <tt>mozapps/downloads</tt>.</td>
<td>[https://bugzilla.mozilla.org/show_bug.cgi?id=564934#c192 Bug 564934, comment 192]</td>
<td>[https://bugzilla.mozilla.org/show_bug.cgi?id=564934#c192 Bug 564934, comment 192]</td>
</tr>
<tr>
<td><tt>NetUtil.newURI</tt> should <tt>QueryInterface</tt> to <tt>nsIFileURL</tt> automatically.</td>
<td>[https://bugzilla.mozilla.org/show_bug.cgi?id=564934#c86 Bug 564934, comment 286]</td>
</tr>
</tr>
<tr>
<tr>
Line 283: Line 200:
|Feature engineering team=Desktop front-end
|Feature engineering team=Desktop front-end
}}
}}
{{FeatureTeamStatus}}
{{FeatureTeamStatus
|Feature security status=sec-review-complete
|Feature security health=OK
|Feature security notes=[[Security/Reviews/Firefox10/PanelDownload|Notes]]
|Feature qa notes=[https://wiki.mozilla.org/User:P.A./Panel-based_Download_Manager/TestPlan Test Plan]
}}

Latest revision as of 17:45, 2 April 2013

Please use "Edit with form" above to edit this page.

Status

Panel-based Download Manager
Stage Landed
Status Complete
Release target Firefox 20
Health OK
Status note In beta, go to release.

{{#set:Feature name=Panel-based Download Manager

|Feature stage=Landed |Feature status=Complete |Feature version=Firefox 20 |Feature health=OK |Feature status note=In beta, go to release. }}

Team

Product manager Asa Dotzler
Directly Responsible Individual Marco Bonardo
Lead engineer Paolo Amadini, Mike Conley
Security lead `
Privacy lead `
Localization lead `
Accessibility lead `
QA lead Simona Badau
UX lead Alexander Limi
Product marketing lead `
Operations lead `
Additional members Sinchan Banerjee, Stephen Horlander, Shawn Wilsher, Mehdi Mulani, Jared Wein

{{#set:Feature product manager=Asa Dotzler

|Feature feature manager=Marco Bonardo |Feature lead engineer=Paolo Amadini, Mike Conley |Feature security lead=` |Feature privacy lead=` |Feature localization lead=` |Feature accessibility lead=` |Feature qa lead=Simona Badau |Feature ux lead=Alexander Limi |Feature product marketing lead=` |Feature operations lead=` |Feature additional members=Sinchan Banerjee, Stephen Horlander, Shawn Wilsher, Mehdi Mulani, Jared Wein }}

Open issues/risks

`

Stage 1: Definition

1. Feature overview

THE DOWNLOADS PANEL HAS BEEN RELEASED IN FIREFOX 20.

YOU CAN READ MORE ABOUT THE FEATURE IN THE INTRODUCTORY BLOG POST.

This is the detailed technical feature page for the Downloads Panel. This feature is part of the download user experience improvements.

The current Download Manager user interface is not optimized for several common use cases, and is not yet integrated with the latest Firefox user experience design. Integrating this interface with the latest design is the first step to improve the downloads user experience.

In the new design, an easily accessible panel shows you current state of downloads, your recent downloads, and gives you a good indicator of how far along your download is. Advanced operations like searching, clearing entries, sorting, and everything else related to download history is integrated with the interface for browsing history.

Goals

  • Fit in with the overall goals of download user experience improvements.
  • Remove the need for a separate Download Manager window.
  • Unify download history with browsing history.
  • Support common use cases, but not necessarily all of those supported previously.
  • Improve the user interface code, and use asynchronous database queries.

2. Users & use cases

We also probably want to consider some, but not all, of the use cases previously suggested for the Download Manager. Note that the current Download Manager does not support all of suggested use cases, while some of them are in the scope of different download user experience improvements.

3. Dependencies

`

4. Requirements

`

Non-goals

  • Power user fuctionality, like handling many concurrent downloads.
  • File management, except for showing where the target file is located.
  • Improve download performance or general front-end responsiveness.
    • Note that we still don't want to introduce significant regressions.
  • Improve the Download Manager or Places back-end C++ code, or make it asynchronous.
  • Any other improvement already defined as download user experience improvements.
    • For example, streamlining the entire download process.

Stage 2: Design

5. Functional specification

`

6. User experience design

We'll reach the stated goals by adding a panel for handling the most recent downloads, anchored to a status indicator in the main browser window, and moving the interface for handling all downloads to a new Downloads predefined folder in the Library window.

In the following sections, entries are marked with these indicators:

  • [ON TRACK] Not yet implemented.
  • [INPUT] Needs design feedback, or a prototype implementation to understand what to do.
  • [DONE] Has an initial implementation that can be tested.

Downloads indicator

Provides a status overview, visible during normal browsing when there are download notifications.

  • [DONE] Always visible by default, located on the navigation bar, between the search bar and the home button.
  • [DONE] When there are no active downloads, shows the classic button icon (downwards arrow).
  • [DONE] When there are active downloads, shows a progress bar and a compact indication of the remaining time, if known.

Provides visual indication of new downloads or completed downloads.

  • [DONE] New downloads are notified with a brief animation near the indicator.
  • [DONE] Finished or failed downloads make the indicator glow until the panel is displayed.
  • [DONE] The usual screen-level notification is shown when all downloads are completed.
    • Note that this is shown even when the indicator is visible.

Provides the anchor for the panel.

  • [DONE] If the indicator is removed from the toolbars, or is located in an invisible toolbar, the panel will never be displayed.
    • [DONE] In this case, the full download management interface will be shown when a new download is started.
  • [DONE] User-initiated requests to show downloads will always open the Downloads view in the Library window, regardless of indicator visibility.

Downloads panel

The entries in the popup panel are just notifications saying that a download is going on, and that a download has finished.

The panel works as follows:

  • [DONE] The panel should be shown automatically for the first download after the feature is enabled, for discoverability.
  • [DONE] Only a few recent downloads are shown in the panel, thus not all the current downloads can be managed from the panel.
    • This must ensure that the panel does not expand to the full screen height when opened in a maximized window.
  • [DONE] Notifications are sorted by start time, most recent first.
    • It's consistent with notification sorting in other platforms, and the order doesn't change unexpectedly while the panel is open.
  • [DONE] The panel contains a link to the full list of downloads.
  • [DONE] The panel is fixed-width.
    • Resizeability is not as much of an issue with the downloads panel as it is with the bookmarks panel, because the downloads panel is less of a "management" interface. The full title of a download is shown in a tooltip.
  • [DONE] When there are no download items, the panel's width can be smaller.

Individual notifications have the following behavior:

  • Notifications should disappear as soon as the user is done with them. We can't know the exact moment, so we use a set of heuristics.
    • [DONE] Completed downloads are removed from the list when the last browser window is closed.
      • Active downloads are never removed from the list automatically, though they can be hidden by most recent downloads.
      • Completed downloads are not restored if the previous session is restored. They can still be accessed from the Downloads view in the Library window.
    • [DONE] Canceling a running download does not make the notification disappear.
    • [DONE] Manually removing a download from the list is possible, but not a top-level interaction.
  • There are no actions that make sense on more than one notification at a time.
  • [DONE] The height of each notification does not change when its state changes.

The layout of a notification includes a main area with the download's distinctive details, and an optional action button. In some states of the download, the main area can be clicked. Double-clicking the main area, instead, is not a supported interaction.

A context menu for the item can always be displayed. It may contain commands already available through a top-level interaction for consistency.

  • [DONE] When the main area can be clicked, a link-style mouse cursor is displayed on hover.
  • When the download is ongoing [not paused or finished or canceled]:
    • [DONE] The button cancels the download.
    • [DONE] The context menu has commands to pause, open containing folder, go to download page, copy download link.
  • When the download is paused:
    • [DONE] The button cancels the download.
    • [DONE] The context menu has commands to resume, open containing folder, go to download page, copy download link.
  • When the download is failed or canceled:
    • [DONE] The button retries the download. Often, the download will resume from where it stopped, if supported by the server.
    • [DONE] The context menu has commands to remove from list, go to download page, copy download link.
  • When the download has finished:
    • [DONE] Clicking the main area opens the file.
      • [ON TRACK] If the target file is missing, the main area should not be clickable. The existence detection should happen in the background.
    • [DONE] The button opens the containing folder.
    • [DONE] The context menu has commands to remove from list, go to download page, copy download link.

There are additional items in the context menu that act on all downloads:

    • [DONE] A context menu item is available for removing completed downloads from the list, without closing the last browser window.

Library window

The Library window allows the user to see the full list of downloads. The user can control ongoing downloads, as well as finding and opening previous downloads.

The interaction with ongoing downloads is different from the standalone Downloads window. The interaction will be more similar to the Downloads Panel.

  • [DONE] When the user selects the Downloads folder, the list of history pages is replaced with a different view for handling current downloads.
  • The Downloads view shows both ongoing downloads and download history.
    • [INPUT] Items are sorted based on the current criteria, selected by the user.
    • [DONE] Items can be found at least by source location or original target file name.
    • [DONE] Most ongoing downloads should also be present in the browsing history, in which case they are shown in the same position as the history item.
      • If there is no specific matching history item, ongoing downloads might be shown in no particular order.
    • [DONE] History items with no matching current download behave in the same way as completed downloads.
  • [DONE] Download items have an interaction similar to the Downloads Panel items.
    • [DONE] The items contain the same elements as the panel items, based on the current download state.
    • The interaction will also be different from history items in other Library views.

Stage 3: Planning

7. Implementation plan

`

8. Reviews

Security review

`

Privacy review

`

Localization review

`

Accessibility

`

Quality Assurance review

`

Operations review

`

Stage 4: Development

9. Implementation

Bugs list and patch queue

Feature tracking bug:

Relevant patches that are available in nightly builds:

The feature is now available in standard release trains. Key implementation bugs are:

Additional patches needed to test the feature:

  • None. The feature is now available in standard release trains.

Work required to release and enable the feature for everyone:

Follow-ups

This section lists non-blocking, suggested follow-ups that need more work before filing a proper bug. Often a search for existing bugs is required before filing a separate bug.

Description References
Cu.import failures don't show up in the Error Console, or the test logs. Bug 564934, comment 224
No feedback when the "open download page" link is clicked and the target page is not available. Bug 564934, comment 191
Allow asynchronous termination functions in the testing framework. Bug 564934, comment 259
Scroll to @@ +47,5 @@
Move original nsDownloadManagerUI.js to mozapps/downloads. Bug 564934, comment 192
NetUtil.newURI should QueryInterface to nsIFileURL automatically. Bug 564934, comment 286
Move fileExecutableSecurityWarning to a common place in Toolkit.

Stage 5: Release

10. Landing criteria

` {{#set:Feature open issues and risks=`

|Feature overview=

THE DOWNLOADS PANEL HAS BEEN RELEASED IN FIREFOX 20.

YOU CAN READ MORE ABOUT THE FEATURE IN THE INTRODUCTORY BLOG POST.

This is the detailed technical feature page for the Downloads Panel. This feature is part of the download user experience improvements.

The current Download Manager user interface is not optimized for several common use cases, and is not yet integrated with the latest Firefox user experience design. Integrating this interface with the latest design is the first step to improve the downloads user experience.

In the new design, an easily accessible panel shows you current state of downloads, your recent downloads, and gives you a good indicator of how far along your download is. Advanced operations like searching, clearing entries, sorting, and everything else related to download history is integrated with the interface for browsing history.

Goals

  • Fit in with the overall goals of download user experience improvements.
  • Remove the need for a separate Download Manager window.
  • Unify download history with browsing history.
  • Support common use cases, but not necessarily all of those supported previously.
  • Improve the user interface code, and use asynchronous database queries.

|Feature users and use cases=* Downloading and running a setup program (Bug 564934, comment 68 and attachment 467459).

We also probably want to consider some, but not all, of the use cases previously suggested for the Download Manager. Note that the current Download Manager does not support all of suggested use cases, while some of them are in the scope of different download user experience improvements. |Feature dependencies=` |Feature requirements=` |Feature non-goals=* Power user fuctionality, like handling many concurrent downloads.

  • File management, except for showing where the target file is located.
  • Improve download performance or general front-end responsiveness.
    • Note that we still don't want to introduce significant regressions.
  • Improve the Download Manager or Places back-end C++ code, or make it asynchronous.
  • Any other improvement already defined as download user experience improvements.
    • For example, streamlining the entire download process.

|Feature functional spec=` |Feature ux design=We'll reach the stated goals by adding a panel for handling the most recent downloads, anchored to a status indicator in the main browser window, and moving the interface for handling all downloads to a new Downloads predefined folder in the Library window.

In the following sections, entries are marked with these indicators:

  • [ON TRACK] Not yet implemented.
  • [INPUT] Needs design feedback, or a prototype implementation to understand what to do.
  • [DONE] Has an initial implementation that can be tested.

Downloads indicator

Provides a status overview, visible during normal browsing when there are download notifications.

  • [DONE] Always visible by default, located on the navigation bar, between the search bar and the home button.
  • [DONE] When there are no active downloads, shows the classic button icon (downwards arrow).
  • [DONE] When there are active downloads, shows a progress bar and a compact indication of the remaining time, if known.

Provides visual indication of new downloads or completed downloads.

  • [DONE] New downloads are notified with a brief animation near the indicator.
  • [DONE] Finished or failed downloads make the indicator glow until the panel is displayed.
  • [DONE] The usual screen-level notification is shown when all downloads are completed.
    • Note that this is shown even when the indicator is visible.

Provides the anchor for the panel.

  • [DONE] If the indicator is removed from the toolbars, or is located in an invisible toolbar, the panel will never be displayed.
    • [DONE] In this case, the full download management interface will be shown when a new download is started.
  • [DONE] User-initiated requests to show downloads will always open the Downloads view in the Library window, regardless of indicator visibility.

Downloads panel

The entries in the popup panel are just notifications saying that a download is going on, and that a download has finished.

The panel works as follows:

  • [DONE] The panel should be shown automatically for the first download after the feature is enabled, for discoverability.
  • [DONE] Only a few recent downloads are shown in the panel, thus not all the current downloads can be managed from the panel.
    • This must ensure that the panel does not expand to the full screen height when opened in a maximized window.
  • [DONE] Notifications are sorted by start time, most recent first.
    • It's consistent with notification sorting in other platforms, and the order doesn't change unexpectedly while the panel is open.
  • [DONE] The panel contains a link to the full list of downloads.
  • [DONE] The panel is fixed-width.
    • Resizeability is not as much of an issue with the downloads panel as it is with the bookmarks panel, because the downloads panel is less of a "management" interface. The full title of a download is shown in a tooltip.
  • [DONE] When there are no download items, the panel's width can be smaller.

Individual notifications have the following behavior:

  • Notifications should disappear as soon as the user is done with them. We can't know the exact moment, so we use a set of heuristics.
    • [DONE] Completed downloads are removed from the list when the last browser window is closed.
      • Active downloads are never removed from the list automatically, though they can be hidden by most recent downloads.
      • Completed downloads are not restored if the previous session is restored. They can still be accessed from the Downloads view in the Library window.
    • [DONE] Canceling a running download does not make the notification disappear.
    • [DONE] Manually removing a download from the list is possible, but not a top-level interaction.
  • There are no actions that make sense on more than one notification at a time.
  • [DONE] The height of each notification does not change when its state changes.

The layout of a notification includes a main area with the download's distinctive details, and an optional action button. In some states of the download, the main area can be clicked. Double-clicking the main area, instead, is not a supported interaction.

A context menu for the item can always be displayed. It may contain commands already available through a top-level interaction for consistency.

  • [DONE] When the main area can be clicked, a link-style mouse cursor is displayed on hover.
  • When the download is ongoing [not paused or finished or canceled]:
    • [DONE] The button cancels the download.
    • [DONE] The context menu has commands to pause, open containing folder, go to download page, copy download link.
  • When the download is paused:
    • [DONE] The button cancels the download.
    • [DONE] The context menu has commands to resume, open containing folder, go to download page, copy download link.
  • When the download is failed or canceled:
    • [DONE] The button retries the download. Often, the download will resume from where it stopped, if supported by the server.
    • [DONE] The context menu has commands to remove from list, go to download page, copy download link.
  • When the download has finished:
    • [DONE] Clicking the main area opens the file.
      • [ON TRACK] If the target file is missing, the main area should not be clickable. The existence detection should happen in the background.
    • [DONE] The button opens the containing folder.
    • [DONE] The context menu has commands to remove from list, go to download page, copy download link.

There are additional items in the context menu that act on all downloads:

    • [DONE] A context menu item is available for removing completed downloads from the list, without closing the last browser window.

Library window

The Library window allows the user to see the full list of downloads. The user can control ongoing downloads, as well as finding and opening previous downloads.

The interaction with ongoing downloads is different from the standalone Downloads window. The interaction will be more similar to the Downloads Panel.

  • [DONE] When the user selects the Downloads folder, the list of history pages is replaced with a different view for handling current downloads.
  • The Downloads view shows both ongoing downloads and download history.
    • [INPUT] Items are sorted based on the current criteria, selected by the user.
    • [DONE] Items can be found at least by source location or original target file name.
    • [DONE] Most ongoing downloads should also be present in the browsing history, in which case they are shown in the same position as the history item.
      • If there is no specific matching history item, ongoing downloads might be shown in no particular order.
    • [DONE] History items with no matching current download behave in the same way as completed downloads.
  • [DONE] Download items have an interaction similar to the Downloads Panel items.
    • [DONE] The items contain the same elements as the panel items, based on the current download state.
    • The interaction will also be different from history items in other Library views.

|Feature implementation plan=` |Feature security review=` |Feature privacy review=` |Feature localization review=` |Feature accessibility review=` |Feature qa review=` |Feature operations review=` |Feature implementation notes===== Bugs list and patch queue ====

Feature tracking bug:

Relevant patches that are available in nightly builds:

The feature is now available in standard release trains. Key implementation bugs are:

Additional patches needed to test the feature:

  • None. The feature is now available in standard release trains.

Work required to release and enable the feature for everyone:

Follow-ups

This section lists non-blocking, suggested follow-ups that need more work before filing a proper bug. Often a search for existing bugs is required before filing a separate bug.

Description References
Cu.import failures don't show up in the Error Console, or the test logs. Bug 564934, comment 224
No feedback when the "open download page" link is clicked and the target page is not available. Bug 564934, comment 191
Allow asynchronous termination functions in the testing framework. Bug 564934, comment 259
Scroll to @@ +47,5 @@
Move original nsDownloadManagerUI.js to mozapps/downloads. Bug 564934, comment 192
NetUtil.newURI should QueryInterface to nsIFileURL automatically. Bug 564934, comment 286
Move fileExecutableSecurityWarning to a common place in Toolkit.

|Feature landing criteria=` }}

Feature details

Priority P2
Rank 4
Theme / Goal Experience
Roadmap Firefox Desktop
Secondary roadmap `
Feature list Desktop
Project `
Engineering team Desktop front-end

{{#set:Feature priority=P2

|Feature rank=4 |Feature theme=Experience |Feature roadmap=Firefox Desktop |Feature secondary roadmap=` |Feature list=Desktop |Feature project=` |Feature engineering team=Desktop front-end }}

Team status notes

  status notes
Products ` `
Engineering ` `
Security sec-review-complete Notes
Privacy ` `
Localization ` `
Accessibility ` `
Quality assurance ` Test Plan
User experience ` `
Product marketing ` `
Operations ` `

{{#set:Feature products status=`

|Feature products notes=` |Feature engineering status=` |Feature engineering notes=` |Feature security status=sec-review-complete |Feature security health=OK |Feature security notes=Notes |Feature privacy status=` |Feature privacy notes=` |Feature localization status=` |Feature localization notes=` |Feature accessibility status=` |Feature accessibility notes=` |Feature qa status=` |Feature qa notes=Test Plan |Feature ux status=` |Feature ux notes=` |Feature product marketing status=` |Feature product marketing notes=` |Feature operations status=` |Feature operations notes=` }}


Retrieved from "https://wiki.mozilla.org/index.php?title=User:P.A./Panel-based_Download_Manager&oldid=643315"