Move "SpherePadding plugin user's guide" to a dedicated sub-page and add it to Help...

diff --git a/doc/salome/gui/SMESH/CMakeLists.txt b/doc/salome/gui/SMESH/CMakeLists.txt
index 1dfd05b52de9570cbcef0f20dcb755c74d1b5da3..2060a5b09344f003a52d196e3ec34999cffe1151 100644 (file)
--- a/doc/salome/gui/SMESH/CMakeLists.txt
+++ b/doc/salome/gui/SMESH/CMakeLists.txt
@@ -48,7 +48,7 @@ ADD_CUSTOM_TARGET(usr_docs ${CMAKE_COMMAND} -E make_directory tmp1
   WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
 )
 
   WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
 )
 

-ADD_DEPENDENCIES(usr_docs html_docs)
+#ADD_DEPENDENCIES(usr_docs html_docs)

 
 INSTALL(CODE "EXECUTE_PROCESS(COMMAND \"${CMAKE_COMMAND}\" --build ${PROJECT_BINARY_DIR} --target usr_docs)")
 INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/SMESH DESTINATION ${SALOME_INSTALL_DOC}/gui)
 
 INSTALL(CODE "EXECUTE_PROCESS(COMMAND \"${CMAKE_COMMAND}\" --build ${PROJECT_BINARY_DIR} --target usr_docs)")
 INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/SMESH DESTINATION ${SALOME_INSTALL_DOC}/gui)

diff --git a/doc/salome/gui/SMESH/doxyfile.in b/doc/salome/gui/SMESH/doxyfile.in
index 6374b61b94e1f3e93e19e7f8678e73d4e7ca53e2..164ad922093500e386e7853652c3e709d4624132 100755 (executable)
--- a/doc/salome/gui/SMESH/doxyfile.in
+++ b/doc/salome/gui/SMESH/doxyfile.in
@@ -38,10 +38,10 @@ WARNINGS          = YES
 #---------------------------------------------------------------------------
 #Input related options
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 #Input related options
 #---------------------------------------------------------------------------

-INPUT             = @CMAKE_CURRENT_SOURCE_DIR@/input @CMAKE_SOURCE_DIR@/src/Tools/padder/doc/input $(GEOM_ROOT_DIR)/share/doc/salome/gui/GEOM/input
+INPUT             = @CMAKE_CURRENT_SOURCE_DIR@/input $(GEOM_ROOT_DIR)/share/doc/salome/gui/GEOM/input

 FILE_PATTERNS     = *.doc
 EXCLUDE           = 
 FILE_PATTERNS     = *.doc
 EXCLUDE           = 

-IMAGE_PATH        = $(GEOM_ROOT_DIR)/share/doc/salome/gui/GEOM @CMAKE_SOURCE_DIR@/src/Tools/padder/doc/images @CMAKE_CURRENT_SOURCE_DIR@/images
+IMAGE_PATH        = $(GEOM_ROOT_DIR)/share/doc/salome/gui/GEOM @CMAKE_CURRENT_SOURCE_DIR@/images

 EXAMPLE_PATH      = @CMAKE_SOURCE_DIR@/doc/salome/examples @CMAKE_SOURCE_DIR@/src/SMESH_SWIG
 
 #---------------------------------------------------------------------------
 EXAMPLE_PATH      = @CMAKE_SOURCE_DIR@/doc/salome/examples @CMAKE_SOURCE_DIR@/src/SMESH_SWIG
 
 #---------------------------------------------------------------------------

diff --git a/doc/salome/gui/SMESH/input/about_meshes.doc b/doc/salome/gui/SMESH/input/about_meshes.doc
index 1490bce1261fc019a4e6aa63434e263210f456b0..003258f37884bc84659434e6861c836b47ebfa8c 100644 (file)
--- a/doc/salome/gui/SMESH/input/about_meshes.doc
+++ b/doc/salome/gui/SMESH/input/about_meshes.doc
@@ -37,17 +37,17 @@ Mesh module provides several ways to create the mesh:
     operations, especially \ref extrusion_page "extrusion" and \ref
     revolution_page "revolution". To create an empty mesh not based on a
     geometry, use the same dialog as to \ref constructing_meshes_page
     operations, especially \ref extrusion_page "extrusion" and \ref
     revolution_page "revolution". To create an empty mesh not based on a
     geometry, use the same dialog as to \ref constructing_meshes_page

