]> SALOME platform Git repositories - modules/geom.git/commitdiff
Salome HOME
"Reduce study" help documentation correction.
authorakl <alexander.kovalev@opencascade.com>
Tue, 24 Jun 2014 12:52:22 +0000 (16:52 +0400)
committerakl <alexander.kovalev@opencascade.com>
Tue, 24 Jun 2014 12:52:22 +0000 (16:52 +0400)
doc/salome/gui/GEOM/input/arranging_study_objects_page.doc
doc/salome/gui/GEOM/input/dependency_tree.doc
doc/salome/gui/GEOM/input/reduce_study.doc
doc/salome/gui/GEOM/input/viewing_geom_obj.doc

index fcf4b26cd4eace9a0875ff9eba2b88471f05d4a2..88aea81d4c7fc3099f16e188460cf7ee0bb9fe59 100644 (file)
@@ -20,6 +20,7 @@ parent object is highlighted with bold font.</li>
 and then displays only the children of the selected object(s).
 </li>
 
+\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. 
@@ -35,8 +36,11 @@ and then displays only the children of the selected object(s).
   to change the order (ascending / descending) by clicking the corresponding title bar of the objects list.
 </li>
 
-<li>\subpage dependency_tree_page "Show dependency tree" - shows dependency tree of selected objects
+<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>
index 12d0387e26d7c8ca5a9c70ee7a6e2dcd936143bb..e44dba4004e11d2995b53040551f5384bbaa9f21 100644 (file)
@@ -2,7 +2,18 @@
 
 \page dependency_tree_page Dependency Tree
 
-\n In order to better understand the relations between the %GEOM 
+<ul>
+<li>\ref dependency_tree_general_description_anchor "General description"</li>
+<li>\ref dependency_tree_nodes_anchor "Nodes" </li>
+<li>\ref dependency_tree_links_anchor "Links" </li>
+<li>\ref dependency_tree_operations_anchor "Operations" </li>
+<li>\ref dependency_tree_navigation_anchor "Navigation" </li>
+<li>\ref dependency_tree_popup_menu_anchor "Context menu"</li>
+</ul>
+
+\anchor dependency_tree_general_description_anchor <h2>General description</h2>
+
+In order to better understand the relations between the %GEOM 
 objects in a study the user has a possibility to display the 
 ascendants and descendant of the object(s) in a family tree.
 
@@ -21,7 +32,7 @@ User can change all necessary parameters of Dependency Tree Viewer
 in \ref pref_dependency_tree "Preferences".
 
 <hr>
-\anchor dependency_tree_nodes <h2>Nodes</h2>
+\anchor dependency_tree_nodes_anchor <h2>Nodes</h2>
 
 Tree nodes in the Dependency Viewer are named according to the study 
 names of the corresponding objects. 
@@ -57,7 +68,7 @@ clicks the left mouse button on node.</li></ul>
 \image html tree_selected_node.png
 
 <hr>
-\anchor dependency_tree_links <h2>Links</h2>
+\anchor dependency_tree_links_anchor <h2>Links</h2>
 
 Dependency Tree Viewer shows oriented links between nodes to 
 represent dependency direction. Viewer supports the following states 
@@ -81,7 +92,7 @@ some nodes.</li></ul>
 \image html tree_cycldep_link.png
 
 <hr>
-\anchor dependency_tree_operations <h2>Operations</h2>
+\anchor dependency_tree_operations_anchor <h2>Operations</h2>
 
 The dependency tree of a chosen %GEOM object is displayed in 
 the dedicated 2D view window.
@@ -149,7 +160,7 @@ of descendants.
 \image html tree_button_update.png
 
 <hr>
-\anchor dependency_tree_navigation <h2>Navigation</h2>
+\anchor dependency_tree_navigation_anchor <h2>Navigation</h2>
 
 Dependency Tree 2D Viewer supports the following navigation mode:
 
@@ -168,7 +179,7 @@ the following view transformations:
 </ul>
 
 <hr>
-\anchor dependency_tree_popup_menu <h2>Popup Menu</h2>
+\anchor dependency_tree_popup_menu_anchor <h2>Popup Menu</h2>
 
 After the object has appeared in the Dependency Tree 2D Viewer, 
 user can select it with left mouse click to change its presentation 
