Issue #3223: Improve Python dump readability

[modules/shaper.git] / src / CollectionPlugin / doc / fieldFeature.rst

diff --git a/src/CollectionPlugin/doc/fieldFeature.rst b/src/CollectionPlugin/doc/fieldFeature.rst
index a3f8cdaebd108fe92cf7ae8254ef3cea9bdbb016..de8516f841e5bf552561e9bcab46d325ea56b4bd 100644 (file)
--- a/src/CollectionPlugin/doc/fieldFeature.rst
+++ b/src/CollectionPlugin/doc/fieldFeature.rst
@@ -1,3 +1,4 @@
+.. |field.icon|    image:: images/field.png
 
 Field
 =====
@@ -11,20 +12,13 @@ The field can include several sets of data called steps, each dedicated to a cer
 To create a Field in the active part:
 
 #. select in the Main Menu *Features - > Field* item  or
-#. click **Field** button in Shaper toolbar:
-
-.. image:: images/field.png
-  :align: center
-
-.. centered::
-   Field button
+#. click |field.icon| **Field** button in the toolbar:
 
 The following property panel appears. 
 
-.. image:: images/field_property_panel.png
+.. figure:: images/field_property_panel.png
   :align: center
 
-.. centered::
   Create a field
 
 Input fields:
@@ -58,13 +52,39 @@ Input fields:
 - **Add Step** button adds a new time step;
 - **Remove Step** button deletes the current time step.
 
+**Visualization of field**
+
+When a field is created then its result in data tree looks like following.
+
+.. figure:: images/field_steps_tree.png
+  :align: center
+
+  Result of created field with two steps.
+  
+It consists of a Field result object and steps as sub-objects. Only one object can be displayed at one moment: field or one of its step. Field result presentation repersents entities used for the Field definition.
+Step presentation shows field entities and values defined on them. For example a step defined on faces with double values looks like following.
+
+.. figure:: images/step_faces_double.png
+  :align: center
+
+Color bar for displayed step is shown only if the setep is selected in **Object Browser**. Desirable parameters of the Color bar (position, number of intervals, text color) can be defined in **Preferences** dialog box.
  
-**TUI Command**: *model.addField(Part_1_doc, 2, "DOUBLE", 2, ["DX", "DY"], [model.selection("FACE", "Box_1_1/Left"), model.selection("FACE", "Box_1_1/Top")])*
+**TUI Commands**:
+
+.. py:function:: model.addField(Part_1_doc, 2, "DOUBLE", 2, ["DX", "DY"], [model.selection("FACE", "Box_1_1/Left"), model.selection("FACE", "Box_1_1/Top")])
 
-**Arguments**:  1 part + integer (number of steps) + text (Type of field) + integer (number of components) + list of text (names of components) + list of objects
+    :param part: The current part object
+    :param integer: Number of steps
+    :param text: Type of the field
+    :param integer: Number of components
+    :param list: List of components names
+    :param list: List of objects
+    :return: the created field object
 
-**TUI Command**: *Field_1.addStep(step, stamp, [[0.1, 0.2], [2.1, 1.7], [3.7, 1.95]])*
+.. py:function:: Field_1.addStep(step, stamp, [[0.1, 0.2], [2.1, 1.7], [3.7, 1.95]])
 
-**Arguments**:  2 integers + list of lists of values with Type of field
+    :param integer: step id
+    :param integer: time stamp id
+    :param list: list of lists of values with Type of field
 
 **See Also** a sample TUI Script of :ref:`tui_create_field` operation.