neos team mailing list archive

[Davide Casciato <casciade@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx>]

Blueprint changed by Davide Casciato:

Whiteboard changed:
- UI prototypes for this blueprint:
- http://bazaar.launchpad.net/~neos/%2Bjunk/revager-dev-
- files/files/head%3A/blueprints-files/spec-redesign-first-screen/
- 
- 
  1. REQUIREMENTS & SPECIFICATION
- Topic of this blueprint is the redesign of the AssistantDialog which opens up after starting the application. This feature has been discussed in the (FR) Bug #493797. 
- 
+ Topic of this blueprint is the redesign of the AssistantDialog which opens up after starting the application. Reasons for the redesigning are:
+ - One important function (aspects-manager) is not available in the first screen.
+ - There are currently too many redundant information and functions in the assistant (aspects-manager in each mode).
+ - Some features are not necessary (open existing review in the instant review mode).
+ - Currently, you have to click too many times to achieve certain goals (open an existing review via file chooser).
+ 
+ Summary of reasons: The redesigning of the startup screen is necessary
+ to improve the usability of the assistant.
+ 
+ Resulting requirements:
+ -improving the first screen within it's functions and design.
+ -summarizing redundant views (information and functions).
+ -removing superfluous features.
+ -redesigning for faster usage.
  ----
  
  
  2. USE CASES
  
  
  2.1. SCHEDULE NEW REVIEW
  
  [ACTORS]
  Moderator
  
  [PRECONDITION]
  -The application is running
  -The assistant dialog is shown
  
  [NORMAL FLOW OF EVENTS]
  (1) While the actors cursor hovers over the 'Schedule new review'-button the description text for this function is shown in the header of the assistant dialog
  (2) The actor clicks on 'Schedule new review'
  (3) A new review is created
  (4) The mainframe in the so called moderator mode is shown
  
  [POSTCONDITION]
  A new review in the moderator mode has been arranged.
  
  [ALTERNATIVE FLOWS OF EVENTS]
  none
  
  --
  
  
  2.2. SCHEDULE NEW REVIEW ON QUICKSTART
  
  [ACTORS]
  Moderator and/or scribe
  
  [PRECONDITION]
  -The application is running
  -The assistant dialog is shown
  
  [NORMAL FLOW OF EVENTS]
  (1) While the actors cursor hovers over the 'Quickstart'-button the description text for this function is shown in the header of the assistant dialog.
  (2) The actor clicks on 'Quickstart'
  (3) The actor enters his personal information and confirms his input.
  (4) A new review is created
  (5) The mainframe in the so called instant review mode is shown
  
  [POSTCONDITION]
  A new review in the instant review mode has been arranged.
  
  [ALTERNATIVE FLOWS OF EVENTS]
  (3a) The actor selects himself out of the address book and confirms
  
  --
  
  
  2.3. OPEN EXISTING REVIEW
  
  [ACTORS]
  Scribe
  
  [PRECONDITION]
  -The application is running
  -The assistant dialog is shown
  
  [NORMAL FLOW OF EVENTS]
  (1) While the actors cursor hovers over the 'Open existing review'-button the description text for this function is shown in the header of the assistant dialog.
  (2) The actor clicks on 'Open existing review'
  (3) The assistant dialog will change it's contents (See:prototype6b1_openReview)
  (4) The actor selects his role in this review out of the combobox
  (5) The components below the mode selection are enabled
  (6) The actor selects one file via file chooser and confirms his selection by clicking on the 'open'-button
  (7)The selected review opens up in the mainframe
  
  [POSTCONDITION]
  The selected review in the mainframe has been opened up.
  
  [ALTERNATIVE FLOWS OF EVENTS]
  (6.b) The actor clicks on one review of the listed review-file-links.
  
  --
  
  
  2.4. SELECT LANGUAGE
  
  [ACTORS]
  User
  
  [PRECONDITION]
  -The application is running
  -The assistant dialog is shown
  
  [NORMAL FLOW OF EVENTS]
  (1) While the actors cursor hovers over the 'Select language'-button the description text for this function is shown in the header of the assistant dialog.
  (2) The actor clicks on 'Select language'
  (3) A pop-up with the selectable languages opens up
  (4) The user selects one of them and confirm his selection by clicking on the 'confirm'-button.
  (5) Regarding to his choice, the application will be updated after a restart of the application.
  
  [POSTCONDITION]
  The application will start in the selected language after a restart of the program.
  
  [ALTERNATIVE FLOWS OF EVENTS]
  (4.b) The user uses the 'cancel'-button or closes the pop-up.
  
  --
  
  
  2.5. OPEN ASPECTS MANAGER
  
  [ACTORS]
  User
  
  [PRECONDITION]
  -The application is running
  -The assistant dialog is shown
  
  [NORMAL FLOW OF EVENTS]
  (1) While the actors cursor hovers over the 'Open aspects manager'-button the description text for this function is shown in the header of the assistant dialog.
  (2) The actor clicks on 'Open aspects manager'
  (3) The aspects manager opens up in a new window.
  
  [POSTCONDITION]
  The focused and maximized aspects manager is shown. The application stays in it's state. This means that the empty mainframe with the assistant dialog is allready open but not focused.
  
  [ALTERNATIVE FLOWS OF EVENTS]
  none
  
  --
  
  
  2.6. CLOSE ASSISTANT
  
  [ACTORS]
  User
  
  [PRECONDITION]
  -The application is running
  -The assistant dialog is shown
  
  [NORMAL FLOW OF EVENTS]
  (1) The actor clicks the 'finish'-button and the assistant disappears
  (2) The maximized mainframe without contents, which was in the background is now focused. Only the menu is available.
  
  [POSTCONDITION]
  The maximized mainframe without contents, which was in the background is now focused. Only the menu is available.
  
  [ALTERNATIVE FLOWS OF EVENTS]
  none
  
  ----
  
  
  3. DESIGN & TECHNICAL SOLUTION
- Only existing SWING- and revager-components will be used.
+ The whole assistant dialog will be re-implemented. After removing the class 'org.revager.gui.dialogs.AssistantDialog', we are going to create a new package called 'org.revager.gui.dialogs.assistant'. The package will contain the following classes:
+ 
+ AssistantDialog (extends AbstractDialog) - the assistant dialog itself which contains one of the following panels
+ FirstScreenPanel (extends AbstractDialogPanel) - the first screen (see prototype)
+ OpenReviewPanel (extends AbstractDialogPanel) - the open review screen (see prototype)
+ AddAttendeePanel (extends AbstractDialogPanel) - the add attendee screen (see prototype)
+ 
+ The AbstractDialogPanel contains the following property 'private
+ AbstractDialog parent' as well as the following constructor and method
+ 
+ public AbstractDialogPanel(AbstractDialog parent) { super(); this.parent
+ = parent; }
+ 
+ public void setHint(String hintText) { parent.setMessage(hintText) }
+ 
+ and will be located inside the 'org.revager.gui' package. By this
+ strategy we can access the description text area inside the dialog
+ itself.
+ 
+ Inside the AssistantDialog class there is one private property for each
+ "screen class".
  
  ----
  
  
  4. UNIT TESTING
  For this feature there is no unit testing because it is part of the user interface only.
  
  ----
  
  
  5. SYSTEM TEST
  This feature is tested by running each of the Use Cases defined above. The results of the execution(s) of this test will be recorded here.

-- 
(SPEC) Redesign the first screen
https://blueprints.launchpad.net/revager/+spec/spec-redesign-first-screen