From 016f5df550d25bb3c661ed0a42df7b08b928f4d3 Mon Sep 17 00:00:00 2001
From: vsr <vsr@opencascade.com>
Date: Wed, 17 Apr 2013 16:20:21 +0000
Subject: [PATCH] Update documentation for 7.2.0

---
 .../SMESH/input/adding_nodes_and_elements.doc |  5 +-
 .../SMESH/input/adding_quadratic_elements.doc | 25 ++++-----
 .../gui/SMESH/input/basic_meshing_algos.doc   |  8 +--
 .../input/convert_to_from_quadratic_mesh.doc  |  4 +-
 doc/salome/gui/SMESH/input/mesh_infos.doc     | 42 +++++++-------
 .../gui/SMESH/input/mesh_preferences.doc      | 14 ++---
 doc/salome/gui/SMESH/input/prism_3d_algo.doc  | 55 +++++++++----------
 .../gui/SMESH/input/projection_algos.doc      |  4 +-
 doc/salome/gui/SMESH/input/scalar_bar.doc     |  2 +-
 .../gui/SMESH/input/smesh_migration.doc       | 32 +++++------
 .../gui/SMESH/input/use_existing_algos.doc    |  2 +-
 11 files changed, 92 insertions(+), 101 deletions(-)

diff --git a/doc/salome/gui/SMESH/input/adding_nodes_and_elements.doc b/doc/salome/gui/SMESH/input/adding_nodes_and_elements.doc
index 38fb8c590..b91324b85 100644
--- a/doc/salome/gui/SMESH/input/adding_nodes_and_elements.doc
+++ b/doc/salome/gui/SMESH/input/adding_nodes_and_elements.doc
@@ -19,9 +19,8 @@
 <li>\ref adding_polyhedrons_anchor "Polyhedrons"</li>
 </ul>
 
-SALOME uses the convention of nodal connectivity of elements of MED library. You
-can consult description of the nodal connectivity of elements located
-within documentation on MED library or 
+SALOME uses the convention of nodal connectivity of MED library elements. You
+can consult the description of nodal connectivity of elements in the documentation on MED library or 
 <a href="http://www.code-aster.org/outils/med/html/connectivites.html">
   here </a>.
 
diff --git a/doc/salome/gui/SMESH/input/adding_quadratic_elements.doc b/doc/salome/gui/SMESH/input/adding_quadratic_elements.doc
index 1d51daa9a..aaa797812 100644
--- a/doc/salome/gui/SMESH/input/adding_quadratic_elements.doc
+++ b/doc/salome/gui/SMESH/input/adding_quadratic_elements.doc
@@ -4,26 +4,25 @@
 
 \n MESH module allows you to work with <b>Quadratic Elements</b>.
 
-Quadratic elements are defined by same corner nodes as the
-corresponding linear ones, and in addition they bear \a midside nodes
+Quadratic elements are defined by the same corner nodes as the
+corresponding linear ones, but in addition they have \a midside nodes
 located between the corner nodes on element sides.
 
-The quadratic quadrilateral element can bear an additional node at the
-element center, then it is referred as bi-quadratic one (or
-QUAD9). The quadratic hexahedral element can bear 7 additional nodes:
-at the element center and at centers of sides, then it is referred as
-tri-quadratic one (or HEXA27).
+If a quadratic quadrilateral element has an additional node at the
+element center, it is a bi-quadratic element (or
+QUAD9). If a quadratic hexahedral element has 7 additional nodes:
+at the element center and at the center of each side it is a
+tri-quadratic element (or HEXA27).
 
-SALOME uses the convention of nodal connectivity of elements of MED library. You
-can consult description of the nodal connectivity of elements located
-within documentation on MED library or 
+SALOME uses the convention of nodal connectivity of MED library elements. You
+can consult the description of nodal connectivity of elements in the documentation on MED library or 
 <a href="http://www.code-aster.org/outils/med/html/connectivites.html">
   here </a>.
 
-There are several ways you can create quadratic elements in your mesh:
-- manually create quadratic elements (the way described below);
+There are several ways to create quadratic elements in your mesh:
+- manually (this way is described below);
 - use \ref quadratic_mesh_anchor "Quadratic Mesh" hypothesis to
