EXTRA_DIST += images input static/footer.html static/doxygen.css
guidocdir = $(docdir)/gui/GEOM
-guidoc_DATA = images/head.png
+guidoc_DATA = images/head.png static/SALOME_BOA_PA.pdf
usr_docs: doxyfile_tui doxyfile_py doxyfile
echo "===========================================" ; \
\page common_operation_page Common
-\n To produce a \b Common operation in the <b>Main Menu</b> select <b>Operations - > Boolean - > Common</b>
+For detail description of the Boolean operations please refer to
+<a href="SALOME_BOA_PA.pdf">this document</a>.
+It provides a general review of the Partition and Boolean
+operations algorithms, describes the usage methodology and highlighs
+major limitations of these operations.
-\n This operation cuts the common part of two shapes and transforms it into an independent geometrical object.
+To produce a \b Common operation in the <b>Main Menu</b> select <b>Operations - > Boolean - > Common</b>
-\n The \b Result will be any \b GEOM_Object.
-\n <b>TUI Command:</b> <em>geompy.MakeCommon(s1, s2)</em>
-\n <b>Arguments:</b> Name + 2 shapes.
-\n <b>Advanced option:</b>
- \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
+This operation cuts the common part of two shapes and transforms it into an independent geometrical object.
+
+The \b Result will be any \b GEOM_Object.
+<b>TUI Command:</b> <em>geompy.MakeCommon(s1, s2)</em>
+<b>Arguments:</b> Name + 2 shapes.
+<b>Advanced option:</b>
+\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\image html bool2.png
-\n <b>Example:</b>
+<b>Example:</b>
\image html fusesn1.png "The initial shapes"
\page cut_operation_page Cut
-\n To produce a \b Cut operation in the <b>Main Menu</b> select <b>Operations - > Boolean - > Cut</b>
+For detail description of the Boolean operations please refer to
+<a href="SALOME_BOA_PA.pdf">this document</a>.
+It provides a general review of the Partition and Boolean
+operations algorithms, describes the usage methodology and highlighs
+major limitations of these operations.
-\n This operation cuts a shape with another one.
-\n The \b Result will be any \b GEOM_Object.
-\n <b>Arguments:</b> Name + 2 shapes.
-\n <b>Advanced option:</b>
- \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
+To produce a \b Cut operation in the <b>Main Menu</b> select <b>Operations - > Boolean - > Cut</b>
-\n <b>Dialog Box:</b>
+This operation cuts a shape with another one.
+The \b Result will be any \b GEOM_Object.
+<b>Arguments:</b> Name + 2 shapes.
+<b>Advanced option:</b>
+\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
+
+<b>Dialog Box:</b>
\image html bool3.png
-\n <b>Example:</b>
+<b>Example:</b>
\image html fusesn1.png "The initial shapes"
\page fuse_operation_page Fuse
-\n To produce a \b Fuse operation in the <b>Main Menu</b> select
+For detail description of the Boolean operations please refer to
+<a href="SALOME_BOA_PA.pdf">this document</a>.
+It provides a general review of the Partition and Boolean
+operations algorithms, describes the usage methodology and highlighs
+major limitations of these operations.
+
+To produce a \b Fuse operation in the <b>Main Menu</b> select
<b>Operations - > Boolean - > Fuse</b>
-\n This operation creates a shape from two shapes.
+This operation creates a shape from two shapes.
-\n The \b Result will be any \b GEOM_Object.
-\n <b>TUI Command:</b> <em>geompy.MakeFuse(s1, s2)</em>
-\n <b>Arguments:</b> Name + 2 shapes.
-\n <b>Advanced option:</b>
- \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
+The \b Result will be any \b GEOM_Object.
+<b>TUI Command:</b> <em>geompy.MakeFuse(s1, s2)</em>
+<b>Arguments:</b> Name + 2 shapes.
+<b>Advanced option:</b>
+\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\image html bool1.png
-\n <b>Example:</b>
+<b>Example:</b>
\image html fusesn1.png "The initial shapes"
\image html image3.png "Example of Geometry module usage for engineering tasks"
+There are also \subpage related_docs_page "additional reference documents"
+for Geometry module that can be useful.
*/
\page partition_page Partition
+For detail description of the Partition operation please refer to
+<a href="SALOME_BOA_PA.pdf">this document</a>.
+It provides a general review of the Partition and Boolean
+operations algorithms, describes the usage methodology and highlighs
+major limitations of these operations.
+
To produce a \b Partition in the <b>Main Menu</b> select <b>Operations - > Partition</b>
This operation builds a compound by intersection of several shapes
--- /dev/null
+/*!
+\page related_docs_page Related Documents
+
+Here you can find additional reference documents for Geometry module
+that can be useful for reading.
+
+<a href="SALOME_BOA_PA.pdf">General Fuse Algorithm, Partition
+Algorithm, Boolean Operations Algorithm. Backgrounds.</a>
+
+*/
\page section_opeartion_page Section
-\n To produce a \b Section operation in the <b>Main Menu</b> select
+For detail description of the Boolean operations please refer to
+<a href="SALOME_BOA_PA.pdf">this document</a>.
+It provides a general review of the Partition and Boolean
+operations algorithms, describes the usage methodology and highlighs
+major limitations of these operations.
+
+To produce a \b Section operation in the <b>Main Menu</b> select
<b>Operations - > Boolean - > Section</b>
-\n This operation creates the section between 2 shapes.
+This operation creates the section between 2 shapes.
-\n The \b Result will be any \b GEOM_Object (EDGE or WIRE).
-\n <b>TUI Command:</b> <em>geompy.MakeSection(s1, s2)</em>
-\n <b>Arguments:</b> Name + 2 shapes.
-\n <b>Advanced option:</b>
- \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
+The \b Result will be any \b GEOM_Object (EDGE or WIRE).
+<b>TUI Command:</b> <em>geompy.MakeSection(s1, s2)</em>
+<b>Arguments:</b> Name + 2 shapes.
+<b>Advanced option:</b>
+\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\image html neo-section.png
-\n <b>Example:</b>
+<b>Example:</b>
\image html fusesn1.png "The initial shapes"
\page using_boolean_operations_page Using Boolean Operations
-\n You can use the following boolean operations for construction of more
+For detail description of the Boolean operations please refer to
+<a href="SALOME_BOA_PA.pdf">this document</a>.
+It provides a general review of the Partition and Boolean
+operations algorithms, describes the usage methodology and highlighs
+major limitations of these operations.
+
+You can use the following boolean operations for construction of more
complex geometrical objects (2D & 3D elements):
<ul>
<em>geompy.MakeSection(Shape1, Shape2)</em>, where \em Shape1 and \em
Shape2 is the second argument of Section operation;
-\n Our <b>TUI Scripts</b> provide you with useful examples of the use of
+Our <b>TUI Scripts</b> provide you with useful examples of the use of
\ref tui_boolean_operations_page "Boolean Operations".
*/
