From: vsv Date: Tue, 7 Aug 2018 15:59:24 +0000 (+0300) Subject: Help templates for plug-ins X-Git-Tag: SHAPER_V9_1_0RC1~89 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=4a2f8ec712062d621bf1c92f061dcf528a437c99;p=modules%2Fshaper.git Help templates for plug-ins --- diff --git a/doc/gui/BuildPlugin/buildPlugin.rst b/doc/gui/BuildPlugin/buildPlugin.rst new file mode 100644 index 000000000..791eb0c34 --- /dev/null +++ b/doc/gui/BuildPlugin/buildPlugin.rst @@ -0,0 +1,21 @@ + +.. _buildPlugin: + +Build plug-in +============= + +.. toctree:: + :maxdepth: 1 + + compoundFeature.rst + compsolidFeature.rst + edgeFeature.rst + faceFeature.rst + fillingFeature.rst + interpolationFeature.rst + polylineFeature.rst + shellFeature.rst + solidFeature.rst + subShapesFeature.rst + vertexFeature.rst + wireFeature.rst diff --git a/doc/gui/BuildPlugin/compoundFeature.rst b/doc/gui/BuildPlugin/compoundFeature.rst new file mode 100644 index 000000000..53465247b --- /dev/null +++ b/doc/gui/BuildPlugin/compoundFeature.rst @@ -0,0 +1,3 @@ + +Compound +======== diff --git a/doc/gui/BuildPlugin/compsolidFeature.rst b/doc/gui/BuildPlugin/compsolidFeature.rst new file mode 100644 index 000000000..ed31b3145 --- /dev/null +++ b/doc/gui/BuildPlugin/compsolidFeature.rst @@ -0,0 +1,3 @@ + +CompSolid +========= diff --git a/doc/gui/BuildPlugin/edgeFeature.rst b/doc/gui/BuildPlugin/edgeFeature.rst new file mode 100644 index 000000000..56094dc4f --- /dev/null +++ b/doc/gui/BuildPlugin/edgeFeature.rst @@ -0,0 +1,3 @@ + +Edge +==== diff --git a/doc/gui/BuildPlugin/faceFeature.rst b/doc/gui/BuildPlugin/faceFeature.rst new file mode 100644 index 000000000..34319233d --- /dev/null +++ b/doc/gui/BuildPlugin/faceFeature.rst @@ -0,0 +1,3 @@ + +Face +==== diff --git a/doc/gui/BuildPlugin/fillingFeature.rst b/doc/gui/BuildPlugin/fillingFeature.rst new file mode 100644 index 000000000..11d56d873 --- /dev/null +++ b/doc/gui/BuildPlugin/fillingFeature.rst @@ -0,0 +1,3 @@ + + Filling + ======= diff --git a/doc/gui/BuildPlugin/interpolationFeature.rst b/doc/gui/BuildPlugin/interpolationFeature.rst new file mode 100644 index 000000000..a69a8a4b2 --- /dev/null +++ b/doc/gui/BuildPlugin/interpolationFeature.rst @@ -0,0 +1,3 @@ + +Interpolation +============= diff --git a/doc/gui/BuildPlugin/polylineFeature.rst b/doc/gui/BuildPlugin/polylineFeature.rst new file mode 100644 index 000000000..b58aa14f6 --- /dev/null +++ b/doc/gui/BuildPlugin/polylineFeature.rst @@ -0,0 +1,3 @@ + +Polyline +======== diff --git a/doc/gui/BuildPlugin/shellFeature.rst b/doc/gui/BuildPlugin/shellFeature.rst new file mode 100644 index 000000000..814b78e25 --- /dev/null +++ b/doc/gui/BuildPlugin/shellFeature.rst @@ -0,0 +1,3 @@ + +Shell +===== diff --git a/doc/gui/BuildPlugin/solidFeature.rst b/doc/gui/BuildPlugin/solidFeature.rst new file mode 100644 index 000000000..db9111567 --- /dev/null +++ b/doc/gui/BuildPlugin/solidFeature.rst @@ -0,0 +1,3 @@ + +Solid +===== diff --git a/doc/gui/BuildPlugin/subShapesFeature.rst b/doc/gui/BuildPlugin/subShapesFeature.rst new file mode 100644 index 000000000..e5af6f800 --- /dev/null +++ b/doc/gui/BuildPlugin/subShapesFeature.rst @@ -0,0 +1,3 @@ + +Sub-shapes +========== diff --git a/doc/gui/BuildPlugin/vertexFeature.rst b/doc/gui/BuildPlugin/vertexFeature.rst new file mode 100644 index 000000000..475ee84f8 --- /dev/null +++ b/doc/gui/BuildPlugin/vertexFeature.rst @@ -0,0 +1,3 @@ + +Vertex +====== diff --git a/doc/gui/BuildPlugin/wireFeature.rst b/doc/gui/BuildPlugin/wireFeature.rst new file mode 100644 index 000000000..a088b7702 --- /dev/null +++ b/doc/gui/BuildPlugin/wireFeature.rst @@ -0,0 +1,3 @@ + +Wire +==== diff --git a/doc/gui/CMakeLists.txt b/doc/gui/CMakeLists.txt index eb5563ab2..33b8ed7d9 100644 --- a/doc/gui/CMakeLists.txt +++ b/doc/gui/CMakeLists.txt @@ -43,7 +43,7 @@ COMMAND ${PYTHON_EXECUTABLE} -c \"import shutil;shutil.rmtree('${CMAKE_INSTALL_P ELSE(${HAVE_SALOME}) INSTALL(CODE " EXECUTE_PROCESS( -COMMAND ${PYTHON_EXECUTABLE} -c \"import shutil;shutil.rmtree('${CMAKE_INSTALL_PREFIX}/doc', True);shutil.copytree('${CMAKE_CURRENT_BINARY_DIR}/html', '${CMAKE_INSTALL_PREFIX}/doc')\" +COMMAND ${PYTHON_EXECUTABLE} -c \"import shutil;shutil.rmtree('${CMAKE_INSTALL_PREFIX}/doc/gui', True);shutil.copytree('${CMAKE_CURRENT_BINARY_DIR}/html', '${CMAKE_INSTALL_PREFIX}/doc/gui')\" ) ") ENDIF(${HAVE_SALOME}) diff --git a/doc/gui/CollectionPlugin/collectionPlugin.rst b/doc/gui/CollectionPlugin/collectionPlugin.rst new file mode 100644 index 000000000..e7bab06bd --- /dev/null +++ b/doc/gui/CollectionPlugin/collectionPlugin.rst @@ -0,0 +1,12 @@ + +.. _collectionPlugin: + + +Collection plug-in +================== + +.. toctree:: + :maxdepth: 1 + + fieldFeature.rst + groupFeature.rst diff --git a/doc/gui/CollectionPlugin/fieldFeature.rst b/doc/gui/CollectionPlugin/fieldFeature.rst new file mode 100644 index 000000000..23a16d5de --- /dev/null +++ b/doc/gui/CollectionPlugin/fieldFeature.rst @@ -0,0 +1,3 @@ + +Field +===== diff --git a/doc/gui/CollectionPlugin/groupFeature.rst b/doc/gui/CollectionPlugin/groupFeature.rst new file mode 100644 index 000000000..c17ee9186 --- /dev/null +++ b/doc/gui/CollectionPlugin/groupFeature.rst @@ -0,0 +1,3 @@ + +Group +===== diff --git a/doc/gui/ConstructionPlugin/axisFeature.rst b/doc/gui/ConstructionPlugin/axisFeature.rst new file mode 100644 index 000000000..bb372bbca --- /dev/null +++ b/doc/gui/ConstructionPlugin/axisFeature.rst @@ -0,0 +1,3 @@ + +Axis +==== diff --git a/doc/gui/ConstructionPlugin/constructionPlugin.rst b/doc/gui/ConstructionPlugin/constructionPlugin.rst new file mode 100644 index 000000000..ac1443406 --- /dev/null +++ b/doc/gui/ConstructionPlugin/constructionPlugin.rst @@ -0,0 +1,12 @@ + +.. _constructionPlugin: + +Construction plug-in +==================== + +.. toctree:: + :maxdepth: 1 + + axisFeature.rst + planeFeature.rst + pointFeature.rst diff --git a/doc/gui/ConstructionPlugin/planeFeature.rst b/doc/gui/ConstructionPlugin/planeFeature.rst new file mode 100644 index 000000000..dbe2ac344 --- /dev/null +++ b/doc/gui/ConstructionPlugin/planeFeature.rst @@ -0,0 +1,3 @@ + +Plane +===== diff --git a/doc/gui/ConstructionPlugin/pointFeature.rst b/doc/gui/ConstructionPlugin/pointFeature.rst new file mode 100644 index 000000000..64f21b167 --- /dev/null +++ b/doc/gui/ConstructionPlugin/pointFeature.rst @@ -0,0 +1,3 @@ + +Point +===== diff --git a/doc/gui/ExchangePlugin/dumpFeature.rst b/doc/gui/ExchangePlugin/dumpFeature.rst new file mode 100644 index 000000000..afdc02407 --- /dev/null +++ b/doc/gui/ExchangePlugin/dumpFeature.rst @@ -0,0 +1,3 @@ + +Dump +==== diff --git a/doc/gui/ExchangePlugin/exchangePlugin.rst b/doc/gui/ExchangePlugin/exchangePlugin.rst new file mode 100644 index 000000000..62081cd38 --- /dev/null +++ b/doc/gui/ExchangePlugin/exchangePlugin.rst @@ -0,0 +1,12 @@ + +.. _exchangePlugin: + +Exchange plug-in +================ + +.. toctree:: + :maxdepth: 1 + + dumpFeature.rst + exportFeature.rst + importFeature.rst diff --git a/doc/gui/ExchangePlugin/exportFeature.rst b/doc/gui/ExchangePlugin/exportFeature.rst new file mode 100644 index 000000000..a007d400b --- /dev/null +++ b/doc/gui/ExchangePlugin/exportFeature.rst @@ -0,0 +1,3 @@ + +Export +====== diff --git a/doc/gui/ExchangePlugin/importFeature.rst b/doc/gui/ExchangePlugin/importFeature.rst new file mode 100644 index 000000000..b033d5be5 --- /dev/null +++ b/doc/gui/ExchangePlugin/importFeature.rst @@ -0,0 +1,3 @@ + +Import +====== diff --git a/doc/gui/GDMLPlugin/GDMLPlugin.rst b/doc/gui/GDMLPlugin/GDMLPlugin.rst new file mode 100644 index 000000000..ab81c5cab --- /dev/null +++ b/doc/gui/GDMLPlugin/GDMLPlugin.rst @@ -0,0 +1,11 @@ + +.. _gdmlPlugin: + +GDML plug-in +============= + +.. toctree:: + :maxdepth: 1 + + coneFeature.rst + ellipsoidFeature.rst diff --git a/doc/gui/GDMLPlugin/coneFeature.rst b/doc/gui/GDMLPlugin/coneFeature.rst new file mode 100644 index 000000000..5041deccf --- /dev/null +++ b/doc/gui/GDMLPlugin/coneFeature.rst @@ -0,0 +1,3 @@ + +Cone +==== diff --git a/doc/gui/GDMLPlugin/ellipsoidFeature.rst b/doc/gui/GDMLPlugin/ellipsoidFeature.rst new file mode 100644 index 000000000..65ce69e85 --- /dev/null +++ b/doc/gui/GDMLPlugin/ellipsoidFeature.rst @@ -0,0 +1,3 @@ + +Ellipsoid +========= diff --git a/doc/gui/ParametersPlugin/managerFeature.rst b/doc/gui/ParametersPlugin/managerFeature.rst new file mode 100644 index 000000000..1659abb1e --- /dev/null +++ b/doc/gui/ParametersPlugin/managerFeature.rst @@ -0,0 +1,3 @@ + +Parameters manager +================== diff --git a/doc/gui/ParametersPlugin/parameterFeature.rst b/doc/gui/ParametersPlugin/parameterFeature.rst new file mode 100644 index 000000000..f0c4785c1 --- /dev/null +++ b/doc/gui/ParametersPlugin/parameterFeature.rst @@ -0,0 +1,3 @@ + +Create parameter +================ diff --git a/doc/gui/ParametersPlugin/parametersPlugin.rst b/doc/gui/ParametersPlugin/parametersPlugin.rst new file mode 100644 index 000000000..fdbc76753 --- /dev/null +++ b/doc/gui/ParametersPlugin/parametersPlugin.rst @@ -0,0 +1,11 @@ + +.. _parametersPlugin: + +Parameters plug-in +================== + +.. toctree:: + :maxdepth: 1 + + managerFeature.rst + parameterFeature.rst diff --git a/doc/gui/PartPlugin/partPlugin.rst b/doc/gui/PartPlugin/partPlugin.rst new file mode 100644 index 000000000..9dfd89688 --- /dev/null +++ b/doc/gui/PartPlugin/partPlugin.rst @@ -0,0 +1,5 @@ + +.. _partPlugin: + +Part plug-in +============= diff --git a/doc/gui/PrimitivesPlugin/boxFeature.rst b/doc/gui/PrimitivesPlugin/boxFeature.rst new file mode 100644 index 000000000..d724515d4 --- /dev/null +++ b/doc/gui/PrimitivesPlugin/boxFeature.rst @@ -0,0 +1,3 @@ + +Box +=== diff --git a/doc/gui/PrimitivesPlugin/coneFeature.rst b/doc/gui/PrimitivesPlugin/coneFeature.rst new file mode 100644 index 000000000..5041deccf --- /dev/null +++ b/doc/gui/PrimitivesPlugin/coneFeature.rst @@ -0,0 +1,3 @@ + +Cone +==== diff --git a/doc/gui/PrimitivesPlugin/cylinderFeature.rst b/doc/gui/PrimitivesPlugin/cylinderFeature.rst new file mode 100644 index 000000000..4cbee32d7 --- /dev/null +++ b/doc/gui/PrimitivesPlugin/cylinderFeature.rst @@ -0,0 +1,3 @@ + +Cylinder +======== diff --git a/doc/gui/PrimitivesPlugin/primitivesPlugin.rst b/doc/gui/PrimitivesPlugin/primitivesPlugin.rst new file mode 100644 index 000000000..0ca82059d --- /dev/null +++ b/doc/gui/PrimitivesPlugin/primitivesPlugin.rst @@ -0,0 +1,14 @@ + +.. _primitivesPlugin: + +Primitives plug-in +================== + +.. toctree:: + :maxdepth: 1 + + boxFeature.rst + coneFeature.rst + cylinderFeature.rst + sphereFeature.rst + torusFeature.rst diff --git a/doc/gui/PrimitivesPlugin/sphereFeature.rst b/doc/gui/PrimitivesPlugin/sphereFeature.rst new file mode 100644 index 000000000..4de1f90be --- /dev/null +++ b/doc/gui/PrimitivesPlugin/sphereFeature.rst @@ -0,0 +1,3 @@ + +Sphere +====== diff --git a/doc/gui/PrimitivesPlugin/torusFeature.rst b/doc/gui/PrimitivesPlugin/torusFeature.rst new file mode 100644 index 000000000..c4cfca39e --- /dev/null +++ b/doc/gui/PrimitivesPlugin/torusFeature.rst @@ -0,0 +1,3 @@ + +Torus +===== diff --git a/doc/gui/SketchPlugin/rectangleFeature.rst b/doc/gui/SketchPlugin/rectangleFeature.rst new file mode 100644 index 000000000..c2afc1802 --- /dev/null +++ b/doc/gui/SketchPlugin/rectangleFeature.rst @@ -0,0 +1,10 @@ + +Rectangle +========= + + +.. image:: images/Rectangle.png + :align: center + +.. centered:: + Create a rectangle diff --git a/doc/gui/index.rst b/doc/gui/index.rst index cfa25b6a0..d06a00f83 100644 --- a/doc/gui/index.rst +++ b/doc/gui/index.rst @@ -12,6 +12,14 @@ Welcome to SHAPER's documentation! FeaturesPlugin/featuresPlugin.rst SketchPlugin/sketchPlugin.rst + BuildPlugin/buildPlugin.rst + CollectionPlugin/collectionPlugin.rst + ConstructionPlugin/constructionPlugin.rst + ExchangePlugin/exchangePlugin.rst + GDMLPlugin/GDMLPlugin.rst + ParametersPlugin/parametersPlugin.rst + PartPlugin/partPlugin.rst + PrimitivesPlugin/primitivesPlugin.rst Indices and tables ================== diff --git a/src/BuildPlugin/plugin-Build.xml b/src/BuildPlugin/plugin-Build.xml index fe7a05ea2..e54004fcd 100644 --- a/src/BuildPlugin/plugin-Build.xml +++ b/src/BuildPlugin/plugin-Build.xml @@ -22,44 +22,56 @@ email : webmaster.salome@opencascade.com - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/src/CollectionPlugin/plugin-Collection.xml b/src/CollectionPlugin/plugin-Collection.xml index ecedd11c4..fcab1b940 100644 --- a/src/CollectionPlugin/plugin-Collection.xml +++ b/src/CollectionPlugin/plugin-Collection.xml @@ -26,14 +26,16 @@ email : webmaster.salome@opencascade.com + apply_continue="true" + helpfile="CollectionPlugin/groupFeature.html"> + icon="icons/Collection/field.png" + helpfile="CollectionPlugin/fieldFeature.html"> diff --git a/src/ConstructionPlugin/plugin-Construction.xml b/src/ConstructionPlugin/plugin-Construction.xml index 247511b6d..023015bca 100644 --- a/src/ConstructionPlugin/plugin-Construction.xml +++ b/src/ConstructionPlugin/plugin-Construction.xml @@ -26,21 +26,24 @@ email : webmaster.salome@opencascade.com + icon="icons/Construction/point.png" + helpfile="ConstructionPlugin/pointFeature.html"> + icon="icons/Construction/axis.png" + helpfile="ConstructionPlugin/axisFeature.html"> + icon="icons/Construction/plane.png" + helpfile="ConstructionPlugin/planeFeature.html"> diff --git a/src/ExchangePlugin/plugin-Exchange.xml b/src/ExchangePlugin/plugin-Exchange.xml index 8a6e8f5c4..30e7f7d45 100755 --- a/src/ExchangePlugin/plugin-Exchange.xml +++ b/src/ExchangePlugin/plugin-Exchange.xml @@ -22,15 +22,18 @@ email : webmaster.salome@opencascade.com - + - + - + - + - + diff --git a/src/ParametersPlugin/plugin-Parameters.xml b/src/ParametersPlugin/plugin-Parameters.xml index e30a9b231..f5aff33e0 100644 --- a/src/ParametersPlugin/plugin-Parameters.xml +++ b/src/ParametersPlugin/plugin-Parameters.xml @@ -22,7 +22,8 @@ email : webmaster.salome@opencascade.com - + @@ -32,7 +33,8 @@ email : webmaster.salome@opencascade.com - + diff --git a/src/PrimitivesPlugin/plugin-Primitives.xml b/src/PrimitivesPlugin/plugin-Primitives.xml index ab969f15d..a4e85ce55 100644 --- a/src/PrimitivesPlugin/plugin-Primitives.xml +++ b/src/PrimitivesPlugin/plugin-Primitives.xml @@ -22,27 +22,32 @@ email : webmaster.salome@opencascade.com - + - + - + - + - + diff --git a/src/PythonAddons/macros/rectangle/widget.xml b/src/PythonAddons/macros/rectangle/widget.xml index e34e38673..5b36b6d0c 100644 --- a/src/PythonAddons/macros/rectangle/widget.xml +++ b/src/PythonAddons/macros/rectangle/widget.xml @@ -28,7 +28,8 @@ email : webmaster.salome@opencascade.com + icon="icons/Addons/rectangle.png" + helpfile="SketchPlugin/rectangleFeature.html">