Salome HOME
Corrections for the user's manual from the English language point of view
[modules/shaper.git] / doc / gui / Introduction.rst
index 00c3a2c31f16074fffa6ebba8b48fa977a67dae4..0a3075b42f6d09e8048f8d4a92c91846d6e08399 100644 (file)
@@ -8,7 +8,7 @@ Introduction to SHAPER
 SHAPER module of SALOME is destined for:\r
 \r
 - import and export of geometrical models in IGES, BREP, STEP and XAO formats;\r
-- parametric construction of geometrical objects using a wide range of functions;\r
+- parametric construction of geometrical objects using a wide range of functions:\r
     \r
   - creation of complex 2D sections using :ref:`sketchPlugin` with consequent extrusion or revolution (see :ref:`featuresPlugin`);\r
   - construction of model using primitives defined in :ref:`primitivesPlugin`;\r
@@ -30,17 +30,17 @@ SHAPER module works with one study containing several documents:
 \r
 Only one document can be active.\r
   \r
-New study contains only partset with 7 default constructions which cannot be deleted:\r
+A new study contains only a partset with 7 default constructions, which cannot be deleted:\r
   \r
-- one point **Origin** coinciding with origin of coordinate system;\r
+- one point **Origin** coinciding with the origin of the coordinate system;\r
 - three axes **OX**, **OY**, **OZ**  coinciding with coordinate axes;\r
 - three planes **YOZ**, **XOZ**, **XOY**  coinciding with coordinate planes.    \r
 \r
-Only  points, axis and planes (see  :ref:`constructionPlugin`) and sketches (see  :ref:`sketchPlugin`) can be added into Partset to be used in any part later.\r
+Only  points, axis, planes (see  :ref:`constructionPlugin`) and sketches (see  :ref:`sketchPlugin`) can be added into Partset to be used in any part later.\r
 :ref:`parameter_usage` can be used both in Partset and any Part.\r
 \r
      \r
-New Part can be created as described in :ref:`partPlugin`.\r
+A new Part can be created as described in :ref:`partPlugin`.\r
 \r
 Double click or pop-up menu can be used to activate existing document.\r
 \r
@@ -113,7 +113,7 @@ Application toolbar contains:
 .. centered::\r
    Toolbars\r
   \r
-SHAPER toolbar duplicates main menu and  provides access to all commands of the application.\r
+SHAPER toolbar duplicates the main menu and  provides access to all commands of the application.\r
 \r
 SHAPER toolbar is separated into sections:\r
 \r
@@ -146,19 +146,19 @@ Standard dock windows are:
 - :ref:`python console`\r
 - :ref:`property_panel`\r
 \r
-Dock windows can be placed in three dock areas using drag-and -drop:\r
+Dock windows can be placed in three dock areas using drag-and-drop:\r
   \r
 - left, \r
 - right, \r
 - bottom.\r
 \r
-By default object browser window is placed at the left dock area, Inspection panel at the right dock area and Python console at the bottom dock area of the main window.\r
+By default Object browser window is placed at the left dock area, Inspection panel at the right dock area and Python console at the bottom dock area of the main window.\r
 \r
 Property Panel is hidden.\r
 \r
-The Property Panel is shown on operation start at left dock area of the main window by default.\r
+Property Panel is shown on operation start in left dock area of the main window by default.\r
 \r
-If Object Browser is shown at the same side then they will be tabbed.\r
+If Object browser is shown at the same side then they will be tabbed.\r
 \r
 Each dock window can be closed using **Cross** window button and opened again using a corresponding command from *View - Windows* :ref:`main_menu` or alternatively using pop-up menu.\r
 \r
@@ -210,14 +210,14 @@ New part contains only 3 empty branches:
 \r
 Features are placed one after another in the active document with default names and their results are placed into the corresponding branch.\r
 \r
-Example of default names assigned automatically for :ref:`box_feature` are:\r
+Examples of default names assigned automatically for :ref:`box_feature` are:\r
  \r
-* **Box_1**, **Box_2**, ... to Feature;\r
-* **Box_1_1**, **Box_2_1**, ... to Result.\r
+* **Box_1**, **Box_2**, ... for Feature;\r
+* **Box_1_1**, **Box_2_1**, ... for Result.\r
 \r
-Not default branch is added into Tree View when the first feature of this type is created.\r
+Note, that a default branch is added into Tree View when the first feature of this type is created.\r
 \r
