Cosmetics. Move XML files to the separate folder inside a corresponding project in VS.

[modules/shaper.git] / src / SketchPlugin / doc / ellipseFeature.rst

diff --git a/src/SketchPlugin/doc/ellipseFeature.rst b/src/SketchPlugin/doc/ellipseFeature.rst
index 139d5d886ec421ead013ef904b4c45d4b6ae098b..8f0a8222898a7fe1cdd702dbf34218ef661e5f50 100644 (file)
--- a/src/SketchPlugin/doc/ellipseFeature.rst
+++ b/src/SketchPlugin/doc/ellipseFeature.rst
@@ -12,50 +12,60 @@ To add a new Ellipse to the Sketch:
 
 There are 2 algorithms for creation of an Ellipse:
 
-.. image:: images/ellipse_cent_rad_32x32.png
+.. figure:: images/ellipse_cent_rad_32x32.png
    :align: left
+   :height: 24px
+
 **By center and major semi-axes and passing points** creates an ellipse with the given center passing through given points.
 
-.. image:: images/ellipse_axes_32x32.png
+.. figure:: images/ellipse_axes_32x32.png
    :align: left
+   :height: 24px
+
 **By major axis and passing point** creates an ellipse passing through the given three points.
 
+-------------------------------------------------------------------------------------------
+
 By center and major semi-axes and passing points
 """"""""""""""""""""""""""""""""""""""""""""""""
 
-.. image:: images/ellipse_panel_pt_rad.png
+.. figure:: images/ellipse_panel_pt_rad.png
    :align: center
 
 Click in the view once to set the center point, then move the mouse and click to set a point of a first semi-axis, then again move the mouse to set a point of a second semi-axis.
 
 **TUI Command**:
 
-.. py:function:: SketchEllipse_1 = Sketch_1.addEllipse(X1, Y1, X2, Y2, X3)
-.. py:function:: [SketchPoint_1, SketchPoint_2, SketchPoint_3, SketchPoint_4, SketchPoint_5, SketchPoint_6, SketchPoint_7, SketchLine_1, SketchLine_2] = SketchEllipse_1.construction(center = "aux", firstFocus = "aux", secondFocus = "aux", majorAxisStart = "aux", majorAxisEnd = "aux", minorAxisStart = "aux", minorAxisEnd = "aux", majorAxis = "aux", minorAxis = "aux")
+.. py:function:: Sketch_1.addEllipse(CenterX, CenterY, MajorAxisX, MajorAxisY, PassedX, PassedY, True)
 
-    :param real: Start X.
-    :param real: Start Y.
+    :param real: Center X.
+    :param real: Center Y.
+    :param real: Major Axis X.
+    :param real: Major Axis Y.
     :param real: Passed X.
     :param real: Passed Y.
+    :param boolean: True mentions that the first coordinates define the center of the ellipse.
     :return: Result object.
 
 By major axis and passing point
 """""""""""""""""""""""""""""""
 
-.. image:: images/ellipse_panel_3pt.png
+.. figure:: images/ellipse_panel_3pt.png
    :align: center
 
 Click in the view once to set a first point of a first axis, then move the mouse and click to set a second point of the first axis, then again move the mouse to set a point of a second semi-axis.
 
 **TUI Command**:
 
-.. py:function:: SketchEllipse_1 = Sketch_1.addEllipse(X1, Y1, X2, Y2, X3)
-.. py:function:: [SketchPoint_1, SketchPoint_2, SketchPoint_3, SketchPoint_4, SketchPoint_5, SketchPoint_6, SketchPoint_7, SketchLine_1, SketchLine_2] = SketchEllipse_1.construction(center = "aux", firstFocus = "aux", secondFocus = "aux", majorAxisStart = "aux", majorAxisEnd = "aux", minorAxisStart = "aux", minorAxisEnd = "aux", majorAxis = "aux", minorAxis = "aux")
+.. py:function:: Sketch_1.addEllipse(MajorAxisStartX, MajorAxisStartY, MajorAxisEndX, MajorAxisEndY, PassedX, PassedY, False)
 
-    :param real: Start X.
-    :param real: Start Y.
+    :param real: Major Axis Start X.
+    :param real: Major Axis Start Y.
+    :param real: Major Axis End X.
+    :param real: Major Axis End Y.
     :param real: Passed X.
     :param real: Passed Y.
+    :param boolean: False mentions that the first coordinates define the start point of major axis of the ellipse.
     :return: Result object.
 
 Result
@@ -63,10 +73,9 @@ Result
 
 Created ellipse appears in the view.
 
-.. image:: images/ellipse_result.png
-          :align: center
+.. figure:: images/ellipse_result.png
+   :align: center
 
-.. centered::
    Ellipse created