]> SALOME platform Git repositories - modules/gui.git/commitdiff
Salome HOME
Update SALOME User's guide:
authorrnv <rnv@opencascade.com>
Wed, 18 Apr 2012 11:34:24 +0000 (11:34 +0000)
committerrnv <rnv@opencascade.com>
Wed, 18 Apr 2012 11:34:24 +0000 (11:34 +0000)
1) Remove from SALOME GUI User's guide Install Wizadr help page.
2) Move module preferences help pages from GUI User's guide to the module User's guide.

doc/salome/gui/input/geometry_preferences.doc [deleted file]
doc/salome/gui/input/index.doc
doc/salome/gui/input/installing_salome.doc [deleted file]
doc/salome/gui/input/introduction_to_gui.doc
doc/salome/gui/input/mesh_preferences.doc [deleted file]
doc/salome/gui/input/postpro_preferences.doc [deleted file]
doc/salome/gui/input/salome_preferences.doc [deleted file]
doc/salome/gui/input/setting_preferences.doc
doc/salome/gui/input/using_object_browser.doc

diff --git a/doc/salome/gui/input/geometry_preferences.doc b/doc/salome/gui/input/geometry_preferences.doc
deleted file mode 100644 (file)
index 3930c03..0000000
+++ /dev/null
@@ -1,94 +0,0 @@
-/*!
-
-\page geometry_preferences_page Geometry preferences
-
-In the \b Geometry module you can set preferences for visualisation of
-geometrical figures which can be used in later sessions with this
-module.
-There is also a special group of preferences controlling input precision for floating-point
-data.
-
-\image html pref15.png
-
-\par
-For all color definitions click on the respective line to access to
-the \ref select_color_and_font_page "Select Color" dialog box.
-
-<ul>
-<li><b>General</b></li>
-<ul>
-<li><b>Default display mode</b> - allows to choose between wireframe, shading or 
-shading with edges.</li>
-<li><b>Default shading color</b> - allows to select default shading
-color.</li>
-<li><b>Edges in shading</b> - allows to select default edges color in shading mode.</li>
-<li><b> Default wireframe color</b> - allows to select default
-wireframe color (to be applied to any lines not being free boundaries
-or isolated lines).</li>
-<li><b>Color of free boundaries</b> - allows to select default color for free boundaries.</li>
-<li><b>Color of edges, vectors and wires</b> - allows to select
-default color for edges, vectors and wires (isolated lines).</li>
-<li><b>Color of points</b> - allows to select default color for
-vertices.</li>
-<li><b>Color of isolines</b> - allows to select default color for
-isolines.</li>
-<li><b>Step value for spin boxes</b> - allows to define the increment
-of values set in spin boxes.</li>
-<li><b>Deflection coefficient</b> - allows to define default deflection
-coefficient for lines and surfaces. A smaller coefficient provides
-better quality of a shape in the viewer.</li>
-<li><b>Default front material</b> - allows to define default front face material.</li>
-<li><b>Default back material</b> - allows to define default back face material.</li>
-<li><b>Edges width</b> - allows to define default width of the edges.</li>
-<li><b>Isolines width</b> - allows to define default width of the isolines.</li>
-<li><b>Preview edges width</b> - allows to define width of the edges for preview.</li>
-<li><b>Measures line width</b> - allows to define lines width of measurements tools.</li>
-
-</ul>
-</ul>
-
-<ul>
-<li><b>Input fields precision</b></li>
-<ul>
-<li><b>Length precision</b> - allows to ajust input precision of coordinates and dimensions.</li>
-<li><b>Angular precision</b> - allows to ajust input precision of angles.</li>
-<li><b>Length tolerance precision</b> - allows to ajust input precision of tolerance of coordinates and dimensions.</li>
-<li><b>Angular tolerance precision</b> - allows to ajust input precision of tolerance of angles.</li>
-<li><b>Weight precision</b> - allows to ajust input precision of weight and mass.</li>
-<li><b>Density precision</b> - allows to ajust input precision of density.</li>
-<li><b>Parametric precision</b> - allows to ajust input precision of parametric values.</li>
-<li><b>Parametric tolerance precision</b> - allows to ajust input precision of tolerance in parametric space.</li>
-</ul>
-</ul>
-
-<ul>
-<li><b>Marker of Points</b></li>
-<ul>
-<li><b>Type</b> - allows to select the symbol for representation of
-points (cross, asterisk, etc.).</li>
-<li><b>Size</b> - allows to define the size of the marker from 1
-(smallest) to 7 (largest).</li>
-</ul>
-</ul>
-
-<ul>
-<li><b>Origin and base vectors</b></li>
-<ul>
-<li><b>Length of base vectors</b> - allows to define the length
-of base vectors.</li>
-<li><b>Auto create</b> - allows to automatically create a point
-of origin and three base vectors of the rectangular coordinate
-system immediately after the module activation.</li>
-</ul>
-</ul>
-
-
-<ul>
-<li><b>Operations</b></li>
-<ul>
-<li><b>Preview</b> - allows to customize the displaying preview by default.</li>
-</ul>
-</ul>
-
-
-*/
index e986d0923c3db377e1259a27534f10b48a7baf40..f86d4028bc4e454bff4dff56469896800e9782e0 100644 (file)
@@ -68,10 +68,8 @@ integrated Python console
 </ul>
 
 From the point of view of the \subpage salome_architecture_page "Architecture", 
-Salome is composed of several modules, which provides a
-great flexibility in its structure during 
-\subpage installing_salome_page "Installation" and
-\subpage running_salome_page "Running".
+Salome is composed of several modules. 
+To run salome (with different options) refer to \subpage running_salome_page page.
 
 This part of documentation on Salome also covers 
 \subpage introduction_to_gui_page "general Salome functionalities",
