Software Update:User Interface

From MozillaWiki
Jump to: navigation, search

SOFTWARE UPDATE USER INTERFACE

10/17/2006: Note, the UI for a major update has changed. See bug #329729 for some screen shots and details.

Components: C1 Menu Item

   C1.1 Normally:
   
     +-------+
     | Help  |
     |       +------------------+
     |   Help Contents       F1 |
     |   For IE Users           |
     |   Release Notes          |
     |--------------------------|
     |   Check for Updates...   | <-- Shows C2.1
     |   About Mozilla Firefox  |
     +--------------------------+
     
   C1.2 Update in Progress (O1):
   
     +-------+
     | Help  |
     |       +------------------+
     |   Help Contents       F1 |
     |   For IE Users           |
     |   Release Notes          |
     |--------------------------|
     | * Downloading Updates... | <-- Shows C2.3
     |   About Mozilla Firefox  |
     +--------------------------+
     
      * = rotating arrows icon
     Detail above shows placement for Windows/Linux.
     The item is placed based on its frequency of use, proximity to other
     UI that vends version information (the About box), and similarity with
     other Windows applications.
     
     MacOS X: place menu item in the "Firefox" menu, below "About Firefox"

C2 Software Update Manager/Wizard

   C2.1:
   
     +---------------------------------------------------+
     |                                                   |
     |  Firefox is searching for available updates...    |
     |                                                   |
     |  [ |||||||||||||||||||||                       ]  |
     |                                                   |
     |                                                   |
     |                                                   |
     |                                                   |
     |                                                   |
     |                                                   |
     |                                                   |
     |                                                   |
     |                                                   |
     |                                        ( Cancel ) |
     +---------------------------------------------------+
     
     When the UI is shown, O1 is performed and then C2.2 is displayed
     upon completion.
   C2.2 (R1):
   
     +---------------------------------------------------+
     |                                                   |
     |  An important Security Update for Firefox is      |
     |  available.                                       |
     |                                                   |
     |  +--------------------------------------------+   |
     |  | FIREFOX 1.0.9              SECURITY UPDATE |   |
     |  | For more information _Click_Here_          |   |
     |  +--------------------------------------------+   |
     |                                                   |
     |   /!\ This update will cause some of your         |
     |       extensions to stop working until they are   |
     |       updated.                     ( Show List )  |
     |                                                   |
     | ( Later )               ( Download & Install >> ) |
     +---------------------------------------------------+
   C2.2 (R2):
   
     +---------------------------------------------------+
     |                                                   |
     |  A new version of Firefox is available            |
     |                                                   |
     |  +--------------------------------------------+   |
     |  | FIREFOX 1.1                    NEW VERSION |   |
     |  | For more information _Click_Here_          |   |
     |  +--------------------------------------------+   |
     |                                                   |
     |   /!\ This update will cause some of your         |
     |       extensions to stop working until they are   |
     |       updated.                     ( Show List )  |
     |                                                   |
     |                                                   |
     | ( Later )               ( Download & Install >> ) |
     +---------------------------------------------------+
     
   C2.3: 
   
     +------------------------------------------+
     | The following extensions have not been   |
     | verified to work with Firefox 1.1.9, so  |
     | they will be disabled when you install   |
     | the update:                              |
     | +--------------------------------------+ |
     | | ExtensionA 1.0                       | |
     | | ExtensionB 2.27                      | |
     | |                                      | |
     | |                                      | |
     | |                                      | |
     | |                                      | |
     | |                                      | |
     | +--------------------------------------+ |
     |                                ( Close ) |
     +------------------------------------------+
     
   C2.3: 
   
     +---------------------------------------------------+
     |                                                   |
     |  The following updates are being/have been        |
     |  installed:                                       |
     |                                                   |
     |  +--------------------------------------------+   |
     |  | FIREFOX 1.0.9                    _Details_ |   |
     |  | [ |||||||||||                            ] |   |
     |  | 245 of 595KB at 12K/sec, 30 secs remain    |   |
     |  | ( Pause )                                  |   |
     |  |--------------------------------------------|   |
     |  | FIREFOX 1.1.8                    _Details_ |   |
     |  | Successfully installed on 8/24/2005        |   |
     |  +--------------------------------------------+   |
     |  [x] Show old updates in this list      ( Close ) |
     +---------------------------------------------------+
   
     This window is called the Software Update Manager.
     
     When this window is opened, the priority of active update downloads is
     increased to that of a foreground download progress, since it is assumed
     the user is interested. 
     
     The _Details_ link links to a page on mozilla.org that describes briefly
     the changes offered by the release. This page will link to the Release
     Notes but not contain everything in the release notes.
     
     Open issue: set the download priority back to "background dl" when the
                 window is closed
     
     When Firefox is shut down, the download is "paused" - it is stopped
     and the current position is saved so that it can be resumed the next time
     the application is started.
     
     "Pause" is not "Pause" in the traditional sense - it does not pause the
     channel, it stops it and resumes. There is no need for Pause/Resume vs.
     Cancel, we do not want people to cancel. If they stop the download, 
     we will remind them on a timeout (30 mins? 1hr? configurable?) using C2.2
     that they need to continue their download.
   C2.4:
   
     +---------------------------------------------------+
     |                                                   |
     |  The following update is ready to install:        |
     |                                                   |
     |  +--------------------------------------------+   |
     |  | FIREFOX 1.1                    NEW VERSION |   |
     |  | For more information _Click_Here_          |   |
     |  +--------------------------------------------+   |
     |                                                   |
     |   /!\ This update will cause some of your         |
     |       extensions to stop working until they are   |
     |       updated.                     ( Show List )  |
     |                                                   |
     |                                                   |
     | ( Later )                      ( Install Now >> ) |
     +---------------------------------------------------+
     

C3 Update Icon

     To the left of the throbber, invisible unless active.
     
     In active state, shows an "updating" animation that when clicked shows
     C2.3
     

Release Types: R1 security update R2 major release

Events: E1 user invokes check and download process

   C2.1 displayed

E2 timer invokes check and download process

   C2.2 displayed
   C3 displayed

Operations: O1 Update Check

   - checks for newer versions of the application according to
       a "scheme of determining newer version available"
   - checks for and applies version updates to extensions, to improve the
     likelihood that an update will not break extensions
   - while O1 is in process C1.2 is displayed

O1.1 R1, no incompatibilities found:

 - P2 set, silent download and install (E2)
 - P4 set, silent download and show C2.4

O1.2 R1, incompatibilities found:

 - display C2.2(R1)

O1.3 R2, no incompatibilities found:

 - P2/4 set, show C2.2(R2)
 - P3 set, silent download and install (E2)

O1.4, R2, incompatibilities found:

 - display C2.2 (R2)
   

Preferences: P1 Application P2 (*) download and install P3 [ ] for major releases too P4 ( ) download and notify P5 Extensions

UI:

Check for updates to:

[x] Firefox
      and (*) automatically download and install them
              [x] for major updates too
          ( ) automatically download them and notify me when they
              are ready to be installed
[x] My Extensions

We can have an [Update Details] button under menu: [Help] > [About Mozilla Firefox]. By clicking this button [Update Details] we can present a tabluar view with the following columns:

 1. Updated Item 
 2. Version
 3. Type  { Security update or enhancement update...}
 4. Updated Item release date
 5. Updated date
 6. Updated by user ?