]> SALOME platform Git repositories - modules/smesh.git/commitdiff
Salome HOME
Accès à la documentation de référence de MeshGems
authorGérald NICOLAS <gerald.nicolas@edf.fr>
Tue, 15 Sep 2020 16:00:26 +0000 (18:00 +0200)
committerGérald NICOLAS <gerald.nicolas@edf.fr>
Tue, 15 Sep 2020 16:00:26 +0000 (18:00 +0200)
doc/salome/gui/SMESH/input/tools.rst
resources/SalomeApp.xml.in
src/Tools/MGCleanerPlug/doc/files/mg-cleaner_user_manual.pdf [deleted file]
src/Tools/MGCleanerPlug/doc/index.rst
src/Tools/YamsPlug/doc/Advanced_params.rst
src/Tools/YamsPlug/doc/files/mg-surfopt_user_manual.pdf [deleted file]
src/Tools/YamsPlug/doc/index.rst

index aa99d0deb5f5564f5cf96045306d7fbd156ef75f..f9b53c046637d2a1e88365b707e2347703d23cda 100644 (file)
@@ -4,14 +4,14 @@
 Plugins
 *******
 
-The following plugins are accessible via **Mesh > SMESH pligins** menu:
+The following plugins are accessible via **Mesh > SMESH plugins** menu:
 
-* `SpherePadder plugin <padder/padder_userguide_page.html>`_ 
+* `SpherePadder plugin <padder/padder_userguide_page.html>`_
 * `MGSurfOpt plugin <yams/index.html>`_
 * `MGCleaner plugin <MGCleaner/index.html>`_
 * `Z-cracks plugin <zcracks/index.html>`_
 * `MacMesh plugin <MacMesh/index.html>`_
-* `blocFissure plugin <blocFissure/index.html>`_ 
+* `blocFissure plugin <blocFissure/index.html>`_
 * **MeshCut plugin** - allows to cut a mesh constituted of linear tetrahedrons by a plane.
 * **Get min or max value of control** - a sample plugin whose sources are located in *${GUI_ROOT_DIR}/share/salome/plugins/gui/demo* directory (files *minmax_plugin.py, minmax_ui.py and smesh_plugins.py*). You can find a detailed description of how to create your own plugin in documentation: **Help > User's Guide > GUI module > How-To's and Best Practices > Extend SALOME gui functions using python plugins**.
 
index 4af56219a913e9b9c8307ba0a26f7ffee0aeed48..392bdc2916173f203cc894e140bca55f4b8484b5 100644 (file)
   <section name="smesh_help" >
     <parameter name="User's Guide/Mesh module/User's Guide"      value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/index.html;;http://docs.salome-platform.org/latest/gui/SMESH/index.html"/>
     <parameter name="Developer's Guide/Mesh module/Developer's Guide" value="%SMESH_ROOT_DIR%/share/doc/salome/tui/SMESH/index.html;;http://docs.salome-platform.org/latest/tui/SMESH/index.html"/>
-    <parameter name="User's Guide/Mesh module/Plug-ins/MGSurfOpt plugin" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/yams/index.html;;http://docs.salome-platform.org/latest/gui/SMESH/yams/index.html"/>
-    <parameter name="User's Guide/Mesh module/Plug-ins/MGCleaner plugin" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/MGCleaner/index.html;;http://docs.salome-platform.org/latest/gui/SMESH/MGCleaner/index.html"/>
     <parameter name="User's Guide/Mesh module/Plug-ins/Z-cracks plugin" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/zcracks/index.html"/>
     <parameter name="User's Guide/Mesh module/Plug-ins/MacMesh plugin" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/MacMesh/index.html;;http://docs.salome-platform.org/latest/gui/SMESH/MacMesh/index.html"/>
     <parameter name="User's Guide/Mesh module/Plug-ins/blocFissure plugin" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/blocFissure/index.html;;http://docs.salome-platform.org/latest/gui/SMESH/blocFissure/index.html"/>
     <parameter name="User's Guide/Mesh module/Plug-ins/SpherePadder plugin" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/padder/index.html;;http://docs.salome-platform.org/latest/gui/SMESH/padder/index.html"/>
+    <parameter name="User's Guide/Mesh module/MGCleaner plugin/User's Guide" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/MGCleaner/index.html;;http://docs.salome-platform.org/latest/gui/SMESH/MGCleaner/index.html"/>
+    <parameter name="User's Guide/Mesh module/MGCleaner plugin/Reference"    value="%MESHGEMS_ROOT_DIR%/Docs/mg-cleaner_api_manual.pdf"/>
+    <parameter name="User's Guide/Mesh module/MGCleaner plugin/Manual"       value="%MESHGEMS_ROOT_DIR%/Docs/mg-cleaner_user_manual.pdf"/>
+    <parameter name="User's Guide/Mesh module/MGSurfOpt plugin/User's Guide" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/yams/index.html;;http://docs.salome-platform.org/latest/gui/SMESH/yams/index.html"/>
+    <parameter name="User's Guide/Mesh module/MGSurfOpt plugin/Reference"    value="%MESHGEMS_ROOT_DIR%/Docs/mg-surfopt_api_manual.pdf"/>
+    <parameter name="User's Guide/Mesh module/MGSurfOpt plugin/Manual"       value="%MESHGEMS_ROOT_DIR%/Docs/mg-surfopt_user_manual.pdf"/>
   </section>
   <section name="resources">
     <!-- Module resources -->
