Salome HOME
Issue #2998: Add help description for automatic creation of constraints
[modules/shaper.git] / src / PartSetPlugin / doc / PartSetPlugin.rst
index 70d009b7dfbe66ee8087064a89e801da2b45af67..df635b9b2d43b429fc029989c788bd82d44fea2f 100644 (file)
@@ -1,47 +1,43 @@
+.. |new_part.icon|    image:: images/new_part.png
+.. |remove.icon|    image:: images/remove.png
+.. |duplicate.icon|    image:: images/duplicate.png
 
 .. _partPlugin:
 
 Part plug-in
 ============
 
+.. _new-part:
+
 New Part
 --------
 
 To create a New Part:
 
 #. select in the Main Menu *Part - > New part* item  or
-#. click **New part** button in Shaper toolbar:
-
-.. image:: images/new_part.png
-  :align: center
+#. click |new_part.icon| **New part** button in Shaper toolbar:
 
-.. centered::
-   New part button 
+**TUI Command**:
 
-**TUI Command**: *model.addPart(partSet)*
+.. py:function:: model.addPart(partSet)
 
-**Arguments**:  1 partset 
+    :param part: The current part object.
+    :return: Result object.
 
 Result
 """"""
 
 Created empty part is activated and appears in the object browser.
 
-**See Also** a sample TUI Script of :ref:`tui_create_part` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_part` operation.
 
 Duplicate Part
 --------------
 
-To duplicate active Part:
+To duplicate an active Part:
 
 #. select in the Main Menu *Part - > Duplicate part* item  or
-#. click **Duplicate part** button in Shaper toolbar:
-
-.. image:: images/duplicate.png 
-  :align: center
-
-.. centered::
-   Duplicate part button    
+#. click |duplicate.icon| **Duplicate part** button in Shaper toolbar:
 
 Result
 """"""
@@ -53,16 +49,10 @@ Copied part contains all objects existing in the source part.
 Remove Part
 -----------
 
-To remove active Part:
+To remove an active Part:
 
 #. select in the Main Menu *Part - > Remove part* item  or
-#. click **Remove part** button in Shaper toolbar:
-
-.. image:: images/remove.png 
-  :align: center
-
-.. centered::
-   Remove part button    
+#. click |remove.icon| **Remove part** button in Shaper toolbar:
 
 Result
 """"""