From: vsv Date: Fri, 3 Aug 2018 15:31:19 +0000 (+0300) Subject: Provide templates for Features plug-in documentation X-Git-Tag: SHAPER_V9_1_0RC1~73^2~16 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=d1fb620b8e260b2b2ddf7eb01488214afaf0fc32;p=modules%2Fshaper.git Provide templates for Features plug-in documentation --- diff --git a/doc/gui/FeaturesPlugin/angularCopyFeature.rst b/doc/gui/FeaturesPlugin/angularCopyFeature.rst new file mode 100644 index 000000000..f29caa171 --- /dev/null +++ b/doc/gui/FeaturesPlugin/angularCopyFeature.rst @@ -0,0 +1,3 @@ + +Angular copy +============ diff --git a/doc/gui/FeaturesPlugin/commonFeature.rst b/doc/gui/FeaturesPlugin/commonFeature.rst new file mode 100644 index 000000000..249be0821 --- /dev/null +++ b/doc/gui/FeaturesPlugin/commonFeature.rst @@ -0,0 +1,3 @@ + +Common +====== diff --git a/doc/gui/FeaturesPlugin/cutFeature.rst b/doc/gui/FeaturesPlugin/cutFeature.rst new file mode 100644 index 000000000..21520755c --- /dev/null +++ b/doc/gui/FeaturesPlugin/cutFeature.rst @@ -0,0 +1,3 @@ + +Cut +=== diff --git a/doc/gui/FeaturesPlugin/extrusionCutFeature.rst b/doc/gui/FeaturesPlugin/extrusionCutFeature.rst new file mode 100644 index 000000000..dfa156f03 --- /dev/null +++ b/doc/gui/FeaturesPlugin/extrusionCutFeature.rst @@ -0,0 +1,24 @@ + +Extrusion cut +============= + + +.. image:: images/StartSketch.png + :align: center + +.. centered:: + Start sketch + + +.. image:: images/ExtrusionCut1.png + :align: center + +.. centered:: + Extrusion: definition by sizes + + +.. image:: images/ExtrusionCut2.png + :align: center + +.. centered:: + Extrusion: definition by bounding planes diff --git a/doc/gui/FeaturesPlugin/extrusionFeature.rst b/doc/gui/FeaturesPlugin/extrusionFeature.rst new file mode 100644 index 000000000..7ba3b93c6 --- /dev/null +++ b/doc/gui/FeaturesPlugin/extrusionFeature.rst @@ -0,0 +1,24 @@ + +Extrusion +========= + + +.. image:: images/StartSketch.png + :align: center + +.. centered:: + Start sketch + + +.. image:: images/Extrusion1.png + :align: center + +.. centered:: + Extrusion: definition by sizes + + +.. image:: images/Extrusion2.png + :align: center + +.. centered:: + Extrusion: definition by bounding planes diff --git a/doc/gui/FeaturesPlugin/extrusionFuseFeature.rst b/doc/gui/FeaturesPlugin/extrusionFuseFeature.rst new file mode 100644 index 000000000..ab214ebf2 --- /dev/null +++ b/doc/gui/FeaturesPlugin/extrusionFuseFeature.rst @@ -0,0 +1,24 @@ + +Extrusion fuse +============== + + +.. image:: images/StartSketch.png + :align: center + +.. centered:: + Start sketch + + +.. image:: images/ExtrusionFuse1.png + :align: center + +.. centered:: + Extrusion: definition by sizes + + +.. image:: images/ExtrusionFuse2.png + :align: center + +.. centered:: + Extrusion: definition by bounding planes diff --git a/doc/gui/FeaturesPlugin/featuresPlugin.rst b/doc/gui/FeaturesPlugin/featuresPlugin.rst new file mode 100644 index 000000000..c79850dab --- /dev/null +++ b/doc/gui/FeaturesPlugin/featuresPlugin.rst @@ -0,0 +1,37 @@ + +.. _featuresPlugin: + + +Fearures plug-in +================ + + +.. toctree:: + :maxdepth: 1 + + angularCopyFeature.rst + commonFeature.rst + cutFeature.rst + extrusionCutFeature.rst + extrusionFeature.rst + extrusionFuseFeature.rst + fillFeature.rst + filletFeature.rst + fuseFeature.rst + intersectionFeature.rst + linearCopyFeature.rst + measurementFeature.rst + partitionFeature.rst + pipeFeature.rst + placementFeature.rst + recoverFeature.rst + removeSubShapesFeature.rst + revolutionCutFeature.rst + revolutionFeature.rst + revolutionFuseFeature.rst + rotationFeature.rst + smashFeature.rst + symmetryFeature.rst + transformationFeature.rst + translationFeature.rst + unionFeature.rst diff --git a/doc/gui/FeaturesPlugin/fillFeature.rst b/doc/gui/FeaturesPlugin/fillFeature.rst new file mode 100644 index 000000000..86348d65a --- /dev/null +++ b/doc/gui/FeaturesPlugin/fillFeature.rst @@ -0,0 +1,3 @@ + +Fill +==== diff --git a/doc/gui/FeaturesPlugin/filletFeature.rst b/doc/gui/FeaturesPlugin/filletFeature.rst new file mode 100644 index 000000000..879ce5953 --- /dev/null +++ b/doc/gui/FeaturesPlugin/filletFeature.rst @@ -0,0 +1,3 @@ + +Fillet +====== diff --git a/doc/gui/FeaturesPlugin/fuseFeature.rst b/doc/gui/FeaturesPlugin/fuseFeature.rst new file mode 100644 index 000000000..13da19446 --- /dev/null +++ b/doc/gui/FeaturesPlugin/fuseFeature.rst @@ -0,0 +1,3 @@ + +Fuse +==== diff --git a/doc/gui/FeaturesPlugin/images/Extrusion1.png b/doc/gui/FeaturesPlugin/images/Extrusion1.png new file mode 100644 index 000000000..898746a9d Binary files /dev/null and b/doc/gui/FeaturesPlugin/images/Extrusion1.png differ diff --git a/doc/gui/FeaturesPlugin/images/Extrusion2.png b/doc/gui/FeaturesPlugin/images/Extrusion2.png new file mode 100644 index 000000000..da0168032 Binary files /dev/null and b/doc/gui/FeaturesPlugin/images/Extrusion2.png differ diff --git a/doc/gui/FeaturesPlugin/images/ExtrusionCut1.png b/doc/gui/FeaturesPlugin/images/ExtrusionCut1.png new file mode 100644 index 000000000..bb5d5f054 Binary files /dev/null and b/doc/gui/FeaturesPlugin/images/ExtrusionCut1.png differ diff --git a/doc/gui/FeaturesPlugin/images/ExtrusionCut2.png b/doc/gui/FeaturesPlugin/images/ExtrusionCut2.png new file mode 100644 index 000000000..348f12c0f Binary files /dev/null and b/doc/gui/FeaturesPlugin/images/ExtrusionCut2.png differ diff --git a/doc/gui/FeaturesPlugin/images/ExtrusionFuse1.png b/doc/gui/FeaturesPlugin/images/ExtrusionFuse1.png new file mode 100644 index 000000000..33c2445f8 Binary files /dev/null and b/doc/gui/FeaturesPlugin/images/ExtrusionFuse1.png differ diff --git a/doc/gui/FeaturesPlugin/images/ExtrusionFuse2.png b/doc/gui/FeaturesPlugin/images/ExtrusionFuse2.png new file mode 100644 index 000000000..f38e71c16 Binary files /dev/null and b/doc/gui/FeaturesPlugin/images/ExtrusionFuse2.png differ diff --git a/doc/gui/FeaturesPlugin/images/Revolution1.png b/doc/gui/FeaturesPlugin/images/Revolution1.png new file mode 100644 index 000000000..1e6b75792 Binary files /dev/null and b/doc/gui/FeaturesPlugin/images/Revolution1.png differ diff --git a/doc/gui/FeaturesPlugin/images/Revolution2.png b/doc/gui/FeaturesPlugin/images/Revolution2.png new file mode 100644 index 000000000..67c7b5fd1 Binary files /dev/null and b/doc/gui/FeaturesPlugin/images/Revolution2.png differ diff --git a/doc/gui/FeaturesPlugin/images/RevolutionCut1.png b/doc/gui/FeaturesPlugin/images/RevolutionCut1.png new file mode 100644 index 000000000..8c7a2885a Binary files /dev/null and b/doc/gui/FeaturesPlugin/images/RevolutionCut1.png differ diff --git a/doc/gui/FeaturesPlugin/images/RevolutionCut2.png b/doc/gui/FeaturesPlugin/images/RevolutionCut2.png new file mode 100644 index 000000000..5cdf5d832 Binary files /dev/null and b/doc/gui/FeaturesPlugin/images/RevolutionCut2.png differ diff --git a/doc/gui/FeaturesPlugin/images/RevolutionFuse1.png b/doc/gui/FeaturesPlugin/images/RevolutionFuse1.png new file mode 100644 index 000000000..600d78e68 Binary files /dev/null and b/doc/gui/FeaturesPlugin/images/RevolutionFuse1.png differ diff --git a/doc/gui/FeaturesPlugin/images/RevolutionFuse2.png b/doc/gui/FeaturesPlugin/images/RevolutionFuse2.png new file mode 100644 index 000000000..87fc70918 Binary files /dev/null and b/doc/gui/FeaturesPlugin/images/RevolutionFuse2.png differ diff --git a/doc/gui/FeaturesPlugin/images/Scale1.png b/doc/gui/FeaturesPlugin/images/Scale1.png new file mode 100644 index 000000000..6e32bfa87 Binary files /dev/null and b/doc/gui/FeaturesPlugin/images/Scale1.png differ diff --git a/doc/gui/FeaturesPlugin/images/Scale2.png b/doc/gui/FeaturesPlugin/images/Scale2.png new file mode 100644 index 000000000..819af55f9 Binary files /dev/null and b/doc/gui/FeaturesPlugin/images/Scale2.png differ diff --git a/doc/gui/FeaturesPlugin/images/StartSketch.png b/doc/gui/FeaturesPlugin/images/StartSketch.png new file mode 100644 index 000000000..20245cf91 Binary files /dev/null and b/doc/gui/FeaturesPlugin/images/StartSketch.png differ diff --git a/doc/gui/FeaturesPlugin/intersectionFeature.rst b/doc/gui/FeaturesPlugin/intersectionFeature.rst new file mode 100644 index 000000000..d48c825a1 --- /dev/null +++ b/doc/gui/FeaturesPlugin/intersectionFeature.rst @@ -0,0 +1,3 @@ + +Intersection +============ diff --git a/doc/gui/FeaturesPlugin/linearCopyFeature.rst b/doc/gui/FeaturesPlugin/linearCopyFeature.rst new file mode 100644 index 000000000..a01a993a2 --- /dev/null +++ b/doc/gui/FeaturesPlugin/linearCopyFeature.rst @@ -0,0 +1,3 @@ + +Linear copy +=========== diff --git a/doc/gui/FeaturesPlugin/measurementFeature.rst b/doc/gui/FeaturesPlugin/measurementFeature.rst new file mode 100644 index 000000000..5fe679ff9 --- /dev/null +++ b/doc/gui/FeaturesPlugin/measurementFeature.rst @@ -0,0 +1,3 @@ + +Measurement +=========== diff --git a/doc/gui/FeaturesPlugin/partitionFeature.rst b/doc/gui/FeaturesPlugin/partitionFeature.rst new file mode 100644 index 000000000..e6ef3cd10 --- /dev/null +++ b/doc/gui/FeaturesPlugin/partitionFeature.rst @@ -0,0 +1,3 @@ + +Partition +========= diff --git a/doc/gui/FeaturesPlugin/pipeFeature.rst b/doc/gui/FeaturesPlugin/pipeFeature.rst new file mode 100644 index 000000000..71cbddbd4 --- /dev/null +++ b/doc/gui/FeaturesPlugin/pipeFeature.rst @@ -0,0 +1,3 @@ + +Pipe +==== diff --git a/doc/gui/FeaturesPlugin/placementFeature.rst b/doc/gui/FeaturesPlugin/placementFeature.rst new file mode 100644 index 000000000..8fc4f8e87 --- /dev/null +++ b/doc/gui/FeaturesPlugin/placementFeature.rst @@ -0,0 +1,3 @@ + +Placement +========= diff --git a/doc/gui/FeaturesPlugin/recoverFeature.rst b/doc/gui/FeaturesPlugin/recoverFeature.rst new file mode 100644 index 000000000..2134d27dc --- /dev/null +++ b/doc/gui/FeaturesPlugin/recoverFeature.rst @@ -0,0 +1,3 @@ + + Recover + ======= diff --git a/doc/gui/FeaturesPlugin/removeSubShapesFeature.rst b/doc/gui/FeaturesPlugin/removeSubShapesFeature.rst new file mode 100644 index 000000000..487026aa4 --- /dev/null +++ b/doc/gui/FeaturesPlugin/removeSubShapesFeature.rst @@ -0,0 +1,3 @@ + +Remove sub-shapes +================= diff --git a/doc/gui/FeaturesPlugin/revolutionCutFeature.rst b/doc/gui/FeaturesPlugin/revolutionCutFeature.rst new file mode 100644 index 000000000..ac60837f2 --- /dev/null +++ b/doc/gui/FeaturesPlugin/revolutionCutFeature.rst @@ -0,0 +1,24 @@ + +Revolution cut +============== + + +.. image:: images/StartSketch.png + :align: center + +.. centered:: + Start sketch + + +.. image:: images/RevolutionCut1.png + :align: center + +.. centered:: + Revolution: definition by angles + + +.. image:: images/RevolutionCut2.png + :align: center + +.. centered:: + Extrusion: definition by bounding planes diff --git a/doc/gui/FeaturesPlugin/revolutionFeature.rst b/doc/gui/FeaturesPlugin/revolutionFeature.rst new file mode 100644 index 000000000..648deb89d --- /dev/null +++ b/doc/gui/FeaturesPlugin/revolutionFeature.rst @@ -0,0 +1,24 @@ + +Revolution +========== + + +.. image:: images/StartSketch.png + :align: center + +.. centered:: + Start sketch + + +.. image:: images/Revolution1.png + :align: center + +.. centered:: + Revolution: definition by angles + + +.. image:: images/Revolution2.png + :align: center + +.. centered:: + Extrusion: definition by bounding planes diff --git a/doc/gui/FeaturesPlugin/revolutionFuseFeature.rst b/doc/gui/FeaturesPlugin/revolutionFuseFeature.rst new file mode 100644 index 000000000..77e77eb84 --- /dev/null +++ b/doc/gui/FeaturesPlugin/revolutionFuseFeature.rst @@ -0,0 +1,24 @@ + +Revolution fuse +=============== + + +.. image:: images/StartSketch.png + :align: center + +.. centered:: + Start sketch + + +.. image:: images/RevolutionFuse1.png + :align: center + +.. centered:: + Revolution: definition by angles + + +.. image:: images/RevolutionFuse2.png + :align: center + +.. centered:: + Extrusion: definition by bounding planes diff --git a/doc/gui/FeaturesPlugin/rotationFeature.rst b/doc/gui/FeaturesPlugin/rotationFeature.rst new file mode 100644 index 000000000..daaa47ab0 --- /dev/null +++ b/doc/gui/FeaturesPlugin/rotationFeature.rst @@ -0,0 +1,3 @@ + +Rotation +======== diff --git a/doc/gui/FeaturesPlugin/smashFeature.rst b/doc/gui/FeaturesPlugin/smashFeature.rst new file mode 100644 index 000000000..e71031105 --- /dev/null +++ b/doc/gui/FeaturesPlugin/smashFeature.rst @@ -0,0 +1,3 @@ + +Smash +===== diff --git a/doc/gui/FeaturesPlugin/symmetryFeature.rst b/doc/gui/FeaturesPlugin/symmetryFeature.rst new file mode 100644 index 000000000..cf5e27fee --- /dev/null +++ b/doc/gui/FeaturesPlugin/symmetryFeature.rst @@ -0,0 +1,3 @@ + +Symmetry +======== diff --git a/doc/gui/FeaturesPlugin/transformationFeature.rst b/doc/gui/FeaturesPlugin/transformationFeature.rst new file mode 100644 index 000000000..5e8f204d7 --- /dev/null +++ b/doc/gui/FeaturesPlugin/transformationFeature.rst @@ -0,0 +1,17 @@ + +Scale +===== + + +.. image:: images/Scale1.png + :align: center + +.. centered:: + Scale: define by a one common factor + + +.. image:: images/Scale2.png + :align: center + +.. centered:: + Scale: define by different factors diff --git a/doc/gui/FeaturesPlugin/translationFeature.rst b/doc/gui/FeaturesPlugin/translationFeature.rst new file mode 100644 index 000000000..730589cc7 --- /dev/null +++ b/doc/gui/FeaturesPlugin/translationFeature.rst @@ -0,0 +1,3 @@ + +Translation +=========== diff --git a/doc/gui/FeaturesPlugin/unionFeature.rst b/doc/gui/FeaturesPlugin/unionFeature.rst new file mode 100644 index 000000000..feadac9a2 --- /dev/null +++ b/doc/gui/FeaturesPlugin/unionFeature.rst @@ -0,0 +1,3 @@ + +Union +===== diff --git a/doc/gui/index.rst b/doc/gui/index.rst index 8f0c9c88d..e43ee518b 100644 --- a/doc/gui/index.rst +++ b/doc/gui/index.rst @@ -7,10 +7,10 @@ Welcome to SHAPER's documentation! ================================== .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :caption: Contents: - + FeaturesPlugin/featuresPlugin.rst Indices and tables ================== diff --git a/src/FeaturesPlugin/plugin-Features.xml b/src/FeaturesPlugin/plugin-Features.xml index dccc6363e..4095ed581 100644 --- a/src/FeaturesPlugin/plugin-Features.xml +++ b/src/FeaturesPlugin/plugin-Features.xml @@ -23,84 +23,85 @@ email : webmaster.salome@opencascade.com + icon="icons/Features/scale.png" helpfile="FeaturesPlugin/transformationFeature.html"> + icon="icons/Features/extrusion.png" helpfile="FeaturesPlugin/extrusionFeature.html"> + icon="icons/Features/extrusion_cut.png" helpfile="FeaturesPlugin/extrusionCutFeature.html"> + icon="icons/Features/extrusion_fuse.png" helpfile="FeaturesPlugin/extrusionFuseFeature.html"> + icon="icons/Features/revol.png" helpfile="FeaturesPlugin/revolutionFeature.html"> + icon="icons/Features/revol_cut.png" helpfile="FeaturesPlugin/revolutionCutFeature.html"> + icon="icons/Features/revol_fuse.png" helpfile="FeaturesPlugin/revolutionFuseFeature.html"> + icon="icons/Features/pipe.png" helpfile="FeaturesPlugin/pipeFeature.html"> - + icon="icons/Features/intersection.png" helpfile="FeaturesPlugin/intersectionFeature.html"> + icon="icons/Features/union.png" helpfile="FeaturesPlugin/unionFeature.html"> + icon="icons/Features/remove_subshapes.png" helpfile="FeaturesPlugin/removeSubShapesFeature.html"> @@ -109,13 +110,13 @@ email : webmaster.salome@opencascade.com + helpfile="FeaturesPlugin/recoverFeature.html"> + icon="icons/Features/fillet.png" auto_preview="true" helpfile="FeaturesPlugin/filletFeature.html"> @@ -123,33 +124,33 @@ email : webmaster.salome@opencascade.com + icon="icons/Features/placement.png" helpfile="FeaturesPlugin/placementFeature.html"> + icon="icons/Features/movement.png" helpfile="FeaturesPlugin/translationFeature.html"> + icon="icons/Features/rotation.png" helpfile="FeaturesPlugin/rotationFeature.html"> + icon="icons/Features/symmetry.png" helpfile="FeaturesPlugin/symmetryFeature.html"> + icon="icons/Features/multitranslation.png" helpfile="FeaturesPlugin/linearCopyFeature.html"> + icon="icons/Features/multirotation.png" helpfile="FeaturesPlugin/angularCopyFeature.html"> + icon="icons/Features/measurement.png" helpfile="FeaturesPlugin/measurementFeature.html">