-Note, that result used in feature as argument is removed.\r
+Note, that the result used in feature as argument is removed.\r
 \r
 This child result can be restored using **Recover** feature.\r
 \r
@@ -241,7 +241,7 @@ Each feature, result, construction, group, field, parameter can be renamed using
 .. centered::\r
    Construction pop-up menu\r
 \r
-Order of features can be changed using *Move to the end* pop-up menu command. Selected feature will be moved to the end of feature list.\r
+The order of features can be changed using *Move to the end* pop-up menu command. The selected feature will be moved to the end of feature list.\r
 \r
 Folders can be used to arrange long Tree View for features.\r
 \r
@@ -251,17 +251,17 @@ Folders can be used to arrange long Tree View for features.
 .. centered::\r
    Object browser with folder Dome. Part_1 active\r
 \r
-*Insert a folder before* pop-up menu command creates a new empty folder before the selected feature. Folder can be renamed.\r
+*Insert a folder before* pop-up menu command creates a new empty folder before the selected feature. The folder can be renamed.\r
 \r
 Features placed after/before the created folder can be moved into the folder using *Move into the previous folder* / *Move into the next folder* pop-up menu command.\r
 \r
-This allows to decrease length of feature list.\r
+This allows to decrease the length of feature list.\r
 \r
-Features can be removed from folder back using *Move out before the folder* / *Move out after the folder* pop-up menu command.\r
+Features can be removed from the folder using *Move out before the folder* / *Move out after the folder* pop-up menu command.\r
 \r
 *Clean history* pop-up menu command looks for features that do not participate in other features.\r
 \r
-**Clean history** dialog box shows list of unused features. After confirmation by click **Yes** button unused features are removed.\r
+**Clean history** dialog box shows list of unused features. After confirmation by click **Yes** button unused features are removed.\r
 \r
 .. image:: images/clean_history.png\r
    :align: center\r
@@ -273,11 +273,11 @@ Features can be removed from folder back using *Move out before the folder* / *M
 *Select result* and *Select parent feature* pop-up menu commands help to navigate along Tree View.\r
 \r
 \r
-Feature together with its result can be deleted using *Delete* pop-up menu command.\r
+A feature and its result can be deleted using *Delete* pop-up menu command.\r
 \r
-Note that all features using removed feature and their results will be removed simultaneously.\r
+Note that all features using the removed feature and their results will be removed simultaneously.\r
 \r
-**Delete feature** dialog box shows list of features to be removed. After confirmation by click **Yes** button all these features are removed.\r
+**Delete feature** dialog box shows the list of features to be removed. After confirmation by click **Yes** button all these features are removed.\r
 \r
 \r
 .. image:: images/delete_feature.png\r
@@ -293,7 +293,7 @@ Property panel
 \r
 Property panel consists of two parts:\r
 \r
-- controls container for input of parameters for the current operation;\r
+- controls container for input of parameters for the current operation;\r
 - buttons panel containing standard buttons:\r
  \r
   .. image:: images/button_ok.png\r
@@ -361,14 +361,14 @@ Python console
 \r
 Python console interpreters Python commands entered manually.\r
 \r
-In particular, it is possible to load python script:\r
+In particular, it is possible to load the python script:\r
 \r
 *execfile(r"/dn48/newgeom/data/example.py")*\r
 \r
-Pop-up menu allows:\r
+Pop-up menu gives the possibility to:\r
 \r
-- Copy selected text to clipboard;\r
-- Paste text from clipboard to Python console ;\r
+- Copy the selected text to clipboard;\r
+- Paste the text from clipboard to Python console ;\r
 - Clear Python console;\r
 - Dump commands from console into the specified file;\r
 - Start/Stop writing log into the specified file.    \r
@@ -385,13 +385,13 @@ Pop-up menu allows:
 Viewer\r
 ------\r
 \r
-The application supports one OCC 3D viewer and is able to show only one 3D space.\r
+The application supports one instance of OCC 3D viewer and is able to show only one 3D space.\r
 \r
 This 3D space can be represented in several view windows. New view window can be created using **Clone view** button in viewer toolbar.\r
 \r
-Each of view windows represents its own point of view on the 3D scene.\r
+Each view windows shows its own point of view on the 3D scene.\r
 \r
-This point of view can be modified by user with help of viewer commands like **Panning**, **Zooming**, **Scaling** and so on.\r
+This point of view can be modified using viewer commands: **Panning**, **Zooming**, **Scaling**, etc.\r
 \r
 \r
 .. image:: images/2_viewers.png\r
