Salome HOME
Correct documentation bugs, adapt for 'Read The Docs' theme (bos #18858)
[modules/shaper.git] / src / SketchPlugin / doc / middleFeature.rst
index 75ff8a7657682025b0b8c1bdd60b3417106efbe5..70efffd9b7289b93d2cdf8d507181eb5b74fb822 100644 (file)
@@ -1,19 +1,14 @@
+.. |middlepoint.icon|    image:: images/MiddlePoint.png
 
 Middle point constraint
 =======================
 
-Middle point constraint makes one point to lie in the middle of a line.
+Middle point constraint forces a point to middle of a line.
 
-To create Middle point in the active Sketch:
+To create Middle point in the active Sketch:
 
 #. select in the Main Menu *Sketch - > Middle point* item  or
-#. click **Middle point** button in Sketch toolbar:
-
-.. image:: images/middlepoint.png
-   :align: center
-
-.. centered::
-   **Middle point**  button
+#. click |middlepoint.icon| **Middle point** button in Sketch toolbar:
 
 Property panel:
 
@@ -25,14 +20,18 @@ Input fields:
 - **First object** is a point or a line selected in the view.
 - **Second object** is a point or a line selected in the view.
 
-Note that one of two objects should be a line and another one a point (i.e. a point, a line or an arc end point, a center of a circle or an arc).
+Note that one of two objects should be a line and the other a point (i.e. a point, a line or an arc end point, a center of a circle or an arc).
+
+| After the objects are selected, the point is moved to the middle of the line.
+| The middle points are marked with a special sign.
 
-| After the objects are selected the point becomes located in the middle of the line.
-| The middle point are marked with the special sign.
+**TUI Command**:
 
-**TUI Command**: *Sketch_1.setMiddlePoint(Point, Line)*
+.. py:function:: Sketch_1.setMiddlePoint(Point, Line)
 
-**Arguments**:  2 objects (the first is a point, the second one is a line)
+    :param object: A point.
+    :param object: A line.
+    :return: Result object.
 
 Result
 """"""
@@ -43,6 +42,6 @@ Created Middle point constraint appears in the view.
           :align: center
 
 .. centered::
-   Middle point constraint created
+   Created middle point constraint
 
-**See Also** a sample TUI Script of :ref:`tui_create_middle` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_middle` operation.