Salome HOME
Merge branch 'V8_4_BR'
[modules/gui.git] / doc / salome / gui / input / using_notebook.doc
index d48fe8fcb33daabf50684579c962dec0d76bbda3..ea7e81eebb5d08717b42767b848208a2c3730bbe 100644 (file)
@@ -2,15 +2,15 @@
 
 \page using_notebook Using NoteBook
 
-SALOME <b>NoteBook</b> is destined for managing numerical and boolean
-parameters (variables) which are used to create and modify objects in
-different components.
+SALOME <b>NoteBook</b> allows to predefine numerical and boolean
+parameters (variables).
 
-To open the <b>NoteBook</b> choose <b>File > Notebook</b>, the following
-dialog box will appear:
+By default, the <b>NoteBook</b> is located in a tabbed widget to the left (shared with the Object Browser).
 
 \image html notebook1.png
 
+To hide/show this tab choose <b>View > Windows > Notebook</b>.
+
 Here you can add new variables, remove and rename existing variables and 
 change their values.
 
@@ -18,9 +18,23 @@ If you have modified some variables, which are already used in the current
 study, you should click <b>Update Study</b> button to apply your changes
 to the study.
 
-\note The dialog will not be validated until at least one of variables in
-the table has invalid name or value (marked by red color). Names of
+\note The study can not be updated until at least one of the variables in
+the table has an invalid name or value (marked by red color). The names of
 variables should be unique and their values should be numerical (integer or
 double) or boolean ("True" / "False").
 
-*/
\ No newline at end of file
+Here is an example of setting variables in python scripts:
+\code
+import salome_notebook
+
+notebook = salome_notebook.notebook
+
+notebook.set("Length", 100)
+notebook.set("Radius", 37.5)
+notebook.set("Flag", True)
+\endcode
+
+Later these values can be used as parameters for any operations in
+various components.
+
+*/