@@ -400,7 +400,7 @@ This point of view can be modified by user with help of viewer commands like **P
 .. centered::\r
    Two view windows\r
 \r
-Description of OCC 3D Viewer architecture and functionality is provided in GUI module user's guide in chapter **OCC 3D Viewer**.\r
+The description of OCC 3D Viewer architecture and functionality is provided in GUI module user's guide in chapter **OCC 3D Viewer**.\r
 \r
 \r
 .. _parameter_usage:\r
@@ -410,15 +410,14 @@ Parameters
 \r
 Model parametrization can be done using parameters.\r
 \r
-Parameter can be created in the active partset or part by:\r
-\r
+A parameter can be created in the active partset or part by:\r
 - :ref:`parameter`;\r
 - :ref:`parameters`;\r
 - :ref:`parameter_expression`.\r
 \r
 Any argument in features can be defined as parameter or expression containing parameters.\r
 \r
-List of features using parameters is given in **Parameters** dialog box:\r
+The list of features using parameters is given in **Parameters** dialog box:\r
 \r
  .. image:: images/parameters_feature.png\r
    :align: center\r
@@ -426,13 +425,13 @@ List of features using parameters is given in **Parameters** dialog box:
 .. centered::\r
    Parameters dialog box\r
   \r
-If parameter value is changed, then all features where it is used are rebuilt.\r
+If parameter value is changed, then all features where it is used are rebuilt.\r
 \r
-Parameter name should be unique in the active document.\r
+A parameter name should be unique in the active document.\r
 \r
-However, partset and part can have parameters with the same name. If parameter name in Partset and Part are identical, then Part parameter has higher priority and its value will be used in the features of this part.\r
+However, partset and part can have parameters with the same name. If parameter names in Partset and Part are identical, then Part parameter has a higher priority and its value will be used in the features of this part.\r
 \r
-In contrast to features (see :ref:`object_browser`), there is an additional option  when Delete parameters.   \r
+In contrast to features (see :ref:`object_browser`), there is an additional option when parameters are deleted.   \r
 \r
 .. image:: images/delete_parameter.png\r
    :align: center\r
@@ -440,16 +439,16 @@ In contrast to features (see :ref:`object_browser`), there is an additional opti
 .. centered::\r
    Delete parameter\r
 \r
-After click **Replace** button. selected parameter is removed but parent parameters and features are not removed. Deleted parameter is replaced by its value.\r
+After clicking **Replace** button, the selected parameter is removed but its parent parameters and features are not removed. The deleted parameter is replaced by its value.\r
 \r
 .. _parameter_expression:\r
 \r
 Create parameter on fly\r
 ^^^^^^^^^^^^^^^^^^^^^^^\r
 \r
-Parameter can be created during feature creation simply writing *variable=expression* in any editbox.\r
+Parameter can be created during feature creation simply by writing *variable=expression* in any editbox.\r
 \r
-After validation of feature a new parameter with given name **variable** and value equal to evaluated expression appears in object browser under **Parameters** in the active partset or part.\r
+After feature validation a new parameter with the given name **variable** and value equal to the evaluated expression appears in object browser under **Parameters** in the active partset or part.\r
 \r
 .. _preferences:\r
 \r
@@ -472,7 +471,7 @@ SHAPER preferences include 4 tabs:
 - :ref:`sketch_preferences`;\r
 - :ref:`viewer_preferences`.\r
 \r
-Visualization tab is activated by default when **Preferences** dialog box is opened in active SHAPER module.\r
+Visualization tab is activated by default when **Preferences** dialog box is opened in the active SHAPER module.\r
 \r
 Other tabs are activated by click on tab header.\r
   \r
@@ -512,8 +511,8 @@ This tab defines presentation of objects displayed in OCC 3D viewer.
 - **Sketch entity color** selects default color for sketch objects;\r
 - **Sketch external entity color** selects default color for external objects selected as reference during sketch creation/edition;\r
 - **Sketch auxiliary entity color** selects default color for sketch auxiliary objects;\r
-- **Sketch overconsrtaint color** selects default color for sketch with redundant constraints;\r
-- **Sketch fully constraint color** selects default color for sketch with zero degrees of freedom.\r
+- **Sketch overconstraint color** selects default color for a sketch with redundant constraints;\r
+- **Sketch fully constraint color** selects default color for sketch with zero degrees of freedom.\r
   \r
 To redefine any color click on the corresponding line to access **Select color** dialog box\r
 \r