-generate quadratic mesh on your geometry;
+generate a quadratic mesh on your geometry;
 - convert an existing linear mesh to a quadratic one 
 (see \ref convert_to_from_quadratic_mesh_page).
 
diff --git a/doc/salome/gui/SMESH/input/basic_meshing_algos.doc b/doc/salome/gui/SMESH/input/basic_meshing_algos.doc
index 82ee9d824..eca53a6b3 100644
--- a/doc/salome/gui/SMESH/input/basic_meshing_algos.doc
+++ b/doc/salome/gui/SMESH/input/basic_meshing_algos.doc
@@ -46,12 +46,8 @@ where the geometrical boundary intersects Cartesian cells.</li>
 \image html image126.gif "Example of a hexahedral 3D mesh"
 </ul>
 
-Some of 3D meshing algorithms also can generate 3D meshes from 2D meshes, working without
-geometrical objects. Such algorithms is
-<ul>
-<li>Hexahedron meshing algorithm (i,j,k),</li>
-<!-- <li>GHS3D meshing algorithm (commercial)</li> -->
-</ul>
+Some 3D meshing algorithms, such as Hexahedron(i,j,k) and GHS3D (commercial), also can generate 3D meshes from 2D meshes, working without
+geometrical objects. 
 
 There is also a number of more specific algorithms:
 <ul>
diff --git a/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc b/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc
index 15fe1b750..c8f53682f 100644
--- a/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc
+++ b/doc/salome/gui/SMESH/input/convert_to_from_quadratic_mesh.doc
@@ -33,8 +33,8 @@ The following dialog box will appear:
 
 <ul>
 <li>If it is necessary to convert a linear mesh to quadratic or a quadratic
-  mesh to linear. **Convert to bi-quadratic** option means same as
-  **Convert to quadratic** except that QUAD9 elements are created
+  mesh to linear. **Convert to bi-quadratic** option does the same as
+  **Convert to quadratic** except for that QUAD9 elements are created
   instead of QUAD8, and HEXA27 elements are created instead of
   HEXA20. Note that the choice is available only if the selected mesh
   (or sub-mesh) contains both quadratic and linear elements, else the
diff --git a/doc/salome/gui/SMESH/input/mesh_infos.doc b/doc/salome/gui/SMESH/input/mesh_infos.doc
index 5c526af67..95897e0f0 100644
--- a/doc/salome/gui/SMESH/input/mesh_infos.doc
+++ b/doc/salome/gui/SMESH/input/mesh_infos.doc
@@ -35,28 +35,28 @@ type: 0D elements, edges, faces, volumes, balls.
 \anchor mesh_element_info_anchor
 <h2>Mesh Element Information</h2> 
 
-The <b>Element Info</b> tab page of the dialog box gives detail
-information about selected mesh node(s) or element(s), namely:
+The <b>Element Info</b> tab page of the dialog box gives detailed
+information about the selected mesh node(s) or element(s), namely:
 
-- For node:
-  - Node ID
-  - Coordinates (X, Y, Z)
-  - Connectivity information (connected elements)
-  - Position on a shape (for meshes built on geometry)
-  - Groups information (names of groups the node belongs to)
+- For a node:
+  - Node ID;
+  - Coordinates (X, Y, Z);
+  - Connectivity information (connected elements);
+  - Position on a shape (for meshes built on a geometry);
+  - Groups information (names of groups the node belongs to).
 
 <center>\image html eleminfo1.png
 <em>"Element Info" page, node information</em></center>
 <br>
 
-- For element:
-  - Element ID
-  - Type (triangle, quadrangle, etc...)
-  - Gravity center (X, Y, Z coordinates)
-  - Connectivity information (connected nodes)
-  - Quality controls (area, aspect ration, volume, etc)
-  - Position on a shape (for meshes built on geometry)
-  - Groups information (names of groups the element belongs to)
+- For an element:
+  - Element ID;
+  - Type (triangle, quadrangle, etc.);
+  - Gravity center (X, Y, Z coordinates);
+  - Connectivity information (connected nodes);
+  - Quality controls (area, aspect ration, volume, etc.);
+  - Position on a shape (for meshes built on a geometry);
+  - Groups information (names of groups the element belongs to).
 
 <center>\image html eleminfo2.png 
 <em>"Element Info" page, element information</em></center>
