Salome HOME
Improve tui examples way of documenting by specifying doxygen alias
authorakl <akl@opencascade.com>
Mon, 18 Feb 2013 13:09:16 +0000 (13:09 +0000)
committerakl <akl@opencascade.com>
Mon, 18 Feb 2013 13:09:16 +0000 (13:09 +0000)
16 files changed:
doc/salome/gui/SMESH/doxyfile.in
doc/salome/gui/SMESH/input/smeshpy_interface.doc
doc/salome/gui/SMESH/input/tui_cartesian_algo.doc
doc/salome/gui/SMESH/input/tui_creating_meshes.doc
doc/salome/gui/SMESH/input/tui_defining_hypotheses.doc
doc/salome/gui/SMESH/input/tui_filters.doc
doc/salome/gui/SMESH/input/tui_generate_flat_elements.doc
doc/salome/gui/SMESH/input/tui_grouping_elements.doc
doc/salome/gui/SMESH/input/tui_measurements.doc
doc/salome/gui/SMESH/input/tui_modifying_meshes.doc
doc/salome/gui/SMESH/input/tui_notebook_smesh.doc
doc/salome/gui/SMESH/input/tui_prism_3d_algo.doc
doc/salome/gui/SMESH/input/tui_quality_controls.doc
doc/salome/gui/SMESH/input/tui_transforming_meshes.doc
doc/salome/gui/SMESH/input/tui_use_existing_faces.doc
doc/salome/gui/SMESH/input/tui_viewing_meshes.doc

index a6a5fc1f1e4a46de9129e8597832b1f22b949b99..6b27a0c76d5b015389cb414a9f43a4cf5443a6bf 100755 (executable)
@@ -42,7 +42,7 @@ INPUT             = @srcdir@/input @top_srcdir@/src/Tools/padder/doc/input
 FILE_PATTERNS     = *.doc
 EXCLUDE           = 
 IMAGE_PATH        = @srcdir@/images @top_srcdir@/src/Tools/padder/doc/images
-EXAMPLE_PATH      = @top_srcdir@/src/SMESH_SWIG @top_srcdir@/doc/salome/examples
+EXAMPLE_PATH      = @top_srcdir@/doc/salome/examples @top_srcdir@/src/SMESH_SWIG
 
 #---------------------------------------------------------------------------
 #HTML related options
@@ -80,3 +80,8 @@ GENERATE_RTF      = NO
 TAGFILES          = smeshpy_doc.tag=../SMESH/smeshpy_doc #rnv: 07.04.2011 Workaround for the doxygen 1.7.3:
                                                          #because it wrongly defines location of the html files for search.                                                  
 SEARCHENGINE      = YES
+
+#---------------------------------------------------------------------------
+#Custom commands
+#---------------------------------------------------------------------------
+ALIASES += tui_script{1}="\include \1 <a href=\"../../examples/SMESH/\1\">Download this script</a>"
index 699e5c981ee9fe8046286bfafd5f5073b2316f8f..72d4585e1beac9664eaeedf4983f0ae477541eee 100644 (file)
@@ -36,8 +36,7 @@ An example below demonstrates usage of the Python API for 3d mesh generation.
 
 \anchor example_3d_mesh
 <h2>Example of 3d mesh generation:</h2>
-\include 3dmesh.py
-<a href="../../examples/SMESH/3dmesh.py">Download this script</a>
+\tui_script{3dmesh.py}
 
 Examples of Python scripts for Mesh operations are available by
 the following links:
index 4cc1ec654f4103892bc67e3a6e74df69ac39fa84..dccf68a5faf620d580987dd497ec0896490d436d 100644 (file)
@@ -1,7 +1,6 @@
 /*!
 
 \page tui_cartesian_algo Usage of Body Fitting algorithm
-\include cartesian_algo.py
-<a href="../../examples/SMESH/cartesian_algo.py">Download this script</a>
+\tui_script{cartesian_algo.py}
 
 */
index bdeeb8a7a9957243e1f5d20dc26e9853b66c9fc6..d7edad332fa10bff4daf53b00e1def2feb45e140 100644 (file)
@@ -7,52 +7,44 @@
 
 <br>
 <h2>Construction of a Mesh</h2>
-\include creating_meshes_ex01.py
-<a href="../../examples/SMESH/creating_meshes_ex01.py">Download this script</a>
+\tui_script{creating_meshes_ex01.py}
 
 <br>
 \anchor tui_construction_submesh
 <h2>Construction of a Submesh</h2>
-\include creating_meshes_ex02.py
-<a href="../../examples/SMESH/creating_meshes_ex02.py">Download this script</a>
+\tui_script{creating_meshes_ex02.py}
 
 <br>
 <h2>Change priority of submeshes in Mesh</h2>
-\include creating_meshes_ex03.py
-<a href="../../examples/SMESH/creating_meshes_ex03.py">Download this script</a>
+\tui_script{creating_meshes_ex03.py}
 
 <br>
 \anchor tui_editing_mesh
 <h2>Editing of a mesh</h2>
-\include creating_meshes_ex04.py
-<a href="../../examples/SMESH/creating_meshes_ex04.py">Download this script</a>
+\tui_script{creating_meshes_ex04.py}
 
 <br>
 \anchor tui_export_mesh
 <h2>Export of a Mesh</h2>
-\include creating_meshes_ex05.py
-<a href="../../examples/SMESH/creating_meshes_ex05.py">Download this script</a>
+\tui_script{creating_meshes_ex05.py}
 
 <br>
 <h2>How to mesh a cylinder with hexahedrons?</h2>
 Here you can see an example of python script, creating a hexahedral
 mesh on a cylinder. And a picture below the source code of the script,
 demonstrating the resulting mesh.
-\include creating_meshes_ex06.py
-<a href="../../examples/SMESH/creating_meshes_ex06.py">Download this script</a>
+\tui_script{creating_meshes_ex06.py}
 
 \image html mesh_cylinder_hexa.png
 
 <br>
 \anchor tui_building_compound
 <h2>Building a compound of meshes</h2>
-\include creating_meshes_ex07.py
-<a href="../../examples/SMESH/creating_meshes_ex07.py">Download this script</a>
+\tui_script{creating_meshes_ex07.py}
 
 <br>
 \anchor tui_copy_mesh
 <h2>Mesh Copying</h2>
