Issue #2998: Add help description for automatic creation of constraints

[modules/shaper.git] / src / ConstructionPlugin / doc / planeFeature.rst

diff --git a/src/ConstructionPlugin/doc/planeFeature.rst b/src/ConstructionPlugin/doc/planeFeature.rst
index c1b54009a6c258927f1bb933e070885aa9505c7b..beff5373144d5370f150af3e87515dbda10545e7 100644 (file)
--- a/src/ConstructionPlugin/doc/planeFeature.rst
+++ b/src/ConstructionPlugin/doc/planeFeature.rst
@@ -1,19 +1,14 @@
+.. |plane_button.icon|    image:: images/plane_button.png
 
 Plane
 =====
 
-The feature Plane creates a new constructive plane.
+Plane feature creates a new constructive plane.
 
-Plane is a construction object and it can be created as in a part as in a part set. To create a plane:
+Plane is a construction object that can be created in a part or in a partset. To create a plane:
 
 #. select in the Main Menu *Construction - > Plane* item  or
-#. click **Point** button in the toolbar
-
-.. image:: images/plane_button.png
-  :align: center
-
-.. centered::
-  **Plane** button
+#. click |plane_button.icon| **Point** button in the toolbar
 
 There are 4 algorithms for creation of a Plane:
 
@@ -43,11 +38,17 @@ By three points
 .. centered::
    **By three points**
 
-In this case user has to select three points in a viewer to define a new plane.
+A plane is created by selecting three points in a viewer.
+
+**TUI Commands**:
 
-**TUI Commands**: *model.addPlane(Part_doc, model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Left&Box_1_1/Bottom"))*
+.. py:function:: model.addPlane(Part_doc, model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Left&Box_1_1/Bottom"))
 
-**Arguments**: Part + 3 vertices.
+    :param part: The current part object.
+    :param object: Vertex 1.
+    :param object: Vertex 2.
+    :param object: Vertex 3.
+    :return: Result object.
 
 Result
 """"""
@@ -60,7 +61,7 @@ The Result of the operation will be a plane:
 .. centered::
    **A plane by three points**
 
-**See Also** a sample TUI Script of a :ref:`tui_create_plane_points` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_plane_points` operation.
 
 
 By line and point
@@ -72,11 +73,17 @@ By line and point
 .. centered::
    **Line and point**
 
-In this case user has to select a linear edge and point to define a plane. It is possible to make the new plane perpendicular to the selected edge.
+A plane is created by selecting  a linear edge and point. It is possible to create a new plane perpendicular to the selected edge.
 
-**TUI Commands**: *model.addPlane(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Bottom"), False)*
+**TUI Commands**:
 
-**Arguments**: Part + line + point + is perpendicular to line flag.
+.. py:function:: model.addPlane(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Bottom"), False)
+
+    :param part: The current part object.
+    :param object: A line.
+    :param object: A point.
+    :param boolean: Is perpendicular to line.
+    :return: Result object.
 
 Result
 """"""
@@ -89,7 +96,7 @@ The Result of the operation will be a plane:
 .. centered::
    Plane created  
 
-**See Also** a sample TUI Script of a :ref:`tui_create_plane_line` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_plane_line` operation.
 
 
 By other plane
@@ -101,7 +108,7 @@ By other plane
 .. centered::
    **By other plane**
 
-In this case user has to select an already existing plane (planar face). There are following possibilities to define a new plane:
+A plane is created by selecting an already existing plane (planar face). There are following possibilities to define a new plane:
 
 .. image:: images/plane_by_distance_from_other_24x24.png
    :align: left
@@ -111,16 +118,22 @@ By distance from the selected plane.
 .. image:: images/plane_by_coincident_to_point_24x24.png
    :align: left
 
-By coincidence to a point.
+By coincidence with a point.
 
 .. image:: images/plane_by_rotation_24x24.png
    :align: left
 
-By rotation around an edge on a specified angle.
+By rotation around an edge by a specified angle.
+
+**TUI Commands**:
 
-**TUI Commands**: *model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Front"), 10, False)*
+.. py:function:: model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Front"), 10, False)
 
-**Arguments**: Part + a plane + offset + is reverse flag.
+    :param part: The current part object.
+    :param object: A plane.
+    :param real: An offset.
+    :param boolean: Is reverse.
+    :return: Result object.
 
 Result
 """"""
@@ -133,7 +146,7 @@ The Result of the operation will be a plane parallel to already existing one:
 .. centered::
    **Plane parallel to a planar face**
 
-**See Also** a sample TUI Script of a :ref:`tui_create_plane_plane` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_plane_plane` operation.
 
 
 By two parallel planes
@@ -145,11 +158,16 @@ By two parallel planes
 .. centered::
    **By two parallel planes**
 
-In this case user has to select two parallel planes. A new plane will be defined between them.
+A plane is created by selecting two parallel planes. A new plane will be defined between them.
+
+**TUI Commands**:
 
-**TUI Commands**: *model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Left"), model.selection("FACE", "Box_1_1/Right"))*
+.. py:function:: model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Left"), model.selection("FACE", "Box_1_1/Right"))
 
-**Arguments**: Part + 2 planes.
+    :param part: The current part object.
+    :param object: A plane 1.
+    :param object: A plane 2.
+    :return: Result object.
 
 Result
 """"""
@@ -162,4 +180,4 @@ The Result of the operation will be a plane created between two selected planes:
 .. centered::
    **Plane created between others**
 
-**See Also** a sample TUI Script of a :ref:`tui_create_plane_parallel` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_plane_parallel` operation.