@@ -65,10 +65,10 @@ The use can either input the ID of a node or element he wants to
 analyze directly in the dialog box or select the node(s) or element(s) in
 the 3D viewer.
 
-\note The information about the groups, the node or element belongs
-to, can be shown in short or detail form. By default, for performance
-reasons, this information is show in short form (group names
-only). Detail information on groups can be switched on via the user
+\note The information about the groups, to which the node or element belongs,
+ can be shown in a short or in a detailed form. By default, for performance
+reasons, this information is shown in a short form (group names
+only). The detailed information on groups can be switched on via the user
 preferences, see \ref mesh_preferences_page.
 
 \anchor mesh_addition_info_anchor
@@ -120,7 +120,7 @@ the "Automatic nodes compute limit" set via the  "Mesh information"
 preferences (zero value means no limit).
 
 The button \b "Dump" allows printing the information displayed in the
-dialog box to the txt file.
+dialog box to a .txt file.
 
 In case you get <b>Mesh Information</b> via a TUI script, the information is
 displayed in the Python Console. 
diff --git a/doc/salome/gui/SMESH/input/mesh_preferences.doc b/doc/salome/gui/SMESH/input/mesh_preferences.doc
index a9d7f87de..1ce536a16 100644
--- a/doc/salome/gui/SMESH/input/mesh_preferences.doc
+++ b/doc/salome/gui/SMESH/input/mesh_preferences.doc
@@ -75,15 +75,15 @@ the user will have to press \em Compute button explicitly. Zero value
 means "no limit". By default the value is set to 100 000 mesh elements.
 </li>
 <li><b>Show details on groups in element information tab</b> - when
-this option is switched off (default), only names of groups, the node
-or element belongs to, are shown in the \ref mesh_element_info_anchor "Info Tab"
+this option is switched off (default), only the names of groups, to which the node
+or element belongs, are shown in the \ref mesh_element_info_anchor "Info Tab"
 tab of "Mesh Information" dialog box. If this option is
-switched on, the detail information on groups is shown.</li>
-<li><b>Dump base information</b> - Dump base mesh information to the
+switched on, the detailed information on groups is shown.</li>
+<li><b>Dump base information</b> - allows to dump base mesh information to the
 file, see \ref mesh_infos_page.</li>
-<li><b>Dump element information</b> - Dump element information to the
+<li><b>Dump element information</b> - allows to dump element information to the
 file, see \ref mesh_infos_page.</li>
-<li><b>Dump additional information</b> - Dump additional mesh
+<li><b>Dump additional information</b> - allows to dump additional mesh
 information to the file, see \ref mesh_infos_page.</li>
 </ul>
 <li><b>Automatic Parameters</b></li>
@@ -113,7 +113,7 @@ number of segments on each edge</li>
 <li><b>Preview</b></li>
 <ul>
 <li><b>Sub-shapes preview chunk size</b> - allows to limit the number
-of preview sub-shapes shown in the hypotheses creation dialog boxes,
+of previewed sub-shapes shown in the hypotheses creation dialog boxes,
 for example "Reverse Edges" parameter of \ref number_of_segments_anchor "Number of segments" hypothesis. 
 </ul>
 <li><b>Python Dump</b></li>
diff --git a/doc/salome/gui/SMESH/input/prism_3d_algo.doc b/doc/salome/gui/SMESH/input/prism_3d_algo.doc
index d68902869..5f6c57cc5 100644
--- a/doc/salome/gui/SMESH/input/prism_3d_algo.doc
+++ b/doc/salome/gui/SMESH/input/prism_3d_algo.doc
@@ -7,66 +7,63 @@ defined by two opposing faces having the same number of vertices and
 edges. These two faces should be connected by quadrangle "side" faces.
 
 The prism is allowed to have sides composed of several faces. (A prism
-side is a row of faces (or one face) connecting corresponding edges of
-the top and base faces). But there is a limitation that a prism 
-side is allowed to be split only vertically as indicated in the
+side is a row of faces (or one face) connecting the corresponding edges of
+the top and base faces). However, a prism 
+side can be split only vertically as indicated in the
 picture below. 
 
