Salome HOME
Correct documentation bugs, adapt for 'Read The Docs' theme (bos #18858)
[modules/shaper.git] / src / SketchPlugin / doc / projectionFeature.rst
index 03d281ae6e47d86a58f56df45b48f0d1c654d0b3..cee5550e051a08d7b8695c1d8d3c87bd4b64634f 100644 (file)
@@ -1,20 +1,15 @@
+.. |projection.icon|    image:: images/Projection.png
 
 Projection
 ==========
 
-| The Projection operation creates projection of 3D edge or vertex onto the sketch plane.
+| The Projection operation creates projection of 3D edge or vertex onto the sketch plane.
 | The result of projection is a line.
 
-To create Projection in the active Sketch:
+To create Projection in the active Sketch:
 
 #. select in the Main Menu *Sketch - > Projection* item  or
-#. click **Projection** button in Sketch toolbar:
-
-.. image:: images/projection.png
-   :align: center
-
-.. centered::
-   **Projection**  button
+#. click |projection.icon| **Projection** button in Sketch toolbar:
 
 Property panel:
 
@@ -29,15 +24,19 @@ Input fields:
 - **Object** is the 3D object (edge or vertex) to project onto the sketch plane.
 - **Include into the sketch result** option defines whether to include the projection line into the sketch result.
 
-**TUI Command**:
+**TUI Commands**:
 
-- *Sketch_1.addProjection(EdgeOrVertex, IncludeIntoResult)*
+.. py:function:: Sketch_1.addProjection(EdgeOrVertex, IncludeIntoResult)
 
-  **Arguments**: edge or vertex and include into the result flag
+    :param object: Edge or vertex.
+    :param boolean: Include into the result flag.
+    :return: Result object.
 
-- *Sketch_1.addProjection(EdgeOrVertexName, IncludeIntoResult)*
+.. py:function:: Sketch_1.addProjection(EdgeOrVertexName, IncludeIntoResult)
 
-  **Arguments**: edge or vertex name and include into the result flag
+    :param object: Edge or vertex name.
+    :param boolean: Include into the result flag.
+    :return: Result object.
 
 Result
 """"""
@@ -48,6 +47,6 @@ Created Projection appears in the view.
           :align: center
 
 .. centered::
-   Projection created (purple line)
+   Created projection (purple line)
 
-**See Also** a sample TUI Script of a :ref:`tui_create_projection` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_projection` operation.