]> SALOME platform Git repositories - modules/visu.git/commitdiff
Salome HOME
Fix documentation warnings V5_1_main_20091125
authorvsr <vsr@opencascade.com>
Tue, 24 Nov 2009 11:42:42 +0000 (11:42 +0000)
committervsr <vsr@opencascade.com>
Tue, 24 Nov 2009 11:42:42 +0000 (11:42 +0000)
doc/salome/gui/VISU/input/3d_presentations.doc
doc/salome/gui/VISU/input/cut_lines.doc
doc/salome/gui/VISU/input/importing_med_objects.doc
doc/salome/gui/VISU/input/med_object.doc
doc/salome/gui/VISU/input/slider.doc
doc/salome/gui/VISU/input/sweeping.doc
doc/salome/gui/VISU/input/table_presentations.doc
doc/salome/gui/VISU/input/viewing_3d_presentations.doc

index e5b70335854a7bc0d18a9acade119560df1fcbf7..701400dfe3a397f213dc15690d7c4d2ce34e7056 100755 (executable)
@@ -4,7 +4,7 @@
 
 \image html introduction.png "Example of a 3D presentation"
 
-\b Post Pro module provides several types of 3D presentations,
+\b Post-Pro module provides several types of 3D presentations,
 visualizing the structure of MED objects. All
 presentations can be seen only in Salome VTK Viewer (ALT+K).
 \n All presentation types could be divided in two main groups:
@@ -14,6 +14,6 @@ presentations can be seen only in Salome VTK Viewer (ALT+K).
 </ul>
 
 Created presentations can be edited, animaded, recorded and viewed in
-different modes. The whole range of such operations is described in \subpage 3d_management_page "Managment of presentations" section.
+different modes. The whole range of such operations is described in \subpage a3d_management_page "Managing 3D Presentations" section.
 
-*/
\ No newline at end of file
+*/
index a119a75fb83b510a809ac92c1f04d65c9e2d9bf5..c5d156f53104c807a6cbd850611d62f4a3265e99 100644 (file)
@@ -77,10 +77,10 @@ the viewer:
 <b>Tip:</b> From <b>Cut Lines</b> presentation you can create a
 <b>data table</b>. This table will consist of the field scalar values
 located on each cut line of the constructed presentation (see also:
-\ref creating_tables_from_cut_lines_page "Creating tables from Cut
-Lines presentations"). After that your data table can be used for
+\ref creating_tables_from_cut_lines "Creating tables from CutLines presentations").
+After that your data table can be used for
 construction of a 2d plot of curves based on the scalar values from
 the table (see also: \ref creating_curves_page "Creating curves" and 
 \ref creating_plot2d_page "Creating Plot 2D presentation").
 
-*/
\ No newline at end of file
+*/
index e6a53c315efccd391067995dcc395ecf6c2ce553..5aa758cf1431d8b9bb24a4e1301b704817a4cf9c 100644 (file)
@@ -2,8 +2,9 @@
 
 \page importing_med_objects_page Import/Export MED objects
 
-\n There exist two sources of \ref structure_of_med_objects_page "MED objects": MED and other Salome
-components publishing them and MED files.
+There are two sources of \ref med_object_page "MED objects":
+- MED and other SALOME components publishing them MED objects
+- MED files
 
 <em>To load MED objects from other components:</em>
 \par
@@ -87,4 +88,4 @@ path and change the name of the exported MED file:
 
 To complete file export click <b>Save</b>.
 
-*/
\ No newline at end of file
+*/
index a6791f42a14f71829aaeeaee80e0fe9d6bd8bf09..268bb51ef22774d1fa0bed02210ef171f4812ff2 100755 (executable)
@@ -5,20 +5,20 @@
 \b MED \b Object is a specific twofold data structure
 with consists of \b  Mesh \b Data and \b Physical \b Data.
 
-\b  Mesh \b Data includes geometrical information: list of nodes, edges, faces and cells
+- \b Mesh \b Data includes geometrical information: list of nodes, edges, faces and cells
 of the mesh, and information on the interpolation in accordance with resulting
