Changes between Version 1 and Version 2 of 2015-5-6

Timestamp:

May 7, 2015, 2:24:15 PM (10 years ago)

Author:

Conrad Huang

Comment:

--

2015-5-6

@@ -10 +10 @@
    - '''volatile''': parameters that are never saved across session;
    - '''sticky''': parameters that are saved whenever their values change; and
-   - '''save-on-demand''': parameters that are saved at user request (''e.g.'', when user clicks on a '''Save Defaults''' button).
+   - '''save-on-demand''': parameters that are saved at user request (''e.g.'', when user clicks on a '''Save Settings''' button).
  * There are three possible values for each parameter:
    - '''factory''': the value used if there is no user selected value at all;
@@ -28 +28 @@
 == User Interface ==
  * Neither the '''preferences''' nor the '''settings''' module provides any user interface.  It is up to tools to provide the appropriate UI for their parameters.  For example, the Chimera 2 core may provide a menu bar entry that brings up a dialog for changing core parameters such as background color or lighting parameters.  This dialog is explicitly '''not''' part of either '''preferences''' or '''settings''' even though both may be used to implement core parameters.
- * For tools that only use sticky and/or volatile parameters, there is no need for extra user interface elements since parameter values are either always or never saved.  For tools that have save-on-demand parameters, there should be a '''Save Defaults''' button to allow users to save the values of parameters that they have changed.
- * A '''Save Defaults''' button should save only parameters in the same dialog/panel/window/tab as the button; parameters on other dialogs/panels/windows/tabs should not be saved as a side effect.  A '''Save All Defaults''' menu item may be offered to save all tool parameters.
- * An (unrecommended) alternative is to use a '''Save All Defaults''' button to save all parameters in all dialogs/panels/windows/tabs.
+ * For tools that only use sticky and/or volatile parameters, there is no need for extra user interface elements since parameter values are either always or never saved.  For tools that have save-on-demand parameters, there should be a '''Save Settings''' button to allow users to save the values of parameters that they have changed.
+ * A '''Save Settings''' button should save only parameters in the same dialog/panel/window/tab as the button; parameters on other dialogs/panels/windows/tabs should not be saved as a side effect.  A '''Save All Settings''' menu item may be offered to save all tool parameters.  There should be buttons to change to either user or factory values.
+ * An (unrecommended) alternative is to use a '''Save All Settings''' button to save all parameters in all dialogs/panels/windows/tabs.
  * Ideally, there should be some way for users to tell the difference among the three different types of parameters (volatile, sticky and save-on-demand).  Conrad proposed a simple icon indicator as part of the parameter description (like the small question mark, magnifier glass or link-out icons on an PDB entry page) but TomG and Eric were against.  For the December release, no attempt will be made to distinguish the three parameter types.