From e2c03813b82c852825b4af3ee086af1acd5abc27 Mon Sep 17 00:00:00 2001
From: eap <eap@opencascade.com>
Date: Tue, 15 Nov 2011 09:09:00 +0000
Subject: [PATCH] Salome documentation revision by Yury Solomatin

---
 doc/salome/gui/input/mesh_preferences.doc     | 18 +++---
 doc/salome/gui/input/occ_3d_viewer.doc        | 10 +--
 doc/salome/gui/input/plot2d_viewer.doc        |  5 +-
 doc/salome/gui/input/themes.doc               | 27 ++++----
 doc/salome/gui/input/using_object_browser.doc | 14 +++--
 doc/salome/gui/input/using_pluginsmanager.doc | 61 +++++++------------
 doc/salome/gui/input/vtk_3d_viewer.doc        | 20 +++---
 7 files changed, 69 insertions(+), 86 deletions(-)

diff --git a/doc/salome/gui/input/mesh_preferences.doc b/doc/salome/gui/input/mesh_preferences.doc
index c7a8cde85..3b778d44f 100644
--- a/doc/salome/gui/input/mesh_preferences.doc
+++ b/doc/salome/gui/input/mesh_preferences.doc
@@ -65,11 +65,11 @@ information is shown:
 <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> - Size limit for the
+<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 preferences,
+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". Default value is set to 100 000 mesh elements.
+means "no limit". By default the value is set to 100 000 mesh elements.
 </li></ul>
 <li><b>Automatic Parameters</b></li>
 <ul>
@@ -105,14 +105,14 @@ dialog box.</li>
 </ul>
 <li><b>Elements</b></li>
 <ul>
-<li><b>Surface color</b>  - allows to select the color of surface of elements
+<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 color of interior surface
-of elements. Use slider to select this color.  This color generated on base 
-of the <b>Surface color</b> by changing it's brightness and saturation.</li>
-<li><b>Outline color</b> - allows to select the color of borders of
-elements. Click on the colored line to access to the 
+<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 
diff --git a/doc/salome/gui/input/occ_3d_viewer.doc b/doc/salome/gui/input/occ_3d_viewer.doc
index cf3b1a288..8eb2b4b15 100644
--- a/doc/salome/gui/input/occ_3d_viewer.doc
+++ b/doc/salome/gui/input/occ_3d_viewer.doc
@@ -178,17 +178,17 @@ the current view area to the minimized / maximized state.</center>
 <hr>
 
 \image html occ_view_sync.png
-<br><center><b>Synchronize view</b> - synchronize 3d view parameters.</center>
+<br><center><b>Synchronize view</b> - allows to synchronize 3d view parameters.</center>
 This button has two states - checked and unchecked. Clicking on this
 button opens a drop-down menu listing the compatible 3d views. As soon
-as user selects any view from the list, the parameters (view point,
-position, zoom coefficient etc) of the current view are synchronized
-to the selected view (static synchronization).
+as the user selects any view from the list, the parameters (view point,
+position, zoom coefficient, etc.) of the current view are synchronized
+with the selected view (static synchronization).
 
 In addition, when this button is in the "checked" state, the dynamic
 synchronization of the views is performed, i.e. any zoom, pan, rotate
 or other view operation done in one view is automatically applied
-to the second view.
+to the other view.
 <hr>
 
 \note OCC Viewer features a special <b>Polyline Selection</b>
diff --git a/doc/salome/gui/input/plot2d_viewer.doc b/doc/salome/gui/input/plot2d_viewer.doc
index ab1a49cd8..c2ff8c43f 100644
--- a/doc/salome/gui/input/plot2d_viewer.doc
+++ b/doc/salome/gui/input/plot2d_viewer.doc
@@ -97,11 +97,12 @@ The options are as follows:
 - <b>Main title</b> the title of the XY plot. By default, it will
 consist of the names of the tables, on the basis of which the curve
 lines have been constructed.
-- <b>Show legend</b> here you can define the position of the
 - <b>Curve type</b> you can select from \b Points, \b Lines and \b Spline.
+- <b>Show legend</b> here you can define the position of the
 description table on the XY plot (to the \b Left, to the \b Right, on
 \b Top or on \b Bottom).
-- <b>Legend font</b> here you can set type, face and color for the font of Legend item.
+- <b>Legend font</b> here you can set type, face and color for the
+font of Legend item.
 - <b>Marker size</b> - size of the points (markers) forming curve lines.
 - <b>Background color</b> of the XY plot.
 - <b>Scale mode</b> here you can select the type of scaling (\b
diff --git a/doc/salome/gui/input/themes.doc b/doc/salome/gui/input/themes.doc
index 4204270b3..d5f459f73 100755
--- a/doc/salome/gui/input/themes.doc
+++ b/doc/salome/gui/input/themes.doc
@@ -2,33 +2,23 @@
 
 \page themes_page Theme 
 
-The look-n-feel of the SALOME desktop can be customized by the user
-via the SALOME theme preferences.
+The look and feel of the SALOME desktop can be customized by the user
+via SALOME style preferences.
 
 <b>SALOME style prefereces</b> dialog box is used for customization of
 the look and feel of SALOME style. To open it, select in the Main menu
 <b>View -> Theme </b> item.
 
-If SALOME theme is not used (<b>Use SALOME Style</b> check bos is
-switched off), the global system settings are applied (for
-example, those ones specified by the KDE settings).
-In such a way, the application's look-n-feel attributes (such as
-palette and/or font) can be customized by using of the Qt utility
-<em>qtconfig</em>.
-
-Alternatively look-n-feel of the application desktop can be customized
-using SALOME theme.
-
 \image html theme1.png
 
 It is possible to choose a predefined scheme in the list to the left
