Salome HOME
Merge branch 'V8_4_BR'
[modules/gui.git] / doc / salome / gui / input / study_management_chapter.doc
index f855d4397ba5e9ea2cf2a7a9604f2e7f9073e324..68b3774ab5c3f05ba06b71e1ad5b4d9a3c150d5d 100644 (file)
@@ -2,42 +2,43 @@
 
 \page study_management_page Study management
 
-Study is a document within GUI, where you can carry out all
+Study is a document within the application, where you can carry out all
 operations provided by the SALOME functionality. 
 This is a certain abstraction layer between actual
 document data (probably, remote data available through CORBA) and data
 presentation (in the Object Browser). The study is composed of Data
-Object instances, united in a tree-like structure.
+Object instances, combined into a tree-like structure.
 
-All operations with studies are available from the \b File menu.
+All operations with study are available from the \b File menu.
 
-\image html studymanagement.png
+\note SALOME is a single-study application. It means that only one study
+can be opened at the moment.
 
-\b New - creates a new study. The study will be created
-with default name \b Study1. It is possible to create
-several studies, each accessible from the task bar.
-\b Open - allows to open an existing study by browsing for it in a
-standard Search File dialog box, choosing the required
-*.hdf file and clicking \b Open button.
-\b Connect - allows to open an unloaded study.
-\image html loadstudy2.png
-Select one of the studies, which has been previously
-created and unloaded and click \b Ok button.
+Immediately after the application is launched there is (normally) no active study.
+However, you have access to the embedded Python console, that can be used to initialize
+a study by means of Python API (see documentation on SALOME KERNEL module for more details).
 
-\note SALOME is a multi-study platform. It means that simultaneously you can
-work with several studies. 
+The following operations are available from the \b File menu:
 
-\b Close - closes the current study, alternatively it is
-possible to click on the cross in the upper right corner of the study window.
+\image html menu_file.png
 
-\note If the study has not been previously saved, this option will
-call the following dialog box with several options:
+As soon as a study is created or loaded from a file or a data server,
+additional operations become available from the \b File menu:
 
-\image html closestudy.png
+\image html studymanagement.png
 
-Here, \b Unload option unloads the current study from the SALOME
-Desktop. It can be reloaded in the same working session, but if you quit the SALOME application, all changes
-in the unloaded study will be lost.
+\b New - creates a new study. The study will be created
+with default name \b Study1. If there is an already opened study,
+you will be asked to close it before creating new one.
+
+\b Open - allows to open an existing study by browsing for it in a
+standard Open File dialog box, choosing the required
+*.hdf file and clicking \a Open button.
+If there is already opened study, you will be asked to close it
+before opening new one.
+
+\b Reopen - reloads the current study from the associated *.hdf file.
+This menu command can be used to reverse the study to the latest saved state.
 
 \b Save - saves the current study. Saving a study you also save its layout, i.e. all positions and sizes
 of dockable windows. It means that the difference in settings of the
@@ -48,11 +49,34 @@ indicate which common windows are necessary for working, and only they
 will be displayed when this module is active.
 
 \note If the study hasn't been previously saved, \b Save will
-call the standard Search File dialog box where you can enter the name
+call the standard Save File dialog box where you can enter the name
 for your study and save it.
 
-\b Save \b as - allows to save the current study with a new name. Input  a new name for the study in the standard
-Search File dialog box and click \b Save button.
+\b Save \b as - allows to save the current study with a new name.
+Input a new name for the study in the standard
+Search File dialog box and click \a Save button.
+
+\b Close - closes the current study; alternatively closing of the study
+can be done by clicking on the cross in the upper right corner of the desktop window.
+
+\note If the study has not been previously saved, you will be prompted
+by the following dialog box with several options:
+
+\image html closestudy.png
+
+\b Connect - allows to open an unloaded or created outside GUI study.
+
+\note Connect is available only if there is an opened study on the data server.
+
+\b Disconnect - unloads the current study from the desktop. The study stays opened
+in the data server; it can be then reloaded in the same working session
+(using \b Connect operation), but if you quit SALOME application, all changes in the
+unloaded study can be lost.
+
+\note If the study has not been previously saved, you will be prompted
+by the following dialog box with several options:
+
+\image html disconnect_study.png
 
 <b>Dump study</b> - allows to Dump a SALOME Study in one or several
 Python scripts. The following dialog box allows to browse for the location and
@@ -71,34 +95,40 @@ is played, otherwise the objects will not be published in the Study.
 saved in the Python file.
 </li>
 </ul>
-To confirm your choice click \b Save.
-
-<b>Notebook</b> - allows to manage study variables using \subpage using_notebook "NoteBook".
+To confirm your choice click \a Save.
 
 <b>Load Script</b> - allows to load a saved Python Script.
 
 \image html loadscript.png
 
-To confirm your choice click \b Open.
+To confirm your choice click \a Open.
 
-<b>Properties</b> - allows to edit the properties of the current study.
+<b>Properties</b> - allows to show/edit the properties of the current study.
 
 \image html studyproperties.png
 
 <ul>
-<li>\b Author - allows to change the name of the study author</li>
-<li>\b Created - gives the date and time of Study creation</li>
-<li>\b Locked - allows to lock the  study for modifications. 
-Just click on this field and choose \b Yes item. In this case your study will be locked for any modifications
+<li>\b Author - allows to change the name of the study author.</li>
+<li><b> Creation date</b> - gives the date and time of Study creation.</li>
+<li>\b Locked - allows to lock the study for modifications. 
+In case if \b Locked checkbox is checked your study will be locked for any modifications
 for all users. Next time you try to edit it, you will see the
 following warning message:
 \image html lockedstudy.png </li>
-<li>\b Modified - allows to see if any modifications have been
+<li><b>Modified/Not Modified</b> - allows to see if any modifications have been
 introduced into study since its last save. </li>
+<li><b>Length units</b> - allows to change the units of the study.</li>
+<li>\b Comment - allows to add arbitrary comment for the study.</li>
 <li>\b Modifications - allows to  view the list of changes made in the study.
-In this dialog box click on the \b Modifications field and scroll it
-down. Each record contains the date and time of the
+Each record contains the date and time of the
 modification and the name of the user, who has introduced it.</li>
+<li><b> Stored data </b> - Shows the versions of data currently stored
+in the study. Note, that this information does not concern the current
+versions of SALOME modules, it shows the version in which the data has been
+initially created. If the study is re-saved in the version of SALOME,
+different from the initial one, the version information is
+highlighted by the red-colored font, which means that the version information
+is not actually valid.</li>
 </ul>
 
 \b Preferences - allows \ref setting_preferences_page "setting preferences"
@@ -110,4 +140,4 @@ studies, giving the possibility to fast load the required study.
 \b Exit - unlike \b Close, closes not only the current, but all opened
 Salome studies.
 
-*/
\ No newline at end of file
+*/