Task #3016: 3.2 To add a mode «through all» for features RevolutionCut and RevolutionFuse

[modules/shaper.git] / src / FeaturesPlugin / doc / translationFeature.rst

diff --git a/src/FeaturesPlugin/doc/translationFeature.rst b/src/FeaturesPlugin/doc/translationFeature.rst
index 47099261a7ec899c36e100a510134189cd3f7e88..5c552c2171b1ddc97051e9afcbabd67dc88b103c 100644 (file)
--- a/src/FeaturesPlugin/doc/translationFeature.rst
+++ b/src/FeaturesPlugin/doc/translationFeature.rst
@@ -1,19 +1,15 @@
+.. _featureTranslation:
+.. |translation_vector_32x32.icon|    image:: images/translation_vector_32x32.png
 
 Translation
 ===========
 
-The feature **Translation** makes translation of a selected shape.
+**Translation** feature translates a selected shape.
 
-To create Translation in the active part:
+To create a Translation in the active part:
 
 #. select in the Main Menu *Part - > Translation* item  or
-#. click **Translation** button in the toolbar
-
-.. image:: images/translation_vector_32x32.png   
-   :align: center
-
-.. centered::
-   **Translation** button 
+#. click |translation_vector_32x32.icon| **Translation** button in the toolbar
 
 The Vector of translation can be defined in three different ways:
 
@@ -40,18 +36,24 @@ Translation by axis and distance
 
 Input fields:
 
-- **Main objects** panel contains shapes to be translated. Shapes are selected in 3D OCC viewer or object browser;
-- **Axis**  defines vector along which the object will be translated. Vector is edge, axis selected in 3D OCC viewer or object browser;
+- **Main objects** panel contains shapes to be translated. The shapes are selected in 3D OCC viewer or object browser;
+- **Axis**  defines a vector along which the object will be translated. The vector is an edge or axis selected in 3D OCC viewer or object browser;
 - **Distance** defines the distance along the **Vector of translation**.
 
-**TUI Command**:  *model.addTranslation(Part_doc, [shape], axis, dist)*
+**TUI Command**:
 
-**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + axis in format *model.selection(TYPE, shape)*+ real (distance value).
+.. py:function:: model.addTranslation(Part_doc, [shape], axis, dist)
+
+    :param part: The current part object.
+    :param list: A list of shapes in format *model.selection(TYPE, shape)*.
+    :param object: axis in format *model.selection(TYPE, shape)*.
+    :param real: Distance value.
+    :return: Result object.
 
 Result
 """"""
 
-Result of operation is shifted initial shape.
+The result of operation is a shifted initial shape.
 
 .. image:: images/translation_XYZ.png
    :align: center
@@ -72,17 +74,24 @@ Translation by vector
 
 Input fields:
 
-- **Main objects** panel contains shapes to be translated. Shapes are selected in 3D OCC viewer or object browser;
+- **Main objects** panel contains shapes to be translated. The shapes are selected in 3D OCC viewer or object browser;
 - **DX**, **DY**, **DZ**  define vector using coordinates along the axis.
 
-**TUI Command**:  *model.addTranslation(Part_1_doc, [shape], DX, DY, DZ)*
+**TUI Command**:
 
-**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + 3 real (coordinate values).
+.. py:function:: model.addTranslation(Part_1_doc, [shape], DX, DY, DZ)
+
+    :param part: The current part object.
+    :param list: A list of shapes in format *model.selection(TYPE, shape)*.
+    :param real: dX value.
+    :param real: dY value.
+    :param real: dZ value.
+    :return: Result object.
 
 Result
 """"""
 
-Result of operation is shifted initial shape.
+The result of operation is a shifted initial shape.
 
 .. image:: images/translation_vector.png
    :align: center
@@ -90,7 +99,7 @@ Result of operation is shifted initial shape.
 .. centered::
    Translation by vector
 
-**See Also** a sample TUI Script of a :ref:`tui_translation_DXDYDZ` operation.
+**See Also** a sample TUI Script of :ref:`tui_translation_DXDYDZ` operation.
 
 
 Translation by two points
@@ -108,14 +117,20 @@ Input fields:
 - **Start point**  defines start vector point as point or vertex selected in 3D OCC viewer or object browser;
 - **End point**  defines end vector point as point or vertex selected in 3D OCC viewer or object browser;
   
-**TUI Command**:  *model.addTranslation(Part_doc, [shape], point1, point2)*
+**TUI Command**:
+
+.. py:function:: model.addTranslation(Part_doc, [shape], point1, point2)
 
-**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + 2 points in format *model.selection(TYPE, shape)*.
+    :param part: The current part object.
+    :param list: A list of shapes in format *model.selection(TYPE, shape)*.
+    :param object: A point in format *model.selection(TYPE, shape)*.
+    :param object: A point in format *model.selection(TYPE, shape)*.
+    :return: Result object.
 
 Result
 """"""
 
-Result of operation is shifted initial shape.
+The result of operation is a shifted initial shape.
 
 .. image:: images/translation_2points.png
    :align: center
@@ -123,5 +138,5 @@ Result of operation is shifted initial shape.
 .. centered::
    Translation by two points
 
-**See Also** a sample TUI Script of a :ref:`tui_translation_2points` operation.
+**See Also** a sample TUI Script of :ref:`tui_translation_2points` operation.