-elements, i.e. the mesh should be compatible with the chosen interpolation;</em></li>
-\b Physical \b Data contains initial and boundary conditions: scalar
+elements, i.e. the mesh should be compatible with the chosen interpolation.
+\b Physical \b Data contains initial and boundary conditions: scalar
 or vector values applied to the mesh cells.
 
-\n It is not possible to create and edit \b MED \b Objects in the \b
+It is not possible to create and edit \b MED \b Objects in the \b
 Post-Pro module. You can only \subpage importing_med_objects_page
 "import a MED object" from Salome MED module or from a MED file.
 
-\n \b MED Objects can be visualized and explored with various types of
+\b MED Objects can be visualized and explored with various types of
 \subpage a3d_presentations_page "3D presentations".
 
-\n \b Post-Pro visualization engine bases on VTK and OpenGL
+\b Post-Pro visualization engine bases on VTK and OpenGL
 technologies, which provide useful tools for 
 \subpage a3d_management_page "Management of presentations".
 
@@ -33,7 +33,7 @@ containing three main folders: \ref families_anchor "Families",
 <h2>Families</h2>
 
 A \b Family is a user-defined submesh composed of cells of a
-definite type  - Nodes, Edges, Faces or Cells</em>. The
+definite type  - Nodes, Edges, Faces or Cells. The
 presentation created on the basis of a particular \b family will be
 composed of geometrical elements, corresponding to the type of cells
 of this \b family.
index bf2f4cc3b0bab261b1a9b51e012a01249467cc18..811cb2899a1a3f79e96353b1bce883283457e581 100755 (executable)
@@ -43,15 +43,13 @@ of the timestamps. </li>
 \image html slider2.png
 
 \b Properties tab allows setting memory management properties.
-<ul>
-<li> \b Minimal radio button commands the application to use a minimum
-amount of memory</li>
-<li> \b Limited radio button allows to set the upper limit for the
-amount of used memory.</li>
-<li> \b Used  and \b Free fields allow to set target values for used
-and free memory.</li>
-<li> \b Speed scroll allows to set the speed of the presentation.</li>
-<ul>
 
+- \b Minimal radio button commands the application to use a minimum
+  amount of memory
+- \b Limited radio button allows to set the upper limit for the amount
+  of used memory
+- \b Used  and \b Free fields allow to set target values for used and
+  free memory.
+- \b Speed scroll allows to set the speed of the presentation.
 
-*/
\ No newline at end of file
+*/
index cd243d2241af69a60a753582fd3730c656507b64..298c5a0827ef52516262b13adfcdf5a1d4abf292 100644 (file)
@@ -20,7 +20,7 @@ displaying the \em basic field presentation will end it.
 
 <em>To sweep a field presentation:</em>
 
-\ref creating_field_presentations_page "Create a field presentation".
+\ref field_presentations_page "Create a field presentation".
  
 In the Main menu select <b>View -> Windows -> Sweep</b>. The following
 dialog will appear.
@@ -54,4 +54,4 @@ viewer and selecting \b Sweep in the context menu.
 Default parameters for \b Sweep can be set in the Main menu in <b>File
 -> Preferences -> Post-Pro -> Sweep, Animation</b> tab
 
-*/
\ No newline at end of file
+*/
index 3a57a993dcfa6f06aaef8bcb6578ea385aaacab2..82dc0c9644e2597da4d8df3cbab0d9c353d3e1d2 100644 (file)
@@ -4,7 +4,7 @@
 
 <b>DataTable object</b> is a way to represent a two-dimensional data array
 (data arranged in rows and columns) in Salome. Each column groups values expressed in certain measurement \b units.
-All \b columns and <b>rows</b>  have  </b>titles</b>. Tables can be \b
+All \b columns and <b>rows</b>  have  <b>titles</b>. Tables can be \b
 rarefied, which means that some cells may be empty, without any
 values.
 
