Salome HOME
refs #676: repairing of the documentation system and help
[modules/hydro.git] / doc / salome / gui / HYDRO / input / profile.doc
diff --git a/doc/salome/gui/HYDRO/input/profile.doc b/doc/salome/gui/HYDRO/input/profile.doc
new file mode 100644 (file)
index 0000000..a51466e
--- /dev/null
@@ -0,0 +1,48 @@
+
+/**
+  @file
+  \brief Help for profile
+*/
+
+/**
+  \page p_profile Profile
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+  
+The profile is used for definition of a stream cross-section or as a base of extrusion to generate a channel or digue.
+
+The 2D profiles are built/defined in a 2D space (U, Z). The coordinate U is parametric coordinate, it has no unit. The coordinate Z is real altitude (in meters). 
+
+To build 2D profile Use function
+
+  - \ref create_profile  "Create profile".
+
+
+2D profile object is internal data model object and can not be shown in OCC viewer. 2D profile  names are colored in red in object browser.
+
+
+
+Created 2D profiles should be positioned in 3D space using Georeferencement to be converted into 3D profiles:
+
+- \ref georeferencement_profile  "Profile georeferencement".
+
+
+3D profile is 3D  wire describing profile curve in 3d space.
+3D profile names are colored in black in object browser.
+
+
+Both 2D and 3D profiles can be imported from external file:
+    - \ref import_profile  "Import profile"
+ <a href="index.html"><b>Back to Main page.</b></a>
+  
+*/
+
+
+
+
+