X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSketchPlugin%2Fdoc%2FSketchPlugin.rst;h=fd95d68e97bc450310b7a027f0f2bc4b4db0b0ea;hb=bcd96990e1fca77402d522bc8b095ebfa1091894;hp=59a693866ef9be95abdc2a5f4eca9c6aaec041dc;hpb=c5ec43297b55923e1cf2ee39978bf42d733ee465;p=modules%2Fshaper.git

diff --git a/src/SketchPlugin/doc/SketchPlugin.rst b/src/SketchPlugin/doc/SketchPlugin.rst
index 59a693866..fd95d68e9 100644
--- a/src/SketchPlugin/doc/SketchPlugin.rst
+++ b/src/SketchPlugin/doc/SketchPlugin.rst
@@ -5,68 +5,152 @@
 Sketch plug-in
 ================
 
+Sketch plug-in includes features for creation of 2D shapes.
 
-.. image:: images/StartSketch.png
-  :align: center
+The sketch creation takes the following steps:
+
+- definition of sketch plane;
+- creation of sketch objects from scratch;
+- generation of sketch objects via operations on the existing operations;
+- definition of constraints.
+
+Sketch can be created in the active part or in a partset (if there is no active part).
+
+To create a Sketch:
+
+#. select in the Main Menu *Sketch - > Sketch* item  or
+#. click **Sketch** button in Sketch toolbar:
+
+.. image:: images/SketchButton.png
+   :align: center
 
 .. centered::
-  Start sketcher
+   **Sketch**  button
+
+First define a plane for the sketch:
+
+.. image:: images/PlaneDefinition.png
+   :align: center
+
+- specify plane size (equal to 25 in the example above);
+- select the appropriate plane in the viewer.
 
+Note that coordinate planes will be suggested for selection if no convenient objects for plane selection are displayed in the viewer:
 
+.. image:: images/CoordinatePlanes.png
+   :align: center
 
-.. image:: images/SketchProperties.png
-  :align: center
+After the plane for sketch is selected, the following property panel will be opened:
+
+.. image:: images/SketchPanel.png
+   :align: center
 
 .. centered::
-  Sketcher properies panel
+  Sketch general panel
+
+- **Reversed** check box - allows reversing the sketch plane normal;
+- **Set plane view** button - switches the viewer to the top view for the sketch plane;
+- **Show geometrical constraints** check box - displays/hides geometrical constraints:
+- **Show dimensional constraints** check box - displays/hides dimensional constraints; 
+- **Show existing expressions** check box - displays/hides expressions.
+
+Now it is possible to:
+
+- create :ref:`sketch objects <sketch_objects>`
+- create :ref:`constraints <sketch_constraints>`
+- perform :ref:`sketch operations <sketch_operations>`
+
+To apply or cancel sketch creation use Apply and Cancel buttons from the
+Sketch panel as well as equivalent buttons from Sketch toolbar.
+
+The Result of operation will be a COMPOUND. In the object tree, Result node is located in
+**Constructions** folder.
+
+The Name is assigned automatically: **Sketch_1**, **Sketch_2**, ... both for Feature and Result.
+
+**TUI Command**:  *Sketch_1 = model.addSketch(PartOrPartSet, plane)*
 
+**Arguments**:    Part or PartSet + plane.
+
+.. _sketch_objects:
 
 Sketch objects
 --------------
 
+The plug-in includes the following features for creation of 2D objects:
+
 .. toctree::
    :maxdepth: 1
 
-   arcFeature.rst
-   circleFeature.rst
-   ellipseFeature.rst
-   lineFeature.rst
    pointFeature.rst
+   lineFeature.rst
+   rectangleFeature.rst
+   circleFeature.rst
+   arcFeature.rst
+
+.. _sketch_constraints:
 
 Constraints
 -----------
 
+Constraints are available and viewable during sketch creation or editing.
+
+The goal of constraints creation is to fix sketch geometry, i.e. set degrees of freedom to zero.
+
+If all degrees of freedom are eliminated, the sketch is fixed and displayed with green color.
+
+.. image:: images/Sketch_fixed.png
+   :align: center
+
+.. centered::
+  Fixed Sketch
+
+If any degrees of freedom remain unsolved, the sketch is under-constrained and displayed with red color.
+
+.. image:: images/Sketch_underconstrained.png
+   :align: center
+
+.. centered::
+  Underconstrained Sketch
+
+The plug-in includes the following constraints:
+
 .. toctree::
    :maxdepth: 1
 
-   angleFeature.rst
-   coincedenceFeature.rst
-   collinearFeature.rst
    distanceFeature.rst
-   equalFeature.rst
    horizontalDistFeature.rst
-   horizontalFeature.rst
+   verticalDistFeature.rst
    lengthFeature.rst
-   middleFeature.rst
+   angleFeature.rst
+   radiusFeature.rst
+   horizontalFeature.rst
+   verticalFeature.rst
+   fixedFeature.rst
    parallelFeature.rst
    perpendicularFeature.rst
-   radiusFeature.rst
-   rigidFeature.rst
    tangentFeature.rst
-   verticalDistFeature.rst
-   verticalFeature.rst
+   coincedentFeature.rst
+   middleFeature.rst
+   equalFeature.rst
+   collinearFeature.rst
+
+.. _sketch_operations:
 
 Operations
 ----------
+Operations modify existing features of the sketch or create new ones by copying them.
+
+The plug-in includes the following operations:
 
 .. toctree::
    :maxdepth: 1
 
    filletFeature.rst
+   splitFeature.rst
+   trimFeature.rst
+   projectionFeature.rst
    intersectionFeature.rst
    mirrorFeature.rst
-   projectionFeature.rst
-   rotationFeature.rst
-   splitFeature.rst
    translationFeature.rst
-   trimFeature.rst
+   rotationFeature.rst