Correct documentation bugs, adapt for 'Read The Docs' theme (bos #18858)

[modules/shaper.git] / src / SketchPlugin / doc / SketchPlugin.rst

diff --git a/src/SketchPlugin/doc/SketchPlugin.rst b/src/SketchPlugin/doc/SketchPlugin.rst
index 3c2902ba16d4ef4b609058fee83358958dc73168..3e894d078182145a4a6bd9fa632913f9c81f212e 100644 (file)
--- a/src/SketchPlugin/doc/SketchPlugin.rst
+++ b/src/SketchPlugin/doc/SketchPlugin.rst
@@ -1,11 +1,12 @@
 
 .. _sketchPlugin:
-.. |SketchButton.icon|    image:: images/SketchButton.png
 
 
 Sketch plug-in
 ================
 
+.. |SketchButton.icon|    image:: images/SketchButton.png
+
 Sketch plug-in includes features for creation of 2D shapes.
 
 The sketch creation takes the following steps:
@@ -49,8 +50,9 @@ After the plane for sketch is selected, the following property panel will be ope
 - **Show dimensional constraints** check box - displays/hides dimensional constraints; 
 - **Show existing expressions** check box - displays/hides expressions.
 - **Show free points** check box - highlights free points in the current sketch if it is checked.
-- **Automatic constraints** - automatically crerate horizontal or vertical constraints if angle between created line and horizontal or vertical less then angular tolerance (defined in preferences).
+- **Automatic constraints** - automatically create horizontal or vertical constraints if angle between created line and horizontal or vertical less then angular tolerance (defined in preferences).
 - **Change sketch plane** button - allows to change working plane of the current sketch.
+- **Show remaining DoFs** button - highlights all sketch edges which are not fully constrained.
 
 Now it is possible to:
 
@@ -91,6 +93,7 @@ The plug-in includes the following features for creation of 2D objects:
    arcFeature.rst
    ellipseFeature.rst
    arcEllipseFeature.rst
+   bsplineFeature.rst
 
 .. _sketch_constraints:
 
@@ -141,6 +144,26 @@ The plug-in includes the following constraints:
 
 .. _sketch_operations:
 
+Overconstraned state
+--------------------
+
+Sketcher comes into overconstrained state when an extra constraint was defined. The following picture shows an example of the overconstrained state:
+
+.. image:: images/Overconstrained.png
+   :align: center
+
+.. centered::
+  Overconstrained Sketch
+
+When Sketcher gets this state then:
+
+- buttons Apply and Cancel for the whole Sketcher are blocked;
+- a constraint which causes the overconstraint state is highlightid by red color;
+- a warning message in sketcher Property Panel is shown with recomendation what to do in this case;
+- an additional Undo button is shown under the warning messages;
+
+After undoing the last operation or deletion of a conflicting constraint Sketcher will be reverted into a normal state.
+
 Operations
 ----------
 Operations modify existing features of the sketch or create new ones by copying them.
@@ -159,3 +182,4 @@ The plug-in includes the following operations:
    translationFeature.rst
    rotationFeature.rst
    sketchDrawer.rst
+   sketchCopy.rst