-or create custom scheme using the controls to the right.
+or to create a custom scheme using the controls to the right.
 
 The dialog box contains two pages.
 
-The first page allows specifying of the color palette.
+The first page allows specifying the color palette.
 - \b Quick button allows automatic color palette definition basing on
-one main color specified by the user.
+the main color specified by the user.
 
 \image html theme2.png
 
@@ -42,4 +32,11 @@ boxes and define their parameters.
 - <b>Widget effect</b> allows to apply special effects to Salome
 dialog boxes.
 
+If SALOME Theme is not used (<b>Use SALOME Style</b> checkbox is
+switched off), the global system settings are applied (for
+example, KDE settings). So, the look and feel of the application (for
+example, palette and/or font) can be customized by using the Qt utility
+<em>qtconfig</em>.
+
+
 */
diff --git a/doc/salome/gui/input/using_object_browser.doc b/doc/salome/gui/input/using_object_browser.doc
index e7b7e6b4b..5421cf6b6 100644
--- a/doc/salome/gui/input/using_object_browser.doc
+++ b/doc/salome/gui/input/using_object_browser.doc
@@ -45,12 +45,14 @@ to the objects</li>
 
 <h1> Enable sorting </h1>
 
-The objects in the object browser are sorted by creation order by default. 
+By default the objects in the object browser are sorted in the creation order. 
 \n
-It is yet possible to enable sorting 
-by alphabetical order (or reverse order) by right clicking in the header of the tree (near the "Name" field) and checking "enable sorting" in the popup menu.
+However, it is possible to enable sorting 
+in the alphabetical order (or the reverse alphabetical order) by right
+clicking in the header of the tree (near the "Name" field) and
+checking "enable sorting" in the popup menu.
 \n
-An arrow appears then near "Name" to reverse the order.
-If unchecking "enable sorting" the objects are sorted with default order again.
- 
+It is possible to use the arrow near "Name" to reverse the order.
+If "enable sorting" is unchecked, the objects are sorted in the default order again.
+
 */
diff --git a/doc/salome/gui/input/using_pluginsmanager.doc b/doc/salome/gui/input/using_pluginsmanager.doc
index f3e5f04c1..4ac23796c 100644
--- a/doc/salome/gui/input/using_pluginsmanager.doc
+++ b/doc/salome/gui/input/using_pluginsmanager.doc
@@ -2,37 +2,34 @@
 
 \page using_pluginsmanager Extends SALOME gui functions using python plugins
 
-This page explains how to extends the SALOME gui function with python
-plugins.
-
 -# \ref S1_SALOMEPLUGINS
 -# \ref S2_SALOMEPLUGINS
 -# \ref S3_SALOMEPLUGINS
 
 \section S1_SALOMEPLUGINS Objectives
 
-The SALOME python plugin manager allows the end user to extends the
-graphic interface of SALOME with its own functions written as python
+The SALOME python plugin manager allows the end user to extend the
+graphic interface of SALOME with custom functions written as python
 modules. The screenshots below show the example of a tool that creates
-a mesh from a set of geometrical parameters, with the support of
+a mesh from a set of geometrical parameters with the support of
 simple graphical interface:
 
-The default menu of plugins is "Tool->Extensions":
+The default menu for plugins is "Tool->Extensions":
 \image html SALOME_pythonplugins_menu.png
 
-In this example, the plugin provides a small interface to capture the
+In this example, the plugin provides a small interface to input the
 parameters (not provided by the plugin manager):
 \image html SALOME_pythonplugins_dialog.png
 
-And then creates the mesh model:
+Then creates the mesh model:
 \image html SALOME_pythonplugins_result.png
 
 In this example, the end user has to write:
 
 -# the python script that creates the mesh from the parameters, using
    the GEOM and SMESH python interface, as in a clasic use case.
--# the dialog box in PyQt to capture the parameters
--# a file salome_plugins.py that must declares the plugins
+-# the dialog box in PyQt to input the parameters
+-# file salome_plugins.py that declares the plugins
 
 This page explains only the last point.
 
