Update documentation for 5.1.5

doc/salome/gui/GEOM/input/creating_edge.doc

@@ -8,8 +8,8 @@ Build > Edge</b>
 There are two ways to create an edge. In both cases the \b Result
 will be a \b GEOM_Object (EDGE). 
 
-1. You can create an \b Edge by specifying two points (\b Point1 and
+Firstly, you can create an \b Edge by specifying two points (\b Point1 and
-\b Point2), being the first and the last vertices of the edge.
+\b Point2), which are the first and the last vertices of the edge.
 
 <b>TUI Command:</b> <em>geompy.MakeEdge(Vertex1, Vertex2)</em><br>
 <b>Arguments:</b> Name + 2 vertices (Vertex1 and Vertex2 are
@@ -17,27 +17,27 @@ correspondingly the first and the last vertex of the edge).
 
 \image html edge1.png "Create edge by two points"
 
-2. You can create an \b Edge by specifying single wire.
+Secondly, you can create an \b Edge by specifying a single wire.
 
 In this mode the following use cases are possible:
-- All the edges, forming the wire, lie on the single geometrical curve
+- All edges that form the wire lie on the same geometrical curve
 (i.e. curve(edge1) == curve(edge2)).
-- The edges forming the wire, lie on the analytical curves of the same
+- The edges that form the wire lie on analytical curves of the same
-type, for example, segments of line, arcs, etc. In this case, an
+type, for example, segments of line, arcs, etc. In this case, the
-algorithm checks the geometrical coincidence of these curves using
+algorithm checks geometrical coincidence of these curves using
-some tolerance. If the curves are coinciding in terms of given
+a certain tolerance. If the curves are coinciding in terms of the given
-tolerance, resulting edge is built as on a single curve.
+tolerance, the resulting edge is built as if on a single curve.
-- The edges forming the wire have the same tangency in the connection
+- The edges that form the wire have the same tangency in the connection
 points. In this case the curves are interpolated by the single
-b-spline curve with the sufficient precision. The resulting edge will
+b-spline curve with sufficient precision. The resulting edge will
-be then built on this curve. 
+be built on this curve. 
 
-The case when the edges forming the wire have different tangency in
+The case when the edges that form the wire have different tangency in
 the connection points (sharp bend) is not processed.
 
 <b>TUI Command:</b> <em>geompy.MakeEdgeWire(Wire, LinearTolerance, AngularTolerance)</em><br>
 <b>Arguments:</b> Name + 1 wire + Linear Tolerance + Angular Tolerance