diff --git a/doc/salome/gui/input/installing_salome.doc b/doc/salome/gui/input/installing_salome.doc
deleted file mode 100644 (file)
index f03bbee..0000000
+++ /dev/null
@@ -1,710 +0,0 @@
-/*!
-
-\page installing_salome_page SALOME Installation Wizard Help
-
-<hr>
-<ul>
-<li>\ref installing_products "Installing products with the Installation Wizard"
-<ul>
-<li>\ref gui_mode_install "GUI mode"
-<li>\ref batch_mode_install "Batch mode"
-<li>\ref environment_files "Environment files"
-</ul>
-<li>\ref pick_up_env "Pick up the environment"
-<li>\ref modifying_xml "Modifying XML configuration file"
-<li>\ref installation_scripts "Implementing installation scripts for the new products"
-<li>\ref finish_buttons "Customizing Readme page buttons"
-</ul>
-<hr>
-\anchor installing_products 
-<h2>Installing products with the <em>Installation Wizard</em></h2>
-
-The Installation Wizard can be launched in two modes: \b GUI and \b
-batch.
-<br>The root directory of the Installation Wizard contains Python
-script \b runInstall. To run the Installation Wizard just type \b runInstall.
-in the terminal window:
-<br><br>[ python ] \b runInstall [options]
-
-Without options this script will launch the SALOME Installation
-Wizard in the default mode (GUI). \n The default installation settings
-can be overridden by using command line options. Each option has a
-short and a long notation:
-
-<b>-g / --gui</b>
-\par
-Runs the Installation Wizard in the GUI mode (this is the default
-mode).
-
-<b>-b / --batch</b>
-\par
-Runs the Installation Wizard in the terminal mode.
-
-<b>-f FILE / --file=FILE</b>
-\par
-The XML configuration file to be used by the Installation Wizard.  If
-this option is not used then the installation script tries to define
-the \e Linux version and use the corresponding XML file if it exists. For
-examle, for <em>Linux Mandrake 10.1</em>  the <b>config_Mandrake_10.1.xml</b>  file
-will be used by default. If no appropriate file is found, the file
-<b>config.xml</b> will be used. This file refers to the basic target platform 
-which is <em>Linux Mandrake 10.1</em> for SALOME 3.0 and newer. If <b>config.xml</b>
-file is not found either, a warning message box is shown (in GUI mode)
-or printed to the console (in batch mode) and the Installation Wizard 
-quits.
-
-<b>-d DIR / --target=DIR</b>
-\par
-The target directory SALOME platform is to be installed to. 
-If used, this option overrides the default target directory, given in
-the configuration XML file (usually <b>${HOME}/salome_\<version\></b>, 
-see \ref modifying_xml "here" for more details).
-
-<b>-t DIR / --tmp=DIR</b>
-\par
-The directory, which should be used for temporary files. If given,
-this option overrides the default temporary directory, given in the
-configuration xml file (usually \b /tmp, see \ref modifying_xml "here"
-for more information).
-
-<b>-a / --all-from-sources</b>
-\par
-Forces all the products to be installed from sources (including all
-SALOME modules). If this option is used, all default installation
-modes for all products are ignored.
-\n This option is helpful when the user wants to install SALOME on the
-platform which is not officially supported. In this case, the user can
-try to run the SALOME Installation Wizard with the \b -a option in order
-to build all the products from sources.
-\n<b>Note, that this is a time-consuming operation which can take
-more than 24 hours depending on the computer.</b>
-
-<b>-s / --single-directory</b>
-\par
-Install all SALOME binaries packages to one directory. <br><b>
-This option is ignored when --all-from-sources (-a) option is used.</b>
-
-<b>-h / --help</b>
-\par
-Prints help information on the Installation Wizard's use.
-
-<b>-v / --version</b>
-\par
-Prints version information (\b Note: this is the Installation Wizard's
-version number, not the number of SALOME platform version).
-
-The installation procedure supports different \em Linux platforms and
-installs various installation 3d-party prerequisite products which are
-required by SALOME platform. As it was mentioned above, the basic
-target platform for SALOME 3.0 and newer is <em>Linux Mandrake 10.1</em>.
-Use of configuration XML files gives a flexible way to modify the list
-of products to be installed by the Installation Wizard without
-changing the program source code. Just create your own XML
-configuration file and implement installation scripts for the
-prerequisite products you need and then use this XML file with the
-Installation Wizard. This can be done, for example, for some Linux
-platform which is not supported directly by the Installation
-Wizard. See \ref modifying_xml "Modifying XML configuration file" and
-\ref installation_scripts "Implementing installation scripts for the new products"
-sections for more information.
-
-<br>
-<hr>
-\anchor gui_mode_install
-<h2>GUI mode</h2>
-
-The <b>Installation Wizard</b> GUI has been developed using
-Trolltech's <b>Qt 3.0.5</b> toolkit. After launching the Installation
-Wizard in the GUI mode the wizard window is shown to the user. This
-wizard guides the user through several subsequent pages. To navigate
-between the pages use \em "Next" and \em "Back" buttons in the lower
-part of the wizard window. The \em "Cancel" button closes the wizard
-window and quits the installation procedure after the user's
-confirmation. The \em "Help" button opens an additional window to show
-help information.
-
-The first \em "Introduction" page is shown in \ref figure_1 "Figure 1". 
-Skip this page by clicking \em "Next":
-
-\anchor figure_1
-\image html intropage.png 
-\n <center><b>Figure 1:</b> "Introduction" page</center>
-
-In the second page you are proposed to select the type of the SALOME installation.<br><br>
-At this step three possible types of installation are available:
-
-1. <b><em>"Install binaries"</em></b> type:
-\par
-    - all binaries and sources of the chosen modules are installed;
-    - all binaries of the chosen prerequisites are installed.
-
-2. <b><em>"Install sources"</em></b> type:
-\par
-    - all sources of the chosen modules and prerequisites are installed without compilation.
-
-3. <b><em>"Install sources and make compilation"</em></b> type:
-\par
-    - all sources of the chosen modules and prerequisites are installed;<br>
-    - all sources are compiled.
-
-In case you select "Install sources and make compilation" installation type, then you can also check "Remove sources and temporary files after compilation" option.
-
-\anchor figure_2
-\image html installtypepage.png
-\n <center><b>Figure 1:</b> "Type Of Installation" page</center>
-
-After the installation type has been selected you click "Next" button and the Installation Wizard tries to determine the Linux platform to load the corresponding configuration file. If the user system is not defined or the current SALOME package does not support this one, the warning will appear (<em>"Install binaries"</em> and <em>"Install sources"</em> installation types only):
-
-\anchor figure_3
-\image html platformpage.png
-\n <center><b>Figure 3:</b> "Installation platform" page</center>
-
-If <em>"Install sources and make compilation"</em> installation type has been selected, the warning message will be slightly different: <em>"Your Linux platform is not supported by this SALOME package and compilation is not tested on this one".</em><br>
-There is a list of all platforms supported by SALOME, but only those supported by the current package are available for selection. in this page you need to to select the reference platform, if you wish to proceed with the present installation procedure.
-
-\b Note: this page is not displayed if the installation platform has been defined automatically.
-
-In the next page you are proposed to enter the target directory
-where the SALOME platform should be installed to. You can also click
-<em>"Browse..."</em> and choose the destination folder using the standard
-browse directory dialog box.
-\n If the necessary directory does not exist you
-are prompted to confirm directory creation. If you type a wrong
-directory path, or if you do not have write permissions 
-for the directory you use, the corresponding message box is shown.
-
-<b> Note: you are strongly recommended to avoid using directory names containing spaces.</b> Otherwise you can experience some troubles with the installation.
-\n
-\anchor figure_4
-\image html directorypage.png
-\n <center><b>Figure 4:</b> "Installation directory" page</center>
-
-You can select the products to be installed in the "Choice of the products to be installed" page.
-\n In the default mode it gives you the possibility to view and select SALOME modules only. There is a hidden list of 3d-party prerequisite products. To show it, just click <em>"Show prerequisites..."</em> button.
-
-\anchor figure_5
-\image html productpage1.png
-\n <center><b>Figure 5:</b> Choice of the SALOME modules</center>
-
-In the full mode you also have the possibility to select prerequisites.
-\n The checkbox before each product indicates if this one will be installed or not (checked or unchecked). The second column shows the disk space occupied by the corresponding module. This value depends on the selected type of installation.
-\n To hide the prerequisites list - click <em>"Hide prerequisites"</em> button.
-
-\anchor figure_6
-\image html productpage2.png
-\n <center><b>Figure 6:</b> Choice of the prerequisites</center>
-
-Some products may require some other prerequisite products to be installed. So the installation procedure has a special feature to automatically mark these products in the list view. For example, to install PyQt it is necessary to have gcc, Python, Qt and Sip installed, and these products will be also turned on when you check on PyQt. GEOM module requires KERNEL, GUI modules and such prerequisites as: OpenCascade, Python, Swig, Qt, etc.
-\n
-\n The dependencies between SALOME modules are managed in the following way:
-\par
-- If one module is unchecked, all modules which depend on this one are also unchecked automatically;\n
-- If one module is checked, all modules required for this one are also checked automatically.
-
-Dependency between modules and prerequisites is realized in the following way:
-\par
--  The choices made by the user in the list of modules have a direct impact on the list of prerequisites;
-- Whenever a module is checked, all the necessary prerequisites are checked automatically with no possibility for the user to uncheck them (see \ref figure_7 "Fig. 7" below);
-- Whenever a module is unchecked, according to the remaining checked modules, the unnecessary prerequisites are unchecked automatically (see \ref figure_7 "Fig. 7" below).
-
-It is possible to check again the prerequisites, which have been automatically unchecked. In other words, it is possible to add more prerequisites than necessary.
-
-\anchor figure_7
-\image html productpage3.png
-\n <center><b>Figure 7:</b> Dependencies between modules and prerequisites</center>
-
-The <em>"Installation with GUI"</em> checkbox allows managing the installation of the graphical interface. Only modules for that 'woguimode' attribute is set to "true" value in the XML file (see \ref modifying_xml "here" for more information about customizing this installation mode) support without GUI mode and will be checked and installed with their necessary prerequisites in case of installation without GUI. And other modules are unchecked with no possibility to check them in this mode (see \ref figure_8 "Figure below").
-\n By default 'Installation with GUI' checkbox is switched on.
-
-\anchor figure_8
-\image html productpage4.png
-\n <center><b>Figure 8:</b> Installation without GUI mode</center>
-
-The box at the right side of the page displays the information about
-currently selected product: name, version and short description,
-required disk space, disk space required for temporary files and the list of
-prerequisites (this information is provided in the XML file).
-
-The <em>"Disk space required:"</em> field displays how much disk space
-on the hard drive is required for installation of selected products.
-\n\b Note: Please, take into account that the displayed amount of
-required disk space is approximate and may differ when you actually install
-products on your hard drive.
-
-The installation procedure uses a special directory to store temporary
-files. The <em>"Space for temporary files:"</em> field shows the information
-about required disk space on the hard drive for extracting and
-compiling the selected products. You can change the temporary directory (this information is provided in the XML file) to the folder you want.
-\n\b Note: Actually, temporary files are not stored directly in the
-directory entered by the user. The Installation Wizard creates in this directory an additional folder named like INSTALLWORK<b>XXXXX</b> where XXXXX is a unique number. This allows launching several Installation Wizards simultaneously. This temporary directory is removed automatically when the installation finishes.
-
-The installation procedure also checks the available disk space. If there is not enough disk space on your hard drive you will see the corresponding error message box.
-
-Also in the current version of Installation Wizard is possible to install all binaries of the selected SALOME modules into a \b single directory. It is "SALOME" directory. For this purpose there is a checkbox "Install modules to a single directory" checkbox exists (see \ref figure_8 "Fig. 8").
-\n This feature helps to get shorter PYTHONPATH and LD_LIBRARY_PATH environment variables.
-\n\b Note: the installation into a single directory is available with the binaries installation type only.
-
-To proceed further click <em>"Next"</em>. At this moment the program will make some tests to check the installation settings: if there is enough disk space on the hard drive, check for the dependencies for each product you have selected to be installed. If any test fails you will see the corresponding warning message box. Otherwise the wizard will proceed to the next page:
-
-\anchor figure_9
-\image html choicepage.png
-\n <center><b>Figure 9:</b> "Check your choice" page</center>
-
-This page summarizes the installation options you've selected in the previous pages. You can review again your choices and change them if necessary returning to the previous pages.
-\n When you are sure that everything is OK, click <em>"Next"</em> to
-follow to the \ref figure_10 "progress page".
-
-\anchor figure_10
-\image html progresspage1.png
-\n <center><b>Figure 10:</b> "Installation progress" page</center>
-
-To start the installation of the selected products click <em>"Start"</em> button. It launches the shell installation script and you will be able to see the output of the script in the topmost frame of the dialog box. If any errors occur during the installation progress, the corresponding messages will be printed to the log window in the bold red font.
-\n It is possible to break the installation at any time by pressing <em>"Stop"</em> button. Then you can get back to the previous pages if you wish to change the installation settings or restart the installation by pressing <em>"Start"</em> button again.
-
-\b Note: in the current implementation it is not possible to resume the stopped installation process; the installation will restart from the very beginning.
-
-\anchor figure_11
-\image html progresspage2.png
-\n <center><b>Figure 11:</b> "Installation progress" page: installation in progress</center>
-
-The <em>"Installation Status"</em> frame window shows you the progress of
-installation. \c "Waiting" status means that installation of this product
-has not been started yet. The product currently being installed is
-marked as \c "Processing" and is displayed in the status bar under "Installation Status" view. All installed products have \c "Completed"
-status.
-
-You can abort installation and close the installation procedure using
-\em "Cancel" button.
-
-\b Note: This button sends the signal "SIGTERM" to the shell
-script. The script tries to clear all temporary files. The process of
-removing temporary files can take some time, so the installation
-wizard will wait 3 seconds before closing.
-
-At the end of the installation <b>"Installation completed"</b> message
-will appear in the status bar. You can return to the previous pages to
-start a new installation or click \em "Next" button to go to the readme page:
-
-\anchor figure_12
-\image html readmepage.png
-\n <center><b>Figure 12:</b> "Finish installation" page</center>
-
-In this page you can read important information about the Instalation
-Wizard itself and some tips: how to run and test SALOME or how to
-build SALOME from the sources. This is the contents of the README file
-which you can find in the root directory of the Installation Wizard.
-
-You can also launch SALOME Desktop from this page or read the Release
-Notes file by clicking on the corresponding buttons in the lower part
-of the page (see \ref modifying_xml "here" and \ref finish_buttons
-"here" for more information about customizing these buttons).
-
-<br>
-<hr>
-\anchor batch_mode_install
-<h2>Batch mode</h2>
-
-To launch the Installation Wizard in the batch mode use -\b b (--\b batch)
-parameter.
-\n In this mode the GUI wizard is not shown but all the installation
-status is displayed directly in the console. In the batch mode the
-user does not have a possibility to change installation settings which
-are given in the configuration file, except target and temporary
-directories which can be overridden by the corresponding command line
-options.
-\n The only exception is --\b all-from-sources (-\b a) option which enables
-special installation mode in which all the products (including SALOME
-modules) are installed from sources, ignoring the default mode defined
-in the XML configuration file (see \ref installing_products "here" for details) and <b>--single-directory (-s)</b> option which defines that all SALOME modules have to be installed into the one directory (SALOME_<version>, by default, where <version> is SALOME version).
-
-\anchor figure_13
-\image html batchmode.png
-\n <center><b>Figure 13:</b> Batch mode</center>
-
-<br>
-<hr>
-\anchor environment_files
-<h2>Environment files</h2>
-
-During the process of installation the script creates some environment
-files to simplify the procedure of launching SALOME. These shell
-scripts set all necessary environment variables for all products you
-have installed. To learn how installation scripts collects the
-environment, see \ref pick_up_env "here". These files are: \b
-salome.csh + \b salome.sh in the <b><em>KERNEL module sources</em></b>
-and <b><em>KERNEL module binaries</em></b> root directories and
-\b env_products.csh + \b env_products.sh and \b env_build.csh + 
-\b env_build.sh in the target installation directory.
-
-\b Note: there is some difference between these files: \b env_build.*
-files are optimized to be used for building SALOME modules from
-sources (see \b README file provided with the installation procedure
-on the CD). The \b env_products.* (and \b salome.*) files are
-optimized for SALOME launching. The behavior is defined by the
-environment variable \b ENV_FOR_LAUNCH which is set to \b 0 in
-env_build.* files and to \b 1 in env_products.* (salome.*) files.
-
-<br>
-<hr>
-\anchor pick_up_env
-<h2>Pick up the <em>environment</em></h2>
-
-Please, read carefully the following information. This section
-describes how the installation procedure generates the environment
-scripts for the SALOME platform being installed.
-
-After installing each product shell the script creates a special
-environment file for the product in its installation folder. The name
-of the file is generated from the name of product by the following
-scheme: \b env_<product_name>.sh (for example \b env_Vtk.sh for the
-Vtk). This file includes all necessary environment settings. At the
-final step of the installation the script picks up all the settings
-files and generates two common environment files from them: \b salome.sh
-and \b salome.csh for \b bash and \b csh shells correspondingly.
-Such approach helps to save time when reinstalling products and you may not bother about setting all environment variables manually to build/launch
-SALOME. What you simply need is to source one of these environment
-files.
-
-This also concerns those products which are not being installed. For
-example, you install some SALOME binaries to the directory where you
-have previously installed other products.  The Installation procedure
-tries to collect environment files from the target directory if it
-finds necessary products installed there. If some product is not found
-in the target directory the corresponding section of
-\b salome.sh/salome.csh files will be skipped.
-\n For native products (like \b gcc, \b tcl, etc...) the installation
-procedure tries to find them first using \b PATH / \b LD_LIBRARY_PATH
-variables and then in the system default directories (\b /usr/bin,
-\b /usr/lib etc., depending on the product).
-<br><br>
-In any case you may edit \b salome.* files after the installation
-procedure finishes, if you want.
-
-\n\b Note: As it was mentioned \ref environment_files "above" there are
-other environment files which are generated by the installation
-procedure: \b env_products.csh + \b env_products.sh and \b env_build.csh +
-\b env_build.sh. These files can be found in the target installation root
-directory.
-
-<br>
-<hr>
-\anchor modifying_xml
-<h2>Modifying <em>XML</em> configuration <em>file</em></h2>
-
-You can create your own XML configuration file. The Installation
-Wizard can then take it as a command line argument to provide a list
-of products you want to install with it. The list of products and some
-other settings for the Installation Wizard are provided in the XML
-file.
-\n This section describes the structure of the configuration file, optional sections/tags are in brackets.
-
-\code
-<document>
-      <config [ version=<application_version>      ]
-              [ caption=<application_caption>      ]
-              [ copyright=<application_copyright>  ]
-              [ license=<application_license_info> ]
-                platforms=<target_platform>
-              [ targetdir=<target_directory>       ]
-              [ tempdir=<temp_directory>           ]
-      />
-    [ <buttons>
-      [ <button   label=<button_label>     
-                [ tooltip=<button_tooltip> ]
-                  script=<button_script>   
-                [ disable=<disable_flag>   ]
-        />
-      ]
-      [ <button ...
-        />
-      ]
-        ...
-      </buttons>
-    ]
-    [ <products>
-      [ <product  name=<product_name>
-                  type=<product_type>
-                [ description=<product_description> ]
-          <installation  os=<installation_platform>
-                         version=<product_version>
-                       [ disable=<disable_flag>            ]
-                       [ woguimode=<without_gui_mode_flag> ]
-                         installdiskspace=<install_disk_space>
-                       [ pickupenv=<pickup_env_flag>       ] 
-                         script=<installation_script_name>
-          />
-          ...
-        />
-      ]
-      [ <product ...
-        />
-      ]
-        ...
-      </products>
-    ]
-    [ <dependencies>
-      [ <product  name=<product_name> >
-        [ <dep> <prerequisite_name> </dep> ]
-          ...
-        </product>
-      ]
-        ...
-      </dependencies>
-    ]
-</document> 
-\endcode
-
-<b>\<config\> section</b>
-\n\n This is an optional section; it provides general information about the Installation Wizard itself.<br><br>
-Attributes:
-<ul>
-<li><b>version</b>
-\n\n The application version number to be shown in the caption.<br><br>
-</li>
-<li><b>caption</b>
-\n\n The application main window caption - if this string contains '\%1' text the title will contain the version number in this place (see
-above).<br><br>
-</li>
-<li><b>copyright</b>
-\n\n The application copyright information (shown in the first page).<br><br>
-</li>
-<li><b>license</b>
-\n\n The application license information (shown in the first page).<br><br>
-</li>
-<li><b>platforms</b>
-\n\n This parameter defines the directory (relative from ./Products/BINARIES) where the Installation Wizard will search
-precompiled binaries packages. If this tag is not provided, binaries
-packages are looked for in the ./Products/BINARIES directory.<br><br>
-</li>
-<li><b>targetdir</b>
-\n\n The target directory - the path to the directory where products
-should be installed.<br><br>
-</li>
-<li><b>tempdir</b>
-\n\n The temporary directory - the path to the directory for the
-temporary files.<br><br>
-</li>
-</ul>
-
-<b>\<button\> section</b>
-\n\n This is an optional section. It allows customization of the last
-"Finish installation" page of the Installation Wizard by adding one or
-more buttons in the lower part of the wizard's window. The script
-which is attached to each such button, can perform some specific
-action, for example, launch the application or show the Release Notes
-file by using an external program. See \ref finish_buttons "here" for
-more details about writing scripts.<br><br>
-Attributes:
-<ul>
-<li><b>label</b>
-\n\n This is the button text.<br><br>
-</li>
-<li><b>tooltip</b>
-\n\n The button tooltip (optional).<br><br>
-</li>
-<li><b>script</b>
-\n\n The script attached to the button.<br><br>
-</li>
-<li><b>disable</b>
-\n\n If this optional flag has 'true' value, the corresponding button
-will not appear in the "<em>Finish installation</em>" page - the section of XML
-file is silently ignored.<br><br>
-</li>
-</ul>
-
-<b>\<product\> section</b>
-\n\n This section describes product to be installed with the
-Installation Wizard. The XML file should include a \<product\> section
-for each product to be installed. The products appear in the tree view
-and are installed in the order they are described in the configuration
-file. It is recommended (but not obligatory) to define native products
-at the top of the list before all other products.
-<br><br>
-Attributes:
-<ul>
-<li><b>name</b>
-\n\n Product name.<br><br>
-</li>
-<li><b>type</b>
-\n\n The type of the product: 'component' - SALOME module or 'prerequisite' - prerequisite product.<br><br>
-</li>
-<li><b>description</b>
-\n\n Product description (optional).<br><br>
-</li>
-</ul>
-
-<b>\<installation\> section</b>
-
-It is a part of the <product> section, that provides installation information by platforms. The <product> section may contains a several <installation> ones for the different platforms. 
-<br><br>
-Attributes:
-<ul>
-<li><b>os</b>
-\n\n A possible installation platform.<br><br>
-</li>
-<li><b>version</b>
-\n\n The version of the product.<br><br>
-</li>
-<li><b>disable</b>
-\n\n If this optional flag has 'true' value, the corresponding product will not appear in the list of products and will not be installed.<br><br>
-</li>
-<li><b>woguimode</b>
-\n\n This optional flag defines that it's possible to install this module without GUI.<br><br>
-</li>
-<li><b>installdiskspace</b>
-\n\n List of three total amount spaces (integer, in Kbytes, derived by comma), which product occupies on the hard drive after the installation in case 'binary', 'sources' and 'sources and compile' installation type.<br><br>
-</li>
-<li><b>pickenv</b>
-\n\n This flag shows that the pickup environment procedure should be performed for this product. If this flag equal to 'true',  salome.sh and salome.csh files will  be created in the product's installation directory. Usually this option is set to true for SALOME KERNEL module. This is optional key, default value is 'false'.<br><br>
-</li>
-<li><b>script</b>
-\n\n The installation script name. This script is in charge of the installation of the product. It is called automatically by the Installation Wizard when necessary from the main program. See the see 
-\ref installation_scripts "next section" for more information.<br><br>
-</li>
-</ul>
-
-\n\b Note: If you add new products to be installed with Installation
-Wizard, you should also provide installation script for this
-product. See the next section for more details.
-
-<br>
-<hr>
-\anchor installation_scripts
-<h2>Implementing <em>installation scripts</em> for the new products</h2>
-
-When you want some product to be installed with the Installation
-Wizard, you should add its description \ref modifying_xml "to the configuration file"
-and create the installation script, following the rules described in this section.
-
-There are some obligatory functions which should be implemented in
-this installation script. These functions are automatically called by
-the master installation script or/and its GUI shell when it is
-necessary. \n File \b common.sh contains some service functions which can
-be used in your installation script, like \b make_env(), \b make_dir(),
-\b try_existing(), \b sort_path(), \b find_in_path(), etc.
-
-<ul>
-<li><b>check_version()</b>
-\n\n This function allows to check the version of the product already
-installed on the computer. It should try to find the product (native
-or preinstalled in the target directory) and check its version. This
-helps to avoid unnecessary reinstallation. This is an internal
-function and is not called from the master installation
-script.<br><br>
-</li>
-<li><b>install_binary()</b>
-\n\n This function is called when <em>'Install binaries'</em> installation mode is selected by the user. The function is responsible for the extracting of the product from the binaries package. It should create environment for the product in the temporary directory (see also the description of \b print_env() function). It is not necessary to implement this function if you do not provide binaries mode installation for the current product.<br><br>
-</li>
-<li><b>install_source()</b>
-This function is called to install SALOME modules sources, if <em>'Install binaries'</em> installation mode is selected by the user, and to install prerequisite products sources, in <em>'Install sources'</em> case (\ref figure_2 "Fig. 2" above). The function is responsible for the building of the product from the sources package. It should create the environment file for the product in the temporary directory (see also the description of print_env() function). It is not necessary to implement this function if you do not provide a sources mode installation for the current product. <br><br>
-</li>
-<li><b>install_source_and_build()</b>
-This function is called when <em>'Install sources and make a compilation'</em> installation mode is selected. This function should be used to unpack SALOME or prerequisite sources package and then call build/install procedure for it.
-For more details please refer to the \ref installing_products "this"
-and \ref gui_mode_install "this" sections for more details.<br><br>
-</li>
-<li><b>try_preinstalled()</b>
-\n\n This function is called when the 'not install' installation mode
-is selected by the user. In this case the script should inspect the
-target directory to try to find an already preinstalled product, pick
-up and check the environment from there. See \ref pick_up_env "here" for more
-details.<br><br>
-</li>
-<li><b>print_env_bin() & print_env_src()</b>
-\n\n These functions are in charge of the creation of the environment scripts. They should create in the temporary directory two files with \b env_<product_name>.sh and \b env_<product_name>_src.sh names and then copy them into the binary and sources product installation directories correspondingly. The file should contain all necessary environment variable settings for the product. It will be collected during the 'pick-up-environment' procedure.<br><br>
-</li>
-<li><b>pickup_env()</b>
-\n\n This procedure corresponds to the \b pickupenv tag of the
-configuration xml file (see previous section). It should call the
-\b make_env procedure to perform the pick-up environment procedure for
-the product.<br><br>
-</li>
-</ul>
-
-The calling signature of the product installation script is the following: 
-<b>\<product_script_name\> \<function_name\> \<temp_folder\>
-\<products_directory\> \<target_directory\> \<dependancies\>
-\<product_name\></b>
-\n\n where \n\n
-<b>\<product_script_name\></b> - installation script name (described in the
-configuration xml file);\n
-<b>\<function_name\></b> - the name of function, corresponding to the selected
-installation mode: \em try_native, \em install_source, \em install_binary or
-\em try_preinstalled;\n
-<b>\<temp_folder\></b> - temporary files directory;\n
-<b>\<products_directory\></b> - directory where the sources/binaries package
-can be found. You should provide the sources package in the
-<em>\<Install_Wizard_root_directory\>/Products/SOURCES</em> directory and
-binaries package in the
-<em>\<InstallWizard_root_directory\>/Products/BINARIES/\<os_version\></em>, where
-\<os_version\> is the target platform description, which appears in the
-corresponding section of the \ref modifying_xml "configuration xml file";
-<em>\<target_directory\></em> - root target directory where the product should be installed to; 
-<em>\<dependancies\></em> - single-quoted list of prerequisite products, separated by space; 
-<em>\<product_name\></em> - product name itself.
-
-\b Example:
-\n <em>med-2.2.3.sh install_binary /tmp/work
-./Products/BINARIES/Mandrake10.1 /usr/salome 'gcc Hdf' med</em>
-
-Copy the created script into the
-<em>\<Install_Wizard_root_directory\>/config_files</em> sub-directory where all
-installation scripts are stored. Installation Wizard will
-automatically search and call your script during the installation
-procedure.
-
-<br>
-<hr>
-\anchor finish_buttons
-<h2>Customizing <em>Readme page</em> buttons</h2>
-
-The Installation Wizard allows customizing the look-n-feel of the last
-<em>"Finish installation"</em> page. If you want to add one or more buttons to
-this page in order to perform some specific actions at the end of the
-installation (for example, to show the Release Notes file by using
-Open Office) you can put an additional section to the XML
-configuration file. This is the \b \<button\> section (see 
-\ref modifying_xml "here" for more details).
-
-To implement the action which will be performed when the user clicks
-the button, you need to create a script and put it to the
-<em>\<Install_Wizard_root_directory\>/config_files</em> directory.
-\n There are some obligatory functions which should be implemented in
-this script. These functions are automatically called by the
-Installation Wizard GUI.
-
-<ul>
-<li><b>check_enabled()</b>
-\n\n This procedure is called by the Installation Wizard when the
-<em>"Finish installation"</em> page is displayed and the status of the buttons
-should be modified according to the installation options. This
-procedure should return \b 0 if the corresponding action can be performed
-and, thus, the button should become enabled. Otherwise, it should
-return \b 1 - in this case the corresponding button will be
-disabled.<br><br>
-</li>
-<li><b>execute()</b>
-\n\n This procedure is invoked when the user clicks the button. This
-procedure should return \b 0 if the corresponding action is done
-successfully and \b 1 if any error occurs.<br><br>
-</li>
-</ul>
-
-The calling signature of the script is the following:
-\n <b>\<product_script_name\> \<function_name\> \<target_directory\>
-\<temp_folder\></b>
-\n\n where \n\n
-\b \<product_script_name\> - the script name itself (retrieved from the XML configuration xml file); 
-\n \b \<function_name\> - the name of function; 
-\n \b \<target_directory\> - root target directory where the product is installed to; 
-\n \b \<temp_folder\> - temporary files directory;
-
-\n\b Note: The standard Installation Wizard buttons "Launch SALOME" and
-"Release Notes" are implemented with this feature. Refer to scripts
-\b start_salome.sh and \b release_notes.sh for sample implementation.
-
-\n\b Note: Any button (even standard) can be ignored by the Installation
-Wizard if the attribute \b \<disable\> in the XML configuration file is set
-to the "true" value.
-
-*/
index 5e3de36f388f841ffe92c648de4dbc780479777a..64130f65c26990dde37c5201d89c293053310eff 100644 (file)
@@ -61,8 +61,9 @@ Help for the GUI module provides information about standard
 <li>\ref plot2d_viewer_page "Plot 2D viewer". </li>
 </ul>
 