@@ -62,12 +59,12 @@ salome_pluginsmanager.AddFunction('My plugin n°2', 'This action runs the plugin
 
 The procedure is to define a function that implements the plugin, and
 to declare this function to the plugins manager. The implementation
-may be anything. The advice is to just consider this function as a
-proxy toward your code that you can manage in a python package
+can be very variable. It is advisable to consider this function as a
+proxy to your code that you can manage in a python package
 installed in the standard SALOME python directories.
 
 In this code, the variable "context" is automatically transmitted by
-the pluginmanager when you request the plugin with at least the
+the pluginmanager when you request the plugin with at least the following
 attributes:
 
 \code
@@ -75,23 +72,22 @@ activeStudy = context.study
 salomegui = context.sg
 \endcode
 
-Once terminated, this script salome_plugin.py has to be move to a
-specific place on your filesystem where SALOME is programmed to lookup
+Once terminated, this script salome_plugin.py has to be moved to a
+specific place on your filesystem where SALOME is programmed to search
 for plugins. The possible directories are:
 
--# The directory <*_ROOT_DIR>/share/salome/plugins, when this plugins
-   is develop in the framework of a SALOME module (<*_ROOT_DIR>
-   specifies here the root installation directory of the module).
+-# The directory <*_ROOT_DIR>/share/salome/plugins, when this plugin
+   is developped in the framework of a SALOME module (<*_ROOT_DIR>
+   is the root installation directory of the module).
 -# The directory ~/.config/salome/Plugins for personnal end user
    plugins
 -# Any path in the shell variable SALOME_PLUGIN_PATH (each path must be
    separated by a comma ":" for unix and ";" for windows). This
-   variable should be set and export before running the SALOME
-   application.  
+   variable should be set and exported before running the SALOME application.  
 
-\section S3_SALOMEPLUGINS Examples
+\section S3_SALOMEPLUGINS A complete example
 
-Suppose you write a SALOME script that creates a trihedron for each of
+Suppose that you write a SALOME script that creates a trihedron for each of
 your studies (a simple and standard SALOME script, that every end user
 is capable to write if he reads the documentation and follows the
 training course):
@@ -115,8 +111,7 @@ geompy.addToStudy( Vz, "Vz" ))
 geompy.addToStudy( origin, "origin" ))
 \endcode
 
-The job consists here in creating the file salome_plugins.py as
-follow:
+The job consists in creating the file salome_plugins.py as follows:
 
 \code
 import salome_pluginsmanager
@@ -143,19 +138,7 @@ salome_pluginsmanager.AddFunction('O,Vx,Vy,Vz',
 
 \endcode
 
-And then, to move this script in the directory
-~/.config/salome/Plugins. Run SALOME and enjoy your new function.
-
-A list of complete examples are included in the module GUI of the
-SALOME plateform. The location is:
-
--# In the source directory: src/SalomeApp/pluginsdemo
--# In the install directory: share/salome/plugins/demo
-
-These plugins are installed by the build procedure but are not
-activated by default. To activate the plugins (i.e. to see an entry in
-the plugins menu of SALOME), you must edit the file salome_plugins.py
-and change the variable DEMO_IS_ACTIVATED to True, and then restart
-the SALOME application.
+Move this script in the directory
+~/.config/salome/Plugins, run SALOME and enjoy your new function.
 
 */
diff --git a/doc/salome/gui/input/vtk_3d_viewer.doc b/doc/salome/gui/input/vtk_3d_viewer.doc
index 325a32314..eb5ab3d09 100644
--- a/doc/salome/gui/input/vtk_3d_viewer.doc
+++ b/doc/salome/gui/input/vtk_3d_viewer.doc
@@ -33,11 +33,11 @@ position) zooming styles. The second mode is available only for parallel
 
 \image html vtk_view_highlight.png
 <br><center><b>Dynamic pre-selection switch</b> - allows to switch
-on/off dynamic pre-selection of the objects. When the dynamic
-pre-selection is switched on, the objects can be selected by clicking
-of the point/cell belonging to this object, with some performance
-loss. Switch dynamic pre-selection off to have good performance on the
-big objects (like huge meshes).</center>
+on/off dynamic pre-selection of objects. When the dynamic
+pre-selection is switched on, an objects can be selected by clicking
+the point/cell belonging to this object, with some performance
+loss. Switch dynamic pre-selection off to have a good performance on 
+big objects (for example, huge meshes).</center>
 <hr>
 
 \image html vtk_view_triedre.png
@@ -196,17 +196,17 @@ of the view:</center><br>
 <hr>
 
 \image html vtk_view_sync.png
-<br><center><b>Synchronize view</b> - synchronize 3d view parameters.</center>
+<br><center><b>Synchronize view</b> - allows to synchronize 3d view parameters.</center>
 This button has two states - checked and unchecked. Clicking on this
 button opens a drop-down menu listing the compatible 3d views. As soon
-as user selects any view from the list, the parameters (view point,
-position, zoom coefficient etc) of the current view are synchronized
-to the selected view (static synchronization).
+as the user selects any view from the list, the parameters (view point,
+position, zoom coefficient, etc.) of the current view are synchronized
+with the selected view (static synchronization).
 
 In addition, when this button is in the "checked" state, the dynamic
 synchronization of the views is performed, i.e. any zoom, pan, rotate
 or other view operation done in one view is automatically applied
-to the second view.
+to the other view.
 <hr>
 
 \image html vtk_view_parallel.png
-- 
2.39.2