-\image html prism_ok_ko.png
+\image html prism_ok_ko.png "A suitable and an unsuitable prism"
 In this picture, the left prism is suitable for meshing with 3D
-extrusion algorithm; it has six sides two of which are split
-vertically. And the right prism can't be meshed with this
-algorithm because one of the prism sides is split horizontally (a
+extrusion algorithm: it has six sides, two of which are split
+vertically. The right prism cannot be meshed with this
+algorithm because one of the prism sides is split horizontally (the
 splitting edge is highlighted).
 
 The algorithm can propagate 2D mesh not only between horizontal
 (i.e. base and top) faces of one prism but also between faces of prisms
 organized in a stack and between stacks sharing prism sides.
 
-\image html prism_stack.png
-In this picture, four neighboring prism stacks, each comprising two prisms,
-are shown. The shown sub-mesh is used by the algorithm to mesh
-all the eight prisms in the stacks.
+\image html prism_stack.png "Prism stacks"
+This picture shows four neighboring prism stacks, each comprising two prisms.
+The shown sub-mesh is used by the algorithm to mesh
+all eight prisms in the stacks.
 
 To use <em>3D extrusion</em> algorithm you need to assign algorithms
-and hypotheses of lower dimension as follows.
+and hypotheses of lower dimensions as follows.
 (A sample picture below shows algorithms and hypotheses used to
 mesh a cylinder with prismatic volumes).
 
-\image html prism_needs_hyps.png
+\image html prism_needs_hyps.png 
 
-\b Global algorithms and hypotheses to be chosen at 
+The \b Global algorithms and hypotheses to be chosen at 
 \ref create_mesh_anchor "Creation of a mesh object" are:
 <ul>
 <li> 1D algorithm and hypothesis that will be applied for meshing
-  (logically) vertical edges of the prism (these edges connect the top and
-  base faces of prism). In the sample picture above these are
+  (logically) vertical edges of the prism (which connect the top and the
+  base faces of the prism). In the sample picture above these are
   "Regular_1D" algorithm and "Nb. Segments_1" hypothesis.</li>
 </ul>
 
-\b Local algorithms and hypotheses to be chosen at 
-\ref constructing_submeshes_page "Constructing sub-meshes" are:
+The \b Local algorithms and hypotheses to be chosen at 
+\ref constructing_submeshes_page "Construction of sub-meshes" are:
 <ul>
   <li> 1D and 2D algorithms and hypotheses that will be applied for
-    meshing the top and base prism faces. These faces can be meshed
+    meshing the top and the base prism faces. These faces can be meshed
     with any type of 2D elements: quadrangles, triangles, polygons or
-    their mix. It's enough to define a sub-mesh on either top or base
+    their mix. It is enough to define a sub-mesh on either the top or the base
     face. In the sample picture above, "BLSURF" algorithm meshes
     "Face_1" base surface with triangles. (1D algorithm is not
-    assigned as "BLSURF" does not require divided edges to create 2D mesh.)
+    assigned as "BLSURF" does not require divided edges to create a 2D mesh.)
   </li>
-  <li> Optionally you can define an 1D sub-mesh on some vertical edges
+  <li> Optionally you can define a 1D sub-mesh on some vertical edges
     of stacked prisms, which will override the global 1D hypothesis mentioned
-    above. In the picture above the picture of Object Browser, the
-    vertical division is not equidistant on all the length because of
-    a "Number Of Segments" hypothesis with Scale Factor=3 assigned to
+    above. In the <b>Prism stacks</b> picture, the
+    vertical division is not equidistant on the whole length because 
+    a "Number Of Segments" hypothesis with Scale Factor=3 is assigned to
     the highlighted edge. 
 </li></ul>
 
