From d3afed6da21a10db226a968698b63af318e6111e Mon Sep 17 00:00:00 2001 From: vsr Date: Wed, 29 Apr 2020 10:37:23 +0300 Subject: [PATCH] Correct documentation bugs, adapt for 'Read The Docs' theme (bos #18858) --- doc/gui/Introduction.rst | 191 ++++++----------- doc/gui/Tutorial.rst | 195 ++++++++++-------- doc/gui/conf.py.in | 8 +- src/BuildPlugin/doc/TUI_polylineFeature.rst | 4 +- src/BuildPlugin/doc/TUI_subshapeFeature.rst | 3 +- src/BuildPlugin/doc/edgeFeature.rst | 5 + src/CollectionPlugin/doc/groupFeature.rst | 28 +-- src/ConstructionPlugin/doc/axisFeature.rst | 20 +- src/ConstructionPlugin/doc/planeFeature.rst | 12 ++ src/ConstructionPlugin/doc/pointFeature.rst | 12 ++ src/FeaturesPlugin/doc/FeaturesPlugin.rst | 2 +- .../doc/TUI_chamferDistAngle.rst | 3 +- .../doc/TUI_chamferDistances.rst | 3 +- .../doc/TUI_extrusionFuseThroughAll.rst | 2 +- .../doc/TUI_filletfixedFeature.rst | 3 +- .../doc/TUI_filletvariableFeature.rst | 3 +- .../doc/TUI_fusefacesFeature.rst | 3 +- .../doc/TUI_importResultFeature.rst | 2 +- .../doc/TUI_linearcopyFeature.rst | 2 +- .../doc/TUI_pipebinormalFeature.rst | 2 +- .../doc/TUI_pipelocationsFeature.rst | 2 +- .../doc/TUI_pipesimpleFeature.rst | 2 +- .../doc/TUI_rotation3pointsFeature.rst | 2 +- .../doc/TUI_rotationaxisFeature.rst | 2 +- .../doc/TUI_scaleXYZFeature.rst | 2 +- .../doc/TUI_scalefactorFeature.rst | 2 +- .../doc/TUI_symmetryaxisFeature.rst | 2 +- .../doc/TUI_symmetryplaneFeature.rst | 2 +- .../doc/TUI_symmetrypointFeature.rst | 2 +- .../doc/TUI_translation2pointsFeature.rst | 2 +- .../doc/TUI_translationdxdydzFeature.rst | 2 +- .../doc/TUI_translationvectorFeature.rst | 3 +- src/FeaturesPlugin/doc/chamferFeature.rst | 20 +- src/FeaturesPlugin/doc/commonFeature.rst | 6 + src/FeaturesPlugin/doc/cutFeature.rst | 1 + .../doc/extrusionCutFeature.rst | 7 + src/FeaturesPlugin/doc/extrusionFeature.rst | 5 + .../doc/extrusionFuseFeature.rst | 9 +- src/FeaturesPlugin/doc/filletFeature.rst | 18 +- src/FeaturesPlugin/doc/fuseFeature.rst | 6 + .../doc/importResultFeature.rst | 2 +- src/FeaturesPlugin/doc/measurementFeature.rst | 44 ++-- src/FeaturesPlugin/doc/pipeFeature.rst | 28 ++- src/FeaturesPlugin/doc/recoverFeature.rst | 5 + .../doc/removeSubShapesFeature.rst | 12 +- .../doc/revolutionCutFeature.rst | 11 +- src/FeaturesPlugin/doc/revolutionFeature.rst | 9 +- .../doc/revolutionFuseFeature.rst | 9 +- src/FeaturesPlugin/doc/rotationFeature.rst | 20 +- src/FeaturesPlugin/doc/smashFeature.rst | 1 + src/FeaturesPlugin/doc/splitFeature.rst | 1 + src/FeaturesPlugin/doc/symmetryFeature.rst | 28 ++- .../doc/transformationFeature.rst | 20 +- src/FeaturesPlugin/doc/translationFeature.rst | 27 ++- src/FiltersPlugin/doc/FiltersPlugin.rst | 4 +- src/ParametersPlugin/doc/managerFeature.rst | 12 +- src/PrimitivesPlugin/doc/TUI_torusFeature.rst | 2 +- src/PrimitivesPlugin/doc/boxFeature.rst | 13 +- src/PrimitivesPlugin/doc/cylinderFeature.rst | 6 + src/SketchPlugin/doc/SketchPlugin.rst | 3 +- src/SketchPlugin/doc/TUI_ellipseFeature.rst | 2 +- src/SketchPlugin/doc/TUI_perpendicular.rst | 2 +- src/SketchPlugin/doc/angleFeature.rst | 37 ++-- src/SketchPlugin/doc/arcFeature.rst | 12 +- src/SketchPlugin/doc/circleFeature.rst | 6 + src/SketchPlugin/doc/distanceFeature.rst | 20 +- src/SketchPlugin/doc/ellipseFeature.rst | 6 + src/SketchPlugin/doc/equalFeature.rst | 4 +- src/SketchPlugin/doc/filletFeature.rst | 4 +- src/SketchPlugin/doc/fixedFeature.rst | 2 +- .../doc/horizontalDistFeature.rst | 20 +- src/SketchPlugin/doc/intersectionFeature.rst | 2 +- src/SketchPlugin/doc/lengthFeature.rst | 20 +- src/SketchPlugin/doc/lineFeature.rst | 2 +- src/SketchPlugin/doc/middleFeature.rst | 2 +- src/SketchPlugin/doc/mirrorFeature.rst | 4 +- src/SketchPlugin/doc/parallelFeature.rst | 4 +- src/SketchPlugin/doc/pointFeature.rst | 4 +- src/SketchPlugin/doc/projectionFeature.rst | 4 +- src/SketchPlugin/doc/radiusFeature.rst | 17 +- src/SketchPlugin/doc/rectangleFeature.rst | 5 +- src/SketchPlugin/doc/rotationFeature.rst | 14 +- src/SketchPlugin/doc/sketchDrawer.rst | 2 +- src/SketchPlugin/doc/splitFeature.rst | 4 +- src/SketchPlugin/doc/tangentFeature.rst | 2 +- src/SketchPlugin/doc/translationFeature.rst | 14 +- src/SketchPlugin/doc/trimFeature.rst | 3 +- src/SketchPlugin/doc/verticalDistFeature.rst | 18 +- src/SketchPlugin/doc/verticalFeature.rst | 4 +- 89 files changed, 603 insertions(+), 494 deletions(-) diff --git a/doc/gui/Introduction.rst b/doc/gui/Introduction.rst index c1f42514c..ed7d557e8 100644 --- a/doc/gui/Introduction.rst +++ b/doc/gui/Introduction.rst @@ -1,7 +1,6 @@ .. _introduction: - Introduction to SHAPER ====================== @@ -38,13 +37,11 @@ A new study contains only a partset with 7 default constructions, which cannot b Only points, axis, planes (see :ref:`constructionPlugin`) and sketches (see :ref:`sketchPlugin`) can be added into Partset to be used in any part later. :ref:`parameter_usage` can be used both in Partset and any Part. - - + A new Part can be created as described in :ref:`partPlugin`. Double click or pop-up menu can be used to activate existing document. - Application desktop ------------------- @@ -56,12 +53,10 @@ The main window of the application consists of the following components: - :ref:`toolbar`; - status bar. -.. image:: images/main_window.png +.. figure:: images/main_window.png :align: center -.. centered:: Main window of SHAPER module - .. _main_menu: @@ -70,10 +65,9 @@ Main menu Main menu provides access to all commands of the application. -.. image:: images/main_menu.png +.. figure:: images/main_menu.png :align: center -.. centered:: Main menu Main menu includes standard Salome items: @@ -107,10 +101,9 @@ Application toolbar contains: - modules toolbar; - SHAPER toolbar. -.. image:: images/toolbar.png +.. figure:: images/toolbar.png :align: center -.. centered:: Toolbars SHAPER toolbar duplicates the main menu and provides access to all commands of the application. @@ -132,8 +125,7 @@ SHAPER toolbar is separated into sections: - Macros. Visibility of SHAPER toolbar sections is managed using *View -> Toolbar* :ref:`main_menu` item or toolbar pop-up menu. - - + .. _doc_windows: Dock windows @@ -163,13 +155,11 @@ If Object browser is shown at the same side then they will be tabbed. 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. -.. image:: images/popup_menu.png +.. figure:: images/popup_menu.png :align: center -.. centered:: Pop-up menu for visibility of windows and toolbars - .. _object_browser: Object browser @@ -181,12 +171,10 @@ Each document includes standard branches where created objects are placed. Documents with branches are shown in Tree View. -.. image:: images/object_browser.png +.. figure:: images/object_browser.png :align: center -.. centered:: - Object browser. Partset active - + **Object browser**: Partset active Partset includes three branches: @@ -224,33 +212,29 @@ This child result can be restored using **Recover** feature. Each feature, result, construction, group, field, parameter can be renamed using *Rename* pop-up menu command. -.. image:: images/popup_menu_object_browser_feature.png +.. figure:: images/popup_menu_object_browser_feature.png :align: center -.. centered:: - Feature pop-up menu + **Feature** pop-up menu -.. image:: images/popup_menu_object_browser_result.png +.. figure:: images/popup_menu_object_browser_result.png :align: center -.. centered:: - Result pop-up menu + **Result** pop-up menu -.. image:: images/popup_menu_object_browser_construction.png +.. figure:: images/popup_menu_object_browser_construction.png :align: center -.. centered:: - Construction pop-up menu + **Construction** pop-up menu The order of features can be changed using *Move to the end* and *Move to the end and split* pop-up menu commands. They work only for Group features. The selected group or several groups will be moved to the end of features list. The *Move to the end and split* also splits the resulting group in several groups: one group per one selection. Folders can be used to arrange long Tree View for features. -.. image:: images/object_browser_folder.png +.. figure:: images/object_browser_folder.png :align: center -.. centered:: - Object browser with folder Dome. Part_1 active + **Object browser** with folder Dome: Part_1 active *Insert a folder before* pop-up menu command creates a new empty folder before the selected feature. The folder can be renamed. @@ -264,27 +248,22 @@ Features can be removed from the folder using *Move out before the folder* / *Mo **Clean history** dialog box shows a list of unused features. After confirmation by click **Yes** button unused features are removed. -.. image:: images/clean_history.png +.. figure:: images/clean_history.png :align: center -.. centered:: **Clean history** dialog box - *Select result* and *Select parent feature* pop-up menu commands help to navigate along Tree View. - A feature and its result can be deleted using *Delete* pop-up menu command. Note that all features using the removed feature and their results will be removed simultaneously. **Delete feature** dialog box shows the list of features to be removed. After confirmation by click **Yes** button all these features are removed. - -.. image:: images/delete_feature.png +.. figure:: images/delete_feature.png :align: center -.. centered:: **Delete feature** dialog box .. _property_panel: @@ -292,34 +271,25 @@ Note that all features using the removed feature and their results will be remov Property panel ^^^^^^^^^^^^^^ +.. |ok_btn| image:: images/button_ok.png +.. |cancel_btn| image:: images/button_cancel.png +.. |help_btn| image:: images/button_help.png + Property panel consists of two parts: - controls a container for input of parameters for the current operation; - buttons panel containing standard buttons: - .. image:: images/button_ok.png - :align: left - **Ok/Apply** executes operation with defined parameters, - - - .. image:: images/button_cancel.png - :align: left - **Cancel/Close** calls **Abort operation** dialog box to confirm operation abort, - - .. image:: images/button_help.png - :align: left - **Help** calls User's guide opened on page describing the current operation. - -.. image:: images/abort_operation.png - :align: center - -.. centered:: - **Abort operation** dialog box + | |ok_btn| **Ok/Apply** executes operation with defined parameters, + | |cancel_btn| **Cancel/Close** calls **Abort operation** dialog box to confirm operation abort, + | |help_btn| **Help** calls User's guide opened on page describing the current operation. + .. figure:: images/abort_operation.png + :align: center + + **Abort operation** dialog box -.. image:: images/button_ok.png - :align: left -**OK/Apply** button is disabled if not all input parameters are defined or some errors are found. Error is shown as tooltip and in status bar. +|ok_btn| **OK/Apply** button is disabled if not all input parameters are defined or some errors are found. Error is shown as tooltip and in status bar. .. _inspection_panel: @@ -328,11 +298,10 @@ Inspection panel Inspection panel provides the list of types and quantities of all topological entities, composing the selected result, construction or feature. -.. image:: images/inspection_panel.png +.. figure:: images/inspection_panel.png :align: center -.. centered:: - Inspection panel for default Box + **Inspection panel** for default Box **Object** displays name of the selected result, construction or feature. @@ -340,20 +309,17 @@ Inspection panel provides the list of types and quantities of all topological en The information about Point, Axis or Edge additionally shows coordinates of point / end points. -.. image:: images/inspection_panel_line.png +.. figure:: images/inspection_panel_line.png :align: center -.. centered:: - Inspection panel for Axis + **Inspection panel** for Axis - The information about Plane, Face additionally shows coordinates of center point and direction of normal. -.. image:: images/inspection_panel_face.png +.. figure:: images/inspection_panel_face.png :align: center -.. centered:: - Inspection panel for Face + **Inspection panel** for Face .. _hidefaces_panel: @@ -362,11 +328,10 @@ Hide Faces panel **Hide Faces** panel makes possible to hide temporary faces of any displayed object. **Hide Faces** panel looks like following: -.. image:: images/hide_faces_panel.png +.. figure:: images/hide_faces_panel.png :align: center -.. centered:: - Hide Faces panel + **Hide Faces** panel - If this panel is activated it "listens" user selection. - If a face is selected then its name will be shown in the panel's list and hidden in the viewer. @@ -376,7 +341,6 @@ Hide Faces panel Also it is possible do not to hide faces, but make them transparent. For this purpose **"Transparent"** check-box can be used. Value of the transparency can be changed in **Visualization** tab of **Preferences** dialog box. Closing of **Hide Faces** panel restores visibility state of all objects. If it is necessary to deactivete the **Hide Faces** panel (preserving the current display state) then user has to press **"Esc"** button. - .. _python console: Python console @@ -396,11 +360,9 @@ Pop-up menu gives the possibility to: - Dump commands from console into the specified file; - Start/Stop writing log into the specified file. - -.. image:: images/python_console_popup.png +.. figure:: images/python_console_popup.png :align: center -.. centered:: Pop-up menu of Python console .. _viewer: @@ -416,16 +378,13 @@ Each view windows shows its own point of view on the 3D scene. This point of view can be modified using viewer commands: **Panning**, **Zooming**, **Scaling**, etc. - -.. image:: images/2_viewers.png +.. figure:: images/2_viewers.png :align: center -.. centered:: Two view windows The description of OCC 3D Viewer architecture and functionality is provided in GUI module user's guide in chapter **OCC 3D Viewer**. - .. _parameter_usage: Parameters @@ -443,10 +402,9 @@ Any argument in features can be defined as parameter or expression containing pa The list of features using parameters is given in **Parameters** dialog box: - .. image:: images/parameters_feature.png + .. figure:: images/parameters_feature.png :align: center -.. centered:: Parameters dialog box If a parameter value is changed, then all features where it is used are rebuilt. @@ -457,10 +415,9 @@ However, partset and part can have parameters with the same name. If parameter n In contrast to features (see :ref:`object_browser`), there is an additional option when parameters are deleted. -.. image:: images/delete_parameter.png +.. figure:: images/delete_parameter.png :align: center -.. centered:: Delete parameter 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. @@ -508,11 +465,10 @@ Visualization tab This tab defines presentation of objects displayed in OCC 3D viewer. -.. image:: images/visualization_preferences.png +.. figure:: images/visualization_preferences.png :align: center -.. centered:: - Preferences - Visualization tab + **Preferences**: Visualization tab **Input fields**: @@ -543,11 +499,10 @@ This tab defines presentation of objects displayed in OCC 3D viewer. To redefine any color click on the corresponding line to access **Select color** dialog box -.. image:: images/select_color.png +.. figure:: images/select_color.png :align: center -.. centered:: - **Select color** dialog box + **Preferences**: **Select color** dialog box Preferences for sketch are applicable during sketch creation/edition operation. @@ -557,11 +512,10 @@ Plugins tab ^^^^^^^^^^^ Plugins tab defines folders where plugins and resources are located. -.. image:: images/plugins_preferences.png +.. figure:: images/plugins_preferences.png :align: center -.. centered:: - Preferences - Plugins tab + **Preferences**: Plugins tab **Input fields**: @@ -569,16 +523,14 @@ Plugins tab defines folders where plugins and resources are located. - **Import initial directory** selects default folder where resources are located. Click on **Open** button opens standard **Find directory** dialog box to navigate to desired folder. -.. image:: images/open_button.png +.. figure:: images/open_button.png :align: center -.. centered:: **Open** button -.. image:: images/find_directory.png +.. figure:: images/find_directory.png :align: center -.. centered:: **Find directory** dialog box @@ -589,11 +541,10 @@ Shortcuts tab Shortcuts tab defines shortcut keys for different operations. -.. image:: images/shortcuts_preferences.png +.. figure:: images/shortcuts_preferences.png :align: center -.. centered:: - Preferences - Shortcuts tab + **Preferences**: Shortcuts tab - **Add parameter in parameters manager dialog** defines shortcut keys for adding parameter in parameters manager dialog box. @@ -604,11 +555,10 @@ Windows tab Windows tab contains definitions for the module windows management. -.. image:: images/windows_preferences.png +.. figure:: images/windows_preferences.png :align: center -.. centered:: - Preferences - Windows tab + **Preferences**: Windows tab - **Use HideFaces panel in operation** if the checkbox is checked then HideFaces panel will be launched automatically on launching an operation where using of this panel is considered. @@ -619,11 +569,10 @@ Sketch tab Sketch tab defines properties of coordinate planes shown for selection of sketch plane when no convenient objects are shown in OCC 3D viewer. -.. image:: images/sketch_preferences.png +.. figure:: images/sketch_preferences.png :align: center -.. centered:: - Preferences - Sketch tab + **Preferences**: Sketch tab **Input fields**: @@ -634,7 +583,6 @@ Sketch tab defines properties of coordinate planes shown for selection of sketch - **Default spline weight** defines default weight for B-spline nodes during creation. The default value can be changed by editing of the spline; - **Cursor for sketch operation** defines a cursor which indicates a launched sketcher sub-operation. - **Create sketch entities by dragging** defines a style of sketch etities creation. It concerns creation of lines, rectangles, circles, arcs, ellipses, elliptic arcs. If it is switched ON then points of objects have to be defined by mouse press - mouse move - mouse release. Otherwise every point of an object has to be defined by mouse click; - .. _viewer_preferences: @@ -643,11 +591,10 @@ Viewer tab Viewer tab defines selection in OCC 3D viewer properties. -.. image:: images/viewer_preferences.png +.. figure:: images/viewer_preferences.png :align: center -.. centered:: - Preferences - Viewer tab + **Preferences**: Viewer tab **Input fields**: @@ -662,7 +609,6 @@ Viewer tab defines selection in OCC 3D viewer properties. - **Vertex** defines selection sensitivity for vertices; - **Edge** defines selection sensitivity for edges. - .. _toolbars_management: Toolbars management @@ -675,10 +621,9 @@ Toolbars management To edit the current tool bars structure select in the Main Menu *Edit - > Edit toolbars* item. The following dialog box with existing toolbars appears: -.. image:: images/Toolbars.png +.. figure:: images/Toolbars.png :align: center -.. centered:: **Toolbars** dialog box **Input fields**: @@ -691,12 +636,10 @@ The following dialog box with existing toolbars appears: - **OK** button closes the dialog box, stores result of tool bars edition and updates Shaper tool bars; - **Cancel** button closes the dialog box without modification of tool bars. -.. image:: images/delete_toolbar.png +.. figure:: images/delete_toolbar.png :align: center -.. centered:: - Warning dialog box - + Warning dialog box .. _create_toolbar: @@ -705,22 +648,19 @@ The following dialog box with existing toolbars appears: **Input fields** of **Create toolbar** dialog box: -.. image:: images/create_toolbar.png +.. figure:: images/create_toolbar.png :align: center -.. centered:: **Create toolbar** dialog box - **Name of a new toolbar** defines name of the new tool bar. The name of tool bar has to be unique. If user defines a not unique name then a warning appears and a new tooolbar with not unique name is not created; - **Ok** button closes the dialog box and add a new tool bar of the module into **Toolbars** window; - **Cancel** button closes the dialog box without addition of a new tool bar. -.. image:: images/name_toolbar.png +.. figure:: images/name_toolbar.png :align: center -.. centered:: **Warning** dialog box - .. _edit_toolbar: @@ -729,10 +669,9 @@ The following dialog box with existing toolbars appears: **Input fields** of **Edit toolbar** dialog box: -.. image:: images/EditToolbar.png +.. figure:: images/EditToolbar.png :align: center -.. centered:: **Edit toolbar** dialog box - **Toolbar name** non-editable field displays name of modified tool bar; @@ -744,5 +683,3 @@ The following dialog box with existing toolbars appears: - **Up** and **Down** buttons change position of selected command in **In the toolbar** window; - **Ok** button closes the dialog box, stores result of edition; - **Cancel** button closes the dialog box without modification of tool bar content. - - diff --git a/doc/gui/Tutorial.rst b/doc/gui/Tutorial.rst index f3aba125b..d9bc3eb9a 100644 --- a/doc/gui/Tutorial.rst +++ b/doc/gui/Tutorial.rst @@ -8,7 +8,7 @@ Tutorial This exercise illustrates how to create screw-nut shape from scratch. -Step1. Sketch. +Step 1. Sketch -------------- At this step we will create a regular hexagon. @@ -19,179 +19,194 @@ At this step we will create a regular hexagon. - Select **XOY** plane in the view - Click **Set plane view** button in the Sketch property panel -.. image:: images/tutorial1_1.png +.. figure:: images/tutorial1_1.png :align: center -.. centered:: Skecth plane XOY + - Start :ref:`Line ` creation via Main Menu *Sketch - > Line* - Pick 3 points in the view one by one and select the first one at the end to get a triangle: -.. image:: images/tutorial1_2.png +.. figure:: images/tutorial1_2.png :align: center -.. centered:: 3 Lines forming a triangle + - Hide trihedron via **Show/Hide trihedron** button in viewer toolbar - Select **Origin** object from **Part set / Constructions** folder in the object browser - Click on the eye icon on the left of the origin item to show it in the view - Select both origin and the bottom vertex of the triangle in the view (use **Shift** key for multi-selection) -.. image:: images/tutorial1_3.png +.. figure:: images/tutorial1_3.png :align: center -.. centered:: Origin and triangle + - Create :ref:`Coincident ` constraint via **Coincident** button in Sketch toolbar -.. image:: images/tutorial1_4.png + +.. figure:: images/tutorial1_4.png :align: center -.. centered:: Triangle vertex coincident with origin + - Show trihedron - Select both **OY** axis and the upper side of the triangle in the view - Create :ref:`Perpendicular ` constraint via **Pependicular** button in Sketch toolbar -.. image:: images/tutorial1_5.png + +.. figure:: images/tutorial1_5.png :align: center -.. centered:: Upper triangle side perpendicular to OY axis + - Select the left and the upper side of the triangle - Create :ref:`Equal ` constraint via **Equal** button in Sketch toolbar - Make the upper and the right sides equal length in the same way -.. image:: images/tutorial1_6.png + +.. figure:: images/tutorial1_6.png :align: center -.. centered:: Equilateral triangle + - Select the left side of the triangle - Check **Auxiliary** check box in the property panel and click **Apply** button -.. image:: images/tutorial1_7.png + +.. figure:: images/tutorial1_7.png :align: center -.. centered:: Line property panel + - Make the right side auxiliary in the same way -.. image:: images/tutorial1_8.png + +.. figure:: images/tutorial1_8.png :align: center -.. centered:: The lateral sides are auxiliary + - Start creation of :ref:`Angular copy ` feature via **Angular copy** button in Sketch toolbar - Select the upper side of the triangle for **Segments** parameter in the property panel - Select origin in the view as a center of rotation - Set **Total number** of objects equal to 6 -.. image:: images/tutorial1_9.png + +.. figure:: images/tutorial1_9.png :align: center -.. centered:: Angular copy parameters + - Click **Apply** button -.. image:: images/tutorial1_10.png + +.. figure:: images/tutorial1_10.png :align: center -.. centered:: Regular hexagon + - Select the upper side of the hexagon - Start creation of :ref:`Length ` constraint via **Length** button in Sketch toolbar - Set length expression equal to "a=115.4" and press **Enter** -.. image:: images/tutorial1_11.png + +.. figure:: images/tutorial1_11.png :align: center -.. centered:: Fully fixed regular hexagon + - Click **Apply** button in the *Skecth* property panel to finish the sketch creation -.. image:: images/tutorial1_12.png + +.. figure:: images/tutorial1_12.png :align: center -.. centered:: Finished Sketch + - Check item corresponding to the created parameter **a** under **Part_1 / Parameters** node -.. image:: images/tutorial1_13.png + +.. figure:: images/tutorial1_13.png :align: center -.. centered:: Parameter created during the Sketch operation -Step2. Polyline. +Step 2. Polyline ---------------- - Start :ref:`Parameter ` creation via Main Menu *Part - > Parameter* - Set parameter name = "h", set parameter expression = "90", set comment = "nut height" -.. image:: images/tutorial2_0.png + +.. figure:: images/tutorial2_0.png :align: center -.. centered:: Creation of parameter h = 90 + - Click **Apply** button to finish parameter creation - Start :ref:`Point ` creation via Main Menu *Construction - > Point* - Set x = 50, y = 0, z = 0 -.. image:: images/tutorial2_1.png + +.. figure:: images/tutorial2_1.png :align: center -.. centered:: Construction of point (50, 0, 0) + - Click **Apply** button to finish point creation - Create points (80, 0, 0), (112, 0, 13), (112, 0, 48), (80, 0, 63), (80, 0, h), (50, 0, h) in the same way - Select the created points in the object browser under **Part_1 / Constructions** node - Click right mouse button and select **Color...** item in the popup menu - Select blue color and click **OK** button -.. image:: images/tutorial2_2.png + +.. figure:: images/tutorial2_2.png :align: center -.. centered:: Points created from scratch + - Start :ref:`Polyline ` creation via Main Menu *Build - > Polyline* - Select all the 7 points (use **Shift** key for multi-selection) - Check **Closed** check box -.. image:: images/tutorial2_3.png + +.. figure:: images/tutorial2_3.png :align: center -.. centered:: Creation of closed polyline from 7 points + - Click **Apply** button in the property panel -.. image:: images/tutorial2_4.png + +.. figure:: images/tutorial2_4.png :align: center -.. centered:: Closed Polyline -Step3. Face. +Step 3. Face ------------ - Start :ref:`Face ` creation via Main Menu *Build - > Face* - Select **Polyline_1_1** in the object browser under **Part_1 / Results** node -.. image:: images/tutorial3_1.png + +.. figure:: images/tutorial3_1.png :align: center -.. centered:: Construction of face from a polyline + - Click **Apply** button in the property panel -.. image:: images/tutorial3_2.png + +.. figure:: images/tutorial3_2.png :align: center -.. centered:: Face -Step4. Revolution. +Step 4. Revolution ------------------ - Start :ref:`Revolution ` creation via Main Menu *Features - > Revolution* - Select the face created at step 3 in the view - Click on axis input field in the property panel and select **OZ** axis in the view -.. image:: images/tutorial4_1.png + +.. figure:: images/tutorial4_1.png :align: center -.. centered:: Revolution around OZ by 360 degrees + - Click **Apply** button in the property panel -.. image:: images/tutorial4_2.png + +.. figure:: images/tutorial4_2.png :align: center -.. centered:: Solid created by rotation of face -Step5. Extrusion. +Step 5. Extrusion ----------------- - Start :ref:`Extrusion ` creation via Main Menu *Features - > Extrusion* @@ -200,115 +215,122 @@ Step5. Extrusion. - Check **By bounding planes and offsets option** - Select the bottom face of the revolution shape as **From** plane - Select the top face of the revolution shape as **To** plane -.. image:: images/tutorial5_1.png + +.. figure:: images/tutorial5_1.png :align: center -.. centered:: Extrusion along OZ axis by bounding planes + - Click **Apply** button in the property panel -.. image:: images/tutorial5_2.png + +.. figure:: images/tutorial5_2.png :align: center -.. centered:: Solid created by extrusion of sketch -Step6. Common. +Step 6. Common -------------- - Start :ref:`Common ` creation via Main Menu *Features - > Common* - Select the extrusion and the revolution in the object browser under **Part_1 / Results** node (use **Shift** key for multi-selection) -.. image:: images/tutorial6_1.png + +.. figure:: images/tutorial6_1.png :align: center -.. centered:: Common creation + - Click **Apply** button in the property panel -.. image:: images/tutorial6_2.png + +.. figure:: images/tutorial6_2.png :align: center -.. centered:: The revolution and the extrusion common part -Step7. Fillet. +Step 7. Fillet -------------- - Start :ref:`Fillet ` creation via Main Menu *Features - > Fillet* - Select the edge -.. image:: images/tutorial7_1.png + +.. figure:: images/tutorial7_1.png :align: center -.. centered:: Select edge for a Fillet + - Select **Radius** parameter equal to 10 -.. image:: images/tutorial7_2.png + +.. figure:: images/tutorial7_2.png :align: center -.. centered:: Fillet with radius = 10 + - Click **Apply** button in the property panel -.. image:: images/tutorial7_3.png + +.. figure:: images/tutorial7_3.png :align: center -.. centered:: Fillet -Step8. Box. +Step 8. Box ----------- - Click right mouse button in the view and select **Hide all** item in the popup menu to clear the view - Start :ref:`Box ` creation via Main Menu *Primitives - > Box* - Set **DX** = 10, **DY** = 120, **DZ** = 20 -.. image:: images/tutorial8_1.png + +.. figure:: images/tutorial8_1.png :align: center -.. centered:: Box creation + - Click **Apply** button in the property panel -.. image:: images/tutorial8_2.png + +.. figure:: images/tutorial8_2.png :align: center -.. centered:: Box -Step9. Translation. +Step 9. Translation ------------------- - Start :ref:`Translation ` creation via Main Menu *Part - > Translation* - Check **By X, Y and Z dimensions** option on the top of the property panel - Select the box in the view - Set **DX** = -10, **DY** = 20, **DZ** = 70 -.. image:: images/tutorial9_1.png + +.. figure:: images/tutorial9_1.png :align: center -.. centered:: Box translation + - Click **Apply** button in the property panel -.. image:: images/tutorial9_2.png + +.. figure:: images/tutorial9_2.png :align: center -.. centered:: Translated Box -Step10. Angular Copy. +Step 10. Angular Copy --------------------- - Start :ref:`Angular Copy ` creation via Main Menu *Part - > Angular Copy* - Select the box in the view - Click on axis input field in the property panel and select **OZ** axis in the view - Set **Nb copies** parameter equal to 6 -.. image:: images/tutorial10_1.png + +.. figure:: images/tutorial10_1.png :align: center -.. centered:: Angular Copy around OZ + - Click **Apply** button in the property panel -.. image:: images/tutorial10_2.png + +.. figure:: images/tutorial10_2.png :align: center -.. centered:: Copied Box -Step11. Cut. +Step 11. Cut ------------ - Select **Fillet_1_1** item in the object browser under **Part_1 / Results** node @@ -316,21 +338,20 @@ Step11. Cut. - Start :ref:`Cut ` creation via Main Menu *Features - > Cut* - Select the fillet object in the view as a main object - Select the angular copy object in the object browser as a tool object -.. image:: images/tutorial11_1.png + +.. figure:: images/tutorial11_1.png :align: center -.. centered:: Cut creation + - Click **Apply** button in the property panel - Select the created **Cut_1_1** item in the object browser under **Part_1 / Results** node - Click right mouse button and select **Color...** item in the popup menu - Set (R: 255, G: 214, B: 0) color and click **OK** button -.. image:: images/tutorial11_2.png +.. figure:: images/tutorial11_2.png :align: center -.. centered:: Cut - -**See Also** a :ref:`TUI Script ` reproducing all the tutorial steps. \ No newline at end of file +**See Also** a :ref:`TUI Script ` reproducing all the tutorial steps. diff --git a/doc/gui/conf.py.in b/doc/gui/conf.py.in index ebe0d98c0..d6a8bebf2 100644 --- a/doc/gui/conf.py.in +++ b/doc/gui/conf.py.in @@ -45,7 +45,7 @@ except: use_rtd_theme = False # Add any paths that contain templates here, relative to this directory. -templates_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','templates')] +#templates_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','templates')] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: @@ -110,12 +110,16 @@ themes_options['classic'] = { 'body_max_width':'none', 'body_min_width':0, } +themes_options['sphinx_rtd_theme'] = { + 'prev_next_buttons_location':'both', +} + html_theme_options = themes_options.get(html_theme, {}) # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','static')] +#html_static_path = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','static')] # -- Options for HTMLHelp output ------------------------------------------ diff --git a/src/BuildPlugin/doc/TUI_polylineFeature.rst b/src/BuildPlugin/doc/TUI_polylineFeature.rst index 1099c4f5c..b521ae80b 100644 --- a/src/BuildPlugin/doc/TUI_polylineFeature.rst +++ b/src/BuildPlugin/doc/TUI_polylineFeature.rst @@ -8,5 +8,5 @@ Create Polyline :linenos: :language: python -:download:`Download this script ` - +:download:`Download this script ` + diff --git a/src/BuildPlugin/doc/TUI_subshapeFeature.rst b/src/BuildPlugin/doc/TUI_subshapeFeature.rst index 10d0f8f80..ddde6b457 100644 --- a/src/BuildPlugin/doc/TUI_subshapeFeature.rst +++ b/src/BuildPlugin/doc/TUI_subshapeFeature.rst @@ -8,5 +8,4 @@ Create Sub-shapes :linenos: :language: python -:download:`Download this script ` - +:download:`Download this script ` diff --git a/src/BuildPlugin/doc/edgeFeature.rst b/src/BuildPlugin/doc/edgeFeature.rst index 2dbc68c5e..4bbc4f3f7 100644 --- a/src/BuildPlugin/doc/edgeFeature.rst +++ b/src/BuildPlugin/doc/edgeFeature.rst @@ -14,12 +14,17 @@ The options to create edges: .. image:: images/edge_by_segments_32x32.png :align: left + :height: 24px + **By edges** creates edges using already existing edges in other shapes or full sketches. .. image:: images/edge_by_points_32x32.png :align: left + :height: 24px + **By points** creates segment between two points. +-------------------------------------------------------------------------------- By edges -------- diff --git a/src/CollectionPlugin/doc/groupFeature.rst b/src/CollectionPlugin/doc/groupFeature.rst index 436653e02..a8d8cd2ca 100644 --- a/src/CollectionPlugin/doc/groupFeature.rst +++ b/src/CollectionPlugin/doc/groupFeature.rst @@ -1,7 +1,4 @@ -.. |shape_group.icon| image:: images/shape_group.png -.. |plus.icon| image:: images/add.png -.. |minus.icon| image:: images/reverce.png -.. |delete.icon| image:: images/delete.png +.. |shape_group.icon| image:: images/shape_group.png .. _groupPage: @@ -22,26 +19,23 @@ The following property panel appears. .. centered:: Create a group +.. |group_vertices| image:: images/group_property_panel_vertice.png +.. |group_edges| image:: images/group_property_panel_edge.png +.. |group_faces| image:: images/group_property_panel_face.png +.. |group_solids| image:: images/group_property_panel_solid.png + Input fields: - **Name** defines the name of the group, by default, it is **Group_n**. - **Type** buttons select geometrical entities to be included in group: - .. image:: images/group_property_panel_vertice.png - :align: left - Vertices; - - .. image:: images/group_property_panel_edge.png - :align: left - Edges; + |group_vertices| Vertices; + + |group_edges| Edges; - .. image:: images/group_property_panel_face.png - :align: left - Faces; + |group_faces| Faces; - .. image:: images/group_property_panel_solid.png - :align: left - Solids; + |group_solids| Solids; - The list of selected entities of the given type. Multiple selection can be done manually in OCC 3D Viewer by mouse click with Shift button pressed or by rectangle selection. To delete entities from the list, select them and call pop-up menu *Delete* item. diff --git a/src/ConstructionPlugin/doc/axisFeature.rst b/src/ConstructionPlugin/doc/axisFeature.rst index bb691a508..4059613fc 100644 --- a/src/ConstructionPlugin/doc/axisFeature.rst +++ b/src/ConstructionPlugin/doc/axisFeature.rst @@ -14,28 +14,42 @@ There are 6 algorithms for creation of an Axis: .. image:: images/axis_dxyz_32x32.png :align: left + :height: 24px + **By three dimensions** creates an axis by dimensions along X, Y, Z axes starting form existing origin. .. image:: images/by_two_points_32x32.png :align: left + :height: 24px + **By two points** creates an axis using existing points. .. image:: images/axis_by_line_32x32.png :align: left + :height: 24px + **By line** creates an axis using a line. -.. image:: images/axis_by_line_32x32.png +.. image:: images/cylindrical_face_32x32.png :align: left + :height: 24px + **As an axis of cylindrical face** creates an axis using a cylindrical face. -.. image:: images/axis_by_line_32x32.png +.. image:: images/axis_by_plane_and_point_32x32.png :align: left + :height: 24px + **By plane and point** creates an axis using a plane and point. -.. image:: images/axis_by_line_32x32.png +.. image:: images/axis_by_two_planes_32x32.png :align: left + :height: 24px + **By two planes** creates an axis as the intersection of two planes. +-------------------------------------------------------------------------------- + By three dimensions ------------------- diff --git a/src/ConstructionPlugin/doc/planeFeature.rst b/src/ConstructionPlugin/doc/planeFeature.rst index beff53731..06215aa79 100644 --- a/src/ConstructionPlugin/doc/planeFeature.rst +++ b/src/ConstructionPlugin/doc/planeFeature.rst @@ -14,20 +14,29 @@ There are 4 algorithms for creation of a Plane: .. image:: images/plane_by_three_points_32x32.png :align: left + :height: 24px + **By three points** creates a plane by three points. .. image:: images/plane_by_line_and_point_32x32.png :align: left + :height: 24px + **By line and point** creates a plane by a line and a point. .. image:: images/plane_by_other_plane_32x32.png :align: left + :height: 24px + **By other plane** creates a plane parallel to another plane. .. image:: images/plane_by_two_parallel_planes_32x32.png :align: left + :height: 24px + **By two parallel planes** creates a plane between two parallel planes. +-------------------------------------------------------------------------------- By three points --------------- @@ -111,16 +120,19 @@ By other plane A plane is created by selecting an already existing plane (planar face). There are following possibilities to define a new plane: .. image:: images/plane_by_distance_from_other_24x24.png + :height: 24px :align: left By distance from the selected plane. .. image:: images/plane_by_coincident_to_point_24x24.png + :height: 24px :align: left By coincidence with a point. .. image:: images/plane_by_rotation_24x24.png + :height: 24px :align: left By rotation around an edge by a specified angle. diff --git a/src/ConstructionPlugin/doc/pointFeature.rst b/src/ConstructionPlugin/doc/pointFeature.rst index 8d2693b49..e198267f0 100644 --- a/src/ConstructionPlugin/doc/pointFeature.rst +++ b/src/ConstructionPlugin/doc/pointFeature.rst @@ -15,24 +15,36 @@ There are 5 algorithms for creation of a Point: .. image:: images/point_by_xyz_32x32.png :align: left + :height: 24px + **By X,Y,Z** creates a point by three coordinates. .. image:: images/point_by_distance_on_edge_32x32.png :align: left + :height: 24px + **By distance on edge** creates a point on an edge. .. image:: images/point_by_projection_32x32.png :align: left + :height: 24px + **By projection on edge or plane** creates a point by projecting an existing point on an edge or plane. .. image:: images/point_by_intersection_32x32.png :align: left + :height: 24px + **By intersection of objects** creates a point by intersection of planes or/ and edges. .. image:: images/point_by_geometrical_property_32x32.png :align: left + :height: 24px + **By geometrical property of object** creates a point in COG or center of arc or circle. +-------------------------------------------------------------------------------- + By X,Y,Z -------- diff --git a/src/FeaturesPlugin/doc/FeaturesPlugin.rst b/src/FeaturesPlugin/doc/FeaturesPlugin.rst index 91db9f48f..9b06e64e5 100644 --- a/src/FeaturesPlugin/doc/FeaturesPlugin.rst +++ b/src/FeaturesPlugin/doc/FeaturesPlugin.rst @@ -22,7 +22,7 @@ Features plug-in provides a set of common topological operations. It implements filletFeature.rst fuseFeature.rst fuseFeatureFaces.rst - importResult.rst + importResultFeature.rst intersectionFeature.rst linearCopyFeature.rst measurementFeature.rst diff --git a/src/FeaturesPlugin/doc/TUI_chamferDistAngle.rst b/src/FeaturesPlugin/doc/TUI_chamferDistAngle.rst index db62e1d88..ebb4d1dfe 100644 --- a/src/FeaturesPlugin/doc/TUI_chamferDistAngle.rst +++ b/src/FeaturesPlugin/doc/TUI_chamferDistAngle.rst @@ -8,5 +8,4 @@ Create Chamfer by a distance and an angle :linenos: :language: python -:download:`Download this script ` - +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_chamferDistances.rst b/src/FeaturesPlugin/doc/TUI_chamferDistances.rst index b9786abe9..f59a219ac 100644 --- a/src/FeaturesPlugin/doc/TUI_chamferDistances.rst +++ b/src/FeaturesPlugin/doc/TUI_chamferDistances.rst @@ -8,5 +8,4 @@ Create Chamfer by distances :linenos: :language: python -:download:`Download this script ` - +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_extrusionFuseThroughAll.rst b/src/FeaturesPlugin/doc/TUI_extrusionFuseThroughAll.rst index a65ce34ff..98df80a3b 100644 --- a/src/FeaturesPlugin/doc/TUI_extrusionFuseThroughAll.rst +++ b/src/FeaturesPlugin/doc/TUI_extrusionFuseThroughAll.rst @@ -2,7 +2,7 @@ .. _tui_create_extrusion_fuse_through_all: Create Extrusion Fuse through all objects -======================================== +========================================= .. literalinclude:: examples/extrusion_fuse_through_all.py :linenos: diff --git a/src/FeaturesPlugin/doc/TUI_filletfixedFeature.rst b/src/FeaturesPlugin/doc/TUI_filletfixedFeature.rst index e573efec2..8a34e1492 100644 --- a/src/FeaturesPlugin/doc/TUI_filletfixedFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_filletfixedFeature.rst @@ -8,5 +8,4 @@ Create Fillet by fixed radius :linenos: :language: python -:download:`Download this script ` - +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_filletvariableFeature.rst b/src/FeaturesPlugin/doc/TUI_filletvariableFeature.rst index ddcee3c82..36311a584 100644 --- a/src/FeaturesPlugin/doc/TUI_filletvariableFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_filletvariableFeature.rst @@ -8,5 +8,4 @@ Create Fillet by variable radius :linenos: :language: python -:download:`Download this script ` - +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_fusefacesFeature.rst b/src/FeaturesPlugin/doc/TUI_fusefacesFeature.rst index 00b1a9f9b..0a4b19d49 100644 --- a/src/FeaturesPlugin/doc/TUI_fusefacesFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_fusefacesFeature.rst @@ -8,5 +8,4 @@ Fuse Faces :linenos: :language: python -:download:`Download this script ` - +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_importResultFeature.rst b/src/FeaturesPlugin/doc/TUI_importResultFeature.rst index 5d27dbee2..cbcf73af9 100644 --- a/src/FeaturesPlugin/doc/TUI_importResultFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_importResultFeature.rst @@ -2,7 +2,7 @@ .. _tui_create_import_result: Create Import Result -============ +==================== .. literalinclude:: examples/import_result.py :linenos: diff --git a/src/FeaturesPlugin/doc/TUI_linearcopyFeature.rst b/src/FeaturesPlugin/doc/TUI_linearcopyFeature.rst index 8b52750e5..d85f2e204 100644 --- a/src/FeaturesPlugin/doc/TUI_linearcopyFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_linearcopyFeature.rst @@ -8,4 +8,4 @@ Create Linear copy :linenos: :language: python -:download:`Download this script ` +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_pipebinormalFeature.rst b/src/FeaturesPlugin/doc/TUI_pipebinormalFeature.rst index 5b2f289a9..10a22b6ab 100644 --- a/src/FeaturesPlugin/doc/TUI_pipebinormalFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_pipebinormalFeature.rst @@ -8,4 +8,4 @@ Pipe by object, path and Bi-normal :linenos: :language: python -:download:`Download this script ` \ No newline at end of file +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_pipelocationsFeature.rst b/src/FeaturesPlugin/doc/TUI_pipelocationsFeature.rst index 611de087d..80591e8c9 100644 --- a/src/FeaturesPlugin/doc/TUI_pipelocationsFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_pipelocationsFeature.rst @@ -8,4 +8,4 @@ Pipe by object, path and locations :linenos: :language: python -:download:`Download this script ` \ No newline at end of file +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_pipesimpleFeature.rst b/src/FeaturesPlugin/doc/TUI_pipesimpleFeature.rst index b65adf293..77a6ba1f9 100644 --- a/src/FeaturesPlugin/doc/TUI_pipesimpleFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_pipesimpleFeature.rst @@ -8,4 +8,4 @@ Pipe by object and path :linenos: :language: python -:download:`Download this script ` \ No newline at end of file +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_rotation3pointsFeature.rst b/src/FeaturesPlugin/doc/TUI_rotation3pointsFeature.rst index b6af697ee..92f8336d7 100644 --- a/src/FeaturesPlugin/doc/TUI_rotation3pointsFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_rotation3pointsFeature.rst @@ -8,4 +8,4 @@ Rotation by center and points :linenos: :language: python -:download:`Download this script ` \ No newline at end of file +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_rotationaxisFeature.rst b/src/FeaturesPlugin/doc/TUI_rotationaxisFeature.rst index de089c14d..5894faf57 100644 --- a/src/FeaturesPlugin/doc/TUI_rotationaxisFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_rotationaxisFeature.rst @@ -8,4 +8,4 @@ Rotation by axis and angle :linenos: :language: python -:download:`Download this script ` \ No newline at end of file +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_scaleXYZFeature.rst b/src/FeaturesPlugin/doc/TUI_scaleXYZFeature.rst index 9b9f360b7..747c392f1 100644 --- a/src/FeaturesPlugin/doc/TUI_scaleXYZFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_scaleXYZFeature.rst @@ -8,4 +8,4 @@ Scale by different factors along axes :linenos: :language: python -:download:`Download this script ` \ No newline at end of file +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_scalefactorFeature.rst b/src/FeaturesPlugin/doc/TUI_scalefactorFeature.rst index af4e71d96..95a30d750 100644 --- a/src/FeaturesPlugin/doc/TUI_scalefactorFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_scalefactorFeature.rst @@ -8,4 +8,4 @@ Scale by one common factor :linenos: :language: python -:download:`Download this script ` \ No newline at end of file +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_symmetryaxisFeature.rst b/src/FeaturesPlugin/doc/TUI_symmetryaxisFeature.rst index 43096341b..7b0299109 100644 --- a/src/FeaturesPlugin/doc/TUI_symmetryaxisFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_symmetryaxisFeature.rst @@ -8,4 +8,4 @@ Symmetry through an Axis of symmetry :linenos: :language: python -:download:`Download this script ` \ No newline at end of file +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_symmetryplaneFeature.rst b/src/FeaturesPlugin/doc/TUI_symmetryplaneFeature.rst index cfafee3c2..426fa46ff 100644 --- a/src/FeaturesPlugin/doc/TUI_symmetryplaneFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_symmetryplaneFeature.rst @@ -8,4 +8,4 @@ Symmetry through a Plane of symmetry :linenos: :language: python -:download:`Download this script ` \ No newline at end of file +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_symmetrypointFeature.rst b/src/FeaturesPlugin/doc/TUI_symmetrypointFeature.rst index 9a121640a..54d168b00 100644 --- a/src/FeaturesPlugin/doc/TUI_symmetrypointFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_symmetrypointFeature.rst @@ -8,4 +8,4 @@ Symmetry through a Point of symmetry :linenos: :language: python -:download:`Download this script ` \ No newline at end of file +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_translation2pointsFeature.rst b/src/FeaturesPlugin/doc/TUI_translation2pointsFeature.rst index b26f8e762..6eeb238ee 100644 --- a/src/FeaturesPlugin/doc/TUI_translation2pointsFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_translation2pointsFeature.rst @@ -8,4 +8,4 @@ Translation by 2 points :linenos: :language: python -:download:`Download this script ` \ No newline at end of file +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_translationdxdydzFeature.rst b/src/FeaturesPlugin/doc/TUI_translationdxdydzFeature.rst index e3e273ce8..2e3c306ee 100644 --- a/src/FeaturesPlugin/doc/TUI_translationdxdydzFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_translationdxdydzFeature.rst @@ -8,4 +8,4 @@ Translation by vector :linenos: :language: python -:download:`Download this script ` \ No newline at end of file +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/TUI_translationvectorFeature.rst b/src/FeaturesPlugin/doc/TUI_translationvectorFeature.rst index 70278fa9f..aa7b794d0 100644 --- a/src/FeaturesPlugin/doc/TUI_translationvectorFeature.rst +++ b/src/FeaturesPlugin/doc/TUI_translationvectorFeature.rst @@ -8,5 +8,4 @@ Translation by axis and distance :linenos: :language: python -:download:`Download this script ` - +:download:`Download this script ` diff --git a/src/FeaturesPlugin/doc/chamferFeature.rst b/src/FeaturesPlugin/doc/chamferFeature.rst index dae55dfb0..2c0e8e009 100644 --- a/src/FeaturesPlugin/doc/chamferFeature.rst +++ b/src/FeaturesPlugin/doc/chamferFeature.rst @@ -3,7 +3,7 @@ .. _featureChamfer: Chamfer -====== +======= **Chamfer** feature creates chamfers on the edges or on the faces of a shape. @@ -14,13 +14,19 @@ To create a Chamfer in the active part: There are 2 types of chamfer: - .. image:: images/chamfer_distances.png - :align: left - chamfer by two distances +.. image:: images/chamfer_distances.png + :align: left + :height: 24px - .. image:: images/chamfer_dist_angle.png - :align: left - chamfer by a distance and an angle +chamfer by two distances + +.. image:: images/chamfer_dist_angle.png + :align: left + :height: 24px + +chamfer by a distance and an angle + +-------------------------------------------------------------------------------- Chamfer by two distances ------------------------ diff --git a/src/FeaturesPlugin/doc/commonFeature.rst b/src/FeaturesPlugin/doc/commonFeature.rst index 52aa644af..a09b6bd18 100644 --- a/src/FeaturesPlugin/doc/commonFeature.rst +++ b/src/FeaturesPlugin/doc/commonFeature.rst @@ -1,4 +1,5 @@ .. |bool_common.icon| image:: images/bool_common.png + :height: 16px Common ====== @@ -14,12 +15,17 @@ There are 2 options for creation of a Common: .. image:: images/bool_common_simple.png :align: left + :height: 24px + **Simple** common part between all selected objects. .. image:: images/bool_common_advanced.png :align: left + :height: 24px + **Advanced** common part for each object between this object and all tools. +-------------------------------------------------------------------------------- Simple ------ diff --git a/src/FeaturesPlugin/doc/cutFeature.rst b/src/FeaturesPlugin/doc/cutFeature.rst index 9a9922406..d9cbbcf6b 100644 --- a/src/FeaturesPlugin/doc/cutFeature.rst +++ b/src/FeaturesPlugin/doc/cutFeature.rst @@ -1,5 +1,6 @@ .. _featureCut: .. |bool_cut.icon| image:: images/bool_cut.png + :height: 16px Cut === diff --git a/src/FeaturesPlugin/doc/extrusionCutFeature.rst b/src/FeaturesPlugin/doc/extrusionCutFeature.rst index fb6a4dee4..9b4a28d07 100644 --- a/src/FeaturesPlugin/doc/extrusionCutFeature.rst +++ b/src/FeaturesPlugin/doc/extrusionCutFeature.rst @@ -22,16 +22,23 @@ There are three variants of the property panel for Extrusion Cut depending on th .. image:: images/extrusion_by_sizes.png :align: left + :height: 24px + **By Sizes** extrudes objects by specifying sizes. .. image:: images/extrusion_by_bounding_planes.png :align: left + :height: 24px + **By Bounding Planes** extrudes objects by specifying bounding planes and offsets. .. image:: images/extrusion_through_all.png :align: left + :height: 24px + **Through All** extrudes base objects through all objects to be cut. +-------------------------------------------------------------------------------- By sizes -------- diff --git a/src/FeaturesPlugin/doc/extrusionFeature.rst b/src/FeaturesPlugin/doc/extrusionFeature.rst index 897279fbb..594048195 100644 --- a/src/FeaturesPlugin/doc/extrusionFeature.rst +++ b/src/FeaturesPlugin/doc/extrusionFeature.rst @@ -22,12 +22,17 @@ There are two variants of the property panel for Extrusion depending on the chos .. image:: images/extrusion_by_sizes.png :align: left + :height: 24px + **By Sizes** extrudes objects by specifying sizes. .. image:: images/extrusion_by_bounding_planes.png :align: left + :height: 24px + **By Bounding Faces** extrudes objects by specifying bounding faces/planes and offsets. +-------------------------------------------------------------------------------- By sizes -------- diff --git a/src/FeaturesPlugin/doc/extrusionFuseFeature.rst b/src/FeaturesPlugin/doc/extrusionFuseFeature.rst index 59d49043e..f5221141b 100644 --- a/src/FeaturesPlugin/doc/extrusionFuseFeature.rst +++ b/src/FeaturesPlugin/doc/extrusionFuseFeature.rst @@ -1,7 +1,7 @@ .. |extrusion_fuse_btn.icon| image:: images/extrusion_fuse_btn.png Extrusion Fuse -============= +============== Extrusion Fuse feature extrudes selected objects along their normals or the selected axis and fuses the result with other objects. @@ -22,16 +22,23 @@ There are three variants of the property panel for Extrusion Fuse depending on t .. image:: images/extrusion_by_sizes.png :align: left + :height: 24px + **By Sizes** extrudes objects by specifying sizes. .. image:: images/extrusion_by_bounding_planes.png :align: left + :height: 24px + **By Bounding Planes** extrudes objects by specifying bounding planes and offsets. .. image:: images/extrusion_through_all.png :align: left + :height: 24px + **Through All** extrudes base objects to pass through all objects fuse with. +-------------------------------------------------------------------------------- By sizes -------- diff --git a/src/FeaturesPlugin/doc/filletFeature.rst b/src/FeaturesPlugin/doc/filletFeature.rst index 20a41847a..af3f6e837 100644 --- a/src/FeaturesPlugin/doc/filletFeature.rst +++ b/src/FeaturesPlugin/doc/filletFeature.rst @@ -14,13 +14,19 @@ To create a Fillet in the active part: There are 2 types of fillet: - .. image:: images/fillet_fixed_radius.png - :align: left - fillet by fixed radius +.. image:: images/fillet_fixed_radius.png + :align: left + :height: 24px - .. image:: images/fillet_var_radius.png - :align: left - fillet by variable radius +fillet by fixed radius + +.. image:: images/fillet_var_radius.png + :align: left + :height: 24px + +fillet by variable radius + +-------------------------------------------------------------------------------- Fillet by fixed radius ---------------------- diff --git a/src/FeaturesPlugin/doc/fuseFeature.rst b/src/FeaturesPlugin/doc/fuseFeature.rst index 24295821e..739d249f6 100644 --- a/src/FeaturesPlugin/doc/fuseFeature.rst +++ b/src/FeaturesPlugin/doc/fuseFeature.rst @@ -1,4 +1,5 @@ .. |bool_fuse.icon| image:: images/bool_fuse.png + :height: 16px Fuse ==== @@ -14,12 +15,17 @@ There are 2 options for creation of a Fuse: .. image:: images/bool_fuse_simple.png :align: left + :height: 24px + **Simple** simply fuses selected objects. .. image:: images/bool_fuse_advanced.png :align: left + :height: 24px + **Advanced** fuse with additional functionality for subshapes of compsolids/compounds. +-------------------------------------------------------------------------------- Simple ------ diff --git a/src/FeaturesPlugin/doc/importResultFeature.rst b/src/FeaturesPlugin/doc/importResultFeature.rst index 28741a32e..5ced0b14a 100644 --- a/src/FeaturesPlugin/doc/importResultFeature.rst +++ b/src/FeaturesPlugin/doc/importResultFeature.rst @@ -1,7 +1,7 @@ .. |import_result_btn.icon| image:: images/import_result_btn.png Import Result -===== +============= The Import Result feature allows the user to import one or several results from another Part. If the result of the source-part is changed, the part and part result that contains the copy-results will be updated. The feature keeps the diff --git a/src/FeaturesPlugin/doc/measurementFeature.rst b/src/FeaturesPlugin/doc/measurementFeature.rst index 42a45fadf..a5f773178 100644 --- a/src/FeaturesPlugin/doc/measurementFeature.rst +++ b/src/FeaturesPlugin/doc/measurementFeature.rst @@ -18,25 +18,37 @@ To start Measurement in the active part: The following dimensions can be calculated: - .. image:: images/meas_length_32x32.png - :align: left - edge length +.. image:: images/meas_length_32x32.png + :align: left + :height: 24px - .. image:: images/meas_distance_32x32.png - :align: left - distance between objects +edge length - .. image:: images/meas_radius_32x32.png - :align: left - radius +.. image:: images/meas_distance_32x32.png + :align: left + :height: 24px - .. image:: images/meas_angle_32x32.png - :align: left - angle between edges +distance between objects - .. image:: images/meas_angle3p_32x32.png - :align: left - angle by 3 points +.. image:: images/meas_radius_32x32.png + :align: left + :height: 24px + +radius + +.. image:: images/meas_angle_32x32.png + :align: left + :height: 24px + +angle between edges + +.. image:: images/meas_angle3p_32x32.png + :align: left + :height: 24px + +angle by 3 points + +-------------------------------------------------------------------------------- Edge length ----------- @@ -160,4 +172,4 @@ Input fields: :param object: A second vertex in format *model.selection("TYPE", shape)*. :param object: A third vertex in format *model.selection("TYPE", shape)*. :return: Calculated value. - \ No newline at end of file + diff --git a/src/FeaturesPlugin/doc/pipeFeature.rst b/src/FeaturesPlugin/doc/pipeFeature.rst index 40611a394..1f9924580 100644 --- a/src/FeaturesPlugin/doc/pipeFeature.rst +++ b/src/FeaturesPlugin/doc/pipeFeature.rst @@ -12,17 +12,25 @@ To create a Pipe in the active part: Pipe can be created in three different ways: - .. image:: images/pipe_simple_32x32.png - :align: left - by object and path +.. image:: images/pipe_simple_32x32.png + :align: left + :height: 24px - .. image:: images/pipe_binormal_32x32.png - :align: left - by object, path and Bi-normal +by object and path - .. image:: images/pipe_locations_32x32.png - :align: left - by object, path and locations +.. image:: images/pipe_binormal_32x32.png + :align: left + :height: 24px + +by object, path and Bi-normal + +.. image:: images/pipe_locations_32x32.png + :align: left + :height: 24px + +by object, path and locations + +-------------------------------------------------------------------------------- Pipe by object and path ----------------------- @@ -140,4 +148,4 @@ Result of extrusion of 3 circles along arc with specified locations. .. centered:: Pipe by object, path and locations -**See Also** a sample TUI Script of :ref:`tui_locations_pipe` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_locations_pipe` operation. diff --git a/src/FeaturesPlugin/doc/recoverFeature.rst b/src/FeaturesPlugin/doc/recoverFeature.rst index 64b27ea59..cc792703a 100644 --- a/src/FeaturesPlugin/doc/recoverFeature.rst +++ b/src/FeaturesPlugin/doc/recoverFeature.rst @@ -14,12 +14,17 @@ The feature has the following options: .. image:: images/recover_default_32x32.png :align: left + :height: 24px + restore only the objects used in the operation .. image:: images/recover_compound_32x32.png :align: left + :height: 24px + restore full compound/compsolid if the operation used one or more of its sub-shapes +-------------------------------------------------------------------------------- Recover objects --------------- diff --git a/src/FeaturesPlugin/doc/removeSubShapesFeature.rst b/src/FeaturesPlugin/doc/removeSubShapesFeature.rst index d3e7fc9c0..25258247b 100644 --- a/src/FeaturesPlugin/doc/removeSubShapesFeature.rst +++ b/src/FeaturesPlugin/doc/removeSubShapesFeature.rst @@ -18,13 +18,14 @@ The following property panel will be opened: .. centered:: Remove Sub-Shapes +.. |by_removing| image:: images/remove_subshapes_32x32.png +.. |by_keeping| image:: images/keep_subshapes_32x32.png + - **Shape** shape from which sub-shapes should be removed. Only wires, shells, compsolids or compounds are allowed for selection. There are 2 options for removing sub-shapes: -.. image:: images/remove_subshapes_32x32.png - :align: left -**By removing** allows selecting sub-shapes to be removed. +|by_removing| **By removing** allows selecting sub-shapes to be removed. - **Sub-Shapes to remove** the list of sub-shapes which should be removed. @@ -40,10 +41,7 @@ There are 2 options for removing sub-shapes: :param list: A list of objects. - -.. image:: images/keep_subshapes_32x32.png - :align: left -**By keeping** allows select sub-shapes to be kept. +|by_keeping| **By keeping** allows select sub-shapes to be kept. - **Sub-Shapes to keep** the list of sub-shapes which should be kept. diff --git a/src/FeaturesPlugin/doc/revolutionCutFeature.rst b/src/FeaturesPlugin/doc/revolutionCutFeature.rst index da86d155e..9c55d1f49 100644 --- a/src/FeaturesPlugin/doc/revolutionCutFeature.rst +++ b/src/FeaturesPlugin/doc/revolutionCutFeature.rst @@ -22,19 +22,26 @@ There are three variants of the property panel for Revolution Cut depending on t .. image:: images/revolution_by_angles.png :align: left + :height: 24px + **By Angles** revolves objects by specifying angles. .. image:: images/revolution_by_bounding_planes.png :align: left + :height: 24px + **By Bounding Planes** revolves objects by specifying bounding planes and angles. .. image:: images/revolution_through_all.png :align: left + :height: 24px + **Through All** revolves objects by 360 degrees. +-------------------------------------------------------------------------------- By angles --------- +--------- .. image:: images/RevolutionCut1.png :align: center @@ -127,7 +134,7 @@ The Result of the operation will be a revolved shape: **See Also** a sample TUI Script of :ref:`tui_create_revolution_cut_by_bounding_planes` operation. Through all --------- +----------- .. image:: images/RevolutionCut3.png :align: center diff --git a/src/FeaturesPlugin/doc/revolutionFeature.rst b/src/FeaturesPlugin/doc/revolutionFeature.rst index cdf8790e3..1c8ec92f3 100644 --- a/src/FeaturesPlugin/doc/revolutionFeature.rst +++ b/src/FeaturesPlugin/doc/revolutionFeature.rst @@ -22,15 +22,20 @@ There are two variants of the property panel for Revolution depending on the cho .. image:: images/revolution_by_angles.png :align: left + :height: 24px + **By Angles** revolves objects by specifying angles. .. image:: images/revolution_by_bounding_planes.png :align: left + :height: 24px + **By Bounding Planes** revolves objects by specifying bounding planes and angles. +-------------------------------------------------------------------------------- By angles --------- +--------- .. image:: images/Revolution1.png :align: center @@ -115,4 +120,4 @@ The Result of the operation will be a revolved shape: .. centered:: **Revolution created** -**See Also** a sample TUI Script of :ref:`tui_create_revolution_by_bounding_planes` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_create_revolution_by_bounding_planes` operation. diff --git a/src/FeaturesPlugin/doc/revolutionFuseFeature.rst b/src/FeaturesPlugin/doc/revolutionFuseFeature.rst index a608a03d9..66e8254d6 100644 --- a/src/FeaturesPlugin/doc/revolutionFuseFeature.rst +++ b/src/FeaturesPlugin/doc/revolutionFuseFeature.rst @@ -22,19 +22,26 @@ There are three variants of the property panel for Revolution Fuse depending on .. image:: images/revolution_by_angles.png :align: left + :height: 24px + **By Angles** revolves objects by specifying angles. .. image:: images/revolution_by_bounding_planes.png :align: left + :height: 24px + **By Bounding Planes** revolves objects by specifying bounding planes and angles. .. image:: images/revolution_through_all.png :align: left + :height: 24px + **Through All** revolves objects by 360 degrees. +-------------------------------------------------------------------------------- By angles --------- +--------- .. image:: images/RevolutionFuse1.png :align: center diff --git a/src/FeaturesPlugin/doc/rotationFeature.rst b/src/FeaturesPlugin/doc/rotationFeature.rst index 548462619..d9afacb27 100644 --- a/src/FeaturesPlugin/doc/rotationFeature.rst +++ b/src/FeaturesPlugin/doc/rotationFeature.rst @@ -13,13 +13,19 @@ To create a Rotation in the active part: Two rotation algorithms are: - .. image:: images/rotation_axis_32x32.png - :align: left - by axis and angle +.. image:: images/rotation_axis_32x32.png + :align: left + :height: 24px - .. image:: images/rotation_3pt_32x32.png - :align: left - by center and 2 points +by axis and angle + +.. image:: images/rotation_3pt_32x32.png + :align: left + :height: 24px + +by center and 2 points + +-------------------------------------------------------------------------------- Rotation by axis and angle -------------------------- @@ -96,4 +102,4 @@ Result of operation is a rotated initial shape. .. centered:: Rotation by center and 2 points -**See Also** a sample TUI Script of :ref:`tui_rotation_3points` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_rotation_3points` operation. diff --git a/src/FeaturesPlugin/doc/smashFeature.rst b/src/FeaturesPlugin/doc/smashFeature.rst index 48225b962..9f5363cab 100644 --- a/src/FeaturesPlugin/doc/smashFeature.rst +++ b/src/FeaturesPlugin/doc/smashFeature.rst @@ -1,4 +1,5 @@ .. |bool_smash.icon| image:: images/bool_smash.png + :height: 16px Smash ===== diff --git a/src/FeaturesPlugin/doc/splitFeature.rst b/src/FeaturesPlugin/doc/splitFeature.rst index b8d4a2003..adc64cf85 100644 --- a/src/FeaturesPlugin/doc/splitFeature.rst +++ b/src/FeaturesPlugin/doc/splitFeature.rst @@ -1,4 +1,5 @@ .. |bool_split.icon| image:: images/bool_split.png + :height: 16px Split ===== diff --git a/src/FeaturesPlugin/doc/symmetryFeature.rst b/src/FeaturesPlugin/doc/symmetryFeature.rst index 7e815e425..39c6eb036 100644 --- a/src/FeaturesPlugin/doc/symmetryFeature.rst +++ b/src/FeaturesPlugin/doc/symmetryFeature.rst @@ -12,17 +12,25 @@ To create a Symmetry in the active part: Symmetrical copy of an Object can be mirrored in three different ways: - .. image:: images/symmetry_point_32x32.png - :align: left - through a Point of symmetry +.. image:: images/symmetry_point_32x32.png + :align: left + :height: 24px - .. image:: images/symmetry_axis_32x32.png - :align: left - through an Axis of symmetry +through a Point of symmetry - .. image:: images/symmetry_plane_32x32.png - :align: left - through a Plane of symmetry +.. image:: images/symmetry_axis_32x32.png + :align: left + :height: 24px + +through an Axis of symmetry + +.. image:: images/symmetry_plane_32x32.png + :align: left + :height: 24px + +through a Plane of symmetry + +-------------------------------------------------------------------------------- Symmetry through a Point of symmetry ------------------------------------ @@ -136,4 +144,4 @@ The result of operation is a mirrored initial shape with **Create a copy** = *Fa .. centered:: Symmetry through a Plane of symmetry -**See Also** a sample TUI Script of :ref:`tui_symmetry_plane` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_symmetry_plane` operation. diff --git a/src/FeaturesPlugin/doc/transformationFeature.rst b/src/FeaturesPlugin/doc/transformationFeature.rst index 6e8594592..7a5a8f380 100644 --- a/src/FeaturesPlugin/doc/transformationFeature.rst +++ b/src/FeaturesPlugin/doc/transformationFeature.rst @@ -12,13 +12,19 @@ To create a Scale in the active part: Two Scale algorithms are: - .. image:: images/scale_factor_32x32.png - :align: left - by one common factor +.. image:: images/scale_factor_32x32.png + :align: left + :height: 24px - .. image:: images/scale_dimensions_32x32.png - :align: left - by different factors along axes +by one common factor + +.. image:: images/scale_dimensions_32x32.png + :align: left + :height: 24px + +by different factors along axes + +-------------------------------------------------------------------------------- Scale by one common factor -------------------------- @@ -98,4 +104,4 @@ Result of operation is transformed initial shape. .. centered:: Scale by different factors -**See Also** a sample TUI Script of :ref:`tui_Scale_XYZ` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_Scale_XYZ` operation. diff --git a/src/FeaturesPlugin/doc/translationFeature.rst b/src/FeaturesPlugin/doc/translationFeature.rst index 5c552c217..c906f075e 100644 --- a/src/FeaturesPlugin/doc/translationFeature.rst +++ b/src/FeaturesPlugin/doc/translationFeature.rst @@ -1,5 +1,6 @@ .. _featureTranslation: .. |translation_vector_32x32.icon| image:: images/translation_vector_32x32.png + :height: 16px Translation =========== @@ -13,17 +14,25 @@ To create a Translation in the active part: The Vector of translation can be defined in three different ways: - .. image:: images/translation_vector_32x32.png - :align: left - by by axis and distance +.. image:: images/translation_vector_32x32.png + :align: left + :height: 24px - .. image:: images/translation_dxyz_32x32.png - :align: left - by vector +by by axis and distance - .. image:: images/translation_2pt_32x32.png - :align: left - by two points +.. image:: images/translation_dxyz_32x32.png + :align: left + :height: 24px + +by vector + +.. image:: images/translation_2pt_32x32.png + :align: left + :height: 24px + +by two points + +-------------------------------------------------------------------------------- Translation by axis and distance -------------------------------- diff --git a/src/FiltersPlugin/doc/FiltersPlugin.rst b/src/FiltersPlugin/doc/FiltersPlugin.rst index 1e9aade08..82193a354 100644 --- a/src/FiltersPlugin/doc/FiltersPlugin.rst +++ b/src/FiltersPlugin/doc/FiltersPlugin.rst @@ -39,7 +39,7 @@ Each filter item can be deleted with help of |delete.icon| button. A filter can if the filter has arguments. - **Select** button traverces all objects of a current document and selects entities acceptable by currently defined set of filters. All selected entities will be shown in viewer 3d with -blue semi-transparent color. Any modification in filters clears current selection. + blue semi-transparent color. Any modification in filters clears current selection. - **Number of selected objects** shows number currently selected entities. @@ -137,4 +137,4 @@ This algorithm finds all the faces topologically connected the argument selected - **Arguments:** A point, an edge or a face. A “propagation” flag (check-box). - **Algorithm:** - If a point of an edge is selected as an argument, the result is all faces that contain this argument.If a face is selected, the result is all faces that have shared edges or vertices with this selection. - - If “propagation” flag is enabled (it is disabled by default), the algorithm becomes recursive: all connected faces are added to the results. So, for the solid shape there will be all faces except internal-volumes faces, not connected to any external faces. \ No newline at end of file + - If “propagation” flag is enabled (it is disabled by default), the algorithm becomes recursive: all connected faces are added to the results. So, for the solid shape there will be all faces except internal-volumes faces, not connected to any external faces. diff --git a/src/ParametersPlugin/doc/managerFeature.rst b/src/ParametersPlugin/doc/managerFeature.rst index c543c34d7..93af4d9c7 100644 --- a/src/ParametersPlugin/doc/managerFeature.rst +++ b/src/ParametersPlugin/doc/managerFeature.rst @@ -18,6 +18,9 @@ The following dialog box with parameter table appears: .. centered:: Parameters dialog box +.. |param_up| image:: images/parameters_up.png +.. |param_down| image:: images/parameters_down.png + **Input fields**: - **Name** defines parameter name. Name follows the naming rules of the python language for variables; @@ -28,14 +31,9 @@ The following dialog box with parameter table appears: - **Insert** button adds a new empty string before the selected parameter; - **Delete** button removes the selected parameter from the table; - **Modify parameter position** button moves the selected parameter - .. image:: images/parameters_up.png - :align: left - one string higher in the table, - .. image:: images/parameters_down.png - :align: left - one string lower in the table. - + | |param_up| one string higher in the table, + | |param_down| one string lower in the table. **TUI Command**: diff --git a/src/PrimitivesPlugin/doc/TUI_torusFeature.rst b/src/PrimitivesPlugin/doc/TUI_torusFeature.rst index 3a46e0b0d..5c4a63261 100644 --- a/src/PrimitivesPlugin/doc/TUI_torusFeature.rst +++ b/src/PrimitivesPlugin/doc/TUI_torusFeature.rst @@ -2,7 +2,7 @@ .. _tui_create_torus: Create / Torus -============= +============== .. literalinclude:: examples/torus.py :linenos: diff --git a/src/PrimitivesPlugin/doc/boxFeature.rst b/src/PrimitivesPlugin/doc/boxFeature.rst index a0809eba8..a8d641e8c 100644 --- a/src/PrimitivesPlugin/doc/boxFeature.rst +++ b/src/PrimitivesPlugin/doc/boxFeature.rst @@ -1,9 +1,10 @@ .. _box_feature: -.. |box.icon| image:: images/box.png Box === +.. |box.icon| image:: images/box.png + Box feature creates a box solid. To create a Box in the active part: @@ -13,14 +14,19 @@ To create a Box in the active part: There are 2 algorithms for creation of a Box: -.. image:: images/box_2pt_32x32.png +.. image:: images/box_dxyz_32x32.png :align: left + :height: 24px + **By dimensions** -.. image:: images/box_dxyz_32x32.png +.. image:: images/box_2pt_32x32.png :align: left + :height: 24px + **By two points** +-------------------------------------------------------------------------------- By dimensions ------------- @@ -74,6 +80,7 @@ Input fields: :param object: First vertex of diagonal. :param object: Second vertex of diagonal. :return: Result object. + **Arguments**: Part + 2 selected points (opposite vertices of the box) Result diff --git a/src/PrimitivesPlugin/doc/cylinderFeature.rst b/src/PrimitivesPlugin/doc/cylinderFeature.rst index 6cd120ab4..b0f1dac30 100644 --- a/src/PrimitivesPlugin/doc/cylinderFeature.rst +++ b/src/PrimitivesPlugin/doc/cylinderFeature.rst @@ -14,12 +14,18 @@ There are 2 algorithms for creation of a Cylinder: .. image:: images/cylinder_32x32.png :align: left + :height: 24px + **Cylinder** creates a cylinder. .. image:: images/cylinder_portion_32x32.png :align: left + :height: 24px + **Portion of cylinder** creates one segment of a cylinder. +-------------------------------------------------------------------------------- + Cylinder -------- diff --git a/src/SketchPlugin/doc/SketchPlugin.rst b/src/SketchPlugin/doc/SketchPlugin.rst index e405acaa0..3e894d078 100644 --- 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: diff --git a/src/SketchPlugin/doc/TUI_ellipseFeature.rst b/src/SketchPlugin/doc/TUI_ellipseFeature.rst index eb0d9c48a..b02541b42 100644 --- a/src/SketchPlugin/doc/TUI_ellipseFeature.rst +++ b/src/SketchPlugin/doc/TUI_ellipseFeature.rst @@ -2,7 +2,7 @@ .. _tui_create_ellipse: Create Skecth Ellipse -==================== +===================== .. literalinclude:: examples/ellipse.py :linenos: diff --git a/src/SketchPlugin/doc/TUI_perpendicular.rst b/src/SketchPlugin/doc/TUI_perpendicular.rst index 78abd1d3c..3690079d4 100644 --- a/src/SketchPlugin/doc/TUI_perpendicular.rst +++ b/src/SketchPlugin/doc/TUI_perpendicular.rst @@ -2,7 +2,7 @@ .. _tui_create_perpendicular: Create Perpendicular constraint -========================== +=============================== .. literalinclude:: examples/perpendicular.py :linenos: diff --git a/src/SketchPlugin/doc/angleFeature.rst b/src/SketchPlugin/doc/angleFeature.rst index 0847e2006..e7d614d65 100644 --- a/src/SketchPlugin/doc/angleFeature.rst +++ b/src/SketchPlugin/doc/angleFeature.rst @@ -18,35 +18,26 @@ Property panel: .. image:: images/Angle_panel.png :align: center +.. |angle_direct| image:: images/angle_direct.png +.. |angle_complement| image:: images/angle_complementary.png +.. |angle_backward| image:: images/angle_backward.png +.. |loc_left| image:: images/location_left.png +.. |loc_auto| image:: images/location_automatic.png +.. |loc_right| image:: images/location_right.png + Input fields: - **Line 1** is the first line selected in the view; - **Line 2** is the second line selected in the view; - **Value** is an angle between the lines, can be modified to set the desirable value; - **Angle type** is a type of angle measurement: - .. image:: images/angle_direct.png - :align: left - **Direct** is the least angle between two lines; - - .. image:: images/angle_complementary.png - :align: left - **Complementary** is 180°- Direct angle between two lines; - - .. image:: images/angle_backward.png - :align: left - **Backward** is 360°- Direct angle between two lines. + | |angle_direct| **Direct** is the least angle between two lines; + | |angle_complement| **Complementary** is 180°- Direct angle between two lines; + | |angle_backward| **Backward** is 360°- Direct angle between two lines. - **Text location** is the position of the angle value label relatively to the angle line (in the view): - .. image:: images/location_left.png - :align: left - **Left** inserts text to the left of the angle line; - - .. image:: images/location_automatic.png - :align: left - **Automatic** inserts text it the middle of the angle line if it has enough length, otherwise - to the left; - - .. image:: images/location_right.png - :align: left - **Right** inserts text to the right of the angle line. + | |loc_left| **Left** inserts text to the left of the angle line; + | |loc_auto| **Automatic** inserts text it the middle of the angle line if it has enough length, otherwise - to the left; + | |loc_right| **Right** inserts text to the right of the angle line. When both lines are selected, the angle value is displayed in the property panel and in the view. @@ -83,4 +74,4 @@ Created Angle appears in the view. .. centered:: Angle created -**See Also** a sample TUI Script of :ref:`tui_create_angle` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_create_angle` operation. diff --git a/src/SketchPlugin/doc/arcFeature.rst b/src/SketchPlugin/doc/arcFeature.rst index 5cdb22aa9..57f0eb85d 100644 --- a/src/SketchPlugin/doc/arcFeature.rst +++ b/src/SketchPlugin/doc/arcFeature.rst @@ -14,20 +14,30 @@ There are 4 algorithms for creation of an Arc: .. image:: images/arc_base_32x32.png :align: left + :height: 24px + **By center and two points** creates an arc segment with the given center passing from the start point to the end point on the circle. .. image:: images/arc_3pt_32x32.png :align: left + :height: 24px + **By three points** creates an arc segment passing from the start point to end point through another point on the circle. .. image:: images/arc_tang_32x32.png :align: left + :height: 24px + **By tangent point and end point** creates an arc segment with the tangent point and the end point. .. image:: images/arc_perp_32x32.png :align: left + :height: 24px + **By point on perpendicular line and end point** creates an arc segment perpendicular to a straight line with the start point, connected with boundary of this line, and the end point. +------------------------------------------------------------------------------------------- + By center and two points """""""""""""""""""""""" @@ -137,4 +147,4 @@ Created arc appears in the view. .. centered:: Arc created -**See Also** a sample TUI Script of :ref:`tui_create_arc` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_create_arc` operation. diff --git a/src/SketchPlugin/doc/circleFeature.rst b/src/SketchPlugin/doc/circleFeature.rst index 1db829331..4932368cf 100644 --- a/src/SketchPlugin/doc/circleFeature.rst +++ b/src/SketchPlugin/doc/circleFeature.rst @@ -14,12 +14,18 @@ There are 2 algorithms for creation of a Circle: .. image:: images/circle_pt_rad_32x32.png :align: left + :height: 24px + **By center and passed point** creates a circle with the given center passing through the given point. .. image:: images/circle_3pt_32x32.png :align: left + :height: 24px + **By three points** creates a circle passing through the given three points. +------------------------------------------------------------------------------------------- + By center and passed point """""""""""""""""""""""""" diff --git a/src/SketchPlugin/doc/distanceFeature.rst b/src/SketchPlugin/doc/distanceFeature.rst index 72e655ff0..2c2324ef4 100644 --- a/src/SketchPlugin/doc/distanceFeature.rst +++ b/src/SketchPlugin/doc/distanceFeature.rst @@ -1,4 +1,4 @@ -.. |distance.icon| image:: images/distance.png +.. |distance.icon| image:: images/Distance.png Distance constraint =================== @@ -17,23 +17,19 @@ Property panel: .. image:: images/Distance_panel.png :align: center +.. |location_left| image:: images/location_left.png +.. |location_auto| image:: images/location_automatic.png +.. |location_right| image:: images/location_right.png + Input fields: - **First object** is the first object selected in the view; - **Second object** is the second object selected in the view; - **Value** is a distance between the objects, can be modified to set the desirable value; - **Text location** is a position of the distance value label relating to extension line (in the view): - .. image:: images/location_left.png - :align: left - **Left** inserts text to the left of the distance extension line; - - .. image:: images/location_automatic.png - :align: left - **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left; - - .. image:: images/location_right.png - :align: left - **Right** inserts text to the right of the distance extension line; + | |location_left| **Left** inserts text to the left of the distance extension line; + | |location_auto| **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left; + | |location_right| **Right** inserts text to the right of the distance extension line; - **Keep orientation** fixes the relative position between selected objects. When both objects are selected, the distance value is displayed in the property panel and in the view. diff --git a/src/SketchPlugin/doc/ellipseFeature.rst b/src/SketchPlugin/doc/ellipseFeature.rst index cdd84a51e..ead26a50f 100644 --- a/src/SketchPlugin/doc/ellipseFeature.rst +++ b/src/SketchPlugin/doc/ellipseFeature.rst @@ -14,12 +14,18 @@ There are 2 algorithms for creation of an Ellipse: .. image:: images/ellipse_cent_rad_32x32.png :align: left + :height: 24px + **By center and major semi-axes and passing points** creates an ellipse with the given center passing through given points. .. image:: images/ellipse_axes_32x32.png :align: left + :height: 24px + **By major axis and passing point** creates an ellipse passing through the given three points. +------------------------------------------------------------------------------------------- + By center and major semi-axes and passing points """""""""""""""""""""""""""""""""""""""""""""""" diff --git a/src/SketchPlugin/doc/equalFeature.rst b/src/SketchPlugin/doc/equalFeature.rst index a0305cb97..343b9edc7 100644 --- a/src/SketchPlugin/doc/equalFeature.rst +++ b/src/SketchPlugin/doc/equalFeature.rst @@ -1,5 +1,5 @@ .. _sketchEqual: -.. |equal.icon| image:: images/equal.png +.. |equal.icon| image:: images/Equal.png Equal constraint ================ @@ -46,4 +46,4 @@ Created Equal constraint appears in the view. .. centered:: Created equal constraint -**See Also** a sample TUI Script of :ref:`tui_create_equal` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_create_equal` operation. diff --git a/src/SketchPlugin/doc/filletFeature.rst b/src/SketchPlugin/doc/filletFeature.rst index 8067285c5..1c71bdb6e 100644 --- a/src/SketchPlugin/doc/filletFeature.rst +++ b/src/SketchPlugin/doc/filletFeature.rst @@ -1,4 +1,4 @@ -.. |fillet.icon| image:: images/fillet.png +.. |fillet.icon| image:: images/Fillet.png Fillet ====== @@ -49,4 +49,4 @@ Created Fillet appears in the view. .. centered:: Created fillet -**See Also** a sample TUI Script of :ref:`tui_create_fillet` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_create_fillet` operation. diff --git a/src/SketchPlugin/doc/fixedFeature.rst b/src/SketchPlugin/doc/fixedFeature.rst index 2b238d0dc..261975a0b 100644 --- a/src/SketchPlugin/doc/fixedFeature.rst +++ b/src/SketchPlugin/doc/fixedFeature.rst @@ -1,4 +1,4 @@ -.. |fixed.icon| image:: images/fixed.png +.. |fixed.icon| image:: images/Fixed.png Fixed constraint ================ diff --git a/src/SketchPlugin/doc/horizontalDistFeature.rst b/src/SketchPlugin/doc/horizontalDistFeature.rst index 68bc3b811..729cb85ea 100644 --- a/src/SketchPlugin/doc/horizontalDistFeature.rst +++ b/src/SketchPlugin/doc/horizontalDistFeature.rst @@ -17,23 +17,19 @@ Property panel: .. image:: images/HorizontalDistance_panel.png :align: center +.. |location_left| image:: images/location_left.png +.. |location_auto| image:: images/location_automatic.png +.. |location_right| image:: images/location_right.png + Input fields: - **First point** is the first point selected in the view; - **Second point** is the second point selected in the view; - **Value** is a distance between the objects, can be modified to set the desirable value; - **Text location** is a position of the distance value label relating to extension line (in the view): - .. image:: images/location_left.png - :align: left - **Left** inserts text to the left of the distance extension line; - - .. image:: images/location_automatic.png - :align: left - **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left; - - .. image:: images/location_right.png - :align: left - **Right** inserts text to the right of the distance extension line. + | |location_left| **Left** inserts text to the left of the distance extension line; + | |location_auto| **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left; + | |location_right| **Right** inserts text to the right of the distance extension line. When both objects are selected, the horizontal distance value is displayed in the property panel and in the view. @@ -68,4 +64,4 @@ Created Horizontal Distance appears in the view. .. centered:: Horizontal Distance created -**See Also** a sample TUI Script of :ref:`tui_create_hdistance` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_create_hdistance` operation. diff --git a/src/SketchPlugin/doc/intersectionFeature.rst b/src/SketchPlugin/doc/intersectionFeature.rst index 4361975d0..a0d24b649 100644 --- a/src/SketchPlugin/doc/intersectionFeature.rst +++ b/src/SketchPlugin/doc/intersectionFeature.rst @@ -1,4 +1,4 @@ -.. |intersection.icon| image:: images/intersection.png +.. |intersection.icon| image:: images/Intersection.png Intersection ============ diff --git a/src/SketchPlugin/doc/lengthFeature.rst b/src/SketchPlugin/doc/lengthFeature.rst index 939a98ee1..214f29a26 100644 --- a/src/SketchPlugin/doc/lengthFeature.rst +++ b/src/SketchPlugin/doc/lengthFeature.rst @@ -1,5 +1,5 @@ .. _sketchLength: -.. |length.icon| image:: images/length.png +.. |length.icon| image:: images/Length.png Length constraint ================= @@ -16,22 +16,18 @@ Property panel: .. image:: images/Length_panel.png :align: center +.. |location_left| image:: images/location_left.png +.. |location_auto| image:: images/location_automatic.png +.. |location_right| image:: images/location_right.png + Input fields: - **Line** is the the line object selected in the view; - **Value** is a line length, can be modified to set the desirable value; - **Text location** is a position of the length value label relating to extension line (in the view): - .. image:: images/location_left.png - :align: left - **Left** inserts text to the left of the length extension line; - - .. image:: images/location_automatic.png - :align: left - **Automatic** inserts text in the middle of the length extension line if it has enough length, otherwise - to the left; - - .. image:: images/location_right.png - :align: left - **Right** inserts text to the right of the length extension line. + | |location_left| **Left** inserts text to the left of the length extension line; + | |location_auto| **Automatic** inserts text in the middle of the length extension line if it has enough length, otherwise - to the left; + | |location_right| **Right** inserts text to the right of the length extension line. When the line is selected, the length value is displayed in the property panel and in the view. diff --git a/src/SketchPlugin/doc/lineFeature.rst b/src/SketchPlugin/doc/lineFeature.rst index a45094e76..7a7d804bb 100644 --- a/src/SketchPlugin/doc/lineFeature.rst +++ b/src/SketchPlugin/doc/lineFeature.rst @@ -1,5 +1,5 @@ .. _sketchLine: -.. |line.icon| image:: images/line.png +.. |line.icon| image:: images/Line.png Line ==== diff --git a/src/SketchPlugin/doc/middleFeature.rst b/src/SketchPlugin/doc/middleFeature.rst index 01a536a9c..70efffd9b 100644 --- a/src/SketchPlugin/doc/middleFeature.rst +++ b/src/SketchPlugin/doc/middleFeature.rst @@ -1,4 +1,4 @@ -.. |middlepoint.icon| image:: images/middlepoint.png +.. |middlepoint.icon| image:: images/MiddlePoint.png Middle point constraint ======================= diff --git a/src/SketchPlugin/doc/mirrorFeature.rst b/src/SketchPlugin/doc/mirrorFeature.rst index 872c5ab1f..bf5c9c7fe 100644 --- a/src/SketchPlugin/doc/mirrorFeature.rst +++ b/src/SketchPlugin/doc/mirrorFeature.rst @@ -1,4 +1,4 @@ -.. |mirror.icon| image:: images/mirror.png +.. |mirror.icon| image:: images/Mirror.png Mirror copy =========== @@ -45,4 +45,4 @@ Created Mirror copy appears in the view. .. centered:: Mirror copy created -**See Also** a sample TUI Script of :ref:`tui_create_mirror` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_create_mirror` operation. diff --git a/src/SketchPlugin/doc/parallelFeature.rst b/src/SketchPlugin/doc/parallelFeature.rst index 556df5676..96832d9c5 100644 --- a/src/SketchPlugin/doc/parallelFeature.rst +++ b/src/SketchPlugin/doc/parallelFeature.rst @@ -1,4 +1,4 @@ -.. |parallel.icon| image:: images/parallel.png +.. |parallel.icon| image:: images/Parallel.png Parallel constraint =================== @@ -41,4 +41,4 @@ Created Parallel constraint appears in the view. .. centered:: Created parallel constraint -**See Also** a sample TUI Script of :ref:`tui_create_parallel` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_create_parallel` operation. diff --git a/src/SketchPlugin/doc/pointFeature.rst b/src/SketchPlugin/doc/pointFeature.rst index d8865b9c7..a7584fac8 100644 --- a/src/SketchPlugin/doc/pointFeature.rst +++ b/src/SketchPlugin/doc/pointFeature.rst @@ -1,4 +1,4 @@ -.. |point.icon| image:: images/point.png +.. |point.icon| image:: images/Point.png Point ===== @@ -42,4 +42,4 @@ Created point appears in the view. .. centered:: Point created -**See Also** a sample TUI Script of :ref:`tui_create_point` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_create_point` operation. diff --git a/src/SketchPlugin/doc/projectionFeature.rst b/src/SketchPlugin/doc/projectionFeature.rst index 587e05ab5..cee5550e0 100644 --- a/src/SketchPlugin/doc/projectionFeature.rst +++ b/src/SketchPlugin/doc/projectionFeature.rst @@ -1,4 +1,4 @@ -.. |projection.icon| image:: images/projection.png +.. |projection.icon| image:: images/Projection.png Projection ========== @@ -49,4 +49,4 @@ Created Projection appears in the view. .. centered:: Created projection (purple line) -**See Also** a sample TUI Script of :ref:`tui_create_projection` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_create_projection` operation. diff --git a/src/SketchPlugin/doc/radiusFeature.rst b/src/SketchPlugin/doc/radiusFeature.rst index 2b8840a44..38b2b280b 100644 --- a/src/SketchPlugin/doc/radiusFeature.rst +++ b/src/SketchPlugin/doc/radiusFeature.rst @@ -14,23 +14,18 @@ Property panel: .. image:: images/Radius_panel.png :align: center +.. |loc_left| image:: images/location_left.png +.. |loc_auto| image:: images/location_automatic.png +.. |loc_right| image:: images/location_right.png Input fields: - **Circle or Arc** is the circle or arc selected in the view; - **Value** is a radius of the selected object, could be modified to set the desirable value - **Text location** is a position of the radius value label relating to extension line (in the view) - .. image:: images/location_left.png - :align: left - **Left** inserts text at the left of the radius extension line. - - .. image:: images/location_automatic.png - :align: left - **Automatic** inserts text at the middle of the radius extension line if it has enough length, otherwise - to the left. - - .. image:: images/location_right.png - :align: left - **Right** inserts text to the right of the radius extension line. + | |loc_left| **Left** inserts text at the left of the radius extension line. + | |loc_auto| **Automatic** inserts text at the middle of the radius extension line if it has enough length, otherwise - to the left. + | |loc_right| **Right** inserts text to the right of the radius extension line. When circle or arc is selected, the radius value is displayed in the property panel and in the view. diff --git a/src/SketchPlugin/doc/rectangleFeature.rst b/src/SketchPlugin/doc/rectangleFeature.rst index 963c04bd0..6167fa055 100644 --- a/src/SketchPlugin/doc/rectangleFeature.rst +++ b/src/SketchPlugin/doc/rectangleFeature.rst @@ -1,9 +1,10 @@ .. _create_sketch_rectangle: -.. |rectangle.icon| image:: images/rectangle.png Rectangle ========= +.. |rectangle.icon| image:: images/Rectangle.png + Rectangle feature creates a rectangle by two opposite points in the current Sketch. The result is represented in form of four Lines which compose a rectangle. @@ -48,4 +49,4 @@ Created rectangle appears in the view. .. centered:: Rectangle created -**See Also** a sample TUI Script of :ref:`tui_create_rectangle` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_create_rectangle` operation. diff --git a/src/SketchPlugin/doc/rotationFeature.rst b/src/SketchPlugin/doc/rotationFeature.rst index 14f59eaea..2dabf9b47 100644 --- a/src/SketchPlugin/doc/rotationFeature.rst +++ b/src/SketchPlugin/doc/rotationFeature.rst @@ -19,20 +19,16 @@ Property panel: .. centered:: Angular copy +.. |full_angle| image:: images/angle_up_full_32x32.png +.. |single_angle| image:: images/angle_up_32x32.png + Input fields: - **Segments** is the list of segments (lines, circles, arcs) selected in the view; - **Center of rotation** is the center point selected in the view; - **Full angle/Single angle** option: - - .. image:: images/angle_up_full_32x32.png - :align: left - **Full angle**: angle step of rotation is equal to the defined angle divided by the number of copies (total number minus one). - - .. image:: images/angle_up_full_32x32.png - :align: left - **Single angle**: angle step of rotation is equal to the defined angle. - + | |full_angle| **Full angle**: angle step of rotation is equal to the defined angle divided by the number of copies (total number minus one). + | |single_angle| **Single angle**: angle step of rotation is equal to the defined angle. - **Angle** is the angle of rotation. - **Reversed** defines rotation direction. If checked - in a clockwise direction, otherwise - in a counterclockwise direction. - **Total number of objects** is the total number of objects including the original one. diff --git a/src/SketchPlugin/doc/sketchDrawer.rst b/src/SketchPlugin/doc/sketchDrawer.rst index 5bd56bc94..1a49f357c 100644 --- a/src/SketchPlugin/doc/sketchDrawer.rst +++ b/src/SketchPlugin/doc/sketchDrawer.rst @@ -2,7 +2,7 @@ .. |SketchDrawer.icon| image:: images/SketchDrawer.png Sketch Drawer -========= +============= Sketch Drawer featrure is a macro-feature, i.e. it is removed after its execution. It allows simplify creation of sketches basing on existing models without referencing to diff --git a/src/SketchPlugin/doc/splitFeature.rst b/src/SketchPlugin/doc/splitFeature.rst index 24d532c05..4ab56d80c 100644 --- a/src/SketchPlugin/doc/splitFeature.rst +++ b/src/SketchPlugin/doc/splitFeature.rst @@ -1,4 +1,4 @@ -.. |split.icon| image:: images/split.png +.. |split.icon| image:: images/Split.png Split ===== @@ -51,4 +51,4 @@ Created Split appears in the view. .. centered:: Created split -**See Also** a sample TUI Script of :ref:`tui_create_split` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_create_split` operation. diff --git a/src/SketchPlugin/doc/tangentFeature.rst b/src/SketchPlugin/doc/tangentFeature.rst index b4ca71dd5..cbe200a3f 100644 --- a/src/SketchPlugin/doc/tangentFeature.rst +++ b/src/SketchPlugin/doc/tangentFeature.rst @@ -1,4 +1,4 @@ -.. |tangent.icon| image:: images/tangent.png +.. |tangent.icon| image:: images/Tangent.png Tangent constraint ================== diff --git a/src/SketchPlugin/doc/translationFeature.rst b/src/SketchPlugin/doc/translationFeature.rst index db2478fbd..0d682cfb8 100644 --- a/src/SketchPlugin/doc/translationFeature.rst +++ b/src/SketchPlugin/doc/translationFeature.rst @@ -18,18 +18,16 @@ Property panel: .. centered:: Linear copy + +.. |single_value| image:: images/translate_32x32.png +.. |full_value| image:: images/translate_full_32x32.png + Input fields: - **Segments** is the list of segments (lines, circles, arcs) selected in the view. - **Single value/Full value** option: - - .. image:: images/translate_32x32.png - :align: left - **Single value**: step of translation is equal to the distance between the start and the end point. - - .. image:: images/translate_full_32x32.png - :align: left - **Full value**: distance from the originals to the farthest copies is equal to the distance between the start and the end point. + | |single_value| **Single value**: step of translation is equal to the distance between the start and the end point. + | |full_value| **Full value**: distance from the originals to the farthest copies is equal to the distance between the start and the end point. - **Start point** is the initial point of translation vector. - **End point** is the terminal point of translation vector. - **Total number of objects** is the total number of objects including the original one. diff --git a/src/SketchPlugin/doc/trimFeature.rst b/src/SketchPlugin/doc/trimFeature.rst index cdb69caa5..5392a17af 100644 --- a/src/SketchPlugin/doc/trimFeature.rst +++ b/src/SketchPlugin/doc/trimFeature.rst @@ -1,4 +1,4 @@ -.. |trim.icon| image:: images/trim.png +.. |trim.icon| image:: images/Trim.png Trim ==== @@ -39,6 +39,7 @@ The selected segment is highlighted in the view: :param object: Line, arc or circle. :param object: Position point. :return: Result object. + **Arguments**: feature (line, arc or circle) and position point (a point on or closest to the segment to remove) Result diff --git a/src/SketchPlugin/doc/verticalDistFeature.rst b/src/SketchPlugin/doc/verticalDistFeature.rst index dac116da2..5a69b329b 100644 --- a/src/SketchPlugin/doc/verticalDistFeature.rst +++ b/src/SketchPlugin/doc/verticalDistFeature.rst @@ -17,23 +17,19 @@ Property panel: .. image:: images/VerticalDistance_panel.png :align: center +.. |location_left| image:: images/location_left.png +.. |location_auto| image:: images/location_automatic.png +.. |location_right| image:: images/location_right.png + Input fields: - **First point** is the first point selected in the view; - **Second point** is the second point selected in the view: - **Value** is a distance between the objects, can be modified to set the desirable value; - **Text location** is a position of the distance value label relating to extension line (in the view): - .. image:: images/location_left.png - :align: left - **Left** inserts text to the left of the distance extension line: - - .. image:: images/location_automatic.png - :align: left - **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left - - .. image:: images/location_right.png - :align: left - **Right** inserts text to the right of the distance extension line. + | |location_left| **Left** inserts text to the left of the distance extension line: + | |location_auto| **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left + | |location_right| **Right** inserts text to the right of the distance extension line. When both objects are selected, the vertical distance value is displayed in the property panel and in the view. diff --git a/src/SketchPlugin/doc/verticalFeature.rst b/src/SketchPlugin/doc/verticalFeature.rst index 69ad936ce..b6fcf65f3 100644 --- a/src/SketchPlugin/doc/verticalFeature.rst +++ b/src/SketchPlugin/doc/verticalFeature.rst @@ -1,4 +1,4 @@ -.. |vertical.icon| image:: images/vertical.png +.. |vertical.icon| image:: images/Vertical.png Vertical constraint =================== @@ -40,4 +40,4 @@ Created Vertical constraint appears in the view. .. centered:: Vertical constraint created -**See Also** a sample TUI Script of :ref:`tui_create_vertical` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_create_vertical` operation. -- 2.30.2