Jump to: navigation, search

Difference between revisions of "UI Checklist"

m
(Image:UI-Checklist-Wizards.png Wizards & Dialogs)
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''NOTE: draft only, chnages in progress'''
+
This is is a shortlist of the most relevant and easy to apply Eclipse '''[[User Interface Guidelines]]'''.  Start by using this list, referring to the linked guideline items for details, then use the [[User_Interface_Guidelines#Checklist_For_Developers| Full Checklist]] for additional guidance.  For comments please use {{bug|205326}}.
  
This is is a shortlist of the most relevant and easy to apply Eclipse [[User Interface Guidelines]]. Start by using this list, referring to the linked guideline items for details, then use the [[User_Interface_Guidelines#Checklist_For_Developers| Full checklist]] for additional guidance.
+
==== [[Image:UI-Checklist-Views.png]] Views & Editors ====
  
'''Views & Editors'''
+
# Put only the most commonly used commands on the view toolbar. Any command on a toolbar must also appear in a menu, either the window menu, context menu or the view menu. ([[User_Interface_Guidelines#Toolbars_2|Guideline 7.12]])
 +
# Use the view pulldown menu for commands not tied to selection ([[User_Interface_Guidelines#Menus_2|Guideline 7.10]]). Fill the context menu with selection oriented actions. ([[User_Interface_Guidelines#Context_Menus_2|Guideline 7.13]])
 +
# If a view or editor has support for Cut, Copy, Paste, or any of the global commands, these commands must be executable from the same commands in the window menu bar and toolbar. ([[User_Interface_Guidelines#Menus|Guideline 6.9]], [[User_Interface_Guidelines#Integration_with_the_Window_Menu_Bar_and_Toolbar|Guideline 7.19]])
 +
# Modifications of workspace resources made in an editor should follow an open-save-close lifecycle model ([[User_Interface_Guidelines#Editors|Guideline 6.2]]), whereas modifications made within a view should be saved immediately ([[User_Interface_Guidelines#Views|Guideline 7.2]]).
 +
# Persist the state of each view between sessions ([[User_Interface_Guidelines#Persistence|Guideline 7.20]]).
  
* Persist the state of each view between sessions (Guideline 7.20).
+
==== [[Image:UI-Checklist-Wizards.png]] Wizards & Dialogs ====
  
* Put only the most commonly used commands on the view toolbar. Any command on a toolbar must also appear in a menu, either the context menu or the view menu. (Guideline 7.12)
+
# Start a wizard with a prompt, not an error message. ([[User_Interface_Guidelines#Initialization_2|Guideline 5.3]])
 +
# Seed the fields within a wizard using the current workbench state. ([[User_Interface_Guidelines#Initialization_2|Guideline 5.4]])
 +
# When a dialog opens, set the initial focus to the first input control in the container. If there are no input controls, the initial focus should be assigned to the default button ([[User_Interface_Guidelines#Initialization|Guideline 4.1]])
 +
# Use a Browse Button whenever an existing object is referenced in a wizard. ([[User_Interface_Guidelines#Browse_Buttons|Guideline 5.8]])
  
* Use the view pulldown menu for presentation commands, not selection-oriented commands (Guideline 7.10).  Fill the context menu with selection oriented actions, not presentation actions.  (Guideline 7.13)
+
==== [[Image:UI-Checklist-Workbench.png]] Workbench & Preferences ====
  
* Modifications made in an editor must follow an open-save-close lifecycle model (Guideline 6.2), whereas modifications made within a view must be saved immediately (Guideline 7.2).
+
# Use Headline style capitalization for menus, tooltip and all titles, including those used for windows, dialogs, tabs, column headings and push buttons ([[User_Interface_Guidelines#Capitalization|Guideline 1.5]]). Use Sentence style capitalization for all control labels in a dialog or window, including those for check boxes, radio buttons, group labels, and simple text fields ([[User_Interface_Guidelines#Capitalization|Guideline 1.6]]).
 
+
# Follow the visual style established for Eclipse UI graphics ([[User_Interface_Guidelines#Style_.26_Design|Guideline 2.1]]). Re-use the color palette ([[User_Interface_Guidelines#Style_.26_Design|Guideline 2.2]]) and visual concepts to maintain consistent representation and meaning across Eclipse plug-ins ([[User_Interface_Guidelines#Consistency_.26_Reuse|Guideline 2.3]])
* If an editor has support for Cut, Copy, Paste, or any of the global commands, these commands must be executable from the same commands in the window menu bar and toolbar. (Guideline 6.9)
+
# If you must create a new preference group, use the root page for frequently used preferences, or those preferences which have wide spread effect. Specialize within the sub pages. The root preference page should not be blank. ([[User_Interface_Guidelines#Preference_Page_Design|Guideline 15.4]])
 
+
'''Wizards and Dialogs'''
+
 
+
* Start a wizard with a prompt, not an error message. (Guideline 5.3)
+
 
+
* Seed the fields within a wizard using the current workbench state. (Guideline 5.4)
+
 
+
* Use a Browse Button whenever an existing object is referenced in a wizard. (Guideline 5.8)
+
 
+
* When a dialog opens, set the initial focus to the first input control in the container. If there are no input controls, the initial focus should be assigned to the default button (Guideline 4.1)
+
 
+
'''Workbench & Preferences'''
+
 
+
* Always use the global status bar to display status related messages. (Guideline 9.9)
+
 
+
* If you create a preference group, use the root page for frequently used preferences, or those preferences which have wide spread effect. Specialize within the sub pages. The root preference page should not be blank. (Guideline 15.4)
+
 
+
* Use Headline style capitalization for menus, tooltip and all titles, including those used for windows, dialogs, tabs, column headings and push buttons (Guideline 1.5).  Use Sentence style capitalization for all control labels in a dialog or window, including those for check boxes, radio buttons, group labels, and simple text fields (Guideline 1.6).
+
  
 
[[Category:UI_Guidelines]]
 
[[Category:UI_Guidelines]]

Latest revision as of 11:44, 14 February 2008

This is is a shortlist of the most relevant and easy to apply Eclipse User Interface Guidelines. Start by using this list, referring to the linked guideline items for details, then use the Full Checklist for additional guidance. For comments please use bug 205326.

UI-Checklist-Views.png Views & Editors

  1. Put only the most commonly used commands on the view toolbar. Any command on a toolbar must also appear in a menu, either the window menu, context menu or the view menu. (Guideline 7.12)
  2. Use the view pulldown menu for commands not tied to selection (Guideline 7.10). Fill the context menu with selection oriented actions. (Guideline 7.13)
  3. If a view or editor has support for Cut, Copy, Paste, or any of the global commands, these commands must be executable from the same commands in the window menu bar and toolbar. (Guideline 6.9, Guideline 7.19)
  4. Modifications of workspace resources made in an editor should follow an open-save-close lifecycle model (Guideline 6.2), whereas modifications made within a view should be saved immediately (Guideline 7.2).
  5. Persist the state of each view between sessions (Guideline 7.20).

UI-Checklist-Wizards.png Wizards & Dialogs

  1. Start a wizard with a prompt, not an error message. (Guideline 5.3)
  2. Seed the fields within a wizard using the current workbench state. (Guideline 5.4)
  3. When a dialog opens, set the initial focus to the first input control in the container. If there are no input controls, the initial focus should be assigned to the default button (Guideline 4.1)
  4. Use a Browse Button whenever an existing object is referenced in a wizard. (Guideline 5.8)

UI-Checklist-Workbench.png Workbench & Preferences

  1. Use Headline style capitalization for menus, tooltip and all titles, including those used for windows, dialogs, tabs, column headings and push buttons (Guideline 1.5). Use Sentence style capitalization for all control labels in a dialog or window, including those for check boxes, radio buttons, group labels, and simple text fields (Guideline 1.6).
  2. Follow the visual style established for Eclipse UI graphics (Guideline 2.1). Re-use the color palette (Guideline 2.2) and visual concepts to maintain consistent representation and meaning across Eclipse plug-ins (Guideline 2.3).
  3. If you must create a new preference group, use the root page for frequently used preferences, or those preferences which have wide spread effect. Specialize within the sub pages. The root preference page should not be blank. (Guideline 15.4)