-    "construct the mesh on geometry" but do not specify a geometry
-    or a meshing algorithm.
+    "construct the mesh on geometry" but specify neither the geometry
+    nor meshing algorithms.

   </li>
   <li>The mesh can be \subpage importing_exporting_meshes_page "imported" from
     (and exported to) the file in MED, UNV, STL, CGNS, DAT, GMF and
     SAUVE formats.
   </li>
   </li>
   <li>The mesh can be \subpage importing_exporting_meshes_page "imported" from
     (and exported to) the file in MED, UNV, STL, CGNS, DAT, GMF and
     SAUVE formats.
   </li>

-  <li>The 3D mesh can be generated from the 2D mesh, which was \ref
-    importing_exporting_meshes_page "imported" or manually created. To
-    setup the meshing parameters of a mesh not based on a geometry, just
-    invoke \ref editing_meshes_page "Edit mesh / sub-mesh" command on
+  <li>The 3D mesh can be generated from the 2D mesh not based on the geometry,
+    which was either \ref importing_exporting_meshes_page "imported" or created in
+    other way. To setup the meshing parameters of a mesh not based on a geometry,
+    just invoke \ref editing_meshes_page "Edit mesh / sub-mesh" command on

     your 2D mesh.
   </li>
   <li>Several meshes can be \subpage building_compounds_page "combined"
     your 2D mesh.
   </li>
   <li>Several meshes can be \subpage building_compounds_page "combined"

diff --git a/doc/salome/gui/SMESH/input/index.doc b/doc/salome/gui/SMESH/input/index.doc
index 9ecb7c5f0886ac597c3170cd42dda4be700b74e2..9bcdd79078048f82a7bb368efe6eaa2013662c13 100644 (file)
--- a/doc/salome/gui/SMESH/input/index.doc
+++ b/doc/salome/gui/SMESH/input/index.doc
@@ -12,9 +12,8 @@
  - bottom-up, using \ref modifying_meshes_page "mesh edition"
    operations, especially \ref extrusion_page "extrusion" and \ref
    revolution_page "revolution";
  - bottom-up, using \ref modifying_meshes_page "mesh edition"
    operations, especially \ref extrusion_page "extrusion" and \ref
    revolution_page "revolution";

- - by generation of the 3D mesh from the 2D mesh (the latter can be
-  either \ref importing_exporting_meshes_page "imported" or manually
-  created); 
+ - by generation of the 3D mesh from the 2D mesh not based on the geometry
+  (\ref importing_exporting_meshes_page "imported" for example); 

  </li>
 <li>\ref importing_exporting_meshes_page "importing and exporting meshes" 
   in various formats;</li>
  </li>
 <li>\ref importing_exporting_meshes_page "importing and exporting meshes" 
   in various formats;</li>


@@ -45,6 +44,9 @@ section of SALOME Mesh Help.
 Almost all mesh module functionalities are accessible via
 \subpage smeshpy_interface_page "Mesh module Python interface".
 
 Almost all mesh module functionalities are accessible via
 \subpage smeshpy_interface_page "Mesh module Python interface".
 

+There is a set of \subpage tools_page "tools" plugged-in the module to extend
+the basic functionality listed above.
+

 \image html image7.jpg "Example of MESH module usage for engineering tasks"
 
 */
 \image html image7.jpg "Example of MESH module usage for engineering tasks"
 
 */

diff --git a/doc/salome/gui/SMESH/input/smeshpy_interface.doc b/doc/salome/gui/SMESH/input/smeshpy_interface.doc
index bbb287f2fb5433a0027ed990dacd3c64757a88e7..1dc47c40700a8376a71b6627d82a119e42cafe80 100644 (file)
--- a/doc/salome/gui/SMESH/input/smeshpy_interface.doc
+++ b/doc/salome/gui/SMESH/input/smeshpy_interface.doc
@@ -13,7 +13,7 @@ in the \ref smeshBuilder and \ref StdMeshersBuilder Python packages.
 
 \n With SALOME 7.2, the Python interface for %Mesh has been slightly modified to offer new functionality.
 \n You may have to modify your scripts generated with SALOME 6 or older versions.
 
 \n With SALOME 7.2, the Python interface for %Mesh has been slightly modified to offer new functionality.
 \n You may have to modify your scripts generated with SALOME 6 or older versions.

-\n Please see \ref smesh_migration_page.
+\n Please see \subpage smesh_migration_page.

 
 Class \ref smeshBuilder.smeshBuilder "smeshBuilder" provides an interface to create and handle
 meshes. It can be used to create an empty mesh or to import mesh from the data file.
 
 Class \ref smeshBuilder.smeshBuilder "smeshBuilder" provides an interface to create and handle
 meshes. It can be used to create an empty mesh or to import mesh from the data file.