@@ -13,6 +13,8 @@ special programming API (this problem lies out of the scope of Salome
 GUI Help), or \subpage importing_exporting_tables_page "imported"
 from properly defined ACSII files. 
 
+\anchor creating_tables_from_cut_lines
+
 \note Alternatively, it is possible to  create a table from
 the scalar values applied to the cells forming a \ref cut_lines_page "Cut Lines"
 or a \ref cut_segment_page "Cut Segment" presentation. Simply right-click on the 
@@ -36,4 +38,4 @@ Plot 2D viewer is described in the documentation on GUI module.
  
 
 
-*/
\ No newline at end of file
+*/
index b4545de605e2ecb19761fe6e01c4ae68cd5bfe76..fb116a68cc02cd850e0ddc226961bb27a1982211 100644 (file)
@@ -2,10 +2,11 @@
 
 \page viewing_3d_presentations_page Viewing 3D presentations
 
-\n Each  newly created presentation is displayed in the <b>VTK 3D
+Each  newly created presentation is displayed in the <b>VTK 3D
 Viewer</b>. <b>VTK 3D Viewer</b> is described in details in the
 documentation on GUI module.
-\n To display an existing presentation, right-click on it in the
+
+To display an existing presentation, right-click on it in the
 Object Browser and select \b Show.
 
 \image html viewing3.png
@@ -19,144 +20,114 @@ options:
 visualization and NOT all properties can be set for a certain 3D
 presentation.
 
-\anchor filter_by_scalars_anchor
+- <b>Hide all</b> - allows to hide all objects from the
+viewer.
+
+- <b>Edit</b> - allows to return to the menu, where the presentation
+has been created and change its parameters.
 
-<ul>
-<li><b>Hide all</b> - allows to hide all objects from the
-viewer.</li>
-<li><b>Edit</b> - allows to return to the menu, where the presentation
-has been created and change its parameters.</li>
-<li><b>Filter by Scalars</b> - allows showing only the cells with
-values that fit into the defined <b>Scalar Range</b>.
+- \anchor filter_by_scalars_anchor <b>Filter by Scalars</b> - allows
+showing only the cells with values that fit into the defined
+<b>Scalar Range</b>.
 
 \image html viewing2.png
 
-In this menu, check in <b>Filter by scalar range</b> box and input
-the minimum and the maximum values for the <b>Scalar Range</b></li>
+In the dialog box, check in <b>Filter by scalar range</b> box and input
+the minimum and the maximum values for the <b>Scalar Range</b>.
 
 \image html viewing4.png 
 
-\anchor rename_anchor
-
-<li><b>Rename</b> - allows to rename the presentation.</li>
-<li><b>Copy</b> - allows to create a copy of the presentation in the
-same subfolder (time stamp) in the Object Browser.</li>
+- \anchor rename_anchor <b>Rename</b> - allows to rename the presentation.
+- <b>Copy</b> - allows to create a copy of the presentation in the
+same subfolder (time stamp) in the Object Browser.
 
-<li><b>Hide</b> - allows to hide the selected presentation from the
-viewer.</li>
-<li>If selected in the Object Browser, <b>Hide</b> is replaced by
-<b>Show</b>, which allows to display the selected presentation in the
-viewer.</li>
-
-<li><b>Values Labeling</b> allows to display values applied to the
+- <b>Values Labeling</b> allows to display values applied to the
 cells or nodes of a 3D presentation.
 
 \image html values_labeling.png
-</li>
 
 \anchor labeling_parameters_anchor
 
-<li><b>Labeling Parameters</b> allows to change such labeling parameters as font and color.
+<b>Labeling Parameters</b> allows to change such labeling parameters as font and color.
 
 \image html labeling_parameters.png
 
