Salome HOME
Cosmetics. Move XML files to the separate folder inside a corresponding project in VS.
[modules/shaper.git] / src / SketchPlugin / doc / trimFeature.rst
index bb08e517abb70c9e8ac7199907f9191d40bd884f..3f70db204f42361aa09f8247afa02029ba8b1e69 100644 (file)
@@ -1,3 +1,4 @@
+.. |trim.icon|    image:: images/Trim.png
 
 Trim
 ====
@@ -6,23 +7,16 @@ Trim
 | The curve should have points lying on it or intersections with other curves.
 | Open curves (line or arc) require one or more points; closed curves (circle) require two or more points.
 
-To create Trim in the active Sketch:
+To create Trim in the active Sketch:
 
 #. select in the Main Menu *Sketch - > Trim* item  or
-#. click **Trim** button in Sketch toolbar:
-
-.. image:: images/trim.png
-   :align: center
-
-.. centered::
-   **Trim**  button
+#. click |trim.icon| **Trim** button in Sketch toolbar:
 
 Property panel:
 
-.. image:: images/Trim_panel.png
-  :align: center
+.. figure:: images/Trim_panel.png
+   :align: center
 
-.. centered::
    Trim
 
 Input fields:
@@ -31,13 +25,18 @@ Input fields:
 
 The selected segment is highlighted in the view:
 
-.. image:: images/Trim_segment_sel.png
+.. figure:: images/Trim_segment_sel.png
    :align: center
 
-.. centered::
    The segment to remove
 
-**TUI Command**: *Sketch_1.addTrim(Feature, PositionPoint)*
+**TUI Command**:
+
+.. py:function:: Sketch_1.addTrim(Feature, PositionPoint)
+
+    :param object: Line, arc or circle.
+    :param object: Position point.
+    :return: Result object.
 
 **Arguments**:   feature (line, arc or circle) and position point (a point on or closest to the segment to remove)
 
@@ -46,10 +45,9 @@ Result
 
 Created Trim appears in the view.
 
-.. image:: images/Trim_res.png
-          :align: center
+.. figure:: images/Trim_res.png
+   :align: center
 
-.. centered::
-   Trim created
+   Created trim
 
-**See Also** a sample TUI Script of :ref:`tui_create_trim` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_trim` operation.