-\include creating_meshes_ex08.py
-<a href="../../examples/SMESH/creating_meshes_ex08.py">Download this script</a>
+\tui_script{creating_meshes_ex08.py}
 
 */
index 3f3124db3df216755c23b75fafa5ed511dd2cfe4..71abf33b6e68bb8018930208f3c451ce270ef20b 100644 (file)
@@ -44,102 +44,84 @@ This page provides example codes of \ref tui_defining_meshing_algos
 <br>
 \anchor tui_1d_arithmetic
 <h3>Arithmetic 1D</h3>
-\include defining_hypotheses_ex01.py
-<a href="../../examples/SMESH/defining_hypotheses_ex01.py">Download this script</a>
+\tui_script{defining_hypotheses_ex01.py}
 
 <br>
 \anchor tui_deflection_1d
 <h3>Deflection 1D and Number of Segments</h3>
-\include defining_hypotheses_ex02.py
-<a href="../../examples/SMESH/defining_hypotheses_ex02.py">Download this script</a>
+\tui_script{defining_hypotheses_ex02.py}
 
 <br>
 \anchor tui_start_and_end_length
 <h3>Start and End Length</h3>
-\include defining_hypotheses_ex03.py
-<a href="../../examples/SMESH/defining_hypotheses_ex03.py">Download this script</a>
+\tui_script{defining_hypotheses_ex03.py}
 
 <br>
 \anchor tui_average_length
 <h3>Local Length</h3>
-\include defining_hypotheses_ex04.py
-<a href="../../examples/SMESH/defining_hypotheses_ex04.py">Download this script</a>
+\tui_script{defining_hypotheses_ex04.py}
 
 <br><h2>Defining 2D and 3D hypotheses</h2>
 
 <br>
 \anchor tui_max_element_area
 <h3>Maximum Element Area</h3>
-\include defining_hypotheses_ex05.py
-<a href="../../examples/SMESH/defining_hypotheses_ex05.py">Download this script</a>
+\tui_script{defining_hypotheses_ex05.py}
 
 <br>
 \anchor tui_max_element_volume
 <h3>Maximum Element Volume</h3>
-\include defining_hypotheses_ex06.py
-<a href="../../examples/SMESH/defining_hypotheses_ex06.py">Download this script</a>
+\tui_script{defining_hypotheses_ex06.py}
 
 <br>
 \anchor tui_length_from_edges
 <h3>Length from Edges</h3>
-\include defining_hypotheses_ex07.py
-<a href="../../examples/SMESH/defining_hypotheses_ex07.py">Download this script</a>
+\tui_script{defining_hypotheses_ex07.py}
 
 <br><h2>Defining Additional Hypotheses</h2>
 
 <br>
 \anchor tui_propagation
 <h3>Propagation</h3>
-\include defining_hypotheses_ex08.py
-<a href="../../examples/SMESH/defining_hypotheses_ex08.py">Download this script</a>
+\tui_script{defining_hypotheses_ex08.py}
 
 <br>
 \anchor tui_defining_meshing_algos
 <h2>Defining Meshing Algorithms</h2>
-\include defining_hypotheses_ex09.py
-<a href="../../examples/SMESH/defining_hypotheses_ex09.py">Download this script</a>
+\tui_script{defining_hypotheses_ex09.py}
 
 <br>
 \anchor tui_projection
 <h3>Projection Algorithms</h3>
-\include defining_hypotheses_ex10.py
-<a href="../../examples/SMESH/defining_hypotheses_ex10.py">Download this script</a>
+\tui_script{defining_hypotheses_ex10.py}
 
 <h3>Projection 1D2D</h3>
-\include defining_hypotheses_ex11.py
-<a href="../../examples/SMESH/defining_hypotheses_ex11.py">Download this script</a>
+\tui_script{defining_hypotheses_ex11.py}
 
 <br>
 
 \anchor tui_fixed_points
 
 <h2>1D Mesh with Fixed Points example</h2>
-\include defining_hypotheses_ex12.py
-<a href="../../examples/SMESH/defining_hypotheses_ex12.py">Download this script</a>
+\tui_script{defining_hypotheses_ex12.py}
 
 \anchor tui_radial_quadrangle
 <h2> Radial Quadrangle 1D2D example </h2>
-\include defining_hypotheses_ex13.py
-<a href="../../examples/SMESH/defining_hypotheses_ex13.py">Download this script</a>
+\tui_script{defining_hypotheses_ex13.py}
 
 \anchor tui_quadrangle_parameters
 <h2>Quadrangle Parameters example 1 (meshing a face with 3 edges) </h2>
-\include defining_hypotheses_ex14.py
-<a href="../../examples/SMESH/defining_hypotheses_ex14.py">Download this script</a>
+\tui_script{defining_hypotheses_ex14.py}
 
 <h2>Quadrangle Parameters example 2 (using different types) </h2>
-\include defining_hypotheses_ex15.py
-<a href="../../examples/SMESH/defining_hypotheses_ex15.py">Download this script</a>
+\tui_script{defining_hypotheses_ex15.py}
 
 \anchor tui_import
 <h2>"Use Existing Elements" example </h2>
-\include defining_hypotheses_ex16.py
-<a href="../../examples/SMESH/defining_hypotheses_ex16.py">Download this script</a>
+\tui_script{defining_hypotheses_ex16.py}
 
 \anchor tui_viscous_layers
 <h2>Viscous layers construction</h2>
-
-\include defining_hypotheses_ex17.py
-<a href="../../examples/SMESH/defining_hypotheses_ex17.py">Download this script</a>
+\tui_script{defining_hypotheses_ex17.py}
 
 */
index 2540f52b87f44e11d477fd814aea66e7d8317aca..eaf5d2803c54fee01d1f6a02921eb27f2362486c 100755 (executable)
@@ -27,8 +27,7 @@ Filter 2D mesh elements (faces) according to the aspect ratio value:
 - functor type should be \a smesh.FT_AspectRatio
 - threshold is floating point value (aspect ratio)
 
-\include filters_ex01.py
-<a href="../../examples/SMESH/filters_ex01.py">Download this script</a>
+\tui_script{filters_ex01.py}
 
 \sa \ref tui_aspect_ratio
 
