ForkMaster/smesh
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/smesh.git synced 2025-02-04 09:50:33 +05:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
eap 2016-06-20 17:14:20 +03:00
parent 466da2436e
commit 287b2ac10e
8 changed files with 33 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/salome/gui/SMESH/CMakeLists.txt
View 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)

4
doc/salome/gui/SMESH/doxyfile.in
View File

@ -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
#---------------------------------------------------------------------------

12
doc/salome/gui/SMESH/input/about_meshes.doc
View 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"

8
doc/salome/gui/SMESH/input/index.doc
View 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"
*/

2
doc/salome/gui/SMESH/input/smeshpy_interface.doc
View 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.

16
doc/salome/gui/SMESH/input/tools.doc Normal file
View File

@ -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>.
*/

1
resources/SalomeApp.xml.in
View File

@ -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/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">

2
src/Tools/padder/doc/CMakeLists.txt
View File

@ -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)