index 8a4f03943d8b88ef07ad4ad6fa6ae3089a14d852..8a3c7e7662ee31a2e7ef0d92a1ab061637edfc8c 100644 (file)
@@ -18,39 +18,41 @@ Browser or OCC Viewer and calling "Reduce study" popup item.
 
 <ul>
 
-<li><b> Objects to be kept</b> - objects will be kept in the study after 
+<li><b> Objects to be kept</b> - objects that will be kept in the study after 
 applying operation of reduce study. The list of objects being selected by 
-the user are highlighted in bold font.
-\n Moreover user can show and hide object(s) in current OCC Viewer using 
-"eye" icons near each item of tree. It's possible to click on "eye" icon 
-in the head of tree in order to show/hide all objects.</li>
+the user are highlighted in bold font.</li>
 
-<li><b> Objects to be removed</b> - objects will be deleted by the 
-function if it is applied.</li>
+<li><b> Objects to be removed</b> - objects that will be deleted.</li>
 
-<li><b> Intermediate objects</b> - allows to choose future action with
-the objects, being in the operations chains to produce final objects:
+\note Mentioned views provide possibility to show/hide object(s) in 
+current Viewer using "eye" icon near each item of tree. Also user can 
+show/hide ALL objects in tree by clicking "eye" icon in the head of tree view.
+
+<li><b> Intermediate objects</b> group box allows to choose an action 
+that will be performed with the objects that took part in the operations 
+chain to produce the selected object(s):
 <ul>
 <li>Keep - object(s) will be kept in the study;</li>
-<li>Unpublish - object(s) will be automatically unpublished (hidden) 
-from the study;</li>
-<li>Remove - object(s) will be removed from the study. Since using of 
-this option can lead to the broken Dump Python, the warning message 
-will be shown to the user.</li>
+<li>Unpublish - object(s) will be unpublished (hidden) from the study;</li>
+<li>Remove - object(s) will be removed from the study. \note Since use of 
+this option can lead to the broken Dump Python script, the warning message 
+will be shown at the operation commiting to confirm/reject removing 
+intermediate objects.</li>
 </ul>
 </li>
 
-<li><b> Sub-objects</b> - allows to choose the same operations for 
+<li><b> Sub-objects</b> group box allows to choose the same operations for 
 sub-objects of selected item(s): keep, unpublish or remove.</li>
 
-<li><b> Remove empty folders</b> - if this option is checked, all folders, 
-which will become empty after removal of the unused objects from the 
-study, will be also removed; otherwise, empty folders will be kept.</li>
+<li><b> Remove empty folders</b> - if this option is checked, then all folders, 
+which will become empty after removing unused objects from the study, 
+will be also removed; otherwise, empty folders will be kept.</li>
 
 <li><b> Soft removal</b> - if this option is checked, operation will just 
-unpublish the redundant objects from the study instead of their hard removal.  
-\n Soft removal would keep all the data in the study to give the user 
-chance to rollback this operation using "Publish Objects" dialog box.</li>
+unpublish the redundant objects from the study instead of their hard delete.
+\n Soft removal would keep all the data in the study to give the user a 
+chance to revert this operation using \ref publish_hidden_objects 
+"Publish Objects" dialog box.</li>
 
 </ul>
 */
index d5bd74feaa0672a671ed9e45f946877a06e68d9c..29a43cfbf1ca54b70a8d297d8b55ca2b065b4af1 100644 (file)
@@ -66,7 +66,8 @@ geometrical object. TUI Command: <em>sg.DisplayOnly(ID)</em></li>
 <li><b>Hide all dimensions</b> - hides all of the persistent dimensions created for the selected geometrical object.</li>
 <li>\subpage dependency_tree_page "Show dependency tree" - shows dependency tree of selected objects
 in new 2D View Window.</li>
-<li>\subpage reduce_study_page "Reduce study" - allows to reduce study.</li>
+<li>\subpage reduce_study_page "Reduce study" - allows to reduce study
+by automatic removing objects according to user's options.</li>
 <li><b>Dump view</b> - exports an object from the viewer in bmp, png,
 jpg or jpeg image format.</li>
 <li><b>Change background</b> - allows to redefine the background