diff --git a/doc/salome/gui/SMESH/input/tools.doc b/doc/salome/gui/SMESH/input/tools.doc
new file mode 100644 (file)
index 0000000..041a073
--- /dev/null
+++ b/doc/salome/gui/SMESH/input/tools.doc
@@ -0,0 +1,16 @@
+/*!
+
+\page tools_page Plugins
+
+The following plugins are accessible via <b> Mesh > SMESH pligins </b> menu:
+
+- <a href="padder/padder_userguide_page.html"> SpherePadder plugin </a>
+- <a href="yams/index.html"                  > MGSurfOpt plugin    </a>
+- <a href="MGCleaner/index.html"             > MGCleaner plugin    </a>
+- <a href="zcracks/index.html"               > Z-cracks plugin     </a>
+- <a href="MacMesh/index.html"               > MacMesh plugin      </a>
+- <a href="blocFissure/index.html"           > blocFissure plugin  </a>
+- <b>MeshCut plugin</b> - allows to cut a mesh constituted of linear tetrahedrons by a plane.
+- <b>Get min or max value of control</b> - a sample plugin whose sources are located in <em>${GUI_ROOT_DIR}/share/salome/plugins/gui/demo</em> directory (files <em>minmax_plugin.py, minmax_ui.py and smesh_plugins.py</em>). You can find a detailed description of how to create your own plugin in documentation: <b>Help > GUI module > User's Guide > How-To's and Best Practices > Extend SALOME gui functions using python plugins</b>.
+
+*/

diff --git a/resources/SalomeApp.xml.in b/resources/SalomeApp.xml.in
index 4020eecc7630267e7ccf5489c86fef89ca502b4c..5aeebc3490e6977a2ba9dc99f1384787a6115e08 100644 (file)
--- a/resources/SalomeApp.xml.in
+++ b/resources/SalomeApp.xml.in
@@ -123,6 +123,7 @@
     <parameter name="Plug-ins/Z-cracks plugin User's Guide" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/zcracks/index.html"/>
     <parameter name="Plug-ins/MacMesh plugin" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/MacMesh/index.html"/>
     <parameter name="Plug-ins/blocFissure plugin" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/blocFissure/index.html"/>
     <parameter name="Plug-ins/Z-cracks plugin User's Guide" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/zcracks/index.html"/>
     <parameter name="Plug-ins/MacMesh plugin" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/MacMesh/index.html"/>
     <parameter name="Plug-ins/blocFissure plugin" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/blocFissure/index.html"/>

+    <parameter name="Plug-ins/SpherePadder plugin" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/padder/index.html"/>

     <parameter name="Developer's Guide" value="%SMESH_ROOT_DIR%/share/doc/salome/tui/SMESH/index.html"/>
   </section>
   <section name="resources">
     <parameter name="Developer's Guide" value="%SMESH_ROOT_DIR%/share/doc/salome/tui/SMESH/index.html"/>
   </section>
   <section name="resources">

diff --git a/src/Tools/padder/doc/CMakeLists.txt b/src/Tools/padder/doc/CMakeLists.txt
index 354da710f1457a810bf61d3b6fc4979758a77ad2..bd0c443f38e5295e650b8f1825b949f3b12660ca 100755 (executable)
--- a/src/Tools/padder/doc/CMakeLists.txt
+++ b/src/Tools/padder/doc/CMakeLists.txt
@@ -21,7 +21,7 @@ SALOME_CONFIGURE_FILE(doxyfile.in doxyfile)
 
 ADD_CUSTOM_TARGET(usr_padder_docs ${DOXYGEN_EXECUTABLE})
 
 
 ADD_CUSTOM_TARGET(usr_padder_docs ${DOXYGEN_EXECUTABLE})
 

-ADD_DEPENDENCIES(usr_padder_docs html_docs)
+#ADD_DEPENDENCIES(usr_padder_docs html_docs)

 
 INSTALL(CODE "EXECUTE_PROCESS(COMMAND \"${CMAKE_COMMAND}\" --build ${PROJECT_BINARY_DIR} --target usr_padder_docs)")
 INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/padder DESTINATION ${SALOME_INSTALL_DOC}/gui/SMESH)
 
 INSTALL(CODE "EXECUTE_PROCESS(COMMAND \"${CMAKE_COMMAND}\" --build ${PROJECT_BINARY_DIR} --target usr_padder_docs)")
 INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/padder DESTINATION ${SALOME_INSTALL_DOC}/gui/SMESH)