Salome HOME
Move "SpherePadding plugin user's guide" to a dedicated sub-page and add it to Help...
authoreap <eap@opencascade.com>
Mon, 20 Jun 2016 14:14:20 +0000 (17:14 +0300)
committereap <eap@opencascade.com>
Mon, 20 Jun 2016 14:14:20 +0000 (17:14 +0300)
doc/salome/gui/SMESH/CMakeLists.txt
doc/salome/gui/SMESH/doxyfile.in
doc/salome/gui/SMESH/input/about_meshes.doc
doc/salome/gui/SMESH/input/index.doc
doc/salome/gui/SMESH/input/smeshpy_interface.doc
doc/salome/gui/SMESH/input/tools.doc [new file with mode: 0644]
resources/SalomeApp.xml.in
src/Tools/padder/doc/CMakeLists.txt

index 1dfd05b..2060a5b 100644 (file)
@@ -48,7 +48,7 @@ ADD_CUSTOM_TARGET(usr_docs ${CMAKE_COMMAND} -E make_directory tmp1
   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)
index 6374b61..164ad92 100755 (executable)
@@ -38,10 +38,10 @@ WARNINGS          = YES
 #---------------------------------------------------------------------------
 #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           = 
-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
 
 #---------------------------------------------------------------------------
index 1490bce..003258f 100644 (file)
@@ -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
-    "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>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"
index 9ecb7c5..9bcdd79 100644 (file)
@@ -12,9 +12,8 @@
  - 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>
@@ -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".
 
+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"
 
 */
index bbb287f..1dc47c4 100644 (file)
@@ -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 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.
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
@@ -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>.
+
+*/
index 4020eec..5aeebc3 100644 (file)
     <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">
index 354da71..bd0c443 100755 (executable)
@@ -21,7 +21,7 @@ SALOME_CONFIGURE_FILE(doxyfile.in doxyfile)
 
 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)