doc/salome/gui/input/study_management_chapter.doc

   1 /*!
   2
   3 \page study_management_page Study management
   4
   5 Study is a document within GUI, where you can carry out all
   6 operations provided by the SALOME functionality.
   7 This is a certain abstraction layer between actual
   8 document data (probably, remote data available through CORBA) and data
   9 presentation (in the Object Browser). The study is composed of Data
  10 Object instances, united in a tree-like structure.
  11
  12 All operations with studies are available from the \b File menu.
  13
  14 \image html studymanagement.png
  15
  16 \b New - creates a new study. The study will be created
  17 with default name \b Study1. It is possible to create
  18 several studies, each accessible from the task bar.
  19 \b Open - allows to open an existing study by browsing for it in a
  20 standard Search File dialog box, choosing the required
  21 *.hdf file and clicking \b Open button.
  22 \b Connect - allows to open an unloaded study.
  23 \image html loadstudy2.png
  24 Select one of the studies, which has been previously
  25 created and unloaded and click \b Ok button.
  26
  27 \note SALOME is a multi-study platform. It means that simultaneously you can
  28 work with several studies.
  29
  30 \b Close - closes the current study, alternatively it is
  31 possible to click on the cross in the upper right corner of the study window.
  32
  33 \note If the study has not been previously saved, this option will
  34 call the following dialog box with several options:
  35
  36 \image html closestudy.png
  37
  38 Here, \b Unload option unloads the current study from the SALOME
  39 Desktop. It can be reloaded in the same working session, but if you quit the SALOME application, all changes
  40 in the unloaded study will be lost.
  41
  42 \b Save - saves the current study. Saving a study you also save its layout, i.e. all positions and sizes
  43 of dockable windows. It means that the difference in settings of the
  44 same windows (for example Python console) is possible between
  45 different modules (the same window can have different size and
  46 position when other module is activated). Also each module can
  47 indicate which common windows are necessary for working, and only they
  48 will be displayed when this module is active.
  49
  50 \note If the study hasn't been previously saved, \b Save will
  51 call the standard Search File dialog box where you can enter the name
  52 for your study and save it.
  53
  54 \b Save \b as - allows to save the current study with a new name. Input  a new name for the study in the standard
  55 Search File dialog box and click \b Save button.
  56
  57 <b>Dump study</b> - allows to Dump a SALOME Study in one or several
  58 Python scripts. The following dialog box allows to browse for the location and
  59 define the name for a Python file.
  60
  61 \image html dumpstudy.png
  62
  63 <ul>
  64 <li>
  65 <b>Publish in study</b> - if checked in, the component objects created by
  66 Python commands will be published in the created Study when the script
  67 is played, otherwise the objects will not be published in the Study.
  68 </li>
  69 <li>
  70 <b>Save GUI state</b> - if checked in, the current application layout will be
  71 saved in the Python file.
  72 </li>
  73 </ul>
  74 To confirm your choice click \b Save.
  75
  76 <b>Notebook</b> - allows to manage study variables using \subpage using_notebook "NoteBook".
  77
  78 <b>Load Script</b> - allows to load a saved Python Script.
  79
  80 \image html loadscript.png
  81
  82 To confirm your choice click \b Open.
  83
  84 <b>Properties</b> - allows to edit the properties of the current study.
  85
  86 \image html studyproperties.png
  87
  88 <ul>
  89 <li>\b Author - allows to change the name of the study author</li>
  90 <li>\b Created - gives the date and time of Study creation</li>
  91 <li>\b Locked - allows to lock the  study for modifications.
  92 Just click on this field and choose \b Yes item. In this case your study will be locked for any modifications
  93 for all users. Next time you try to edit it, you will see the
  94 following warning message:
  95 \image html lockedstudy.png </li>
  96 <li>\b Modified - allows to see if any modifications have been
  97 introduced into study since its last save. </li>
  98 <li>\b Modifications - allows to  view the list of changes made in the study.
  99 In this dialog box click on the \b Modifications field and scroll it
 100 down. Each record contains the date and time of the
 101 modification and the name of the user, who has introduced it.</li>
 102 </ul>
 103
 104 \b Preferences - allows \ref setting_preferences_page "setting preferences"
 105  applicable to Salome in general and its modules.
 106
 107 <b>Most recently used</b> - contains a list of recently opened
 108 studies, giving the possibility to fast load the required study.
 109
 110 \b Exit - unlike \b Close, closes not only the current, but all opened
 111 Salome studies.
 112
 113 */