X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2Finput%2Fstudy_management_chapter.doc;h=68b3774ab5c3f05ba06b71e1ad5b4d9a3c150d5d;hb=1db44a79861a849bb2bf6f3e0fe4e81c7df8eef3;hp=b06d868738c3845b2076c58dfec941b0ea109203;hpb=5ab4e9f868874916c91b51f12aa8beacf09f4125;p=modules%2Fgui.git diff --git a/doc/salome/gui/input/study_management_chapter.doc b/doc/salome/gui/input/study_management_chapter.doc index b06d86873..68b3774ab 100644 --- a/doc/salome/gui/input/study_management_chapter.doc +++ b/doc/salome/gui/input/study_management_chapter.doc @@ -2,47 +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. +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). -\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. +The following operations are available from the \b File menu: -\b Reopen - reloads the current study from the *.hdf file. This menu command -can be used to reverse the study to the latest saved state. +\image html menu_file.png -\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. +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: -\note SALOME is a multi-study platform. It means that simultaneously you can -work with several studies. - -\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 studymanagement.png -\note If the study has not been previously saved, this option will -call the following dialog box with several options: +\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. -\image html closestudy.png +\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. -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 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 @@ -53,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 Dump study - allows to Dump a SALOME Study in one or several Python scripts. The following dialog box allows to browse for the location and @@ -76,15 +95,13 @@ is played, otherwise the objects will not be published in the Study. saved in the Python file. -To confirm your choice click \b Save. - -\subpage using_notebook "Notebook" - allows to predefine study variables. +To confirm your choice click \a Save. Load Script - 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. Properties - allows to show/edit the properties of the current study. @@ -106,11 +123,11 @@ introduced into study since its last save. Each record contains the date and time of the modification and the name of the user, who has introduced it.