-\image html image157.gif 
-
-Prism with 3D extrusion meshing. "Vertical" division is different on
-neighbor edges due to local 1D hypotheses assigned.
+\image html image157.gif "Prism with 3D extrusion meshing. Vertical division is different on neighbor edges because a local 1D hypotheses is assigned."
 
 \sa a sample TUI Script of
 \ref tui_prism_3d_algo "Use 3D extrusion meshing algorithm".
diff --git a/doc/salome/gui/SMESH/input/projection_algos.doc b/doc/salome/gui/SMESH/input/projection_algos.doc
index 4cd8b81fa..e2f68a897 100644
--- a/doc/salome/gui/SMESH/input/projection_algos.doc
+++ b/doc/salome/gui/SMESH/input/projection_algos.doc
@@ -59,8 +59,8 @@ In this dialog you can define
     two <b>Target Vertices</b>, which belong to the same edge of the
     face being meshed.</li>
 </ul>
-For groups of face, the groups must contain equal number of faces and
-they must form topologically equal structures. 
+
+The groups of faces are suitable for this algorithm only if they contain an equal number of faces and form topologically equal structures. 
 
 \n <b>Projection 1D-2D</b> algorithm differs from <b>Projection 2D</b>
 algorithm in one aspect: it generates mesh segments on edges of
diff --git a/doc/salome/gui/SMESH/input/scalar_bar.doc b/doc/salome/gui/SMESH/input/scalar_bar.doc
index 7ef8da51d..9d36cd301 100755
--- a/doc/salome/gui/SMESH/input/scalar_bar.doc
+++ b/doc/salome/gui/SMESH/input/scalar_bar.doc
@@ -9,7 +9,7 @@ In this dialog you can specify the properties of the scalar bar
 <ul>
 <li><b>Scalar Range</b> - in this menu you can specify 
 <b>Min value</b> and <b>Max value</b> of the <b>Scalar Bar</b>, and
-also you can turn on/off <b>Logarithmic</b> scaling of the scalar bar.</li>
+turn on/off <b>Logarithmic</b> scaling of the scalar bar.</li>
 
 \note <b>Logarithmic scale</b> is not applicable in case of
 negative and zero values in the range. In such cases it is disabled.
