Salome HOME
refs #676: repairing of the documentation system and help
[modules/hydro.git] / doc / salome / gui / HYDRO / input / preferences.doc
diff --git a/doc/salome/gui/HYDRO/input/preferences.doc b/doc/salome/gui/HYDRO/input/preferences.doc
new file mode 100644 (file)
index 0000000..dc5a065
--- /dev/null
@@ -0,0 +1,64 @@
+
+/
+/**
+  @file
+  \brief Help for the HYDRO module Preferences
+*/
+
+/**
+  \page preferences Preferences
+
+ <a href="index.html"><b>Back to Main page</b></a>
+
+
+  Salome application supports Preferences. The Preferences dialog box can be called via:<ol>
+
+  <li> The main menu <b>File => Preferences</b>;  </li>
+  
+  <li> <b>CTRL + R</b> buttons combination.</li>
+ </ol>
+  
+  
+
+  <b>Preferences</b> dialog box appears. Help for all sections of  <b>Preferences</b> dialog box except HYDRO can be found in Introduction to Salome platform.
+
+The user selects <b>HYDRO</b> in Available preferences section:
+ \image html preferences.png  "Preferences dialog box"
+  
+
+ Controls inside <b>Preferences</b> dialog box:
+
+<b>Type</b> - combo - box to select the cursor presentation for edition operation;<br>
+
+\image html preferences_type.png  "Type combo-box in Preferences dialog box"
+
+<b>Make automatic fit all after show object operation</b> - check - box swith on/off Fit all;<br>
+<b>Default Strickler coefficient</b> field is used for Strickler coefficient asigned to area not covered by land cover or land cover with undefined type;<br>
+<b>OK</b> - button to validate changes and close dialog box;<br>
+<b>Apply</b> - button to validate changes;<br>
+<b>Defaults</b> - button to restore default values in all fields;<br>
+<b>Close</b> - button to close dialog box;<br>
+<b>Import</b> - button to import Preferences from external xml file.
+
+ The user clicks <b>Import</b> button. <b>Import preferences</b> dialog box appears:
+
+\image html preferences_import.png  "Import preferences dialog box"
+  
+  
+
+The user selects folder in <b>Look in</b> filed and desired file in this folder.
+
+The user clicks <b>Open</b> button.
+
+<b>Import preferences</b> dialog box is closed. Prefernces are updated.
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+*/