@@ -39,8 +38,7 @@ Filter 3D mesh elements (volumes) according to the aspect ratio value:
 - functor type is \a smesh.FT_AspectRatio3D
 - threshold is floating point value (aspect ratio)
 
-\include filters_ex02.py
-<a href="../../examples/SMESH/filters_ex02.py">Download this script</a>
+\tui_script{filters_ex02.py}
 
 \sa \ref tui_aspect_ratio_3d
 
@@ -51,8 +49,7 @@ Filter 2D mesh elements (faces) according to the warping angle value:
 - functor type is \a smesh.FT_Warping
 - threshold is floating point value (warping angle)
 
-\include filters_ex03.py
-<a href="../../examples/SMESH/filters_ex03.py">Download this script</a>
+\tui_script{filters_ex03.py}
 
 \sa \ref tui_warping
 
@@ -63,8 +60,7 @@ Filter 2D mesh elements (faces) according to the minimum angle value:
 - functor type is \a smesh.FT_MinimumAngle
 - threshold is floating point value (minimum angle)
 
-\include filters_ex04.py
-<a href="../../examples/SMESH/filters_ex04.py">Download this script</a>
+\tui_script{filters_ex04.py}
 
 \sa \ref tui_minimum_angle
 
@@ -75,8 +71,7 @@ Filter 2D mesh elements (faces) according to the taper value:
 - functor type is \a smesh.FT_Taper
 - threshold is floating point value (taper)
 
-\include filters_ex05.py
-<a href="../../examples/SMESH/filters_ex05.py">Download this script</a>
+\tui_script{filters_ex05.py}
 
 \sa \ref tui_taper
 
@@ -87,8 +82,7 @@ Filter 2D mesh elements (faces) according to the skew value:
 - functor type is \a smesh.FT_Skew
 - threshold is floating point value (skew)
 
-\include filters_ex06.py
-<a href="../../examples/SMESH/filters_ex06.py">Download this script</a>
+\tui_script{filters_ex06.py}
 
 \sa \ref tui_skew
 
@@ -99,8 +93,7 @@ Filter 2D mesh elements (faces) according to the area value:
 - functor type is \a smesh.FT_Area
 - threshold is floating point value (area)
 
-\include filters_ex07.py
-<a href="../../examples/SMESH/filters_ex07.py">Download this script</a>
+\tui_script{filters_ex07.py}
 
 \sa \ref tui_area
 
@@ -111,8 +104,7 @@ Filter 3D mesh elements (volumes) according to the volume value:
 - functor type is \a smesh.FT_Volume3D
 - threshold is floating point value (volume)
 
-\include filters_ex08.py
-<a href="../../examples/SMESH/filters_ex08.py">Download this script</a>
+\tui_script{filters_ex08.py}
 
 \sa \ref tui_volume
 
@@ -123,8 +115,7 @@ Filter 1D mesh elements (edges) which represent free borders of a mesh:
 - functor type is \a smesh.FT_FreeBorders
 - threshold value is not required
 
-\include filters_ex09.py
-<a href="../../examples/SMESH/filters_ex09.py">Download this script</a>
+\tui_script{filters_ex09.py}
 
 \sa \ref tui_free_borders
 
@@ -136,8 +127,7 @@ element of mesh only:
 - functor type is \a smesh.FT_FreeEdges
 - threshold value is not required
 
-\include filters_ex10.py
-<a href="../../examples/SMESH/filters_ex10.py">Download this script</a>
+\tui_script{filters_ex10.py}
 
 \sa \ref tui_free_edges
 
@@ -148,8 +138,7 @@ Filter free nodes:
 - functor type is \a smesh.FT_FreeNodes
 - threshold value is not required
 
-\include filters_ex11.py
-<a href="../../examples/SMESH/filters_ex11.py">Download this script</a>
+\tui_script{filters_ex11.py}
 
 \sa \ref tui_free_nodes
 
@@ -160,8 +149,7 @@ Filter free faces:
 - functor type is \a smesh.FT_FreeFaces
 - threshold value is not required
 
-\include filters_ex12.py
-<a href="../../examples/SMESH/filters_ex12.py">Download this script</a>
+\tui_script{filters_ex12.py}
 
 \sa \ref tui_free_faces
 
@@ -172,8 +160,7 @@ Filter faces with bare borders:
 - functor type is \a smesh.FT_BareBorderFace
 - threshold value is not required
 
-\include filters_ex13.py
-<a href="../../examples/SMESH/filters_ex13.py">Download this script</a>
+\tui_script{filters_ex13.py}
 
 \sa \ref tui_bare_border_faces
 
@@ -185,8 +172,7 @@ Filter faces with bare borders:
 - threshold value is the face ID
 - tolerance is in degrees
 
-\include filters_ex14.py
-<a href="../../examples/SMESH/filters_ex14.py">Download this script</a>
+\tui_script{filters_ex14.py}
 
 \section filter_over_constrained_faces Over-constrained faces
 
@@ -195,8 +181,7 @@ Filter over-constrained faces:
 - functor type is \a smesh.FT_OverConstrainedFace
 - threshold value is not required
 
-\include filters_ex15.py
-<a href="../../examples/SMESH/filters_ex15.py">Download this script</a>
+\tui_script{filters_ex15.py}
 
 \sa \ref tui_over_constrained_faces
 
@@ -208,8 +193,7 @@ filter mesh elements basing on the same set of nodes:
           smesh.FT_EqualFaces or \a smesh.FT_EqualVolumes, 
 - threshold value is not required
 
-\include filters_ex16.py
-<a href="../../examples/SMESH/filters_ex16.py">Download this script</a>
+\tui_script{filters_ex16.py}
 
 
 \section tui_double_nodes_control Double nodes