-\subpage setting_preferences_page "Preferences" for all Salome modules
-are also described in this section of SALOME GUI Help.
+General application preferences are described in the \subpage setting_preferences_page "Preferences" 
+section of SALOME GUI Help.
+
 
 \subpage using_input_widgets_page "Using input widgets" sub-section
 covers specific aspects of behavior of certain kinds of SALOME GUI
diff --git a/doc/salome/gui/input/mesh_preferences.doc b/doc/salome/gui/input/mesh_preferences.doc
deleted file mode 100644 (file)
index 4ebe19e..0000000
+++ /dev/null
@@ -1,209 +0,0 @@
-/*!
-
-\page mesh_preferences_page Mesh preferences
-
-In the Mesh module you can set mesh preferences, which can be used in
-later sessions with this module.
-
-<h2>General Preferences</h2>
-
-\image html pref21.png
-
-<ul>
-<li><b>Automatic Update</b></li>
-<ul>
-<li>If you toggle <b>Automatic Update</b> checkbox, the model in your
-viewer automatically updated whenever you make changes in it.</li>
-<li><b>Size limit (elements)</b> - allows to specify the maximum
-number of elements in the resulting mesh for which the automatic updating
-of the presentation is performed. This option affects only
-<b>Compute</b> operation. Zero value means "no limit". Default value
-is 500 000 mesh elements.
-</ul>
-<li><b>Quality Controls</b></li>
-<ul>
-<li>If you toggle <b>Display entity</b>, both faces and edges of an
-object will be displayed in the viewer by default.</li>
-<li>If you toggle <b>Use precision</b> checkbox, you can display numbers in
-<b>Quality Control</b> diagrams at the necessary level of precision.</li>
-<li><b>Number of digits after point</b> - defines precision for <b>Quality Controls</b>. By default, numbers in <b>Quality Control</b>
-diagrams are presented as integers.</li>
-<li><b>Double nodes tolerance</b> defines maximal distance between two
-mesh nodes at which they are considered coincident by <b>Double nodes</b>
-quality control.
-</ul>
-<li><b>Display mode</b> - allows to set Wireframe, Shading, Nodes or Shrink
-presentation mode as default.</li>
-<li><b>Representation of the 2D quadratic elements</b></li>
-<ul>
-<li><b>Representation of the 2D quadratic elements</b> combobox - allows
-to select lines or arcs for representation of quadratic elements.</li>
-<li><b>Maximum Angle</b> - maximum deviation angle used by the
-application to build arcs. </li>
-</ul>
-<li><b>Mesh export</b></li>
-<ul>
-<li>If you toggle <b>Automatically create groups for MED export</b> checkbox,
-this operation will be carried out automatically.</li>
-<li>If you toggle <b>Automatic renumbering</b> checkbox, the exported
-mesh will be renumbered automatically</li>
-</ul>
-<li><b>Mesh computation</b></li>
-<ul>
-<li><b>Show a computation result notification</b> combobox allows to
-select the notification mode about a mesh computation result.
-There are 3 possible modes:</li>
-<ul>
-<li><b>Never</b> - do not show the result dialog at all;</li>
-<li><b>Errors only</b> - the result dialog will be shown if there were
-some errors during a mesh computation;</li>
-<li><b>Always</b> - show the result dialog after each mesh
-computation. This is a default mode.</li>
-</ul></ul>
-<li><b>Mesh information</b></li>
-<ul>
-<li><b>Mesh element information</b></li> - Change the way mesh element
-information is shown:
-<ul>
-<li><b>Simple</b> - as a plain text</li>
-<li><b>Tree</b> - in a tree-like form</li>
-</ul>
-<li><b>Automatic nodes compute limit</b></li> - allows to define the size limit for the
-mesh groups for which the number of underlying nodes is calculated
-automatically. If the group size exceeds the value set in the preferences,
-the user will have to press \em Compute button explicitly. Zero value
-means "no limit". By default the value is set to 100 000 mesh elements.
-</li></ul>
-<li><b>Automatic Parameters</b></li>
-<ul>
-<li><b>Ratio Bounding Box Diagonal / Max Size</b> - this parameter is
-used for automatic meshing: ratio between the bounding box of the
-meshed object and the Max Size of segments.</li>
-<li><b>Default Number of Segments</b> - allows defining the default
-number of segments on each edge</li>
-</li></ul>
-<li><b>Mesh loading</b></li>
-<ul>
-<li>If you toggle <b>No mesh loading from study file at hypothesis modification</b>
-  checkbox, then mesh data won't be loaded from the study file
-  provided that your first action on a mesh after study opening is
-  modification of hypotheses. This can save your time by omitting
-  loading data of a large mesh that your are going to recompute with
-  other parameters.</li>
-</ul>
-<li><b>Input fields precision</b></li>
-<ul>
-<li><b>Length precision</b> - allows to adjust input precision of coordinates and dimensions.</li>
-<li><b>Angular precision</b> - allows to adjust input precision of angles.</li>
-<li><b>Length tolerance precision</b> - allows to adjust input precision of tolerance of coordinates and dimensions.</li>
-<li><b>Parametric precision</b> - allows to adjust input precision of parametric values.</li>
-<li><b>Area precision</b> - allows to adjust input precision of mesh element area.</li>
-<li><b>Volume precision</b> - allows to adjust input precision of mesh element volume.</li>
-</ul>
-<li><b>Python Dump</b></li>
-<ul>
-<li><b>Historical python dump</b> checkbox switches Python Dump from
-  \a Historical to \a Snapshot mode and backward. In the \a
-  Historical mode, the Python Dump script includes all commands
-  performed by SMESH engine. In the \a Snapshot mode, commands
-  relating to objects removed from the Study are excluded from the
-  script as well as commands not influencing the current state of meshes.</li>
-</ul>
-</ul>
-
-<h2>Mesh Preferences</h2>
-
-\image html pref22.png
-
-<ul>
-<li><b>Nodes</b></li>
-<ul>
-<li><b>Color</b> -  allows to select the color of nodes. Click on the
-colored line to access to the \ref select_color_and_font_page "Select Color" 
-dialog box.</li>
-<li><b>Type of marker</b> - allows to define the shape of nodes.</li>
-<li><b>Scale of marker</b> - allows to define the size of nodes.</li>
-</ul>
-<li><b>Elements</b></li>
-<ul>
-<li><b>Surface color</b>  - allows to select the surface color of elements
-(seen in Shading mode). Click on the colored line to access to the
-\ref select_color_and_font_page "Select Color" dialog box.</li>
-<li><b>Back surface color</b> - allows to select the interior surface color
-of elements. Use the slider to select the color generated basing on  
-the <b>Surface color</b> by changing its brightness and saturation.</li>
-<li><b>Outline color</b> - allows to select the color of element
-borders. Click on the colored line to access to the 
-\ref select_color_and_font_page "Select Color" dialog box.</li>
-<li><b>Wireframe color</b> - allows to select the color of borders of
-elements in the wireframe mode. Click on the colored line to access to the 
-\ref select_color_and_font_page "Select Color" dialog box.</li>
-<li><b>Width</b> - allows to define the width of lines (edges and borders of elements).</li>
-<li><b>Shrink coef.</b> - allows to define relative space of elements
-compared to gaps between them in shrink mode.</li>
-</ul>
-<li><b>Orientation of Faces</b> - allows to define the behavior of
-<b>Orientation of faces</b> functionality</li>
-<ul>
-<li> \b Color - allows to define the color of orientation vertors;</li>
-<li> \b Scale - allows to define the size of orientation vectors;</li> 
-<li> <b> 3D Vector </b> checkbox allows to choose between 2D planar
-and 3D vectors.</li>
-</ul>
-</ul>
-
-<br><h2>Selection Preferences</h2>
-
-\image html pref23.png
-
-<ul>
-<li><b>Selection</b> - performed with mouse-indexing (preselection)
-and left-clicking on an object, whose appearance changes as defined in
-the <b>Preferences</b>.</li>
-<ul>
-<li><b>Object Color</b> -  allows to select the color of mesh (edges and
-borders of meshes) of the selected entity. Click on the colored line
-to access to the \ref select_color_and_font_page "Select Color" dialog
-box.</li>
-<li><b>Element color</b> - allows to select the color of surface of selected
-elements (seen in Shading mode). Click on the colored line to access
-to the \ref select_color_and_font_page "Select Color" dialog box.</li>
-</ul>
-<li><b>Preselection</b> - performed with mouse-indexing on an object,
-whose appearance changes as defined in the <b>Preferences</b>.</li>
-<ul>
-<li><b>Highlight Color</b> -  allows to select the color of mesh (edges and
-borders of meshes) of the entity . Click on the colored line to access
-to the \ref select_color_and_font_page "Select Color" dialog box.</li>
-</ul>
-<li><b>Precision</b> - in this menu you can set the value of precision
-used for <b>Nodes</b>, <b>Elements</b> and <b>Objects</b>.</li>
-</ul>
-
-<br><h2>Scalar Bar Preferences</h2>
-
-\image html pref24.png
-
-<ul>
-<li><b>Font</b> - in this menu you can set type, face and color for
-the font of <b>Title</b> and <b>Labels</b>.</li>
-<li><b>Colors & Labels</b> - in this menu you can set the <b>number of
-colors</b> and the <b>number of labels</b> in use.</li>
-<li><b>Orientation</b> - here you can choose between vertical and
-horizontal orientation of the <b>Scalar Bar</b></li>.
-<li><b>Origin & Size Vertical & Horizontal</b> - allows to define
-placement (<b>X</b> and <b>Y</b>) and lookout (<b>Width</b> and
-<b>Height</b>) of Scalar Bars</li>
-<ul>
-<li><b>X</b>: abscissa of the point of origin (from the left
-side)</li>
-<li><b>Y</b>: ordinate of the origin of the bar (from the bottom)</li>
-</ul>
-<li><b>Distribution</b> in this menu you can Show/Hide distribution histogram of the values of the <b>Scalar Bar</b> and specify the <b>Coloring Type</b> of the histogram</li>
-<ul>
-<li><b>Multicolor</b> the histogram is colored as <b>Scalar Bar</b></li>
-<li><b>Monocolor</b> the histogram is colored as selected with <b>Distribution color</b> selector</li>
-</ul>
-</ul>
-
-*/
diff --git a/doc/salome/gui/input/postpro_preferences.doc b/doc/salome/gui/input/postpro_preferences.doc
deleted file mode 100644 (file)
index f9710be..0000000
+++ /dev/null
@@ -1,397 +0,0 @@
-/*!
-
-\page postpro_preferences_page Post-Pro Preferences
-
-In the Post-Pro module you can set preferences, default settings,
-which can be used in later sessions with this module.
-
-<h2>General Preferences</h2>
-
-\image html ppref0.png
-
-<ul>
-<li><b>Input fields precision</b></li>
-<ul>
-<li><b>Visual data precision</b> - allows to adjust precision of scalar data displayed as text, data values round-up, various visualization options.</li>
-<li><b>Length precision</b> - allows to adjust input precision of coordinates and dimensions.</li>
-<li><b>Angular precision</b> - allows to adjust input precision of angles.</li>
-<li><b>Length tolerance precision</b> - allows to adjust input precision of tolerance of coordinates and dimensions.</li>
-<li><b>Parametric precision</b> - allows to adjust input precision of parametric values.</li>
-<li><b>Memory size precision</b> - allows to adjust input precision of memory size.</li>
-</ul>
-</ul>
-
-<h2>MED import Preferences</h2>
-
-\image html ppref1.png
-
-<ul>
-<li><b>MED files import</b></li>
-<ul>
-<li><b>Use Build Progress</b> - when this option is checked you can choose
-all other import MED options at the moment of loading of each file
-using <b>Build Progress</b> menu, otherwise the loading will be done
-according to the <b>Preferences</b> without addressing to the
-user.</li>
-<li><b>Full MED Loading</b> - when this option is checked, the MED file is
-fully loaded in the study, and no additional access to the MED file is
-needed during the session. Reversibly, when unchecked, the MED file is
-loaded on demand. This is the default behaviour in SALOME and
-recommended for big files to optimize memory usage.</li>
-<li><b>Build at once</b> - when this option is checked, you can't
-perform any operations until the MED file is fully loaded and
-processed.</li>
-<li><b>Build fields</b> - when this option is checked, the fields are
-built automatically at loading.</li>
-<li><b>Build min/max</b> - when this option is checked, minimum and
-maximum values of the time stamps are found at loading.</li>
-<li><b>Build groups</b> - when this option is checked, the groups and
-families are built automatically at loading.</li>
-<li><b>Close dialog at finish</b> - when this option is checked, the
-dialog box is closed after loading of the selected MED file. When
-unchecked, it allows loading other MED files.</li>
-</ul>
-</ul>
-
-<br><h2>Scalar Bar Preferences</h2>
-
-\image html pref31.png
-
-<ul>
-<li><b>Scalar Range</b></li>
-<ul>
-<li><b>Scalar Mode</b> - this feature allows refining the value to be
-inspected:</li>
-<ul>
-<li><b>Modulus:</b> value of a scalar or modulus of a vector.</li>
-<li><b>Component N:</b> Nth component of a vector, a tensor or a matrix.</li>
-</ul>
-<li><b>Logarithmic Scaling</b> - this checkbox toggles logarithmic
-scaling.</li>
-<li><b>Ranges to Use</b> - you can use either Field Range or Imposed
-Range.</li>
-<li><b>Gauss Metric</b> - gives the choice among Average, Minimum and Maximum.
-</ul>
-<li><b>Min and Max for Imposed Range</b> - in this menu  you can set
-the limits for your Imposed Range, if you have chosen to use it.</li>
-<li><b>Font</b> - in this menu you can set type, face and color for
-the font of <b>Title</b> and <b>Labels</b>.</li>
-<li><b>Colors & Labels</b> - in this menu you can set the <b>number of
-colors</b> and the <b>number of labels</b> in the Scalar bar.</li>
-<li><b>Orientation</b> - here you can choose between vertical and horizontal
-orientation of the Scalar Bar.</li>
-<li><b>Scalar bars default position</b></li>
-<ul>
-<li><b>Arrange Scalar Bars</b> - this option prevents superposition of
-scalar bars during visualisation of several fields in the same
-window. If checked, a separate scalar bar is displayed for each
-presentation.</li>
-</ul>
-<li><b>Origin & Size Vertical & Horizontal</b> - allows to define
-placement and lookout of Scalar Bars and their labels.</li>
-<ul>
-<li><b>X:</b> abscissa of the point of origin (from the left
-side)</li>
-<li><b>Y:</b> ordinate of the origin of the bar (from the bottom)</li>
-</ul>
-
-</ul>
-
-<br><h2>Cut Lines Preferences</h2>
-
-\image html ppref2.png
-
-<ul>
-<li><b>CutLine Preferences</b></li>
-<ul>
-<li><b>Show preview</b> check box allows to edit the parameters of the
-presentation and simultaneously observe the preview of this
-presentation in the viewer.</li>
-<li><b>Invert all curves</b> check box allows to invert the resulting
-curves.</li>
-<li><b>Use absolute length</b> check box allows to use absolute length
-for curves.</li>
-<li><b>Generate Data Table:</b> If this check box is marked, <b>Post
-Pro</b> will automatically generate a data table on the basis of your
-Cut Lines presentation. This table will be created in the structure of
-the study.</li>
-<li><b>Generate Curves:</b> If this check box is marked, <b>Post Pro</b>  will
-automatically generate curve lines on the basis of values taken from
-the generated data table. These curves will be created in the
-structure of the study and can be visualized in a XY plot.</li>
-</ul>
-</ul>
-
-<br><h2>Stream Lines Preferences</h2>
-
-\image html pref32.png
-
-<ul>
-<li><b>Stream Lines Preferences</b></li>
-<ul>
-<li><b>Used points</b> - allows to define a default percentage
-of points used for building the Stream Lines presentation.</li>
-</ul>
-</ul>
-
-<br><h2>Sweep and Animation Preferences</h2>
-
-\image html ppref3.png
-
-
-<ul>
-<li><b>3D Cache</b> - allow to define the mode of usage
-and the size of the 3D Cache, which enables to save in RAM and quickly
-restore the states of field animation (\b Sliding functionality).</li>
-<ul>
-<li><b>Memory Mode</b> - allows to define the mode of usage
-of the 3D Cache: <b>Minimal</b> actually disables the Cache,
-<b>Limited</b> Cache size depends on the current system
-configuration.</li>
-<li><b>Memory Limit</b> - allows to define the maximum size of the 3D
-Cache</li> 
-</ul>
-
-<li><b>Animation preferences</b></li>
-<ul>
-<li><b>Speed</b> - allows to define the speed of the animation.</li>
-<li><b>Cycled animation</b> - allows to start a cycled animation of the presentation.</li>
-<li><b>Use proportional timing</b> - allows to render the animation with proportional periods of time between every frame (not depending on the time stamps).</li>
-<li><b>Clean memory at each frame</b> - this option allows to optimize the performance of the operation.</li>
-<li><b>Dump mode</b> - this option allows to choose a mode of dumping
-the animation process. Three modes are available:
-<ul>
-<li><b>No dump</b> - disables dumping.</li>
-<li><b>Save pictures to directory</b> - dumps the animation
-to set of pictures corresponding to each timestamp.</li>
-<li><b>Save animation to AVI file</b> - generates a movie that
-reproduces the animation process.</li>
-</ul></li>
-<li><b>Time stamp frequency</b> - this option is available if
-<b>Save animation to AVI file</b> mode is turned on. It provides a
-possibility to capture only timestamps with indices divisable by the
-specified frequency, that allows to generate less voluminous films.</li>
-</ul>
-
-<li><b>Sweeping preferences</b></li>
-<ul>
-<li><b>Mode of the Sweeping</b> - allows to choose between Linear,
-Cosinusoidal and sinusoidal sweeping.</li>
-<li><b>Time step</b> - in this menu you can set the time of
-representation of one step.</li>
-<li><b>Number of cycles</b> - in this menu you can define the number
-of times this animation will be repeated.</li>
-<li><b>Number of steps</b> - in this menu you can define the number of
-steps, which will compose the whole animation.</li>
-<li><b>Parameter varies</b> - allows to choose the range for the
-parameter: from 0 to Pi or from Pi to -Pi.</li>  
-</ul>
-</ul>
-
-<br><h2>Representation Preferences</h2>
-
-\image html pref33.png
-
-<ul>
-<li><b>Representation properties</b> - these checkboxes allow to
-choose the default representation type for each field presentation.</li>
-<ul>
-<li><b>Floating Point Precision</b> - allows defining the number
-of digits displayed after the decimal point.</li>
-<li><b>Representation of the 2D quadratic elements</b> - allows
-selecting lines or arcs for representation of quadratic elements.</li>
-<li><b>Maximum Angle</b> - maximum deviation angle used by the
-application to build arcs. </li>
-<li><b>Edge Color</b> - allows selecting the color for representation
-of edges. </li>
-<li><b>Type of marker</b> - allows to choose a shape of point markers.</li>
-<li><b>Scale of marker</b> - allows to choose a scale of point markers.</li>
-<li><b>Use Shading</b> - when this option is checked, the objects will
-be displayed with shading.</li>
-<li><b>Display only on creation</b> - when this option is checked, all
-previously created presentations will be automatically removed from
-the viewer when a new presentation is created and displayed. You can
-restore the previously created presentations using the Object
-Browser.</li>
-<li><b>Automatic Fit All</b> - when this option is checked, the center
-of the view is automatically chosen to represent all displayed objects
-in the visible area.</li> 
-</ul>
-</ul>
-
-<br><h2>Tables</h2>
-
-\image html pref35.png
-
-<ul>
-<li><b>Enable editing</b></li> - allows to edit contents of the tables
-(in particular, to sort table data by clicking on the column header).
-<li><b>Sort policy</b></li> - specify how the empty cells will be processed
-during the sort procedure. The following options are available:
-</li>
-<ul>
-<li><b>Empty cells are considered as lowest values</b></li>
-<li><b>Empty cells are considered as highest values</b></li>
-<li><b>Empty cells are always first</b></li>
-<li><b>Empty cells are always last</b></li>
-<li><b>Empty cells are ignored</b> (means that positions of the empty cells
-will not change after sorting)</li>
-</ul>
-</ul>
-
-<br><h2>Feature Edges</h2>
-
-\image html featureedgesprops.png
-
-These properties define which contours should be highlighted with
-<b>Feature Edges</b> functionality. 
-<ul>
-<li><b>Feature edges angle</b> - allows to define at which minimum
-angle between two faces a wire is considered an edge </li> 
-<li><b>Show feature edges</b> - allows to display feature edges.</li>
-<li><b>Show boundary edges</b> - allows to display boundary edges.</li>
-<li><b>Show manifold edges</b> - allows to display manifold edges. </li>
-<li><b>Show non-manifold edges</b> - allows to display non-manifold edges.</li>
-</ul>
-  
-
-<br><h2>Gauss Points Preferences</h2>
-
-\image html pref34.png
-
-<ul>
-<li><b>Primitive</b> - this menu allows user to choose the graphic
-primitive to use to present the results at Gauss points in the
-viewer.</li>
-<ul>
-<li><b>Primitive type</b> - provides choice between <b>Point
-sprites</b>, <b>Open GL points</b> and <b>Geometrical Spheres</b>.</li>
-<li><b>Maximum Size (Clamp)</b> - defines the maximum size of sprite
-points ranging from 1 to 512. By default the value is set to 256
-pixels.</li>
-<li><b>Main Texture</b> -  path to the <b>Main Texture</b> (16x16
-pixels) which defines the shape of the point sprite used for
-rendering.</li>
-<li><b>Alpha Channel Texture (16*16)</b> - path to the <b>Alpha
-Channel Texture</b> which defines the texture of the point
-sprite.</li>
-<li><b>Alpha Channel Threshold</b> - defines the level of transparency
-ranging from 0 to 1.</li>
-<li><b>Geometrical Sphere Resolution</b> - defines the number of faces
-of <b>Geometry Spheres</b>.</li>
-<li><b>Notify when number of faces exceeds</b> - limitation of the
-number of faces; the user will be warned if it exceeds the given
-value.</li>
-</ul>
-</ul>
-
-<ul>
-<li><b>Size</b> - in this menu you can define:</li>
-<ul>
-<li><b>Range value for min and max size</b> - these two parameters
-will be respectively multiplied by a reference length (average size of
-cells of the mesh) to define the range for minimum and maximum size of
-a point during rendering (at magnification = 100%). Default values
-are:</li>
-<ul>
-<li><b>Rainbow</b> scale: <b>min</b> = <b>10%</b>, <b>max</b> =
-<b>33%</b></li>
-<ul>
-<li>Min size is associated to the smallest real value (including
-negative values).</li>
-<li>Max size is associated to the largest real value.</li>
-</ul>
-<li><b>Bicolor</b> scale: <b>min</b> = <b>0</b> (not editable),
-<b>max</b> = <b>33%</b></li>
-<ul>
-<li>Null size is associated to the 0 scalar value.</li>
-<li>Max size is associated to the largest absolute value.</li>
-</ul>
-</ul>
-Both values are dynamically updated by the system according to the
-selected scalar bar. In the case of a Bicolor scale, the minimum value
-is set to 0 in the dialog and the control is disabled.
-<li><b>Magnification (%)</b> corresponds to the change of size of
-results at Gauss point primitives in 2D space. Acceptable values range
-from 0 to N; 100% means no magnification, 50% means half of its size,
-200% mean twice its size and so forth. By default this value is set to
-100%.</li>
-<li><b>+/- Ratio</b> corresponds to the number by which the
-magnification will be respectively multiplied or divided at edition,
-ranging from 0.01 to 10. By default this value is set to 2.</li>
-</ul>
-</ul>
-
-<ul>
-<li><b>Geometry</b></li>
-<ul>
-<li><b>Size of points (%)</b> defines a value that will be multiplied
-by a reference length (representative of the average size of cells of
-the mesh) to define the size of points during rendering (at
-magnification = 100%). Default values 10%.</li>
-<li><b>Color</b> -  allows to select the color of points used for
-presentations. Click on the colored line to access to the \ref
-select_color_and_font_page "Select Color" dialog box.</li>
-</ul>
-</ul>
-
-<ul>
-<li><b>Gauss Points Scalar Bar</b></li>
-<ul>
-  <li><b>Active Bar</b> - this option allows to choose <b>Local</b> or
-    <b>Global</b> Bar as active.</li>
-  <li><b>Display Global Bar</b> - this option allows to visualize or to
-    hide the Global Bar.</li>
-  <li><b>Scalar Bar Mode</b> - this option allows to choose between
-    <b>Bicolor</b> and <b>Rainbow</b> Scalar Bar Mode.</li>
-  <li><b>Spacing</b> - allows to define Spacing from 0.01 to 1.</li>
-</ul>
-</ul>
-
-<ul>
-<li><b>Spacemouse</b></li>
-<ul>
-<li><b>Decrease Gauss Points Magnification </b> - divides the current
-magnification by magnification ratio. </li>
-<li><b>Increase Gauss Points Magnification </b> - multiplies the
-current magnification by magnification ratio. </li>
-</ul>
-</ul>
-
-<br><br><b>Inside<b> and </b>Outside Cursor Preferences</b> allow to set
-<b>Primitives</b>, <b>Size</b> and <b>Magnification</b> for the
-respective zones.
-
-<br><h2>Picking Preferences</h2>
-
-\image html pref37.png
-
-<ul>
-<li><b>Cursor</b> - allows to adjust the Size of the cursor used for
-Picking (ranging from 0.1 to 1), the Height of the pyramids (ranging
-from 0 to 10) and the Selection cursor color.</li>
-<li><b>Tolerance</b> - defines at which distance of the cursor from
-the point it becomes selected (ranges from 0.001 to 10).</li>
-<li><b>Information window</b> - allows to define the
-<b>Transparency</b> (from 0% = opaque to 100% = transparent) and
-<b>Position</b> of the window, which can be:</li>
-<li><ul>
-  <li><b>Centred below the point</b>, or</li>
-  <li>located at <b>Top-left corner of the 3D view</b></li>
-</ul></li>
-<li><b>Movement of the Camera</b> can also be define by the user.</li>
-<li><ul>
-  <li><b>Zoom at first selected point</b> - This value is used to define
-    the focal distance at the first selected point (at the end of the
-    movement of the camera). This value is a ratio that will be multiplied
-    by the current zoom value.</li>
-  <li><b>Number of steps between two positions</b> - defines the
-    smoothness of camera movement at selection by the number of
-    iterations. If set to 1 the camera is zoomed and centered at the point
-    momentarily. Greater numbers mean very slow camera movement.</li>
-</ul></li>
-<li><b>Display parent mesh element</b> - allows to visualize or hide
-the patent mesh element of the selected gauss point.</li>
-</ul>
-
-*/
diff --git a/doc/salome/gui/input/salome_preferences.doc b/doc/salome/gui/input/salome_preferences.doc
deleted file mode 100644 (file)
index fa51cc3..0000000
+++ /dev/null
@@ -1,269 +0,0 @@
-/*!
-
-\page salome_preferences_page SALOME preferences
-
-General application preferences are specified at the \b SALOME section
-of the \b Preferences dialog box. These preferences affect on the
-application look-n-feel and common functionality.
-
-If you've just started your study and haven't yet loaded other
-modules, you'll be able to change only those settings, which refer to
-the whole GUI SALOME session. These settings will be valid for the
-whole study session.
-
-<h2>General Preferences</h2>
-
-\image html pref_salome_general.png
-
-- <b>Language</b>
-  - <b>Current language</b> - the language used by the application
-  GUI. The language change will come in force only after the application is restarted.
-- <b>Look and feel</b>
-  - <b>Opaque resize</b> - force opaque resize mode for viewers area (tabbed workspace).
-  Clear this checkbox for less perfomant workstations.
-  - <b>Drop-down buttons in toolbars for action groups</b> - when
-  checked, the action groups are represented in the viewer toolbars as
-  a single drop-down button, switchable by the user. Otherwise, all
-  the buttons from the action groups are displayed in the toolbar. 
-- <b>Study Properties</b>
-  - <b>Multi file save</b> - if checked in, your study will be saved in
-    several HDF files (one basic HDF file which will store the main
-    information about the saved study and several other files for the
-    data created by each component used during the study
-    session). Opening of this study requires that \b ALL saved files
-    should be stored in the \b SAME directory. If you would like to
-    copy your saved study in another directory or machine, you should
-    copy all stored files. Otherwise, if you try to open this study,
-    some data will be lost and it will lead to invalid functioning of
-    the SALOME platform. 
-  - <b>ASCII save</b> - if checked in, your study will be saved in
-    ASCII format file (or files).
-  - <b>Store positions of windows</b> -  if checked in, positions of windows
-    will be saved in a special file at the end of the current session and
-    then restored for a new session.
-  - <b>Auto-save interval (min)</b> - allows to specify the time interval (in
-    minutes) for automatic study saving operation. If the time interval is
-    equal to 0 ("Disabled" value is shown) the automatic saving is not performed.
-  - <b>Store/restore last GUI state</b> - if checked in, all GUI settings are
-    saved with the rest of the data whenever you save the study. When the
-    study is reopened, the GUI state is restored.
-  - <b>Multi file python dump</b> - allows to generate multiple files
-    (separately for each component) for dumping of a study to a python script.
-    If the option is disabled, the study is dumped to a single python script.
-  - <b>Publish in study in python dump</b> - if this option is switched on,
-    the Python script resulting from Dump Python operation will
-    include commands related to the publication of the data in the
-    study (if this option is supported by specific module).
-  - <b>Save GUI state in python dump</b> - if this option is switched on,
-    the Python script resulting from Dump Python operation will
-    include commands related to the GUI state.
-- <b>External browser</b> - allow to define what browser will 
-    be used to show SALOME reference manuals: internal (built-in
-    SALOME browser) or external (IE, Netscape, Mozilla, ...). In
-    addition, it is possible to specify 
-    - \b Application - this option allows you to set an external browser (IE,
-    Netscape) which will be used for viewing SALOME reference manuals. By
-    default, Mozilla is used.
-    - \b Parameters - additional parameters required for launching of
-    the external browser (if applicable).
-- <b>Python console</b> - here you can quickly set the parameters
-  (style, size, face) of the \ref font_color_dlg "font" used in
-  embedded Python console. 
-- <b>Show MRU items</b> - allows to define the maximum \b Number of
-items in <b>Most Recently Used</b> list and the <b>Link type</b>: 
-  - \b Long - shows the full path to the file. 
-  - \b Short - shows the file name only.
-  - \b Auto - shows full paths to the files only if some files from
-different locations have the same name.
-
-\anchor occ_preferences
-<h2>OCC Viewer 3d Preferences</h2>
-
-\image html pref_salome_occviewer.png
-
-- <b>Trihedron</b> - viewer trihedron settings:
-  - <b>Size</b> - size of the coordinate axes (global trihedron)
-    displayed in the viewer.
-  - <b>Relative size</b> - if this option is switched on, trihedron
-    axes scale to fit the size of the scene displayed in 3D viewer.
-  - <b>Show static trihedron</b> - allows to show/hide the static
-    mini-trihedron located in the bottom-left corner of the viewer.
-- <b>Number of isolines</b> - this submenu allows to specify the
-  number of isolines along the axes of coordinates:
-  - <b>Along U</b> and
-  - <b>Along V</b>
-- <b>Background</b> - specifies the default background for the viewers,
-  separately for (for more details, refer to the \ref occ_background
-  "this page"):
-  - <b>3D View</b>
-  - <b>XZ View</b>
-  - <b>YZ View</b>
-  - <b>XY View</b>
-- <b>Navigation style</b> - this option allows to choose one of the
-  modes of work with mouse in OCC and VTK 3D viewers.
-  - <b>Salome Standard Controls</b> - allows to manipulate objects in the
-  viewer with the mouse and locked Ctrl button: increase or decrease the
-  zoom ratio with the left mouse button, translate object in any
-  direction with the central mouse button or rotate it with the right
-  mouse button.
-  - <b>Keyboard Free</b> - allows to manipulate objects in the viewer
-  with the mouse without locking Ctrl button. In this case the
-  operations are assigned to the buttons differently: rotation is made
-  with the left button, translation with the right and zoom with both
-  pressed in the same time.
-- <b>Zooming style</b> - this option allows to choose a zooming mode.
-  - <b>Relative to the view's center</b> - allows to zoom the view 
-  relatively to its center.
-  - <b>Relative to the cursor</b> - allows to zoom the view
-  relatively to the current cursor position.
-
-\anchor vtk_preferences
-<h2>VTK Viewer 3d Preferences</h2>
-
-\image html pref_salome_vtkviewer.png
-
-- <b>Projection mode</b> - allows choosing between \b Orthogonal and
-\b Perspective projection mode.
-- <b>Background</b> - specifies the default background for the viewer;
-  for more details, refer to the \ref vtk_background "this page".
-- <b>Navigation style</b> - this option allows to choose one of the
-  modes of work with mouse in OCC and VTK 3D viewers (for more details
-  see \ref occ_preferences "preferences for OCC Viewer 3d").
-- <b>Zooming style</b> - this option allows to choose a zooming mode
-  (for more details see \ref occ_preferences "preferences for OCC Viewer 3d").
-- <b>Speed Increment</b> - defines the number of units by
-  which the speed increases or respectively decreases after pressing [+]
-  or [-] keyboard buttons.
-- <b>Modification Mode</b> - allows choosing between \b Arithmetic
-  and \b Geometrical progression used for zooming.
-- <b>Dynamic pre-selection</b> - switches dynamic pre-selection on/off.
-- <b>Trihedron</b> - viewer trihedron settings:
-  - <b>Size</b> - size of the coordinate axes displayed in the viewer.
-  - <b>Relative size</b> - if this option is switched on, trihedron
-    axes scale to fit the size of the scene displayed in 3D viewer.
-  - <b>Show static trihedron</b> - allows to show/hide the static
-    mini-trihedron located in the bottom-left corner of the viewer.
-- <b>Spacemouse</b> - a mouse-like manipulator device specially designed
-  for working with 3D presentations, objects, etc. You can reassign the
-  actions listed below to any of its buttons.
-  - <b>Decrease Speed Increment</b> - decreases by 1 the speed
-  increment used for the keyboard (same as [-] key).
-  - <b>Increase Speed Increment</b> - increase by 1 the speed
-  increment used for the keyboard (same as [+] key).
-  - <b>Dominant / combined switch</b> - toggles button to switch to
-  dominant or combined movements. 
-- <b>AVI Recording</b>
-  - <b>Mode</b> - allows to choose from two recording regimes:
-    - <b>Recording all displayed frames</b> - records exactly at the
-    FPS rate specified by the user. 
-    - <b>Recording at a given FPS</b> - records only when the contents
-    of the viewer change (some activity is performed).  In the AVI file
-    non-recorded images are substituted with the copies of the latest
-    recorded image, which produces files with lower quality but requires
-    less system resources.
-  - <b>FPS</b> - allows to define the FPS (frames per second) rate for
-  the clip. Set greater value for better quality.
-  - <b>Quality</b> - allows to set the quality of the clip in the
-  interval between 0 and 100.
-  - <b>Progressive</b> - allows to record a progressive API file.
-- <b>Names of groups</b> - allows to specify parameters of the
-titles displayed in the viewer:
-  - <b>Text color</b> - allows selecting the text color;
-  - <b>Transparency</b> - allows selecting the text transparency.
-
-\anchor plot2d_preferences
-<h2>Plot2d Viewer Preferences</h2>
-
-\image html pref_salome_plot2dviewer.png
-
-- <b>Show legend</b> - this options specifies if it's necessary to
-show legend by default.
-- <b>Legend Position</b> - this submenu allows to set the default position
-of the legend, it can be located to the left, to the right, on top or
-on bottom of the graph.
-- <b>Legend font</b> - this allows to set type and face for the font of Legend item.
-- <b>Curve Type</b> - this allows to set the representation of graphs in
-your presentations. You can see only <b>Points</b>, points connected with
-<b>Lines</b> or points connected with smooth <b>Splines</b>.
-- <b>Marker Size</b> - this submenu allows you to set the size of
-markers in your graphs.
-- <b>Horizontal</b> and <b>Vertical axis scale</b> - this submenus allow you to set
-the scale for vertical and horizontal axes. It can be either <b>Linear</b> or
-<b>Logarithmic</b>. Note that the <b>Logarithmic</b> scale can be used only
-if the minimum value of corresponding component (abscissa or ordinate)
-of all points displayed in the viewer is greater than zero.
-If this condition is not met, the scale is switched to <b>Linear</b>
-automatically, even if it is set to <b>Logarithmic</b>.
-- <b>Background color</b> - this submenu allows to select the background
-color. Click on the colored line to access to the
-\ref select_color_and_font_page "Select Color" dialog box.
-- <b>Legend font color</b> - this allows to select the color of the
-font of the legend item. 
-- <b>Highlighted legend font color</b> - this submenu allows to select
-the color of the font of the selected legend item. 
-- <b>Selection color</b> - this submenu allows to select the color of
-selected object in the viewer. 
-- <b>Deviation marker color</b> - this submenu allows to select the
-color of the deviation marker. 
-- <b>Deviation marker line width</b> allows to define line width of
-the deviation marker. 
-- <b>Deviation marker tick size</b> allows to define size of the upper
-and lower horizontal lines of the deviation marker. 
-
-<br><h2>Directories Preferences</h2>
-
-\image html pref_salome_directories.png
-
-- <b>Quick Directory List</b> - this section allows to create and manage
-a custom quick directory list. To add a directory in the list, press
-the "Add directory" button:
-\image html image70.png
-then the &quot;<b>...</b>&quot; button and browse the data tree for the
-directory you need.
-The "Up" and "Down" buttons(see the picture below) help you to sort
-the directories in the list:
-\image html image73.png
-\image html image75.png
-To remove the selected directory from the list, press the "Delete"
-button:
-\image html image72.png
-
-<br><h2>Object Browser Preferences</h2>
-
-\image html pref_salome_objbrowser.png
-
-- <b>Search Tool</b> - specifies behavior of the
-\ref using_find_tool_page "Search tool".
-  - <b>Enable auto-hiding</b> checkbox - hides the search tool
-  automatically after short perioud of time when it is not used.
-- <b>Look and feel</b>
-  - <b>Auto size for the first column</b> - this checkbox enables automatic
-  resizing for the first column.
-  - <b>Auto size for other columns</b> - this checkbox enables
-  automatic resizing for the other columns.
-  - <b>Resize columns after expanding an item</b> - this checkbox enables
-  resizing columns on expanding an object browser item.
-  - <b>Browse to the published object</b> - this combobox allows to enable
-  automatic browsing to the objects just published to the study (using GUI
-  dialogs only). It means that the object browser will be scrolled to the
-  published objects, make them visible if they are collapsed and select the
-  first of them. Three modes are allowed for activating this feature:
-    - <b>Never</b> - automatic browsing is disabled.
-    - <b>After Apply & Close only</b> - browsing is activated when the
-    dialog is accepted by <b>Apply & Close</b> or <b>Ok</b> buttons (or if
-    the objects are published without using a dialog, for example, by
-    clicking a context menu button) and not activated when the
-    <b>Apply</b> button is pressed and therefore the dialog remains visible.
-    - <b>Always</b> - automatic browsing is always enabled.
-- <b>Default columns</b> - these checkboxes allow to display or hide <b>Value</b>,
-<b>Entry</b>, <b>IOR</b> and <b>Reference entry</b> columns in the Object Browser.
-
-<br><h2>Shortcuts Preferences</h2>
-
-\image html pref_salome_shortcuts.png
-
-- <b>Shortcuts settings</b> widget allows to define custom shortcuts for
-various operations. To change keyboard sequence for a certain action - select the
-action and press the custom keys combination.
-
-*/
index 0ecc8a2a4f4c655e6a7a28645ad69d752e1416ca..79f9c85b6bba00c10bdc2ce906800ad1a845376c 100644 (file)
@@ -18,12 +18,272 @@ controls that can be used to customize the preferences.
 explicit loading of these modules. Until that time the dialog box will
 show corresponding warning message. 
 
