From dee3117354e2a6ddc5df885306526b5fc8730567 Mon Sep 17 00:00:00 2001 From: vsr Date: Mon, 3 Dec 2012 11:05:05 +0000 Subject: [PATCH] Correction of documentation --- .../GEOM/input/check_compound_of_blocks.doc | 4 +- .../gui/GEOM/input/creating_3dsketcher.doc | 28 ++++----- .../gui/GEOM/input/creating_adv_obj.doc | 14 ----- .../GEOM/input/creating_dividedcylinder.doc | 6 +- .../gui/GEOM/input/creating_divideddisk.doc | 14 ++--- .../GEOM/input/creating_hexaedral_solid.doc | 36 +++++------- .../gui/GEOM/input/creating_pipe_path.doc | 18 +++--- .../GEOM/input/creating_quadrangle_face.doc | 58 ++++++++++--------- .../gui/GEOM/input/creating_sketcher.doc | 6 +- doc/salome/gui/GEOM/input/faq.doc | 4 +- doc/salome/gui/GEOM/input/fuse_operation.doc | 6 +- doc/salome/gui/GEOM/input/get_non_blocks.doc | 14 ++--- doc/salome/gui/GEOM/input/import_export.doc | 6 +- doc/salome/gui/GEOM/input/partition.doc | 6 +- .../gui/GEOM/input/partition_explanation.doc | 12 ++-- .../gui/GEOM/input/working_with_groups.doc | 15 +++-- 16 files changed, 116 insertions(+), 131 deletions(-) delete mode 100644 doc/salome/gui/GEOM/input/creating_adv_obj.doc diff --git a/doc/salome/gui/GEOM/input/check_compound_of_blocks.doc b/doc/salome/gui/GEOM/input/check_compound_of_blocks.doc index 81d8379a0..568725868 100644 --- a/doc/salome/gui/GEOM/input/check_compound_of_blocks.doc +++ b/doc/salome/gui/GEOM/input/check_compound_of_blocks.doc @@ -7,9 +7,9 @@ considered as a compound of blocks, the given shape must satisfy the following conditions: \n Informs of the following possible errors: diff --git a/doc/salome/gui/GEOM/input/creating_3dsketcher.doc b/doc/salome/gui/GEOM/input/creating_3dsketcher.doc index 6446a0245..6c44c25da 100755 --- a/doc/salome/gui/GEOM/input/creating_3dsketcher.doc +++ b/doc/salome/gui/GEOM/input/creating_3dsketcher.doc @@ -13,16 +13,16 @@ To create a 3D Sketch, select in the main menu New Entity -> Basic -> 3D Ske \image html 3dsketch_dlg.png -The first sketcher point can be defined by \b Absolute coordinates X, Y and Z. +The first point of a sketch can be defined by \b Absolute coordinates X, Y and Z. When the first point is defined, it is possible to add straight segments. -Each segment will start at the end point of previous segment or at the -sketcher first point, if there are no validated segments. +Each segment will start at the end point of the previous segment or at the +first point of the sketch, if there are no validated segments. The way of segment construction can be selected by the Coordinates Type radio buttons. -To validate the segment and to proceed with the definition of the next -segment, click Apply button. \b Undo and \b Redo buttons, +To validate a segment and to proceed with the definition of the next +one, click Apply button. \b Undo and \b Redo buttons, respectively, remove or restore the last segment in the wire. \n "Sketch Validation" button applies the wire, built by the @@ -30,32 +30,32 @@ user, "as is". \n "Sketch Closure" closes the Sketch by a straight line from the start to the end point and applies it. -Segment can be defined by: -- Cartesian coordinates of its second end, it can be either: - - \b Absolute coordinates X, Y and Z, +A segment can be defined by: +- Cartesian coordinates of its second end, which can be either: + - \b Absolute coordinates X, Y and Z, or - \b Relative coordinates DX, DY and DZ with respect to the previous applied point, -- Angular coordinates of its second end, which is specified by: +- Angular coordinates of its second end specified by:
-\note It is not assumed that exact or approximate copy of the Shape - can be obtained by applying existing Pipe operation on the - resulting "Path" wire taking the first Base as the base - it is - not always possible; though in some particular cases it might - work it is not guaranteed. Thus, RestorePath function should not +\note It is not always possible to obtain an exact or approximate + copy of the Shape by applying the \b Pipe operation to the + resulting "Path" wire with the first Base as the base; + though in some particular cases it might + work. Thus, Restore Path function should not be considered as an exact reverse operation of the Pipe.
\n Example: diff --git a/doc/salome/gui/GEOM/input/creating_quadrangle_face.doc b/doc/salome/gui/GEOM/input/creating_quadrangle_face.doc index 1aa7c91f8..63d2e9494 100644 --- a/doc/salome/gui/GEOM/input/creating_quadrangle_face.doc +++ b/doc/salome/gui/GEOM/input/creating_quadrangle_face.doc @@ -2,39 +2,45 @@ \page create_quadrangle_face_page Quadrangle face -\n Description: Builds a face using the below mentioned -arguments. This operation allows to build a face bypassing the -intermediate stage of building edges and wires (in the case of -building by 4 points) or wires (in the case of building by 4 or 2 +This operation allows to build a face bypassing the +intermediate stage of building edges and wires (in case of +building by 4 points) or wires (in case of building by 4 or 2 edges). -\n The \b Result of the operation will be a \b GEOM_Object (face). - -\n TUI Command: -
    -
  • geompy.MakeQuad4Vertices(V1, V2, V3, V4), where V1, V2, -V3, V4 are four vertices from which a face is constructed. Edges are -created automatically.
    • -
  • geompy.MakeQuad2Edges(E1, E2), where E1, E2 are edges from -which the face is constructed, two other edges are created -automatically.
    • -
  • geompy.MakeQuad(E1, E2, E3, E4), where E1, E2, E3, E4 are -four edges from which the face is constructed.
    • -
- -Arguments: -
    -
  • Name + 4 Points, or
    • -
  • Name + 2 Edges, or
    • -
  • Name + 4 Edges.
    • -
- -\n Dialog Box: +There are 3 algorithms to create a Quadrangle Face in the 3D space. +\n The \b Result of each op + +The created blocks can be processed with \ref blocks_operations_page "Operations on Blocks". + +Our TUI Scripts provide you with useful examples of +\ref tui_building_by_blocks_p + +The created blocks can be processed with \ref blocks_operations_page "Operations on Blocks". + +Our TUI Scripts provide you with useful examples of +\ref tui_building_by_blocks_page "Building by Blocks". +age "Building by Blocks". +eration will be a \b GEOM_Object (face). + +Firstly you can define a Quadrangle Face by four vertices. Edges are +created automatically. + +TUI Command: geompy.MakeQuad4Vertices(V1, V2, V3, V4), +Arguments: Name + 4 Points. \image html block1.png +Secondly, you can define a Quadrangle Face by two edges, while the other two edges are created automatically. +TUI Command: geompy.MakeQuad2Edges(E1, E2) +Arguments: Name + 2 Edges. + \image html block2.png +Finally, you can define a Quadrangle Face by four edges. + +TUI Command: geompy.MakeQuad(E1, E2, E3, E4),. +Arguments: Name + 4 Edges. + \image html block3.png \n Example: diff --git a/doc/salome/gui/GEOM/input/creating_sketcher.doc b/doc/salome/gui/GEOM/input/creating_sketcher.doc index 7aa11153a..922f2a6aa 100644 --- a/doc/salome/gui/GEOM/input/creating_sketcher.doc +++ b/doc/salome/gui/GEOM/input/creating_sketcher.doc @@ -27,7 +27,7 @@ To create a 2D Sketch:
  • Select the \b plane or the planar face on which to create the sketch. \note By default the sketch is created on the XOY plane of the global coordinate system. If Local Coordinate Systems have been created in the study they appear -in the combobox and can be selected as a reference coordinate system.
    • +in the combo-box and can be selected as a reference coordinate system.
  • Choose a \b segment or an \b arc element to start a \b profile or choose \b rectangle to draw a rectangle. @@ -50,7 +50,7 @@ origin of the reference coordinate system.
  • You can define the segment by either its end point or \b direction and \b length. The direction is defined relatively to the tangent at the last point of the sketch. It can be:
      -
    • Tangent (colinear to the tangent at the last point)
      • +
    • Tangent (collinear to the tangent at the last point)
    • Perpendicular
    • Defined by an angle
    • Defined by a vector (Vx, Vy)
      • @@ -159,7 +159,7 @@ points in the current LCS. Our TUI Scripts provide you with useful examples of the use of \ref tui_sketcher_page "Sketcher". -A wrapper also exists to help in the construction of a sketcher using simple commands. +There is also a wrapper that can help in the construction of a sketcher using simple commands. The description of this wrapper can be found in the dedicated page of the salome.geom python package. diff --git a/doc/salome/gui/GEOM/input/faq.doc b/doc/salome/gui/GEOM/input/faq.doc index f6ae6c3b0..78fa0d58c 100644 --- a/doc/salome/gui/GEOM/input/faq.doc +++ b/doc/salome/gui/GEOM/input/faq.doc @@ -2,10 +2,10 @@ \page faq FAQ ("Frequently Asked Questions") -You can find here some the answer to some frequentlyasked questions: +Here you can find the answers to some frequently asked questions:
        -
      • \subpage partition_explanation "What's the difference between partition, compounds and fuse operation ?"
        • +
      • \subpage partition_explanation "What is the difference between partition, compounds and fuse operation ?"
      diff --git a/doc/salome/gui/GEOM/input/fuse_operation.doc b/doc/salome/gui/GEOM/input/fuse_operation.doc index 2f41cd86d..df13c732e 100644 --- a/doc/salome/gui/GEOM/input/fuse_operation.doc +++ b/doc/salome/gui/GEOM/input/fuse_operation.doc @@ -26,12 +26,12 @@ Our TUI Scripts provide you with useful examples of the use of More details
        -
      • For detail description of the Boolean operations please refer to +
      • For a detailed description of the Boolean operations please refer to this document. It provides a general review of the Partition and Boolean -operations algorithms, describes the usage methodology and highlighs +operations algorithms, describes the usage methodology and highlights major limitations of these operations.
        • -
      • Also perhaps you ask yourself : \ref partition_explanation "What's the difference between partition, compounds and fuse operation ?"
        • +
      • Perhaps you also ask yourself : \ref partition_explanation "What is the difference between partition, compounds and fuse operation ?"
      */ diff --git a/doc/salome/gui/GEOM/input/get_non_blocks.doc b/doc/salome/gui/GEOM/input/get_non_blocks.doc index 8df0e324c..1bf4806b3 100644 --- a/doc/salome/gui/GEOM/input/get_non_blocks.doc +++ b/doc/salome/gui/GEOM/input/get_non_blocks.doc @@ -4,18 +4,18 @@ \image html measures2.png -Retrieve all non blocks solids and faces from the given shape. -Collect them in two groups: solids and faces separately. +This operation retrieves all non block solids and faces from the given +shape in two groups: solids and faces separately. -\n Result: Two or less groups are published in the Object - Browser under the processed object. Reports error if - no bad sub-shapes (solids and faces) have been found. +Two or less groups are published in the Object +Browser under the processed object. An error is raised if +no bad sub-shapes (solids and faces) have been found. \n TUI Command: geompy.GetNonBlocks(Compound). Returns a tuple of two GEOM_Objects. The first object is a group of all non block solids - (= not 6 faces, or with 6 faces, but with the presence of - non-quadrangular faces). The second object is a group of all non + (not having 6 faces, or having 6 faces, but some of them + are not quadrangular). The second object is a group of all non quadrangular faces. See also a \ref tui_get_non_blocks_page "TUI example". diff --git a/doc/salome/gui/GEOM/input/import_export.doc b/doc/salome/gui/GEOM/input/import_export.doc index 7946987aa..62a80da55 100644 --- a/doc/salome/gui/GEOM/input/import_export.doc +++ b/doc/salome/gui/GEOM/input/import_export.doc @@ -22,10 +22,10 @@ Select the required file and click \b Open. Your file will be imported in the module and its contents (geometrical object) will be displayed in the Object Browser. -\note If the selected file is in IGES or in STEP format and the length -is not expressed in meters, it will be asked to take or not these +\note If the selected file is in IGES or STEP format and the length +is not expressed in meters, it will be asked whether to take or not these units into account (see the picture below). This feature can be -helpful if some wrong units have been written to the IGES file by a +helpful if some wrong units have been written to the IGES or STEP file by a 3rd-party software. \image html iges_unit.png diff --git a/doc/salome/gui/GEOM/input/partition.doc b/doc/salome/gui/GEOM/input/partition.doc index edaa01e49..dfee4899f 100644 --- a/doc/salome/gui/GEOM/input/partition.doc +++ b/doc/salome/gui/GEOM/input/partition.doc @@ -3,13 +3,13 @@ \page partition_page Partition
        -
      • For detail description of the Partition operation please refer to +
      • For a detailed description of the Partition operation please refer to this document. It provides a general review of the Partition and Boolean -operations algorithms, describes the usage methodology and highlighs +operations algorithms, describes the usage methodology and highlights major limitations of these operations.
        • -
      • Also perhaps you ask yourself : \ref partition_explanation "What's the difference between partition, compounds and fuse operation ?"
        • +
      • Perhaps you also ask yourself : \ref partition_explanation "What's the difference between partition, compounds and fuse operation ?"
      To produce a \b Partition in the Main Menu select Operations - > Partition diff --git a/doc/salome/gui/GEOM/input/partition_explanation.doc b/doc/salome/gui/GEOM/input/partition_explanation.doc index 2725784af..5325b37e7 100644 --- a/doc/salome/gui/GEOM/input/partition_explanation.doc +++ b/doc/salome/gui/GEOM/input/partition_explanation.doc @@ -4,15 +4,15 @@ \tableofcontents -It is frequently asked about the difference between the above mentioned operations. It's indeed simple. Lets take the example of a cylinder and a box that you want to join together. +It is frequently asked about the difference between the above mentioned operations. It is indeed simple. Let us take the example of a cylinder and a box that you want to join together. \section sec1 Fuse -The \b fuse operation will make a single solid from the two given solids. It allows you to build complex models by putting simple shapes together. +The \b fuse operation will make a single solid from two given solids. It allows you to build complex models by putting simple shapes together. \image html fuse.png \section sec2 Partition -The \b partition operation will also connect the two solids but it will keep a face at the frontier (in brown on the picture below). The resulting shape will consist in two connected solids that share +The \b partition operation will also connect the solids but it will keep a face at the frontier (in brown in the picture below). The resulting shape will consist of two connected solids that share a face at their frontier. It means that this face is present only one time in the resulting shape and is a sub-shape of both the box and the cylinder. \n This operation allows you to identify different areas in a shape (e.g. different materials) and to ensure a conformal mesh when meshing it later. Indeed the face at the frontier is meshed only once. @@ -21,10 +21,10 @@ a face at their frontier. It means that this face is present only one time in th \section sec3 Compound -When you build a \b compound by using the build -> compound operation you just make an object that contains the two separate solids like in a "bag". +When you build a \b compound by using the Build -> Compound operation you just make an object that contains two separate solids like in a "bag". The two solids remain unconnected. The compound is just a set of shapes, no more. -\n The compound Allows applying operations to a collection of shapes. +\n The compound allows applying operations to a collection of shapes. \image html compound2.png @@ -42,7 +42,7 @@ In the frame of this example we can summarize the following differences:
    • \b Partition
      • \a Result : Two connected solids sharing faces.
        • -
      • \a Purpose : Useful to ensure a conformal mesh of separated areas of your model (fluid / solid , concrete / steel ...)
        • +
      • \a Purpose : Useful to ensure a conformal mesh of separate areas of your model (fluid / solid , concrete / steel ...).
    • \b Compound
        diff --git a/doc/salome/gui/GEOM/input/working_with_groups.doc b/doc/salome/gui/GEOM/input/working_with_groups.doc index a09865efa..99b98bac9 100644 --- a/doc/salome/gui/GEOM/input/working_with_groups.doc +++ b/doc/salome/gui/GEOM/input/working_with_groups.doc @@ -3,8 +3,8 @@ \page work_with_groups_page Working with groups Creation and editing groups of sub-shapes of a geometrical object makes -handling sub-shapes much easier. Also some Boolean operations on -groups are available. +handling sub-shapes much easier. Boolean operations on +groups are also available.
        • \ref create_groups_anchor "Create a Group"
          • @@ -142,7 +142,7 @@ The following dialog box will appear: \image html groups_union_dlg.png In this dialog box you should specify the name of the resulting group -and set of groups which will be united. +and select the groups, which will be united.
        • Click the \b Apply or Apply and Close button to confirm creation of the group.
          • @@ -155,7 +155,7 @@ and set of groups which will be united.

          Intersection of groups

          This operation allows to create a new group in such a way that only -sub-shapes that are present in all initial groups together are added to the +the sub-shapes that are present in all initial groups are added to the new one. To intersect groups: @@ -166,7 +166,7 @@ The following dialog box will appear: \image html groups_intersect_dlg.png In this dialog box you should specify the name of the resulting group -and set of groups which will be intersected. +and select the groups, which will be intersected.
        • Click the \b Apply or Apply and Close button to confirm creation of the group.
          • @@ -190,10 +190,9 @@ The following dialog box will appear: \image html groups_cut_dlg.png In this dialog box you should specify the name of the resulting group -and groups which will be cut. +and the groups which will be cut. -
        • Click the \b Apply or Apply and Close button to confirm creation of the -group.
          • +
        • Click the \b Apply or Apply and Close button to confirm creation of the group.
          • Our TUI Scripts provide you with useful examples of -- 2.39.2