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
  20 \b Open - allows to open an existing study by browsing for it in a
  21 standard Search File dialog box, choosing the required
  22 *.hdf file and clicking \b Open button.
  23
  24 \b Reopen - reloads the current study from the *.hdf file. This menu command
  25 can be used to reverse the study to the latest saved state.
  26
  27 \b Connect - allows to open an unloaded study.
  28 \image html loadstudy2.png
  29 Select one of the studies, which has been previously
  30 created and unloaded and click \b Ok button.
  31
  32 \note SALOME is a multi-study platform. It means that simultaneously you can
  33 work with several studies.
  34
  35 \b Close - closes the current study, alternatively it is
  36 possible to click on the cross in the upper right corner of the study window.
  37
  38 \note If the study has not been previously saved, this option will
  39 call the following dialog box with several options:
  40
  41 \image html closestudy.png
  42
  43 Here, \b Unload option unloads the current study from the SALOME
  44 Desktop. It can be reloaded in the same working session, but if you quit the SALOME application, all changes
  45 in the unloaded study will be lost.
  46
  47 \b Save - saves the current study. Saving a study you also save its layout, i.e. all positions and sizes
  48 of dockable windows. It means that the difference in settings of the
  49 same windows (for example Python console) is possible between
  50 different modules (the same window can have different size and
  51 position when other module is activated). Also each module can
  52 indicate which common windows are necessary for working, and only they
  53 will be displayed when this module is active.
  54
  55 \note If the study hasn't been previously saved, \b Save will
  56 call the standard Search File dialog box where you can enter the name
  57 for your study and save it.
  58
  59 \b Save \b as - allows to save the current study with a new name. Input  a new name for the study in the standard
  60 Search File dialog box and click \b Save button.
  61
  62 <b>Dump study</b> - allows to Dump a SALOME Study in one or several
  63 Python scripts. The following dialog box allows to browse for the location and
  64 define the name for a Python file.
  65
  66 \image html dumpstudy.png
  67
  68 <ul>
  69 <li>
  70 <b>Publish in study</b> - if checked in, the component objects created by
  71 Python commands will be published in the created Study when the script
  72 is played, otherwise the objects will not be published in the Study.
  73 </li>
  74 <li>
  75 <b>Save GUI state</b> - if checked in, the current application layout will be
  76 saved in the Python file.
  77 </li>
  78 </ul>
  79 To confirm your choice click \b Save.
  80
  81 \subpage using_notebook "Notebook" - allows to predefine study variables.
  82
  83 <b>Load Script</b> - allows to load a saved Python Script.
  84
  85 \image html loadscript.png
  86
  87 To confirm your choice click \b Open.
  88
  89 <b>Properties</b> - allows to show/edit the properties of the current study.
  90
  91 \image html studyproperties.png
  92
  93 <ul>
  94 <li>\b Author - allows to change the name of the study author.</li>
  95 <li><b> Creation date</b> - gives the date and time of Study creation.</li>
  96 <li>\b Locked - allows to lock the study for modifications.
  97 In case if \b Locked checkbox is checked your study will be locked for any modifications
  98 for all users. Next time you try to edit it, you will see the
  99 following warning message:
 100 \image html lockedstudy.png </li>
 101 <li><b>Modified/Not Modified</b> - allows to see if any modifications have been
 102 introduced into study since its last save. </li>
 103 <li><b>Length units</b> - allows to change the units of the study.</li>
 104 <li>\b Comment - allows to add arbitrary comment for the study.</li>
 105 <li>\b Modifications - allows to  view the list of changes made in the study.
 106 Each record contains the date and time of the
 107 modification and the name of the user, who has introduced it.</li>
 108 <li><b> Stored data </b> - Shows the versions of data currently stored
 109 in the study. Note, that this information does not concern current
 110 versions of SALOME modules, it shows the version in which the data has been
 111 initially created. If the study is re-saved in the version of SALOME,
 112 different from initial one, the version information is
 113 highlighted by red-colored font; this means that version information
 114 is not actually valid.</li>
 115 </ul>
 116
 117 \b Preferences - allows \ref setting_preferences_page "setting preferences"
 118  applicable to Salome in general and its modules.
 119
 120 <b>Most recently used</b> - contains a list of recently opened
 121 studies, giving the possibility to fast load the required study.
 122
 123 \b Exit - unlike \b Close, closes not only the current, but all opened
 124 Salome studies.
 125
 126 */