From 287b2ac10eee586fb10a950958023b05aa008407 Mon Sep 17 00:00:00 2001 From: eap Date: Mon, 20 Jun 2016 17:14:20 +0300 Subject: [PATCH] Move "SpherePadding plugin user's guide" to a dedicated sub-page and add it to Help sub-menu --- doc/salome/gui/SMESH/CMakeLists.txt | 2 +- doc/salome/gui/SMESH/doxyfile.in | 4 ++-- doc/salome/gui/SMESH/input/about_meshes.doc | 12 ++++++------ doc/salome/gui/SMESH/input/index.doc | 8 +++++--- doc/salome/gui/SMESH/input/smeshpy_interface.doc | 2 +- doc/salome/gui/SMESH/input/tools.doc | 16 ++++++++++++++++ resources/SalomeApp.xml.in | 1 + src/Tools/padder/doc/CMakeLists.txt | 2 +- 8 files changed, 33 insertions(+), 14 deletions(-) create mode 100644 doc/salome/gui/SMESH/input/tools.doc diff --git a/doc/salome/gui/SMESH/CMakeLists.txt b/doc/salome/gui/SMESH/CMakeLists.txt index 1dfd05b52..2060a5b09 100644 --- 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} ) -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) diff --git a/doc/salome/gui/SMESH/doxyfile.in b/doc/salome/gui/SMESH/doxyfile.in index 6374b61b9..164ad9220 100755 --- a/doc/salome/gui/SMESH/doxyfile.in +++ b/doc/salome/gui/SMESH/doxyfile.in @@ -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 #--------------------------------------------------------------------------- diff --git a/doc/salome/gui/SMESH/input/about_meshes.doc b/doc/salome/gui/SMESH/input/about_meshes.doc index 1490bce12..003258f37 100644 --- 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 - "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.
  • 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.
    • -
  • 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 +
  • 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.
  • 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 9ecb7c5f0..9bcdd7907 100644 --- 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"; - - 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);
  • \ref importing_exporting_meshes_page "importing and exporting meshes" in various formats;
    • @@ -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" */ diff --git a/doc/salome/gui/SMESH/input/smeshpy_interface.doc b/doc/salome/gui/SMESH/input/smeshpy_interface.doc index bbb287f2f..1dc47c407 100644 --- 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 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 index 000000000..041a07385 --- /dev/null +++ b/doc/salome/gui/SMESH/input/tools.doc @@ -0,0 +1,16 @@ +/*! + +\page tools_page Plugins + +The following plugins are accessible via Mesh > SMESH pligins menu: + +- SpherePadder plugin +- MGSurfOpt plugin +- MGCleaner plugin +- Z-cracks plugin +- MacMesh plugin +- blocFissure plugin +- 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 > GUI module > User's Guide > How-To's and Best Practices > Extend SALOME gui functions using python plugins. + +*/ diff --git a/resources/SalomeApp.xml.in b/resources/SalomeApp.xml.in index 4020eecc7..5aeebc349 100644 --- a/resources/SalomeApp.xml.in +++ b/resources/SalomeApp.xml.in @@ -123,6 +123,7 @@ +
    diff --git a/src/Tools/padder/doc/CMakeLists.txt b/src/Tools/padder/doc/CMakeLists.txt index 354da710f..bd0c443f3 100755 --- 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_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) -- 2.30.2