-(tolerance are used to check coincidence of the edges' underlying curves).
+(tolerance values are used to check coincidence of the underlying curves).
 
 \image html edge2.png "Create edge from wire"
 

doc/salome/gui/GEOM/input/creating_filling.doc

@@ -4,39 +4,38 @@
 
 To generate a \b Filling in the <b>Main Menu</b> select <b>New Entity - > Generation  - > Filling</b>
 
-To create a curving face using several edges you need to define the
+To create a curvilinear face from several edges you need to define the
 following parameters:
 \n <b>Input Compound</b> - the list of edges/wires used for creation
-of the surface. Before perform filling algorithm each wire from
+of the surface. To prepare for the filling each wire of the compound
-compound is converted to one edge created on BSpline curve built using
+is converted to an edge created on a BSpline curve built using curves
-curves from all edges from wire.
+from all edges of the wire.
 \n \b Minimum and <b>Maximum Degree</b> of equation of the resulting
 BSpline or Besier curves describing the surface; 
 \n \b Tolerance for \b 2D and for \b 3D - minimum distance between the
 created surface and the reference edge; 
-\n <b>Number of
+\n <b>Number of Iterations</b> - defines the maximum number of iterations. The
-Iterations</b> - defines the maximum number of iterations. The
 iterations are repeated until the required tolerance is reached. So, a
 greater number of iterations allows producing a better surface. 
 \n <b>Method</b> - Kind of method to perform filling operation
-1. Default - standard behaviour
+1. Default - the standard behaviour.
-2. Use edges orientation - orientation of edges are used: if edge is
+2. Use edges orientation - the edges orientation is used: if an edge is
-reversed curve from this edge is reversed before using in filling
+reversed, the curve from this edge is reversed before being used by the filling
 algorithm.
-3. Auto-correct edges orientation - change orientation of curves using
+3. Auto-correct edges orientation - curves orientation is changed to 
-minimization of sum of distances between ends points of edges.
+minimize the sum of distances between ends points of edges.
 \n <b>Approximation</b> - if checked, BSpline curves are generated in
 the process of surface construction (using
 GeomAPI_PointsToBSplineSurface functionality). By default the surface
 is created using Besier curves. The usage of <b>Approximation</b>
-makes the algorithm work slower, but allows building the surface for
+slows the algorithm, but allows building the surface for complex cases. 
-rather complex cases. 
 
 \n The \b Result of the operation will be a GEOM_Object (face).
 
 \n <b>TUI Command:</b> <em>geompy.MakeFilling(Edges, MinDegree, MaxDegree, Tol2D, Tol3D, NbIter)</em>
 \n <b>Arguments:</b> Name + 1 List of edges + 7 Parameters
-(Min. degree, Max. degree, 2D tolerance, 3D tolerance, Number of iterations, Method, Approximation).
+(Min. degree, Max. degree, Number of iterations, 2D tolerance, 3D
+tolerance, Number of iterations, Method, Approximation).
 
 \image html filling.png
 

doc/salome/gui/GEOM/input/index.doc

@@ -23,8 +23,7 @@ various algorithms;</li>
 Almost all geometry module functionalities are accessible via
 \subpage geompy_page "Geometry module Python Interface"
 
-\n Have a look also at the
+Also it can be useful to have a look at the \subpage geompypkg_page "documentation on GEOM python packages".
-<a href="../../gui/GEOM/geompypkg_page.html"> documentation of the GEOM python packages</a>
 
 \image html image3.png "Example of Geometry module usage for engineering tasks"
 

doc/salome/gui/GEOM/input/limit_tolerance_operation.doc

@@ -13,25 +13,25 @@
 
 \n The \b Result will be a \b GEOM_Object.
 
-\n This functionality tries to set new value of tolerance for the
+\n This functionality tries to set a new value of tolerance for the
-   given shape. But the final tolerance value depends also on the
+   given shape. However, the final tolerance value also depends on the
-   initial shape topology (regards existing gaps) in order to obtain
+   initial shape topology (takes into consideration the existing gaps) to obtain
-   valid resulting shape.
+   a valid resulting shape.
 
 \n Example of usage:
 <ol>
-<li>Try a partition on objects obj1 and obj2.</li>
+<li>Partition objects obj1 and obj2.</li>
 <li>Partition fails.</li>
 <li>Perform Limit Tolerance on objects obj1 and obj2.</li>
-<li>Try again the partition.</li>
+<li>Try to partition them again.</li>
 </ol>
 See also \ref tui_limit_tolerance "TUI example".
 
 \n <b>TUI Command:</b> <em>geompy.LimitTolerance(Shape, Tolerance),</em>
  where \em Shape is a shape with presumably incorrect tolerance, \em
- Tolerance is a desired value of tolerance.
+ Tolerance is the required tolerance value.
 
-Our <b>TUI Scripts</b> provide you with useful examples of the use of
+Our <b>TUI Scripts</b> provide you with useful examples of
 \ref tui_limit_tolerance "Repairing Operations".
 
 */

doc/salome/gui/GEOM/input/multi_translation_operation.doc

@@ -12,8 +12,8 @@ two directions.
 \n To produce a <b>Simple Multi Translation</b> (in one direction) you
 need to indicate an \b Object to be translated, a \b Vector of
 translation, a \b Step of translation and a <b>Number of Times</b> the
-Object should be duplicated. If a curve was selected instead of Vector, 
+Object should be duplicated. If a curve has been selected instead of
-only its first and last vertices will be used to get the vector direction
+the Vector, only its first and last vertices will be used to get the vector direction
 and the dialog preview will display the vector along which the object will be translated.
 \n <b>TUI Command:</b> <em>geompy.MakeMultiTranslation1D(Shape, Dir,
 Step, NbTimes)</em>
@@ -29,7 +29,7 @@ step value + 1 value (repetition).
 \n To produce a <b>Double Multi Translation</b> (in two directions) you need to
 indicate an \b Object to be translated, and, for both axes, a \b
 Vector of translation, a \b Step of translation and a <b>Number of Times</b> the shape must be duplicated.
-If a curve was selected instead of Vectors, only its first and last vertices will be used to get the vector direction
+If a curve has been selected instead of the Vector, only its first and last vertices will be used to get the vector direction
 and the dialog preview will display the vector along which the object will be translated.
 
 \n <b>TUI Command:</b> <em>geompy.MakeMultiTranslation2D(Shape, Dir1,

doc/salome/gui/GEOM/input/partition.doc

@@ -6,7 +6,7 @@ To produce a \b Partition in the <b>Main Menu</b> select <b>Operations - > Parti
 
 This operation builds a compound by intersection of several shapes
 with a set of tool objects or with a plane.
-The \b Result will be \b GEOM_Object.
+The \b Result will be a \b GEOM_Object.
 
 <br><h2>Intersection of two shapes.</h2>
 
@@ -20,7 +20,7 @@ As far as the intersection of two objects can produce any type of
 geometrical objects, <b>Resulting type</b> box allows choosing the
 preferrable result, i.e. a solid, a shell, a list of faces, etc.
 
-<b>Resulting type</b> has to be equal or lower than the type of the
+The <b>Resulting type</b> has to be equal or lower than the type of the
 \em Objects. In other words, if the \em Objects don't contain any
 shape of this type, Partition fails.
 
@@ -28,30 +28,30 @@ shape of this type, Partition fails.
 type other than the \em Limit. If it is checked, lower dimension
 objects will be preserved, else they will be lost.
 
-For example, you do a partition of a box (Solid) and a face (Face)
+For example, you partition a box (Solid) and a face (Face)
-without any tool. If you choose Resulting Type "Solid", you will
+without any tool (the box is split in two parts by the shape). If you
-obtain a compound of two solids (let's the box will be splitted by the
+choose the Resulting Type "Solid", you will
-face on two parts), but if you will also check <b>Keep shapes of lower
+obtain a compound of two solids, but if you also check <b>Keep shapes of lower
 type</b> checkbox, you will obtain a compound of two solids and one
-face (the face will have a hole where the original face lays inside
+face (there will be a hole in the resulting face, where the original
-the box, see corresponding \ref partition_picture_3 "picture" below).
+face intersects with the box, see the corresponding \ref partition_picture_3 "picture" below).
 
-<b>No sub-shapes intersection (Compounds only)</b> check box affects only input shapes
+<b>No sub-shapes intersection (Compounds only)</b> check box affects
-of the Compound type. If this option is switched off (default
+only input shapes of the Compound type. If this option is switched off (default
-behavior) each input compound will be automatically exploded to the
+behavior) each input compound will be automatically exploded into
-sub-shapes and intersection between those shapes will be also
+sub-shapes and the intersection between these shapes will be also
 computed. If this option is switched on, the intersection between
-sub-shapes will be not performed. In this case the Partition algorithm
+sub-shapes will not be performed. In this case the Partition algorithm
-will work faster, but result might differ from the default behavior.
+will work faster, but the result might differ from the default behavior.
 
  <b>Advanced option:</b>
    \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
 
-\note Partition is a kind of complex operation, result of it depends
+\note Partition is a complex operation, so its result of it depends
-      on the initial shapes quality. Sometimes, if partition fails,
+      on the quality of the initial shapes. Sometimes, if partition fails,
-      some healing operations could help. Try <b>Shape Processing</b>
+      such healing operations as <b>Shape Processing</b>
-      and <b>Limit Tolerance</b> in such cases. See also \ref
+      and <b>Limit Tolerance</b> can help to attune source shapes to obtain correct result of the Partition.
-      tui_limit_tolerance "TUI example" of shape healing.
+      See also \ref tui_limit_tolerance "TUI example" of shape healing.
 
 <b>TUI Command (with sub-shapes intersection):</b>
 
@@ -59,7 +59,7 @@ will work faster, but result might differ from the default behavior.
 ListOfRemoveInside, Limit, RemoveWebs, ListOfMaterials,
 KeepNonlimitShapes)</em>
 
-<b>TUI Command (no sub-shapes intersection):</b>
+<b>TUI Command (without sub-shapes intersection):</b>
 
 <em>geompy.MakePartitionNonSelfIntersectedShape(ListOfShapes,
 ListOfTools, ListOfKeepInside, ListOfRemoveInside, Limit, RemoveWebs,
@@ -68,10 +68,10 @@ ListOfMaterials, KeepNonlimitShapes)</em>
 Here,
 - \em ListOfShapes is a list of shapes to be intersected
 - \em ListOfTools is a list of shapes to intersect the shapes from
-ListOfShapes
+\em ListOfShapes
-- \em Limit is a Type of resulting shapes and \em KeepNonlimitShapes
+- \em Limit is a Type of resulting shapes
-is a flag that allows to preserve standalone shapes of low dimension
+- \em KeepNonlimitShapes is a flag that allows to preserve standalone
-(than \em Limit) in the result.
+shapes of low dimension (than \em Limit) in the result.
 - Other parameters are obsolete and kept only for compatibility with
 previous versions of SALOME.
 
@@ -86,20 +86,20 @@ previous versions of SALOME.
 
 <b>TUI Command:</b>
 
-<em>geompy.MakeHalfPartition(Shape, Plane)</em> where
+<em>geompy.MakeHalfPartition(Shape, Plane)</em>, where:
-- \em Shape is a source shape to be intersected by \em Plane
+- \em Shape is a source shape to be intersected by the \em Plane
 - \em Plane is a tool shape, to intersect the \em Shape.
 
-<b>Example:</b>
+<b>Examples:</b>
 
 \image html partitionsn1.png "Box intersected by a plane"
 
 \image html partitionsn2.png "Result of intersection"
 
 \anchor partition_picture_3
-\image html partitionsn3.png "Result of intersection of a box and a plane (both as \em Objects, no tools) with Resulting type \em Solid and checked \em Keep \em shapes \em of \em lower \em type"
+\image html partitionsn3.png "Result of intersection of a box and a
+plane (both as \em Objects, no tools) with the Resulting type \em Solid and checked <em> "Keep shapes of lower type"</em>
 
-Our <b>TUI Scripts</b> provide you with useful examples of the use of
+Our <b>TUI Scripts</b> provide you with useful examples of \ref tui_partition "Basic Operations".
-\ref tui_partition "Basic Operations".
 
 */

doc/salome/gui/GEOM/input/shape_processing_operation.doc

@@ -15,16 +15,16 @@ is a list of operators ("FixShape", "SplitClosedFaces", etc.),
 etc), \em Values is a list of values of parameters placed in the same
 order as in the list of Parameters.
 
