Salome HOME
Join modifications from branch BR_DEBUG_3_2_0b1
[modules/gui.git] / doc / salome / gui / GUI / dump_study.htm
diff --git a/doc/salome/gui/GUI/dump_study.htm b/doc/salome/gui/GUI/dump_study.htm
new file mode 100755 (executable)
index 0000000..660565d
--- /dev/null
@@ -0,0 +1,172 @@
+<!doctype HTML public "-//W3C//DTD HTML 4.0 Frameset//EN">\r
+\r
+<html>\r
+\r
+<head>\r
+<title>Dump Study</title>\r
+<meta http-equiv="content-type" content="text/html; charset=windows-1252">\r
+<meta name="generator" content="RoboHelp by eHelp Corporation www.ehelp.com">\r
+<link rel="stylesheet" href="default_ns.css"><script type="text/javascript" language="JavaScript" title="WebHelpSplitCss">\r
+<!--\r
+if (navigator.appName !="Netscape")\r
+{   document.write("<link rel='stylesheet' href='default.css'>");}\r
+//-->\r
+</script>\r
+<style type="text/css">\r
+<!--\r
+p.whs1 { font-weight:bold; margin-left:40px; }\r
+img_whs2 { border:none; width:461px; height:270px; float:none; border-style:none; }\r
+ul.whs3 { list-style:disc; }\r
+p.whs4 { margin-left:48px; }\r
+p.whs5 { font-family:'Times New Roman' , serif; margin-left:40px; }\r
+p.whs6 { margin-left:0px; }\r
+p.whs7 { margin-left:40px; }\r
+-->\r
+</style><script type="text/javascript" language="JavaScript">\r
+<!--\r
+if ((navigator.appName == "Netscape") && (parseInt(navigator.appVersion) == 4))\r
+{\r
+  var strNSS = "<style type='text/css'>";\r
+  strNSS += "p.whs6 {margin-left:1pt; }";\r
+  strNSS +="</style>";\r
+  document.write(strNSS);\r
+}\r
+//-->\r
+</script>\r
+<script type="text/javascript" language="JavaScript" title="WebHelpInlineScript">\r
+<!--\r
+function reDo() {\r
+  if (innerWidth != origWidth || innerHeight != origHeight)\r
+     location.reload();\r
+}\r
+if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {\r
+       origWidth = innerWidth;\r
+       origHeight = innerHeight;\r
+       onresize = reDo;\r
+}\r
+onerror = null; \r
+//-->\r
+</script>\r
+<style type="text/css">\r
+<!--\r
+div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }\r
+p.WebHelpNavBar { text-align:right; }\r
+-->\r
+</style><script type="text/javascript" language="javascript1.2" src="whmsg.js"></script>\r
+<script type="text/javascript" language="javascript" src="whver.js"></script>\r
+<script type="text/javascript" language="javascript1.2" src="whproxy.js"></script>\r
+<script type="text/javascript" language="javascript1.2" src="whutils.js"></script>\r
+<script type="text/javascript" language="javascript1.2" src="whtopic.js"></script>\r
+<script type="text/javascript" language="javascript1.2">\r
+<!--\r
+if (window.gbWhTopic)\r
+{\r
+       if (window.setRelStartPage)\r
+       {\r
+       addTocInfo("GUI module\nStudy management\nWorking with Python Scripts");\r
+addButton("show",BTN_IMG,"Show","","","","",0,0,"whd_show0.gif","whd_show2.gif","whd_show1.gif");\r
+addButton("hide",BTN_IMG,"Hide","","","","",0,0,"whd_hide0.gif","whd_hide2.gif","whd_hide1.gif");\r
+\r
+       }\r
+\r
+\r
+       if (window.setRelStartPage)\r
+       {\r
+       setRelStartPage("index.htm");\r
+\r
+               autoSync(1);\r
+               sendSyncInfo();\r
+               sendAveInfoOut();\r
+       }\r
+\r
+}\r
+else\r
+       if (window.gbIE4)\r
+               document.location.reload();\r
+//-->\r
+</script>\r
+</head>\r
+<body><script type="text/javascript" language="javascript1.2">\r
+<!--\r
+if (window.writeIntopicBar)\r
+       writeIntopicBar(4);\r
+//-->\r
+</script>\r
+<h1>Working with Python Scripts</h1>\r
+\r
+<p><span style="font-weight: bold;"><B>SALOME </B></span>Platform can be launched \r
+ in the batch mode, without Graphical User Interface, and operated with \r
+ the use of Python scripts, which can fulfill most of the necessary tasks, \r
+ however, the process of scripting is quite time consuming and rather error-prone. \r
+ </p>\r
+\r
+<p>This problem has been resolved by the possibility to automatically generate \r
+ a set of Python scripts from data created with SALOME GUI, which greatly \r
+ increases the productivity of using SALOME platform in the batch mode. \r
+ This mechanism can convert a SALOMEDS Study in one or several Python scripts, \r
+ which can be stored and imported later to re-create the content of the \r
+ original study. The first script is a SALOMEDS document, which re-creates \r
+ the SALOMEDS Study, adds the stored Salome components to the SALOMEDS \r
+ and automatically calls Python scripts of the second type containing component \r
+ specific Python function calls. This architecture gives great flexibility \r
+ in manual modification of the generated scripts because you can modify \r
+ only one of the component specific Python scripts without touching others, \r
+ thus avoiding expert knowledge of Python API of unused components. </p>\r
+\r
+<p>&nbsp;</p>\r
+\r
+<p>To Dump a &nbsp;SALOME \r
+ Study in one or several scripts, in the main menu select <span style="font-weight: bold;"><B>File</B></span> \r
+ --&gt; <span style="font-weight: bold;"><B>Dump study</B></span></p>\r
+\r
+<p>The following dialog box allowing to browse for the location and define \r
+ the name for a Python file will appear: </p>\r
+\r
+<p>&nbsp;</p>\r
+\r
+<p class="whs1"><img src="pics/dumpstudy.png" x-maintain-ratio="TRUE" width="461px" height="270px" border="0" class="img_whs2"></p>\r
+\r
+<p>&nbsp;</p>\r
+\r
+<ul type="disc" class="whs3">\r
+       \r
+       <li class=kadov-p><p class="whs4"><span style="font-weight: bold;"><B>Publish \r
+ in study - </B></span>if checked in, the component objects created by Python \r
+ commands will be published in the created Study when the script is played, \r
+ otherwise the objects will not be published in the Study.</p></li>\r
+       \r
+       <li class=kadov-p><p class="whs4"><span style="font-weight: bold;"><B>Save \r
+ GUI state</B></span> - if checked in, the current application layout will \r
+ be saved in the Python file. &nbsp;</p></li>\r
+</ul>\r
+\r
+<p>&nbsp;</p>\r
+\r
+<p class="whs5">To \r
+ confirm your choice click <span style="font-weight: bold;"><B>Save</B></span>.</p>\r
+\r
+<p class="whs5">&nbsp;</p>\r
+\r
+<p class="whs6">Reversibly it is possible to load a saved \r
+ Python Script selecting in the main menu <span style="font-weight: bold;"><B>File</B></span> \r
+ -&gt; <span style="font-weight: bold;"><B>Load Script</B></span>. </p>\r
+\r
+<p class="whs6">&nbsp;</p>\r
+\r
+<p class="whs7"><img src="pics/loadscript.png" x-maintain-ratio="TRUE" width="461px" height="270px" border="0" class="img_whs2"></p>\r
+\r
+<p>&nbsp;</p>\r
+\r
+<p class="whs5">To \r
+ confirm your choice click <span style="font-weight: bold;"><B>Open.</B></span></p>\r
+\r
+<p>&nbsp;</p>\r
+\r
+<script type="text/javascript" language="javascript1.2">\r
+<!--\r
+if (window.writeIntopicBar)\r
+       writeIntopicBar(0);\r
+//-->\r
+</script>\r
+</body>\r
+</html>\r