From: vsr <vsr@opencascade.com>
Date: Mon, 14 May 2012 06:15:41 +0000 (+0000)
Subject: Update user documentation
X-Git-Tag: V6_5_0~1
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=181cf995341977380c7ce63383f12e78791440a6;p=modules%2Fsmesh.git

Update user documentation
---

diff --git a/doc/salome/gui/SMESH/input/about_quality_controls.doc b/doc/salome/gui/SMESH/input/about_quality_controls.doc
index 7854d5e49..1e170e440 100644
--- a/doc/salome/gui/SMESH/input/about_quality_controls.doc
+++ b/doc/salome/gui/SMESH/input/about_quality_controls.doc
@@ -45,7 +45,7 @@ Face quality controls:
 <li>\subpage warping_page "Warping"</li>
 <li>\subpage skew_page "Skew"</li>
 <li>\subpage max_element_length_2d_page "Element Diameter 2D"</li>
-<li>\subpage double_elements_page "Double faces"</li>
+<li>\ref double_elements_page "Double faces"</li>
 </ul>
 
 Volume quality controls:
@@ -55,7 +55,7 @@ Volume quality controls:
 <li>\subpage max_element_length_3d_page "Element Diameter 3D"</li>
 <li>\subpage bare_border_volumes_page "Bare border volumes"</li>
 <li>\subpage over_constrained_volumes_page "Over-constrained volumes"</li>
-<li>\subpage double_elements_page "Double volumes"</li>
+<li>\ref double_elements_page "Double volumes"</li>
 </ul>
 
 To manage the quality controls call pop-up in the VTK viewer and select "Controls" sub-menu
diff --git a/doc/salome/gui/SMESH/input/cartesian_algo.doc b/doc/salome/gui/SMESH/input/cartesian_algo.doc
index 89b11e947..3240150c7 100644
--- a/doc/salome/gui/SMESH/input/cartesian_algo.doc
+++ b/doc/salome/gui/SMESH/input/cartesian_algo.doc
@@ -3,7 +3,7 @@
 \page cartesian_algo_page Body Fitting 3D meshing algorithm
 
 Body Fitting algorithm generates hexahedrons of a Cartesian grid in
-the internal part of geometry and polyhedra and other types of
+the internal part of geometry and polyhedrons and other types of
 elements at the intersection of Cartesian cells with the geometrical
 boundary.
 
@@ -21,7 +21,7 @@ of the geometry boundary. Depending on a result of this check
 <ul>
 <li> skip a cell, if all its nodes are outside </li>
 <li> skip a cell, if it is too small according to <b> Size
-    Threshold </b> paremeter</li>
+    Threshold </b> parameter</li>
 <li> add a hexahedron in the mesh, if all nodes are inside </li>
 <li> add a polyhedron or another cell type in the mesh, if some
 nodes are inside and some outside. </li> 
@@ -55,10 +55,10 @@ This dialog allows to define
     click on a coordinate in the list enables its edition. A grid
     defined by \b Coordinates should enclose the geometry, else the
     algorithm will fail. </li>
-  <li> You can define the \b Spacing of a grid as an algebraic formular 
-    <em>f(t)</em> where \a t is a position along a grid axiz
+  <li> You can define the \b Spacing of a grid as an algebraic formula 
+    <em>f(t)</em> where \a t is a position along a grid axis
     normalized at [0.0,1.0]. The whole range of geometry can be
-    divided into sub-ranges with their own spacing formulars to apply;
+    divided into sub-ranges with their own spacing formulas to apply;
     \a t varies between 0.0 and 1.0 within each sub-range. \b Insert button
     divides a selected range into two ones. \b Delete button adds the
     selected sub-range to the previous one. Double click on a range in
diff --git a/doc/salome/gui/SMESH/input/double_nodes_page.doc b/doc/salome/gui/SMESH/input/double_nodes_page.doc
index 1ac96910f..a8a93d1f9 100644
--- a/doc/salome/gui/SMESH/input/double_nodes_page.doc
+++ b/doc/salome/gui/SMESH/input/double_nodes_page.doc
@@ -2,7 +2,7 @@
 
 \page double_nodes_page Duplicate Nodes
 
-\n This operation allows to duplicate nodes of your mesh that is
+\n This operation allows to duplicate nodes of your mesh, which can be
 useful to emulate a crack in the model.
 Duplication consists in replacement of an existing mesh element by another one.
 Lower level elements of the duplicated ones are cloned automatically. 