diff --git a/doc/salome/gui/SMESH/input/smesh_migration.doc b/doc/salome/gui/SMESH/input/smesh_migration.doc
index 5349eb65f..055723dd7 100644
--- a/doc/salome/gui/SMESH/input/smesh_migration.doc
+++ b/doc/salome/gui/SMESH/input/smesh_migration.doc
@@ -1,16 +1,16 @@
 /*!
 
-\page smesh_migration_page Modifying Mesh Python scripts from SALOME 6 and before
+\page smesh_migration_page Modifing Mesh Python scripts from SALOME 6 and before
 
-\n With SALOME 7.2, the Python interface for %Mesh has been slightly modified to offer new functionality:
+\n In SALOME 7.2, the Python interface for %Mesh has been slightly modified to offer new functionality:
 
 <ul>
   <li>\subpage tui_execution_distribution_page</li>
   <li>\subpage tui_auto_completion_documentation_page</li>
 </ul>
 
-\n Scripts generated for SALOME 6 and older versions must be adapted to work in SALOME 7.2 with all functionality.
-\n A compatibility mode allows old scripts to work in almost all cases, but with a warning.
+\n Scripts generated for SALOME 6 and older versions must be adapted to work in SALOME 7.2 with full functionality.
+\n The compatibility mode allows old scripts to work in almost all cases, but with a warning.
 
 See also <li>\subpage geompy_migration_page</li>
 
@@ -22,12 +22,12 @@ salome.salome_init()
 \endcode
 
 <b>smesh initialisation is modified.</b>
-\n old mode (from dump):
+\n the old mode (from dump):
 \code
 import smesh, SMESH, SALOMEDS
 smesh.SetCurrentStudy(theStudy)
 \endcode
-new mode:
+\n the new mode:
 \code
 import SMESH, SALOMEDS
 from salome.smesh import smeshBuilder
@@ -38,7 +38,7 @@ smesh =  smeshBuilder.New(salome.myStudy)
 <b> Of course, <em>from smesh import *</em> is no more possible.</b>
 \n You have to explicitely write <em>smesh.some_method()</em>.
 
-<b>algorithms are no longer in the namespace <em>smesh</em> but in <em>smeshBuilder</em>.</b>
+<b>Some algorithms have been transferred from the namespace <em>smesh</em> to the namespace <em>smeshBuilder</em>.</b>
 \n For instance:
 \code
 MEFISTO_2D_1 = Mesh_1.Triangle(algo=smesh.MEFISTO,geom=Face_1)
@@ -48,17 +48,17 @@ is replaced by:
 MEFISTO_2D_1 = Mesh_1.Triangle(algo=smeshBuilder.MEFISTO,geom=Face_1)
 \endcode
 \n StdMeshers algoritms concerned are <em>REGULAR, PYTHON, COMPOSITE, MEFISTO, Hexa, QUADRANGLE, RADIAL_QUAD</em>.
-\n SMESH Plugins provides algorithms such as: <em> NETGEN, NETGEN_FULL, FULL_NETGEN, NETGEN_1D2D3D, NETGEN_1D2D, NETGEN_2D, NETGEN_3D</em>.
+\n SMESH Plugins provide such algorithms as: <em> NETGEN, NETGEN_FULL, FULL_NETGEN, NETGEN_1D2D3D, NETGEN_1D2D, NETGEN_2D, NETGEN_3D</em>.
 \n If you use DISTENE plugins, you also have <em>BLSURF, GHS3D, GHS3DPRL, Hexotic</em>.
 
-<b>Some variables where at the same time in namespaces <em>smesh</em> and <em>SMESH</em>.
-They are now only in namespace <em>SMESH</em>.</b>.
-\n The dump function was already using the namespace <em>SMESH</em>,
-so, if your script was built with the help of dump function, it should be already OK for that part.
+<b>Some variables were available in both namespaces <em>smesh</em> and <em>SMESH</em>.
+Now they are available only in namespace <em>SMESH</em></b>.
+\n The dump function used only the namespace <em>SMESH</em>,
+so, if your script was built with the help of the dump function, it should be already OK in this respect.
 
-The more used variables concerned are:
-\n <em>NODE, EDGE, FACE, VOLUME, ALL.<em>
-\n <em>FT_xxx, geom_xxx, ADD_xxx...<em>
+The most used variables concerned are:
+\n <em>NODE, EDGE, FACE, VOLUME, ALL.</em>
+\n <em>FT_xxx, geom_xxx, ADD_xxx...</em>
 
 \n For instance:
 \code
@@ -84,7 +84,7 @@ is replaced by:
 Compound1 = smesh.Concatenate([Mesh_inf.GetMesh(), Mesh_sup.GetMesh()], 0, 1, 1e-05)
 \endcode
 
-<b>If you need to import explicitely an %SMESH Plugin, they are now in separate namespaces.</b>
+<b>If you need to import a %SMESH Plugin explicitely, keep in mind that  they are now located in separate namespaces.</b>
 \n For instance:
 \code
 import StdMeshers
diff --git a/doc/salome/gui/SMESH/input/use_existing_algos.doc b/doc/salome/gui/SMESH/input/use_existing_algos.doc
index b568a94dd..53d1010b4 100644
--- a/doc/salome/gui/SMESH/input/use_existing_algos.doc
+++ b/doc/salome/gui/SMESH/input/use_existing_algos.doc
@@ -42,7 +42,7 @@ the same groups as in the imported source mesh.</li>
 a geometrical face (or group of faces)
 by importing mesh faces contained in a group (or groups) from another
 (or this) mesh. 1D elements on the boundary of the geometrical face
-(if not yet present) are also created by the algorithm according to be conformal
+(if not yet present) are also created by the algorithm in conformity 
 with the created 2D elements.
 \n To apply this algorithm select the geometrical face to be meshed (indicated in
 the field \b Geometry of <b>Create mesh</b> dialog box),
-- 
2.30.2