Salome HOME
Merge remote branch 'origin/akl/22379'
[modules/geom.git] / doc / salome / gui / GEOM / input / arranging_study_objects_page.doc
index 44df8f830e1242b3320fc641a4738f6092abe6b0..88aea81d4c7fc3099f16e188460cf7ee0bb9fe59 100644 (file)
@@ -1,27 +1,75 @@
 /*!
+\page arranging_study_objects_page Viewing objects in the Object Browser
 
-\page arranging_study_objects_page Arranging objects in study
+<h2> Context Menu </h2>
 
-The possibility to classify the geometrical objects by moving it into early created container (folder) was introduced to Geometry module.
+Newly created or imported geometrical objects are listed in the Object Browser. 
+The following commands appear in the Object Browser context menu under certain conditions:
 
-\image html arranging1.png "Classified objects in folders"
+\image html ob_popup_menu.png <br>
 
-To create a folder select "Create folder" popup menu item for root "Geometry" object or another folder.
+<ul>
+<li>\ref work_with_groups_page "Create Group" - allows creating groups of geometrical objects.</li>
 
-\image html arranging2.png "Creation of folder"
+<li><b>Conceal child items</b> / <b>Disclose child items</b> - hides / shows child
+sub-objects in the Object Browser, if the selected geometric object has
+child objects. When some child objects are hidden, the name of the
+parent object is highlighted with bold font.</li>
 
-"Drag&Drop" mechanism was integrated to arrange objects.
+<li><b>Show Only Children</b> - erases from the current viewer all objects
+and then displays only the children of the selected object(s).
+</li>
 
-\image html arranging3.png "Moving object into folder"
+\anchor publish_hidden_objects
+<li><b>Unpublish</b> - hides the selected geometric object from the Object Browser 
+  and erases it from all viewers. To publish unpublished geometric objects select in the 
+  context menu of the <b>Geometry</b> root object <b>Publish...</b> item. 
+  The following dialog box will appear
 
-\note Only two categories of objects can be moved into folder:
-<ul> 
-<li> geometrical model(s) under root "Geometry" item or under any folder
-<li> folder(s)
+  \image html publish_dlg.png <br>
+
+  Switch the check-box near the appropriate object and
+  click <b>Publish</b> or <b>Publish And Close</b> button. 
+
+  "Eye" icons in this dialog box allow previewing unpublished objects in the viewer. By default all 
+  unpublished objects are sorted by name in ascending order. It is possible
+  to change the order (ascending / descending) by clicking the corresponding title bar of the objects list.
+</li>
+
+<li>\ref dependency_tree_page "Show dependency tree" - shows dependency tree of selected objects
+in new 2D View Window.</li>
+
+<li>\ref reduce_study_page "Reduce study" - allows to reduce study
+by automatic removing objects according to user's options.</li>
 </ul>
 
+<h2> Folders </h2>
+
+In the Object Browser it is possible to classify geometrical objects into folders.
+
+To create a folder select <b> Create folder</b> item in the context menu of the root \b Geometry Object Browser item or in another folder.
+
+The objects can be added into folders by drag and drop 
+
+\note Only two categories of objects can be moved into folder:
+- geometrical model(s) under root "Geometry" item or under any folder;
+- another folder.
+
+If a geometrical object has more than one child sub-object, it is possible to sort them in ascending order by selecting <b>Sort children</b> context menu item of the parent object.
+
 Our <b>TUI Scripts</b> provide you with useful examples of 
 \ref tui_arranging_study_objects "Arranging objects in study".
 
+<h2>Information Window</h2>
+At the bottom of the Object Browser, there is \b Information
+window providing some information on a selected geometric object:
+
+\image html creation_op_info.png Information window
+
+- <b>Creation operation</b> shows a name of the operation
+used to create the selected object.
+- The table below lists \b Parameters used to create the
+selected object and their \b Values.
+
 */