-</li>
-
-<li><b>Show Only</b> - allows to display only the selected
-presentation, hiding all other from the viewer.</li>
-<li><b>Hide Scalar Bar</b>/<b>Show Scalar Bar</b> - allows to show/hide the scalar bar
-attached to the 3d presentation.</li>
-<li><b>Representation</b> - allows to switch among the available
-representation types.
-
-\image html viewing10.png 
-
-</ul>
-
-\image html viewing5.png "Points"
-
-\image html viewing6.png "Surface" 
-
-\image html viewing7.png "Wireframe"
-
-\image html viewing8.png "Insideframe - displays the wires lying within the object"
-
-\image html viewing9.png "Surfaceframe - displays wires and cells lying on the object surface" 
-
-\image html viewing11.png "Feature edges - shows the contour of the object" 
-
-\image html viewing12.png "Shrink"
-
-<b>Shading on</b> - colors the object in a realistic
-way, revealing its geometry, for example, by applying shadows to the inside regions; used together with \b Surface.
-
-<b>Shading off</b> - colors the object basing only on scalar values. </li>
-
-\anchor width_opacity_anchor
-<ul>
-<li><b>2D Quadratic</b> - allows to choose how the quadratic elements
-are visualized: as straight lines or as arcs of circle.</li>
+- <b>Hide</b> - allows to hide the selected presentation from the
+viewer.
+- If selected in the Object Browser, <b>Hide</b> is replaced by
+<b>Show</b>, which allows to display the selected presentation in the
+viewer.
+- <b>Show Only</b> - allows to display only the selected
+presentation, hiding all other from the viewer.
+
+- <b>Hide Scalar Bar</b>/<b>Show Scalar Bar</b> - allows to show/hide the scalar bar
+attached to the 3d presentation.
+
+- <b>Representation</b> - allows to switch among the available
+representation types.\n\n\image html viewing10.png 
+  - <b>Points</b> \image html viewing5.png
+  - <b>Surface</b> \image html viewing6.png
+  - <b>Wireframe</b> \image html viewing7.png
+  - <b>Insideframe</b> - displays the wires lying within the object \image html viewing8.png
+  - <b>Surfaceframe</b> - displays wires and cells lying on the object surface \image html viewing9.png
+  - <b>Feature edges</b> - shows the contour of the object \image html viewing11.png
+  - <b>Shrink</b> \image html viewing12.png
+  - <b>Shading on</b> - colors the object in a realistic way,
+    revealing its geometry, for example, by applying shadows to the
+    inside regions; used together with \b Surface.
+  - <b>Shading off</b> - colors the object basing only on scalar values.
+
+- <b>2D Quadratic</b> - allows to choose how the quadratic elements
+are visualized: as straight lines or as arcs of circle.
 
 \image html quadratic.png
 
