Salome HOME
Issue #19190: group filter "on a solid"
[modules/shaper.git] / src / BuildPlugin / doc / compoundFeature.rst
index c3fc9761c59399313a12b4fadb241a29a1f4ec89..6ba8de92f4562f4a38864893bdf2300da2f1f5ae 100644 (file)
@@ -1,47 +1,44 @@
+.. |feature_compound.icon|    image:: images/feature_compound.png
 
 Compound
 ========
 
-The Compound feature creates a compound using already existing shapes in other objects.
+Compound feature creates a compound using shapes already existing in other objects.
 
-To create compound in the active part:
+To create compound in the active part:
 
 #. select in the Main Menu *Build - > Compound* item  or
-#. click **Compound** button in the toolbar
-
-.. image:: images/feature_compound.png
-  :align: center
-
-.. centered::
-  **Compound** button
+#. click |feature_compound.icon| **Compound** button in the toolbar
 
 The following property panel will be opened:
 
-.. image:: images/Compound.png
+.. figure:: images/Compound.png
   :align: center
 
-.. centered::
   Create a compound
 
-Select one or several shapes in a viewer. Selected shapes can be of any type (vertex, edge, face and so on).
+Select one or several shapes in the viewer. The selected shapes can be of any type (vertex, edge, face, etc.)
+
+**Apply** button creates a compound.
 
-**Apply** button creates compound.
+**Cancel** button cancels the operation. 
 
-**Cancel** button cancels operation. 
+**TUI Command**:
 
-**TUI Command**:  *model.addCompound(Part_doc, Shapes)*
+.. py:function:: model.addCompound(Part_doc, Shapes)
 
-**Arguments**:   Part document + list of shapes.
+    :param part: The current part object.
+    :param list: A list of shapes.
+    :return: Result object.
 
 Result
 """"""
 
-The result of the operation will be a compound created from selected shapes:
+The result of the operation will be a compound created from the selected shapes:
 
-.. image:: images/CreateCompound.png
+.. figure:: images/CreateCompound.png
   :align: center
 
-.. centered::
   Result of the operation.
 
-**See Also** a sample TUI Script of :ref:`tui_create_compound` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_compound` operation.