Salome HOME
Merge branch 'jfa/26449_1'
[modules/shaper.git] / src / ExchangePlugin / doc / dumpFeature.rst
index afdc0240705c7a1f00638ccd70aa145c975e1e9a..515271509f5226084ceaa690b2e6944386080eb0 100644 (file)
@@ -1,3 +1,36 @@
+.. |dump.icon|    image:: images/dump.png
 
 Dump
 ====
+
+The Dump feature allows exporting a current study to a Python script which dumps the study creation process as a sequence of Python commands.
+
+It is possible to dump the current study state into a Python script. To dump a study:
+
+#. select in the Main Menu *Part - > Dump* item  or
+#. click |dump.icon| **Dump** button in the toolbar.
+
+The following property panel will be opened:
+
+.. figure:: images/Dump_panel.png
+   :align: center
+
+   **Dump property panel**
+
+In this panel it is necessary to enter a file name directly or press **'...'** button and browse it with help of dump file dialog box:
+
+.. figure:: images/DumpFileDlg.png
+   :align: center
+
+   **Dump file dialog box**
+  
+**Apply** button writes the dump file.
+  
+**Cancel** button cancels the operation.
+
+**TUI Command**: Is not supported.
+
+Result
+""""""
+
+The Result of the operation is a Python file.