Correct documentation bugs, adapt for 'Read The Docs' theme (bos #18858)

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

diff --git a/src/SketchPlugin/doc/translationFeature.rst b/src/SketchPlugin/doc/translationFeature.rst
index 6221fd8236aeeb6bf06bbe9c661d2407cef19cd1..0d682cfb8fd5ecf35bc2a062ccbca172f3a7ea0f 100644 (file)
--- a/src/SketchPlugin/doc/translationFeature.rst
+++ b/src/SketchPlugin/doc/translationFeature.rst
@@ -1,19 +1,14 @@
+.. |translate.icon|    image:: images/translate.png
 
 Linear copy
 ===========
 
-Linear copy operation creates one or multiple copies of the skecth entities along a vector defined by two points.
+Linear copy operation creates one or multiple copies of the sketch entities along a vector defined by two points.
 
-To create Linear copy in the active Sketch:
+To create a Linear copy in the active Sketch:
 
 #. select in the Main Menu *Sketch - > Linear copy* item  or
-#. click **Linear copy** button in Sketch toolbar:
-
-.. image:: images/translate.png
-   :align: center
-
-.. centered::
-   **Linear copy**  button
+#. click |translate.icon| **Linear copy** button in Sketch toolbar:
 
 Property panel:
 
@@ -23,33 +18,38 @@ Property panel:
 .. centered::
    Linear copy
 
+
+.. |single_value| image:: images/translate_32x32.png
+.. |full_value| image:: images/translate_full_32x32.png
+
 Input fields:
 
 - **Segments** is the list of segments (lines, circles, arcs) selected in the view.
 - **Single value/Full value** option:
-
-  .. image:: images/translate_32x32.png
-     :align: left
-  **Single value**: step of translation is equal to the distance between the start and the end point.
-
-  .. image:: images/translate_full_32x32.png
-     :align: left
-  **Full value**: distance from the originals to the farthest copies is equal to the distance between the start and the end point.
+   | |single_value| **Single value**: step of translation is equal to the distance between the start and the end point.
+   | |full_value| **Full value**: distance from the originals to the farthest copies is equal to the distance between the start and the end point.
 - **Start point** is the initial point of translation vector.
 - **End point** is the terminal point of translation vector.
 - **Total number of objects** is the total number of objects including the original one.
 
 
-**TUI Command**: *Sketch_1.addTranslation(Objects, Point1, Point2, NumberOfObjects, FullValue)*
+**TUI Command**:
+
+.. py:function:: Sketch_1.addTranslation(Objects, Point1, Point2, NumberOfObjects, FullValue)
 
-**Arguments**:   list of objects + start and end points + number of objects + full value flag
+    :param list: A list of objects.
+    :param object: Start point.
+    :param object: End point.
+    :param integer: Number of objects.
+    :param boolean: Full value flag.
+    :return: Result object.
 
 Result
 """"""
 
 Created Linear copy appears in the view.
 
-| The original and a linear copy objects are marked with the special sign.
+| The original and a linear copy objects are marked with a special sign.
 | Copy objects are drawn with a thinner line.
 
 .. image:: images/Linear_res.png
@@ -58,4 +58,4 @@ Created Linear copy appears in the view.
 .. centered::
    Linear copy created
 
-**See Also** a sample TUI Script of a :ref:`tui_create_translation` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_translation` operation.