-\note <b>Shape Processing</b> is usefull not only on invalid shapes,
+\note <b>Shape Processing</b> is useful not only on invalid shapes,
-      but sometimes also on shapes, that are classified as valid by
+      but also on the shapes, that are classified as valid by
-      the <b>Check</b> functionality. Use it, if some operation (for
+      the <b>Check</b> functionality. Use it, if an operation (for
       example, <b>Partition</b>) fails.
       Example of usage:
       <ol>
-      <li>Try a partition on objects obj1 and obj2.</li>
+      <li>Try to partition objects obj1 and obj2.</li>
       <li>Partition fails.</li>
       <li>Perform Shape Processing on objects obj1 and obj2.</li>
-      <li>Try again the partition.</li>
+      <li>Try to partition them again.</li>
       </ol>
       See also \ref tui_limit_tolerance "TUI example".
 

doc/salome/gui/GEOM/input/translation_operation.doc

@@ -31,8 +31,8 @@ of the vector.
 
 \image html transformation2.png
 
-\n Finally you can define an \b Object and the vector. The object will be translated by the length of the vector. 
+\n Finally you can define an \b Object and a vector. The object will be translated by the length of the vector. 
-If a curve was selected instead of vector, only its first and last vertices will be used to get the vector direction 
+If a curve has been selected instead of the vector, only its first and last vertices will be used to get the vector direction 
 and the dialog preview will display the vector along which the object will be translated. 
 \n <b>TUI Command:</b> <em>geompy.MakeTranslationVector(Object, Vector)</em>
 \n <b>Activate Distance</b> checkbox and <b>Distance</b> field allow defining the custom distance of translation.