Additional changes for issue 0020835: EDF 1363 GEOM : 'New entity/Face' and 'Build Face' confusion (update documentation)

doc/salome/gui/GEOM/input/creating_primitives.doc

@@ -11,8 +11,8 @@ geometrical objects, such as:
 <li>\subpage create_sphere_page</li>
 <li>\subpage create_torus_page</li>
 <li>\subpage create_cone_page</li>
-<li>\subpage create_squareface_page "Face"</li>
+<li>\subpage create_squareface_page</li>
 <li>\subpage create_disk_page</li>
 </ul>
 
-*/
+*/

doc/salome/gui/GEOM/input/creating_squareface.doc

@@ -1,19 +1,19 @@
 /*!
 
-\page create_squareface_page Square Face
+\page create_squareface_page Rectangle
 
-A primitive called <b>Square Face</b> is a square plane of certain dimensions and orientation
+A primitive called \b Rectangle is a rectangular face of certain dimensions and orientation
 
-To create a \b Square Face  in the <b>Main Menu</b> select <b>New Entity - >
-Primitives - > Face</b>
+To create a \b Rectangle  in the <b>Main Menu</b> select <b>New Entity - >
+Primitives - > Rectangle</b>
 
-\n There are 2 algorithms to create a \b Square \b Face in the 3D space. 
+\n There are 2 algorithms to create a \b Rectangle in the 3D space. 
 \n The \b Result of each operation will be a GEOM_Object (Face).
 
-\n Firstly, you can create a \b Face at the origin 
+\n Firstly, you can create a \b Rectangle at the origin 
 of coordinates defining its boundaries by the height and the width and its axis by the orientation
 radio buttons (OXY, OYZ or OZX).This 
-means that the Square Face will lie in "OXY", "OYZ" or "OZX" plane correspondingly.
+means that the \b Rectangle will lie in "OXY", "OYZ" or "OZX" plane correspondingly.
 \n <b>TUI Command:</b> <em>geompy.MakeFaceHW(Height, Width, Orientation)</em>
 \n <b>Arguments:</b> Name + 3 values (Dimensions at origin: heigth, width and
 orientation).
@@ -21,12 +21,12 @@ orientation).
 
 \image html face1.png
 
-\n Secondly, you can define a \b Face by the height and the width sizes and an \b Edge defining the normal to the center of the face.
+\n Secondly, you can define a \b Rectangle by the height and the width sizes and an \b Edge defining the normal to the center of the face.
 \n <b>TUI Command:</b> <em>geompy.MakeFaceObjHW(Vector, Height, Width)</em>
 \n <b>Arguments:</b> Name + 1 Vector (normal to the center) + 2 doubles (to
 describe a face sizes).
 
-\n It is also possible to create a Square Face from another selected face. For this, switch the <b>Object Type</b> button 
+\n It is also possible to create a \b Rectangle from another selected face. For this, switch the <b>Object Type</b> button 
 to \b Face, then select a face object and set the values of
 Height and Width for the new face. The created face will lie in the plane of the selected face.
 \n <b>TUI Command:</b> <em>geompy.MakeFaceObjHW(Face, Height, Width)</em>
@@ -35,9 +35,9 @@ Height and Width for the new face. The created face will lie in the plane of the
 \image html face2.png
 
 <b>Example:</b>
-\image html faces.png "Square face"
+\image html faces.png "Rectangle"
 
 Our <b>TUI Scripts</b> provide you with useful examples of creating 
-\ref tui_creation_face "Primitives".
+\ref tui_creation_squareface "Primitives".
 
 */

doc/salome/gui/GEOM/input/tui_primitives.doc

@@ -196,7 +196,7 @@ gg.createAndDisplayGO(id_diks3)
 \endcode
 
 \anchor tui_creation_squareface
-<br><h2>Creation of a Face</h2>
+<br><h2>Creation of a Rectangle</h2>
 
 \code
 import geompy
@@ -210,23 +210,21 @@ py = geompy.MakeVertex(0.  , 100., 0.  )
 # create a vector on two points
 vxy  = geompy.MakeVector(px, py)
 
-# create a face in OXY plane
+# create a rectangle in OXY plane
 face1 = geompy.MakeFaceHW(100, 100, 1)
 
-# create a disk from a point, a vector and a radius
+# create a rectangle using normal vector
 face2 = geompy.MakeFaceObjHW(vxy, 50, 150)
 
-#create a circle from three points
+# create a rectangle from other face
 face3 = geompy.MakeFaceObjHW(face2, 150, 50)
 
 # add objects in the study
-id_vxy    = geompy.addToStudy(vxy,  "Vector")
 id_face1  = geompy.addToStudy(face1,"Face1")
 id_face2  = geompy.addToStudy(face2,"Face2")
 id_face3  = geompy.addToStudy(face3,"Face3")
 
-# display disks
-gg.createAndDisplayGO(id_vxy)
+# display rectangles
 gg.createAndDisplayGO(id_face1)
 gg.createAndDisplayGO(id_face2)
 gg.createAndDisplayGO(id_face3)