-<li>\b Properties</li>
-
-<ul>
-<li>\b Opacity - allows to set the value of opacity of the
-presentation between 0 (transparent) and 100 (opaque).
-\note For a \ref gauss_points_presentations_page "Gauss Points"
-presentation, displayed using <b>Point Sprites</b> or <b>OpenGL Points</b>
-\ref primitive_types_page "primitives", this property only allows
-switching between transparent and opaque modes. The textures are drawn
-in the opaque mode if the opacity is equal to 100% and in
-the transparent mode if the opacity is lower that 100% (note that
-they become invisible when the opacity is equal to 0%).
-</li>
-
-\image html viewing13.png 
-
-<li><b>Line Width</b> - allows to set the width of lines representing
-edges of the presentation between 1 (thin) and 100 (thick).</li>
-
-\image html line_width.png
-
-<li><b>Shrink Factor</b> - allows to set the shrink factor of the
-presentation to be used in \b Shrink mode. Possible values range
-between 20 and 100, the default value is 80.</li>
-
-\image html shrink_factor.png
-
-<li><b>Edge Color</b> - allows to set the color of lines representing
-the edges of the presentation displayed in SurfaceFrame mode</li> 
-
-</ul>
-<li>\ref translate_presentation_page "Translate Presentation" - allows
-to translate the presentation along coordinate axes.</li>
-<li>\ref clipping_page "Clipping Planes" - allows to create
-cross-section views of presentations.</li>
-<li>\ref sweeping_page "Sweep" - allows to display pseudo-animation of
-the presentation.</li>
-
-<li><b>Dump view</b> - exports an object from the viewer in bmp, png,
-jpg or jpeg image format.</li>
-<li><b>Change Background</b> - allows to change the properties of the
-background.</li>
-<li><b>View Operations</b> checkbox - shows or hides the VTK viewer
+- \b Properties
+  - \b Opacity - allows to set the value of opacity of the
+  presentation between 0 (transparent) and 100 (opaque).
+  \note For a \ref gauss_points_presentations_page "Gauss Points"
+  presentation, displayed using <b>Point Sprites</b> or <b>OpenGL
+  Points</b> \ref primitive_types_page "primitives", this property
+  only allows switching between transparent and opaque modes. The
+  textures are drawn in the opaque mode if the opacity is equal to
+  100% and in the transparent mode if the opacity is lower that 100%
+  (note that they become invisible when the opacity is equal to
+  0%).\n\n \image html viewing13.png
+  - <b>Line Width</b> - allows to set the width of lines representing
+    edges of the presentation between 1 (thin) and 100 (thick).\n\n
+    \image html line_width.png
+  - <b>Shrink Factor</b> - allows to set the shrink factor of the
+  presentation to be used in \b Shrink mode. Possible values range
+  between 20 and 100, the default value is 80.\n\n \image html
+  shrink_factor.png
+  - <b>Edge Color</b> - allows to set the color of lines representing
+  the edges of the presentation displayed in SurfaceFrame mode.
+
+- \ref translate_presentation_page "Translate Presentation" - allows
+to translate the presentation along coordinate axes.
+- \ref clipping_page "Clipping Planes" - allows to create
+cross-section views of presentations.
+- \ref sweeping_page "Sweep" - allows to display pseudo-animation of
+the presentation.
+
+- <b>Dump view</b> - exports an object from the viewer in bmp, png,
+jpg or jpeg image format.
+- <b>Change Background</b> - allows to change the properties of the
+background.
+
+- <b>View Operations</b> checkbox - shows or hides the VTK viewer
 toolbar. The information about the VTK viewer functionalities is
-available in the documentation on the GUI module.</li>
-<li><b>Recording operations</b> checkbox - shows or hides buttons used
-for \ref recording_page "Recording" </li>
+available in the documentation on the GUI module.
+<b>Recording operations</b> checkbox - shows or hides buttons used
+for \ref recording_page "Recording".
 
-<li>The following menu items are added when the presentation is
-selected in the Object Browser</li>.
-<ul>
-<li> \b Delete - removes the presentation from the study.</li>
-<li> \b Refresh - updates the presentation in the VTK viewer </li>
-<li> \b Find - activates <b> Find Tool</b> described in the documentation
-on GUI module. </li>
+The following menu items are added when the presentation is
+selected in the Object Browser.
 
-</ul>
-</ul>
+- \b Delete - removes the presentation from the study.
+- \b Refresh - updates the presentation in the VTK viewer.
+- \b Find - activates <b> Find Tool</b> described in the documentation
+  on GUI module.
 
 When you create several presentations of the same object, you may wish
 to see them simultaneously,  which might be impossible, because they
@@ -173,17 +144,18 @@ In \b Auto mode you specify along which \b Axis and at which
 In \b Manual mode you set the coordinates for each presentation
 separately.
 
-<br>
 Displaying several presentations at the same time may cause
 superposition of their scalar bars. To avoid this, check <b>Arrange
 Scalar Bars</b> radio button  in the <b>Preferences -> Post-Pro ->
 Scalar Bar</b>. A separate scalar bar will be displayed for each
 presentation.
-\n Alternatively you may wish to merge the scalar bars to have a
+
+Alternatively you may wish to merge the scalar bars to have a
 common scalar bar for all presentations. To do this, select several
 presentations or fields in the object browser, right-click and from
 the pop-up menu select <b>Merge Scalar Range</b>.
-\n To restore separate bars and scales for each module select <b>Use
+
+To restore separate bars and scales for each module select <b>Use
 Field Range</b> from the same menu.
 
 */