@@ -220,8 +204,7 @@ filters mesh nodes which are coincident with other nodes (within a given toleran
 - threshold value is not required
 - default tolerance is 1.0e-7
 
-\include filters_ex17.py
-<a href="../../examples/SMESH/filters_ex17.py">Download this script</a>
+\tui_script{filters_ex17.py}
 
 
 \section filter_borders_multiconnection Borders at multi-connection
@@ -232,8 +215,7 @@ connections (faces belonging the border edges)
 - functor type is \a smesh.FT_MultiConnection
 - threshold is integer value (number of connections)
 
-\include filters_ex18.py
-<a href="../../examples/SMESH/filters_ex18.py">Download this script</a>
+\tui_script{filters_ex18.py}
 
 \sa \ref tui_borders_at_multiconnection
 
@@ -245,8 +227,7 @@ to the specified number of mesh elements
 - functor type is \a smesh.FT_MultiConnection2D
 - threshold is integer value (number of connections)
 
-\include filters_ex19.py
-<a href="../../examples/SMESH/filters_ex19.py">Download this script</a>
+\tui_script{filters_ex19.py}
 
 \sa \ref tui_borders_at_multiconnection_2d
 
@@ -257,8 +238,7 @@ Filter 1D mesh elements (edges) according to the edge length value:
 - functor type should be \a smesh.FT_Length
 - threshold is floating point value (length)
 
-\include filters_ex20.py
-<a href="../../examples/SMESH/filters_ex20.py">Download this script</a>
+\tui_script{filters_ex20.py}
 
 \sa \ref tui_length_1d
 
@@ -270,8 +250,7 @@ value of its edges:
 - functor type should be \a smesh.FT_Length2D
 - threshold is floating point value (edge length)
 
-\include filters_ex21.py
-<a href="../../examples/SMESH/filters_ex21.py">Download this script</a>
+\tui_script{filters_ex21.py}
 
 \sa \ref tui_length_2d
 
@@ -283,8 +262,7 @@ value of its edges and diagonals:
 - functor type should be \a smesh.FT_MaxElementLength2D
 - threshold is floating point value (edge/diagonal length)
 
-\include filters_ex22.py
-<a href="../../examples/SMESH/filters_ex22.py">Download this script</a>
+\tui_script{filters_ex22.py}
 
 \sa \ref tui_max_element_length_2d
 
@@ -296,8 +274,7 @@ value of its edges and diagonals:
 - functor type should be \a smesh.FT_MaxElementLength3D
 - threshold is floating point value (edge/diagonal length)
 
-\include filters_ex23.py
-<a href="../../examples/SMESH/filters_ex23.py">Download this script</a>
+\tui_script{filters_ex23.py}
 
 \sa \ref tui_max_element_length_3d
 
@@ -308,8 +285,7 @@ Filter 3D mesh elements with bare borders:
 - functor type is \a smesh.FT_BareBorderVolume
 - threshold value is not required
 
-\include filters_ex24.py
-<a href="../../examples/SMESH/filters_ex24.py">Download this script</a>
+\tui_script{filters_ex24.py}
 
 \sa \ref tui_bare_border_volumes
 
@@ -320,8 +296,7 @@ Filter over-constrained volumes:
 - functor type is \a smesh.FT_OverConstrainedVolume
 - threshold value is not required
 
-\include filters_ex25.py
-<a href="../../examples/SMESH/filters_ex25.py">Download this script</a>
+\tui_script{filters_ex25.py}
 
 \sa \ref tui_over_constrained_faces
 
@@ -333,8 +308,7 @@ shape defined by threshold value:
 - functor type should be \a smesh.FT_BelongToGeom
 - threshold is geometrical object
 
-\include filters_ex26.py
-<a href="../../examples/SMESH/filters_ex26.py">Download this script</a>
+\tui_script{filters_ex26.py}
 
 \section filter_lying_on_geom Lying on Geom
 
@@ -344,8 +318,7 @@ shape defined by threshold value:
 - functor type should be \a smesh.FT_LyingOnGeom
 - threshold is geometrical object
 
-\include filters_ex27.py
-<a href="../../examples/SMESH/filters_ex27.py">Download this script</a>
+\tui_script{filters_ex27.py}
 
 \section filter_belong_to_plane Belong to Plane
 
@@ -356,8 +329,7 @@ plane defined by threshold value with the given tolerance:
 - threshold is geometrical object (plane)
 - default tolerance is 1.0e-7
 
-\include filters_ex28.py
-<a href="../../examples/SMESH/filters_ex28.py">Download this script</a>
+\tui_script{filters_ex28.py}
 
 \section filter_belong_to_cylinder Belong to Cylinder
 
@@ -368,8 +340,7 @@ cylindrical face defined by threshold value with the given tolerance:
 - threshold is geometrical object (cylindrical face)
 - default tolerance is 1.0e-7
 
-\include filters_ex29.py
-<a href="../../examples/SMESH/filters_ex29.py">Download this script</a>
+\tui_script{filters_ex29.py}
 
 \section filter_belong_to_surface Belong to Surface
 
@@ -380,8 +351,7 @@ arbitrary surface defined by threshold value with the given tolerance:
 - threshold is geometrical object (arbitrary surface)
 - default tolerance is 1.0e-7
 
-\include filters_ex30.py
-<a href="../../examples/SMESH/filters_ex30.py">Download this script</a>
+\tui_script{filters_ex30.py}
 
 \section filter_range_of_ids Range of IDs
 
@@ -391,8 +361,7 @@ specified identifiers range:
 - functor type is \a smesh.FT_RangeOfIds
 - threshold is string listing required IDs and/or ranges of IDs, e.g."1,2,3,50-60,63,67,70-78" 
 
-\include filters_ex31.py
-<a href="../../examples/SMESH/filters_ex31.py">Download this script</a>
+\tui_script{filters_ex31.py}
 
 \section filter_bad_oriented_volume Badly oriented volume
 
@@ -402,8 +371,7 @@ the point of view of MED convention.
 - functor type is \a smesh.FT_BadOrientedVolume
 - threshold is not required
 
-\include filters_ex32.py
-<a href="../../examples/SMESH/filters_ex32.py">Download this script</a>
+\tui_script{filters_ex32.py}
 
 \section filter_linear_or_quadratic Linear / quadratic
 
@@ -414,8 +382,7 @@ Filter linear / quadratic mesh elements:
 - if unary operator is set to smesh.FT_LogicalNOT, the quadratic
 elements are selected, otherwise (by default) linear elements are selected
 
-\include filters_ex33.py
-<a href="../../examples/SMESH/filters_ex33.py">Download this script</a>
+\tui_script{filters_ex33.py}
 
 \section filter_group_color Group color
 
@@ -424,8 +391,7 @@ Filter mesh entities, belonging to the group with the color defined by the thres
 - functor type is \a smesh.FT_GroupColor
 - threshold should be of SALOMEDS.Color type
 
-\include filters_ex34.py
-<a href="../../examples/SMESH/filters_ex34.py">Download this script</a>
+\tui_script{filters_ex34.py}
 
 \section filter_geom_type Geometry type
 
@@ -436,8 +402,7 @@ entity type.
 - functor type should be \a smesh.FT_ElemGeomType
 - threshold is of smesh.GeometryType value
 
-\include filters_ex35.py
-<a href="../../examples/SMESH/filters_ex35.py">Download this script</a>
+\tui_script{filters_ex35.py}
 
 \section combining_filters How to combine filters with Criterion structures?
 
@@ -445,8 +410,7 @@ Filters can be combined by making use of "criteria".
 
 Example :
 
-\include filters_ex36.py
-<a href="../../examples/SMESH/filters_ex36.py">Download this script</a>
+\tui_script{filters_ex36.py}
 
 
 */
index 36e13d30424ac6b62366d8da9a5b151e08725cbc..7284a76b54c2480a553b9a135d3fee2f263372ce 100644 (file)
@@ -17,8 +17,7 @@ by flat elements.
 \n This example represents an iron cable (a thin cylinder) in a concrete bloc (a big cylinder).
 The big cylinder is defined by two geometric volumes.
 
-\include generate_flat_elements.py
-<a href="../../examples/SMESH/generate_flat_elements.py">Download this script</a>
+\tui_script{generate_flat_elements.py}
 
 \n Here, the 4 groups of volumes [Solid_1_1, Solid_2_1, Solid_3_1, Solid_4_1] constitute a partition of the mesh.
 The flat elements on group boundaries and on faces are built with the
index d3113ab2c26997d7d392a238c1bcd85bbf7d0af3..a264f254262ab5913013a6864836b11c1582c162 100644 (file)
@@ -5,29 +5,25 @@
 <br>
 \anchor tui_create_standalone_group
 <h2>Create a Standalone Group</h2>
-\include grouping_elements_ex01.py
-<a href="../../examples/SMESH/grouping_elements_ex01.py">Download this script</a>
+\tui_script{grouping_elements_ex01.py}
 
 \image html create_group.png
 
 <br>
 \anchor tui_create_group_on_geometry
 <h2>Create a Group on Geometry</h2>
-\include grouping_elements_ex02.py
-<a href="../../examples/SMESH/grouping_elements_ex02.py">Download this script</a>
+\tui_script{grouping_elements_ex02.py}
 
 <br>
 \anchor tui_create_group_on_filter
 
 <h2>Create a Group on Filter</h2>
-\include grouping_elements_ex03.py
-<a href="../../examples/SMESH/grouping_elements_ex03.py">Download this script</a>
+\tui_script{grouping_elements_ex03.py}
 
 <br>
 \anchor tui_edit_group
 <h2>Edit a Group</h2>
-\include grouping_elements_ex04.py
-<a href="../../examples/SMESH/grouping_elements_ex04.py">Download this script</a>
+\tui_script{grouping_elements_ex04.py}
 
 \image html editing_groups1.png
 
@@ -36,8 +32,7 @@
 <br>
 \anchor tui_union_of_groups
 <h2>Union of groups</h2>
-\include grouping_elements_ex05.py
-<a href="../../examples/SMESH/grouping_elements_ex05.py">Download this script</a>
+\tui_script{grouping_elements_ex05.py}
 
 \image html union_groups1.png
 
@@ -48,8 +43,7 @@
 <br>
 \anchor tui_intersection_of_groups
 <h2>Intersection of groups</h2>
-\include grouping_elements_ex06.py
-<a href="../../examples/SMESH/grouping_elements_ex06.py">Download this script</a>
+\tui_script{grouping_elements_ex06.py}
 
 \image html intersect_groups1.png
 
@@ -60,8 +54,7 @@
 <br>
 \anchor tui_cut_of_groups
 <h2>Cut of groups</h2>
-\include grouping_elements_ex07.py
-<a href="../../examples/SMESH/grouping_elements_ex07.py">Download this script</a>
+\tui_script{grouping_elements_ex07.py}
 
 \image html cut_groups1.png
 
@@ -72,8 +65,7 @@
 <br>
 \anchor tui_create_dim_group
 <h2>Creating groups of entities from existing groups of superior dimensions</h2>
-\include grouping_elements_ex08.py
-<a href="../../examples/SMESH/grouping_elements_ex08.py">Download this script</a>
+\tui_script{grouping_elements_ex08.py}
 
 \image html dimgroup_tui1.png
 <center>Source groups of faces</center>
index 8ca283fc37020b5005a439ea2023c8299e85da1d..4d25c73584fc30d33a76068e5c7fbd7c175470f4 100644 (file)
@@ -3,11 +3,9 @@
 \page tui_measurements_page Measurements
 
 \section tui_min_distance Minimum Distance
-\include measurements_ex01.py
-<a href="../../examples/SMESH/measurements_ex01.py">Download this script</a>
+\tui_script{measurements_ex01.py}
 
 \section tui_bounding_box Bounding Box
-\include measurements_ex02.py
-<a href="../../examples/SMESH/measurements_ex02.py">Download this script</a>
+\tui_script{measurements_ex02.py}
 
 */
index e7844327c721e01c7c781ab9b0c67eed9bd45b28..7ceb5ebf7d3df335804156e73c12817bd4f1c6a0 100644 (file)
@@ -9,62 +9,52 @@
 <br>
 \anchor tui_add_node
 <h3>Add Node</h3>
-\include modifying_meshes_ex01.py
-<a href="../../examples/SMESH/modifying_meshes_ex01.py">Download this script</a>
+\tui_script{modifying_meshes_ex01.py}
 
 <br>
 \anchor tui_add_0DElement
 <h3>Add 0D Element</h3>
-\include modifying_meshes_ex02.py
-<a href="../../examples/SMESH/modifying_meshes_ex02.py">Download this script</a>
+\tui_script{modifying_meshes_ex02.py}
 
 <br>
 \anchor tui_add_0DElement_on_all_nodes
 <h3>Add 0D Element on Element Nodes</h3>
-\include modifying_meshes_ex03.py
-<a href="../../examples/SMESH/modifying_meshes_ex03.py">Download this script</a>
+\tui_script{modifying_meshes_ex03.py}
 
 <br>
 \anchor tui_add_edge
 <h3>Add Edge</h3>
-\include modifying_meshes_ex04.py
-<a href="../../examples/SMESH/modifying_meshes_ex04.py">Download this script</a>
+\tui_script{modifying_meshes_ex04.py}
 
 <br>
 \anchor tui_add_triangle
 <h3>Add Triangle</h3>
-\include modifying_meshes_ex05.py
-<a href="../../examples/SMESH/modifying_meshes_ex05.py">Download this script</a>
+\tui_script{modifying_meshes_ex05.py}
 
 <br>
 \anchor tui_add_quadrangle
 <h3>Add Quadrangle</h3>
-\include modifying_meshes_ex06.py
-<a href="../../examples/SMESH/modifying_meshes_ex06.py">Download this script</a>
+\tui_script{modifying_meshes_ex06.py}
 
 <br>
 \anchor tui_add_tetrahedron
 <h3>Add Tetrahedron</h3>
-\include modifying_meshes_ex07.py
-<a href="../../examples/SMESH/modifying_meshes_ex07.py">Download this script</a>
+\tui_script{modifying_meshes_ex07.py}
 
 <br>
 \anchor tui_add_hexahedron
 <h3>Add Hexahedron</h3>
-\include modifying_meshes_ex08.py
-<a href="../../examples/SMESH/modifying_meshes_ex08.py">Download this script</a>
+\tui_script{modifying_meshes_ex08.py}
 
 <br>
 \anchor tui_add_polygon
 <h3>Add Polygon</h3>
-\include modifying_meshes_ex09.py
-<a href="../../examples/SMESH/modifying_meshes_ex09.py">Download this script</a>
+\tui_script{modifying_meshes_ex09.py}
 
 <br>
 \anchor tui_add_polyhedron
 <h3>Add Polyhedron</h3>
-\include modifying_meshes_ex10.py
-<a href="../../examples/SMESH/modifying_meshes_ex10.py">Download this script</a>
+\tui_script{modifying_meshes_ex10.py}
 
 <br>
 \anchor tui_removing_nodes_and_elements
 <br>
 \anchor tui_removing_nodes
 <h3>Removing Nodes</h3>
-\include modifying_meshes_ex11.py
-<a href="../../examples/SMESH/modifying_meshes_ex11.py">Download this script</a>
+\tui_script{modifying_meshes_ex11.py}
 
 <br>
 \anchor tui_removing_elements
 <h3>Removing Elements</h3>
-\include modifying_meshes_ex12.py
-<a href="../../examples/SMESH/modifying_meshes_ex12.py">Download this script</a>
+\tui_script{modifying_meshes_ex12.py}
 
 <br>
 \anchor tui_removing_orphan_nodes
 <h3>Removing Orphan Nodes</h3>
-\include modifying_meshes_ex13.py
-<a href="../../examples/SMESH/modifying_meshes_ex13.py">Download this script</a>
+\tui_script{modifying_meshes_ex13.py}
 
 <br>
 \anchor tui_renumbering_nodes_and_elements
 <h2>Renumbering Nodes and Elements</h2>
-\include modifying_meshes_ex14.py
-<a href="../../examples/SMESH/modifying_meshes_ex14.py">Download this script</a>
+\tui_script{modifying_meshes_ex14.py}
 
 <br>
 \anchor tui_moving_nodes
 <h2>Moving Nodes</h2>
-\include modifying_meshes_ex15.py
-<a href="../../examples/SMESH/modifying_meshes_ex15.py">Download this script</a>
+\tui_script{modifying_meshes_ex15.py}
 
 <br>
 \anchor tui_diagonal_inversion
 <h2>Diagonal Inversion</h2>
-\include modifying_meshes_ex16.py
-<a href="../../examples/SMESH/modifying_meshes_ex16.py">Download this script</a>
+\tui_script{modifying_meshes_ex16.py}
 
 <br>
 \anchor tui_uniting_two_triangles
 <h2>Uniting two Triangles</h2>
-\include modifying_meshes_ex17.py
-<a href="../../examples/SMESH/modifying_meshes_ex17.py">Download this script</a>
+\tui_script{modifying_meshes_ex17.py}
 
 <br>
 \anchor tui_uniting_set_of_triangles
 <h2>Uniting a Set of Triangles</h2>
-\include modifying_meshes_ex18.py
-<a href="../../examples/SMESH/modifying_meshes_ex18.py">Download this script</a>
+\tui_script{modifying_meshes_ex18.py}
 
 <br>
 \anchor tui_orientation
 <h2>Orientation</h2>
-\include modifying_meshes_ex19.py
-<a href="../../examples/SMESH/modifying_meshes_ex19.py">Download this script</a>
+\tui_script{modifying_meshes_ex19.py}
 
 <br>
 \anchor tui_cutting_quadrangles
 <h2>Cutting Quadrangles</h2>
-\include modifying_meshes_ex20.py
-<a href="../../examples/SMESH/modifying_meshes_ex20.py">Download this script</a>
+\tui_script{modifying_meshes_ex20.py}
 
 <br>
 \anchor tui_smoothing
 <h2>Smoothing</h2>
-\include modifying_meshes_ex21.py
-<a href="../../examples/SMESH/modifying_meshes_ex21.py">Download this script</a>
+\tui_script{modifying_meshes_ex21.py}
 
 <br>
 \anchor tui_extrusion
 <h2>Extrusion</h2>
-\include modifying_meshes_ex22.py
-<a href="../../examples/SMESH/modifying_meshes_ex22.py">Download this script</a>
+\tui_script{modifying_meshes_ex22.py}
 
 <br>
 \anchor tui_extrusion_along_path
 <h2>Extrusion along a Path</h2>
-\include modifying_meshes_ex23.py
-<a href="../../examples/SMESH/modifying_meshes_ex23.py">Download this script</a>
+\tui_script{modifying_meshes_ex23.py}
 
 <br>
 \anchor tui_revolution
 <h2>Revolution</h2>
-\include modifying_meshes_ex24.py
-<a href="../../examples/SMESH/modifying_meshes_ex24.py">Download this script</a>
+\tui_script{modifying_meshes_ex24.py}
 
 <br>
 \anchor tui_pattern_mapping
 <h2>Pattern Mapping</h2>
-\include modifying_meshes_ex25.py
-<a href="../../examples/SMESH/modifying_meshes_ex25.py">Download this script</a>
+\tui_script{modifying_meshes_ex25.py}
 
 <br>
 \anchor tui_quadratic
 <h2>Convert mesh to/from quadratic</h2>
-\include modifying_meshes_ex26.py
-<a href="../../examples/SMESH/modifying_meshes_ex26.py">Download this script</a>
+\tui_script{modifying_meshes_ex26.py}
 
 */
index 3403590697e6a95e0244eb2dca6214625fb6a2ca..7f34deca91911fc926ba45fe31a3d625b6bb9565 100644 (file)
@@ -3,7 +3,6 @@
 \page tui_notebook_smesh_page Using SALOME NoteBook
 
 \anchor tui_notebook_smesh
-\include notebook_smesh.py
-<a href="../../examples/SMESH/notebook_smesh.py">Download this script</a>
+\tui_script{notebook_smesh.py}
 
 */
index d0234a7ab0b620dfcd142c8f45abd2649b889947..6ba5e25d38eea29550d4be84a34d94ef766c9aca 100644 (file)
@@ -1,8 +1,7 @@
 /*!
 
 \page tui_prism_3d_algo Use 3D extrusion meshing algorithm
-\include prism_3d_algo.py
-<a href="../../examples/SMESH/prism_3d_algo.py">Download this script</a>
+\tui_script{prism_3d_algo.py}
 
 The result geometry and mesh is shown below
 \image html prism_tui_sample.png
index e09389d3f815d25eef339afde955d06564e6f8de..be849962cee00808c17bc3e4b1130433355ef043 100644 (file)
@@ -3,91 +3,69 @@
 \page tui_quality_controls_page Quality Controls
 
 \section tui_free_borders Free Borders
-\include quality_controls_ex01.py
-<a href="../../examples/SMESH/quality_controls_ex01.py">Download this script</a>
+\tui_script{quality_controls_ex01.py}
 
 \section tui_borders_at_multiconnection Borders at Multiconnection
-\include quality_controls_ex02.py
-<a href="../../examples/SMESH/quality_controls_ex02.py">Download this script</a>
+\tui_script{quality_controls_ex02.py}
 
 \section tui_length_1d Length 1D
-\include quality_controls_ex03.py
-<a href="../../examples/SMESH/quality_controls_ex03.py">Download this script</a>
+\tui_script{quality_controls_ex03.py}
 
 \section tui_free_edges Free Edges
-\include quality_controls_ex04.py
-<a href="../../examples/SMESH/quality_controls_ex04.py">Download this script</a>
+\tui_script{quality_controls_ex04.py}
 
 \section tui_free_nodes Free Nodes
-\include quality_controls_ex05.py
-<a href="../../examples/SMESH/quality_controls_ex05.py">Download this script</a>
+\tui_script{quality_controls_ex05.py}
 
 \section tui_free_faces Free Faces
-\include quality_controls_ex06.py
-<a href="../../examples/SMESH/quality_controls_ex06.py">Download this script</a>
+\tui_script{quality_controls_ex06.py}
 
 \section tui_bare_border_faces Bare border faces
-\include quality_controls_ex07.py
-<a href="../../examples/SMESH/quality_controls_ex07.py">Download this script</a>
+\tui_script{quality_controls_ex07.py}
 
 \section tui_bare_border_volumes Bare border volumes
-\include quality_controls_ex08.py
-<a href="../../examples/SMESH/quality_controls_ex08.py">Download this script</a>
+\tui_script{quality_controls_ex08.py}
 
 \section tui_over_constrained_faces Over-constrained faces
-\include quality_controls_ex09.py
-<a href="../../examples/SMESH/quality_controls_ex09.py">Download this script</a>
+\tui_script{quality_controls_ex09.py}
 
 \section tui_over_constrained_volumes Over-constrained volumes
-\include quality_controls_ex10.py
-<a href="../../examples/SMESH/quality_controls_ex10.py">Download this script</a>
+\tui_script{quality_controls_ex10.py}
 
 \section tui_length_2d Length 2D
-\include quality_controls_ex11.py
-<a href="../../examples/SMESH/quality_controls_ex11.py">Download this script</a>
+\tui_script{quality_controls_ex11.py}
 
 \section tui_borders_at_multiconnection_2d Borders at Multiconnection 2D
-\include quality_controls_ex12.py
-<a href="../../examples/SMESH/quality_controls_ex12.py">Download this script</a>
+\tui_script{quality_controls_ex12.py}
 
 \section tui_area Area
-\include quality_controls_ex13.py
-<a href="../../examples/SMESH/quality_controls_ex13.py">Download this script</a>
+\tui_script{quality_controls_ex13.py}
 
 \section tui_taper Taper
-\include quality_controls_ex14.py
-<a href="../../examples/SMESH/quality_controls_ex14.py">Download this script</a>
+\tui_script{quality_controls_ex14.py}
 
 \section tui_aspect_ratio Aspect Ratio
-\include quality_controls_ex15.py
-<a href="../../examples/SMESH/quality_controls_ex15.py">Download this script</a>
+\tui_script{quality_controls_ex15.py}
 
 \section tui_minimum_angle Minimum Angle
-\include quality_controls_ex16.py
-<a href="../../examples/SMESH/quality_controls_ex16.py">Download this script</a>
+\tui_script{quality_controls_ex16.py}
 
 \section tui_warping Warping
-\include quality_controls_ex17.py
-<a href="../../examples/SMESH/quality_controls_ex17.py">Download this script</a>
+\tui_script{quality_controls_ex17.py}
 
 \section tui_skew Skew
-\include quality_controls_ex18.py
-<a href="../../examples/SMESH/quality_controls_ex18.py">Download this script</a>
+\tui_script{quality_controls_ex18.py}
 
 \section tui_max_element_length_2d Element Diameter 2D
-\include quality_controls_ex19.py
-<a href="../../examples/SMESH/quality_controls_ex19.py">Download this script</a>
+\tui_script{quality_controls_ex19.py}
 
 \section tui_aspect_ratio_3d Aspect Ratio 3D
-\include quality_controls_ex20.py
-<a href="../../examples/SMESH/quality_controls_ex20.py">Download this script</a>
+\tui_script{quality_controls_ex20.py}
 
 \section tui_volume Volume
-\include quality_controls_ex21.py
-<a href="../../examples/SMESH/quality_controls_ex21.py">Download this script</a>
+\tui_script{quality_controls_ex21.py}
 
 \section tui_max_element_length_3d Element Diameter 3D
-\include quality_controls_ex22.py
-<a href="../../examples/SMESH/quality_controls_ex22.py">Download this script</a>
+\tui_script{quality_controls_ex22.py}
 
 */
index 3b77fab34b86bbff2f75ce650aa9f85eb7a60a22..303b7cec4a7d07797a9be1e330f612c39df00ab7 100644 (file)
@@ -7,81 +7,68 @@
 <br>
 \anchor tui_translation
 <h3>Translation</h3>
-\include transforming_meshes_ex01.py
-<a href="../../examples/SMESH/transforming_meshes_ex01.py">Download this script</a>
+\tui_script{transforming_meshes_ex01.py}
 
 <br>
 \anchor tui_rotation
 <h3>Rotation</h3>
-\include transforming_meshes_ex02.py
-<a href="../../examples/SMESH/transforming_meshes_ex02.py">Download this script</a>
+\tui_script{transforming_meshes_ex02.py}
 
 <br>
 \anchor tui_scale
 <h3>Scale</h3>
-\include transforming_meshes_ex03.py
-<a href="../../examples/SMESH/transforming_meshes_ex03.py">Download this script</a>
+\tui_script{transforming_meshes_ex03.py}
 
 <br>
 \anchor tui_symmetry
 <h3>Symmetry</h3>
-\include transforming_meshes_ex04.py
-<a href="../../examples/SMESH/transforming_meshes_ex04.py">Download this script</a>
+\tui_script{transforming_meshes_ex04.py}
 
 <br>
 \anchor tui_merging_nodes
 <h3>Merging Nodes</h3>
-\include transforming_meshes_ex05.py
-<a href="../../examples/SMESH/transforming_meshes_ex05.py">Download this script</a>
+\tui_script{transforming_meshes_ex05.py}
 
 <br>
 \anchor tui_merging_elements
 <h3>Merging Elements</h3>
-\include transforming_meshes_ex06.py
-<a href="../../examples/SMESH/transforming_meshes_ex06.py">Download this script</a>
+\tui_script{transforming_meshes_ex06.py}
 
 <br><h2>Sewing Meshes</h2>
 
 <br>
 \anchor tui_sew_meshes_border_to_side
 <h3>Sew Meshes Border to Side</h3>
-\include transforming_meshes_ex07.py
-<a href="../../examples/SMESH/transforming_meshes_ex07.py">Download this script</a>
+\tui_script{transforming_meshes_ex07.py}
 
 <br>
 \anchor tui_sew_conform_free_borders
 <h3>Sew Conform Free Borders</h3>
-\include transforming_meshes_ex08.py
-<a href="../../examples/SMESH/transforming_meshes_ex08.py">Download this script</a>
+\tui_script{transforming_meshes_ex08.py}
 
 <br>
 \anchor tui_sew_free_borders
 <h3>Sew Free Borders</h3>
-\include transforming_meshes_ex09.py
-<a href="../../examples/SMESH/transforming_meshes_ex09.py">Download this script</a>
+\tui_script{transforming_meshes_ex09.py}
 
 <br>
 \anchor tui_sew_side_elements
 <h3>Sew Side Elements</h3>
-\include transforming_meshes_ex10.py
-<a href="../../examples/SMESH/transforming_meshes_ex10.py">Download this script</a>
+\tui_script{transforming_meshes_ex10.py}
 
 <br>
 \anchor tui_duplicate_nodes
 <h3>Duplicate nodes</h3>
-\include transforming_meshes_ex11.py
-<a href="../../examples/SMESH/transforming_meshes_ex11.py">Download this script</a>
+\tui_script{transforming_meshes_ex11.py}
 
 <br>
 \anchor tui_make_2dmesh_from_3d
 <h3>Create boundary elements</h3>
-\include transforming_meshes_ex12.py
-<a href="../../examples/SMESH/transforming_meshes_ex12.py">Download this script</a>
+\tui_script{transforming_meshes_ex12.py}
 
 <br>
 \anchor tui_reorient_faces
 <h3>Reorient faces by vector</h3>
-\include transforming_meshes_ex13.py
-<a href="../../examples/SMESH/transforming_meshes_ex13.py">Download this script</a>
+\tui_script{transforming_meshes_ex13.py}
 
 */
index 46dfe1e054a22efa783bbc87e876b3511d05e89a..ddc56cb839bb9b44b5ca437d7e49a018d62160f0 100644 (file)
@@ -6,8 +6,7 @@ This sample demonstrates how to use <b>Use existing faces</b> algorithm,
 which is actulally just a stub allowing to use your own 2D algoritm
 implemented in Python.
 
-\include use_existing_faces.py
-<a href="../../examples/SMESH/use_existing_faces.py">Download this script</a>
+\tui_script{use_existing_faces.py}
 
 Resulting mesh:
 \image html use_existing_face_sample_mesh.png
index 06586ffea212f7e88f9edb190bc10296498d7113..2f3c4b40494c765ba4a95c1151d3b4336e4ac3b1 100644 (file)
@@ -5,13 +5,11 @@
 <br>
 \anchor tui_viewing_mesh_infos
 <h2>Viewing Mesh Infos</h2>
-\include viewing_meshes_ex01.py
-<a href="../../examples/SMESH/viewing_meshes_ex01.py">Download this script</a>
+\tui_script{viewing_meshes_ex01.py}
 
 <br>
 \anchor tui_find_element_by_point
 <h2>Find Element by Point</h2>
-\include viewing_meshes_ex02.py
-<a href="../../examples/SMESH/viewing_meshes_ex02.py">Download this script</a>
+\tui_script{viewing_meshes_ex02.py}
 
 */