diff --git a/src/Tools/MGCleanerPlug/doc/files/mg-cleaner_user_manual.pdf b/src/Tools/MGCleanerPlug/doc/files/mg-cleaner_user_manual.pdf
deleted file mode 100644 (file)
index 2ac264e..0000000
Binary files a/src/Tools/MGCleanerPlug/doc/files/mg-cleaner_user_manual.pdf and /dev/null differ
index 032067dfadb8b79bfb07fc464009935f2ff9d616..528789920cabd522ae9c2150774946abd14ef3fd 100644 (file)
@@ -6,25 +6,22 @@ MeshGems-Cleaner plugin documentation
 =====================================
 
 This documentation covers the usage of MeshGems-Cleaner, also named MG-Cleaner or MGCleaner as plug-in in Salome that can be used within the Salome
-Mesh module for remeshing 2D Surface. 
+Mesh module for remeshing 2D Surface.
 
 MG-Cleaner plug-in uses Distene commercial software MeshGems-Cleaner, which is an **automatic surface remeshing tool**.
 This plug_in offers only the most common functionalities of the tool.
 
-.. note::
-  for a complete documentation, see :download:`MG-cleaner user manual <files/mg-cleaner_user_manual.pdf>`.
-
 Contents:
 
 .. toctree::
    :maxdepth: 2
-  
+
    lct.rst
    Mandatory_params.rst
    Advanced_params.rst
    Generics_params.rst
    editHypo.rst
-   
-   
+
+
 
 
index c2af74a552e7ecbe929e5fe7dc7d79924a96377d..269b32b665c646f3e49dfd7d3d1945d536ffe84d 100644 (file)
@@ -2,8 +2,7 @@ Advanced Remeshing Options
 ==========================
 
 .. note::
-  Be aware that no control of coherency is done when you set these parameters : for instance, geometrical approximation is only allowed when SurfOpt computes a mesh for finite elements but the GUI will let you choose geometrical approximation and compute a visualisation mesh. See Distene's documentation for more details : 
-  :download:`MeshGems-SurfOpt: The automatic surface remeshing tool of the MeshGems Suite <files/mg-surfopt_user_manual.pdf>`.
+  Be aware that no control of coherency is done when you set these parameters : for instance, geometrical approximation is only allowed when SurfOpt computes a mesh for finite elements but the GUI will let you choose geometrical approximation and compute a visualisation mesh. See Distene's documentation for more details.
 
 
 - **Ridge detection**
@@ -30,7 +29,7 @@ This parameter P enables the user to specify the maximal chordal deviation  E re
 
 - **Maximal/Minimal size around vertices**
 
-  These two parameters allow the user to prescribe a Maximal/Minimal size for the mesh elements, ie the lengths of the edges. 
+  These two parameters allow the user to prescribe a Maximal/Minimal size for the mesh elements, ie the lengths of the edges.
 
 - **Mesh gradation**
 
diff --git a/src/Tools/YamsPlug/doc/files/mg-surfopt_user_manual.pdf b/src/Tools/YamsPlug/doc/files/mg-surfopt_user_manual.pdf
deleted file mode 100644 (file)
index b85b199..0000000
Binary files a/src/Tools/YamsPlug/doc/files/mg-surfopt_user_manual.pdf and /dev/null differ
index 16533bcbab7b453ec4787813710951544bb2e5d6..efa50891487da38346f63559fc19b1d8088ca01a 100644 (file)
@@ -6,25 +6,22 @@ MeshGems-SurfOpt plugin documentation
 =====================================
 
 This documentation covers the usage of MeshGems-SurfOpt as plug-in in Salome that can be used within the Salome
-Mesh module for remeshing 2D Surface. 
+Mesh module for remeshing 2D Surface.
 
 MeshGems-SurfOpt plug-in uses Distene commercial software MeshGems-SurfOpt, which is an **automatic surface remeshing tool**.
 This plug-in offers only the most common functionalities of the tool.
 
-.. note::
-  for a complete documentation, see :download:`MeshGems-SurfOpt: The automatic surface remeshing tool of the MeshGems Suite <files/mg-surfopt_user_manual.pdf>`.
-
 Contents:
 
 .. toctree::
    :maxdepth: 2
-  
+
    lct.rst
    Mandatory_params.rst
    Advanced_params.rst
    Generics_params.rst
    editHypo.rst
-   
-   
+
+