-For more details about application preferences can be found in the
-following chapters:
-- \subpage salome_preferences_page
-- \subpage geometry_preferences_page
-- \subpage mesh_preferences_page
-- \subpage postpro_preferences_page
+More detailed information about certain module preferences can be found in the User's guide of the corresponding module.
+
+General application preferences are specified at the \b SALOME section
+of the \b Preferences dialog box. These preferences affect on the
+application look-n-feel and common functionality.
+
+If you've just started your study and haven't yet loaded other
+modules, you'll be able to change only those settings, which refer to
+the whole GUI SALOME session. These settings will be valid for the
+whole study session.
+
+<h2>General Preferences</h2>
+
+\image html pref_salome_general.png
+
+- <b>Language</b>
+  - <b>Current language</b> - the language used by the application
+  GUI. The language change will come in force only after the application is restarted.
+- <b>Look and feel</b>
+  - <b>Opaque resize</b> - force opaque resize mode for viewers area (tabbed workspace).
+  Clear this checkbox for less perfomant workstations.
+  - <b>Drop-down buttons in toolbars for action groups</b> - when
+  checked, the action groups are represented in the viewer toolbars as
+  a single drop-down button, switchable by the user. Otherwise, all
+  the buttons from the action groups are displayed in the toolbar. 
+- <b>Study Properties</b>
+  - <b>Multi file save</b> - if checked in, your study will be saved in
+    several HDF files (one basic HDF file which will store the main
+    information about the saved study and several other files for the
+    data created by each component used during the study
+    session). Opening of this study requires that \b ALL saved files
+    should be stored in the \b SAME directory. If you would like to
+    copy your saved study in another directory or machine, you should
+    copy all stored files. Otherwise, if you try to open this study,
+    some data will be lost and it will lead to invalid functioning of
+    the SALOME platform. 
+  - <b>ASCII save</b> - if checked in, your study will be saved in
+    ASCII format file (or files).
+  - <b>Store positions of windows</b> -  if checked in, positions of windows
+    will be saved in a special file at the end of the current session and
+    then restored for a new session.
+  - <b>Auto-save interval (min)</b> - allows to specify the time interval (in
+    minutes) for automatic study saving operation. If the time interval is
+    equal to 0 ("Disabled" value is shown) the automatic saving is not performed.
+  - <b>Store/restore last GUI state</b> - if checked in, all GUI settings are
+    saved with the rest of the data whenever you save the study. When the
+    study is reopened, the GUI state is restored.
+  - <b>Multi file python dump</b> - allows to generate multiple files
+    (separately for each component) for dumping of a study to a python script.
+    If the option is disabled, the study is dumped to a single python script.
+  - <b>Publish in study in python dump</b> - if this option is switched on,
+    the Python script resulting from Dump Python operation will
+    include commands related to the publication of the data in the
+    study (if this option is supported by specific module).
+  - <b>Save GUI state in python dump</b> - if this option is switched on,
+    the Python script resulting from Dump Python operation will
+    include commands related to the GUI state.
+- <b>External browser</b> - allow to define what browser will 
+    be used to show SALOME reference manuals: internal (built-in
+    SALOME browser) or external (IE, Netscape, Mozilla, ...). In
+    addition, it is possible to specify 
+    - \b Application - this option allows you to set an external browser (IE,
+    Netscape) which will be used for viewing SALOME reference manuals. By
+    default, Mozilla is used.
+    - \b Parameters - additional parameters required for launching of
+    the external browser (if applicable).
+- <b>Python console</b> - here you can quickly set the parameters
+  (style, size, face) of the \ref font_color_dlg "font" used in
+  embedded Python console. 
+- <b>Show MRU items</b> - allows to define the maximum \b Number of
+items in <b>Most Recently Used</b> list and the <b>Link type</b>: 
+  - \b Long - shows the full path to the file. 
+  - \b Short - shows the file name only.
+  - \b Auto - shows full paths to the files only if some files from
+different locations have the same name.
+
+\anchor occ_preferences
+<h2>OCC Viewer 3d Preferences</h2>
+
+\image html pref_salome_occviewer.png
+
+- <b>Trihedron</b> - viewer trihedron settings:
+  - <b>Size</b> - size of the coordinate axes (global trihedron)
+    displayed in the viewer.
+  - <b>Relative size</b> - if this option is switched on, trihedron
+    axes scale to fit the size of the scene displayed in 3D viewer.
+  - <b>Show static trihedron</b> - allows to show/hide the static
+    mini-trihedron located in the bottom-left corner of the viewer.
+- <b>Number of isolines</b> - this submenu allows to specify the
+  number of isolines along the axes of coordinates:
+  - <b>Along U</b> and
+  - <b>Along V</b>
+- <b>Background</b> - specifies the default background for the viewers,
+  separately for (for more details, refer to the \ref occ_background
+  "this page"):
+  - <b>3D View</b>
+  - <b>XZ View</b>
+  - <b>YZ View</b>
+  - <b>XY View</b>
+- <b>Navigation style</b> - this option allows to choose one of the
+  modes of work with mouse in OCC and VTK 3D viewers.
+  - <b>Salome Standard Controls</b> - allows to manipulate objects in the
+  viewer with the mouse and locked Ctrl button: increase or decrease the
+  zoom ratio with the left mouse button, translate object in any
+  direction with the central mouse button or rotate it with the right
+  mouse button.
+  - <b>Keyboard Free</b> - allows to manipulate objects in the viewer
+  with the mouse without locking Ctrl button. In this case the
+  operations are assigned to the buttons differently: rotation is made
+  with the left button, translation with the right and zoom with both
+  pressed in the same time.
+- <b>Zooming style</b> - this option allows to choose a zooming mode.
+  - <b>Relative to the view's center</b> - allows to zoom the view 
+  relatively to its center.
+  - <b>Relative to the cursor</b> - allows to zoom the view
+  relatively to the current cursor position.
+
+\anchor vtk_preferences
+<h2>VTK Viewer 3d Preferences</h2>
+
+\image html pref_salome_vtkviewer.png
+
+- <b>Projection mode</b> - allows choosing between \b Orthogonal and
+\b Perspective projection mode.
+- <b>Background</b> - specifies the default background for the viewer;
+  for more details, refer to the \ref vtk_background "this page".
+- <b>Navigation style</b> - this option allows to choose one of the
+  modes of work with mouse in OCC and VTK 3D viewers (for more details
+  see \ref occ_preferences "preferences for OCC Viewer 3d").
+- <b>Zooming style</b> - this option allows to choose a zooming mode
+  (for more details see \ref occ_preferences "preferences for OCC Viewer 3d").
+- <b>Speed Increment</b> - defines the number of units by
+  which the speed increases or respectively decreases after pressing [+]
+  or [-] keyboard buttons.
+- <b>Modification Mode</b> - allows choosing between \b Arithmetic
+  and \b Geometrical progression used for zooming.
+- <b>Dynamic pre-selection</b> - switches dynamic pre-selection on/off.
+- <b>Trihedron</b> - viewer trihedron settings:
+  - <b>Size</b> - size of the coordinate axes displayed in the viewer.
+  - <b>Relative size</b> - if this option is switched on, trihedron
+    axes scale to fit the size of the scene displayed in 3D viewer.
+  - <b>Show static trihedron</b> - allows to show/hide the static
+    mini-trihedron located in the bottom-left corner of the viewer.
+- <b>Spacemouse</b> - a mouse-like manipulator device specially designed
+  for working with 3D presentations, objects, etc. You can reassign the
+  actions listed below to any of its buttons.
+  - <b>Decrease Speed Increment</b> - decreases by 1 the speed
+  increment used for the keyboard (same as [-] key).
+  - <b>Increase Speed Increment</b> - increase by 1 the speed
+  increment used for the keyboard (same as [+] key).
+  - <b>Dominant / combined switch</b> - toggles button to switch to
+  dominant or combined movements. 
+- <b>AVI Recording</b>
+  - <b>Mode</b> - allows to choose from two recording regimes:
+    - <b>Recording all displayed frames</b> - records exactly at the
+    FPS rate specified by the user. 
+    - <b>Recording at a given FPS</b> - records only when the contents
+    of the viewer change (some activity is performed).  In the AVI file
+    non-recorded images are substituted with the copies of the latest
+    recorded image, which produces files with lower quality but requires
+    less system resources.
+  - <b>FPS</b> - allows to define the FPS (frames per second) rate for
+  the clip. Set greater value for better quality.
+  - <b>Quality</b> - allows to set the quality of the clip in the
+  interval between 0 and 100.
+  - <b>Progressive</b> - allows to record a progressive API file.
+- <b>Names of groups</b> - allows to specify parameters of the
+titles displayed in the viewer:
+  - <b>Text color</b> - allows selecting the text color;
+  - <b>Transparency</b> - allows selecting the text transparency.
+
+\anchor plot2d_preferences
+<h2>Plot2d Viewer Preferences</h2>
+
+\image html pref_salome_plot2dviewer.png
+
+- <b>Show legend</b> - this options specifies if it's necessary to
+show legend by default.
+- <b>Legend Position</b> - this submenu allows to set the default position
+of the legend, it can be located to the left, to the right, on top or
+on bottom of the graph.
+- <b>Legend font</b> - this allows to set type and face for the font of Legend item.
+- <b>Curve Type</b> - this allows to set the representation of graphs in
+your presentations. You can see only <b>Points</b>, points connected with
+<b>Lines</b> or points connected with smooth <b>Splines</b>.
+- <b>Marker Size</b> - this submenu allows you to set the size of
+markers in your graphs.
+- <b>Horizontal</b> and <b>Vertical axis scale</b> - this submenus allow you to set
+the scale for vertical and horizontal axes. It can be either <b>Linear</b> or
+<b>Logarithmic</b>. Note that the <b>Logarithmic</b> scale can be used only
+if the minimum value of corresponding component (abscissa or ordinate)
+of all points displayed in the viewer is greater than zero.
+If this condition is not met, the scale is switched to <b>Linear</b>
+automatically, even if it is set to <b>Logarithmic</b>.
+- <b>Background color</b> - this submenu allows to select the background
+color. Click on the colored line to access to the
+\ref select_color_and_font_page "Select Color" dialog box.
+- <b>Legend font color</b> - this allows to select the color of the
+font of the legend item. 
+- <b>Highlighted legend font color</b> - this submenu allows to select
+the color of the font of the selected legend item. 
+- <b>Selection color</b> - this submenu allows to select the color of
+selected object in the viewer. 
+- <b>Deviation marker color</b> - this submenu allows to select the
+color of the deviation marker. 
+- <b>Deviation marker line width</b> allows to define line width of
+the deviation marker. 
+- <b>Deviation marker tick size</b> allows to define size of the upper
+and lower horizontal lines of the deviation marker. 
+
+<br><h2>Directories Preferences</h2>
+
+\image html pref_salome_directories.png
+
+- <b>Quick Directory List</b> - this section allows to create and manage
+a custom quick directory list. To add a directory in the list, press
+the "Add directory" button:
+\image html image70.png
+then the &quot;<b>...</b>&quot; button and browse the data tree for the
+directory you need.
+The "Up" and "Down" buttons(see the picture below) help you to sort
+the directories in the list:
+\image html image73.png
+\image html image75.png
+To remove the selected directory from the list, press the "Delete"
+button:
+\image html image72.png
+
+<br><h2>Object Browser Preferences</h2>
+
+\image html pref_salome_objbrowser.png
+
+- <b>Search Tool</b> - specifies behavior of the
+\ref using_find_tool_page "Search tool".
+  - <b>Enable auto-hiding</b> checkbox - hides the search tool
+  automatically after short perioud of time when it is not used.
+- <b>Look and feel</b>
+  - <b>Auto size for the first column</b> - this checkbox enables automatic
+  resizing for the first column.
+  - <b>Auto size for other columns</b> - this checkbox enables
+  automatic resizing for the other columns.
+  - <b>Resize columns after expanding an item</b> - this checkbox enables
+  resizing columns on expanding an object browser item.
+  - <b>Browse to the published object</b> - this combobox allows to enable
+  automatic browsing to the objects just published to the study (using GUI
+  dialogs only). It means that the object browser will be scrolled to the
+  published objects, make them visible if they are collapsed and select the
+  first of them. Three modes are allowed for activating this feature:
+    - <b>Never</b> - automatic browsing is disabled.
+    - <b>After Apply & Close only</b> - browsing is activated when the
+    dialog is accepted by <b>Apply & Close</b> or <b>Ok</b> buttons (or if
+    the objects are published without using a dialog, for example, by
+    clicking a context menu button) and not activated when the
+    <b>Apply</b> button is pressed and therefore the dialog remains visible.
+    - <b>Always</b> - automatic browsing is always enabled.
+- <b>Default columns</b> - these checkboxes allow to display or hide <b>Value</b>,
+<b>Entry</b>, <b>IOR</b> and <b>Reference entry</b> columns in the Object Browser.
+
+<br><h2>Shortcuts Preferences</h2>
+
+\image html pref_salome_shortcuts.png
+
+- <b>Shortcuts settings</b> widget allows to define custom shortcuts for
+various operations. To change keyboard sequence for a certain action - select the
+action and press the custom keys combination.
+
 
 \subpage select_color_and_font_page "Font and color preferences"
 are most oftenly used types of user settings.
index 97bad300b463a4a1ae6ea3ee216e4de775887542..6511e7995e537449ab4c13f2cf257e3bac79bcd5 100644 (file)
@@ -26,7 +26,7 @@ right-click on a definite object in the Object Browser.
 The Object Browser may contain supplementary attributes of the objects
 displayed in additional columns. By default, these columns are not
 displayed -  displaying/hiding these columns is possible through
-\ref salome_preferences_page "setting study preferences" or
+\ref setting_preferences_page "setting study preferences" or
 right-clicking on the attributes bar and toggling the necessary
 attributes.