Changeset 78f02c3 in sasview for src/sas/guiframe/media/data_explorer_help.rst

Timestamp:

Feb 14, 2015 12:12:40 PM (9 years ago)

Author:

smk78

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

898a8b9

Parents:

3e2ebbb

Message:

Level 1 sphinx-ready commit of remaining help files

File:

• src/sas/guiframe/media/data_explorer_help.rst (modified) (1 diff)

src/sas/guiframe/media/data_explorer_help.rst

@@ -1 +1 @@
 .. _data_explorer_help.rst
+
+.. This is a port of the original SasView html help file to ReSTructured text
+.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015.
 
 Loading Data
 ============
 
-Introduction_ 
-Load data_
-Handy menu_
-Activate data_
-Remove data_
-Append plot to graph_
-Create new plot_
-Freeze theory_
-Send data to applications_
+1. Introduction_ 
+2. Load Data_
+3. Handy Menu_
+4. Activate Data_
+5. Remove Data_
+6. Append Plot to Graph_
+7. Create New Plot_
+8. Freeze Theory_
+9. Send Data to Applications_
 
-.. _Introduction : 
-------------------
-*Data Explorer*  is a panel that allows the user more interactions with data. Some functionalities provided by the Data Explorer are also available through the context menu of plot panels or other menus of the applications.Under menu *View*  of the menubar, Data explorer can be toggled between Show and Hide by clicking the menu *Show/Hide Data Explorer* .
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-*IMPORTANT!*  When Data explorer is hidden, all the data loaded will be sent directly to the current active application, if possible. When data Explorer is shown data go first to the Data Explorer for the user to handle them later.
+.. _Introduction:
 
-.. _Load data : 
----------------
-To Load data, click the button *Load Data* , then select one or more (holding Ctrl key) files to load into the application. In the list, the *Data*  will be displayed as the name of each selected file. Expending this data by clicking the *+*  symbol will display available information about the data such as data title if exists.
+Introduction
+------------
+*Data Explorer* is a panel that allows the user more interactions with data. 
+Some functionalities provided by the Data Explorer are also available through 
+the context menu of plot panels or other menus of the applications.Under menu 
+*View*  of the menubar, Data explorer can be toggled between Show and Hide by 
+clicking the menu *Show/Hide Data Explorer* .
 
-.. _Handy menu : 
-----------------
-For a quick Data-info/Save/Plot/3d-plot(2d only)/Edit-mask(2d only), high-light the data/theory, right-click, and select a proper item from the context menu.
+*IMPORTANT!*  When Data explorer is hidden, all the data loaded will be sent 
+directly to the current active application, if possible. When data Explorer is 
+shown data go first to the Data Explorer for the user to handle them later.
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. _Load Data:
+
+Load Data
+---------
+
+To Load data, click the button *Load Data* , then select one or more (holding 
+Ctrl key) files to load into the application. In the list, the *Data*  will be 
+displayed as the name of each selected file. Expending this data by clicking 
+the *+*  symbol will display available information about the data such as data 
+title if exists.
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. _Handy Menu:
+
+Handy Menu
+----------
+
+For a quick Data-info/Save/Plot/3d-plot(2d only)/Edit-mask(2d only), 
+high-light the data/theory, right-click, and select a proper item from the 
+context menu.
+
 .. _ image:: hand_menu.png
 
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. _Activate data : 
--------------------
-To interact with data, check a data label and click on a button. Checking Data make them active for the button operation. Unchecking Data labels will deactivate them.
+.. _Activate Data:
 
-There is a combo box labeled *Selection Options*  that allows to activate or select multiple data simultaneously.
+Activate Data
+-------------
 
-.. _Remove data : 
------------------
+To interact with data, check a data label and click on a button. Checking Data 
+make them active for the button operation. Unchecking Data labels will 
+deactivate them.
+
+There is a combo box labeled *Selection Options*  that allows to activate or 
+select multiple data simultaneously.
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. _Remove Data:
+
+Remove Data
+-----------
+
 Remove data button remove all reference of this data into the application.
 
 *WARNING!* Remove data will stop any jobs currently using the selected data.
 
-.. _Append plot to graph : 
---------------------------
-Click on the button *Append To*  to append selected Data to a plot panel on focus. Next to this button is a combo box containing available panels names. Selecting a name from this combo box will set the corresponding lot panel on focus. If not plot panel is available, the combo box and button will be disable. 2D Data cannot be appended to any plot panels . This operation can only be performed on 1D data and plot panels currently containing 1D data.
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. _Create new plot : 
----------------------
-Click on *New Plot*  button to create a new plot panel where selected data will be plotted.
+.. _Append Plot to Graph:
 
-.. _Freeze theory : 
+Append Plot to Graph
+--------------------
+
+Click on the button *Append To*  to append selected Data to a plot panel on 
+focus. Next to this button is a combo box containing available panels names. 
+Selecting a name from this combo box will set the corresponding lot panel on 
+focus. If not plot panel is available, the combo box and button will be 
+disable. 2D Data cannot be appended to any plot panels . This operation can 
+only be performed on 1D data and plot panels currently containing 1D data.
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. _Create New Plot:
+
+Create New Plot
+---------------
+
+Click on *New Plot*  button to create a new plot panel where selected data 
+will be plotted.
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. _Freeze Theory:
+
+Freeze Theory
+-------------
+
+*Freeze Theory*  button generate Data from selected theory. This operation can 
+only be performed when theory labels are selected.
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. _Send to application:
+
+Send to Application
 -------------------
-*Freeze Theory*  button generate Data from selected theory. This operation can only be performed when theory labels are selected.
 
-.. _Send to application : 
--------------------------
-Click on the button *Send To*  to send Data to the current active control page. One of the single/batch mode can be selected only for Fitting. The batch mode provides serial (batch) fitting with one model, i.e., fitting one data by another data. Note that only the Fitting allows more that one data to be sent.
-
+Click on the button *Send To*  to send Data to the current active control 
+page. One of the single/batch mode can be selected only for Fitting. The batch 
+mode provides serial (batch) fitting with one model, i.e., fitting one data by 
+another data. Note that only the Fitting allows more that one data to be sent.