diff --git a/doc/salome/gui/SMESH/input/mesh_preferences.doc b/doc/salome/gui/SMESH/input/mesh_preferences.doc
index aad8ef386..1b1b2f96c 100644
--- a/doc/salome/gui/SMESH/input/mesh_preferences.doc
+++ b/doc/salome/gui/SMESH/input/mesh_preferences.doc
@@ -28,8 +28,8 @@ object will be displayed in the viewer by default.</li>
 <b>Quality Control</b> diagrams at the necessary level of precision.</li>
 <li><b>Number of digits after point</b> - defines precision for <b>Quality Controls</b>. By default, numbers in <b>Quality Control</b>
 diagrams are presented as integers.</li>
-<li><b>Double nodes tolerance</b> defines maximal distance between two
-mesh nodes at which they are considered coincident by <b>Double nodes</b>
+<li><b>Double nodes tolerance</b> defines the maximal distance between two
+mesh nodes, at which they are considered coincident by <b>Double nodes</b>
 quality control.
 </ul>
 <li><b>Display mode</b> - allows to set Wireframe, Shading, Nodes or Shrink
@@ -84,12 +84,10 @@ number of segments on each edge</li>
 </li></ul>
 <li><b>Mesh loading</b></li>
 <ul>
-<li>If you toggle <b>No mesh loading from study file at hypothesis modification</b>
-  checkbox, then mesh data won't be loaded from the study file
-  provided that your first action on a mesh after study opening is
-  modification of hypotheses. This can save your time by omitting
-  loading data of a large mesh that your are going to recompute with
-  other parameters.</li>
+<li>If <b>No mesh loading from study file at hypothesis modification</b>
+  checkbox is on, the mesh data will not be loaded from the study file
+  when a hypothesis is modified. This allows  saving time by omitting
+  loading data of a large mesh that is planned to be recomputed with other parameters.</li>
 </ul>
 <li><b>Input fields precision</b></li>
 <ul>
@@ -102,12 +100,12 @@ number of segments on each edge</li>
 </ul>
 <li><b>Python Dump</b></li>
 <ul>
-<li><b>Historical python dump</b> checkbox switches Python Dump from
-  \a Historical to \a Snapshot mode and backward. In the \a
-  Historical mode, the Python Dump script includes all commands
-  performed by SMESH engine. In the \a Snapshot mode, commands
-  relating to objects removed from the Study are excluded from the
-  script as well as commands not influencing the current state of meshes.</li>
+<li><b>Historical python dump</b> checkbox allows switching between 
+  \a Historical and \a Snapshot dump mode. In \a
+  Historical mode, Python Dump script includes all commands
+  performed by SMESH engine. In \a Snapshot mode, the commands
+  relating to objects removed from the Study as well as the commands
+  not influencing the current state of meshes are excluded from the script.</li>
 </ul>
 </ul>
 
diff --git a/doc/salome/gui/SMESH/input/selection_filter_library.doc b/doc/salome/gui/SMESH/input/selection_filter_library.doc
index 1b46bcc0a..4e58dcee0 100644
--- a/doc/salome/gui/SMESH/input/selection_filter_library.doc
+++ b/doc/salome/gui/SMESH/input/selection_filter_library.doc
@@ -106,17 +106,17 @@ specified arbitrary surface within a given <b>Tolerance</b>.
 </li>
 </ul>
 
-Additional criteria to select mesh <b>Nodes</b> are the following:
+The following criteria allow selecting mesh <b>Nodes</b>:
 <ul><li>
-<b>Free nodes</b> selects nodes belonging to none mesh element.
+<b>Free nodes</b> selects nodes not belonging to any mesh element.
 </li><li>
-<b>Double nodes</b> selects node coincident with other nodes 
+<b>Double nodes</b> selects a node coincident with other nodes 
 (within a given <b>Tolerance</b>). 
 See also \ref tui_double_nodes_control "Double Nodes quality control".
 </li>
 </ul>
 
-Additional criteria to select mesh <b>Edges</b> are the following:
+The following criteria allow selecting mesh <b>Edges</b>:
 <ul><li>
 <b>Free Borders</b> selects free 1D mesh elements, i.e. edges belonging to 
 one face only. See also a
@@ -137,7 +137,7 @@ See also a
 </li>
 </ul>
 
-Additional criteria to select mesh <b>Faces</b> are the following:
+The following criteria allow selecting mesh <b>Faces</b>:
 <ul><li>
 <b>Aspect ratio</b> selects 2D mesh elements with an aspect ratio (see also an
 \ref aspect_ratio_page "Aspect Ratio quality control"), which is more, less or equal
@@ -203,7 +203,7 @@ diagonals with a value of length, which is more, less or equal
 </li>
 </ul>
 
-Additional criteria to select mesh <b>Volumes</b> are the following:
+The following criteria allow selecting  mesh <b>Volumes</b>:
 <ul><li>
 <b>Aspect ratio 3D</b> selects 3D mesh elements with an aspect ratio (see also an
 \ref aspect_ratio_3d_page "Aspect Ratio 3D quality control"), which is more, less or equal