From 9e2d5798dc1800777805c11a37efd75571cf9982 Mon Sep 17 00:00:00 2001
From: Christophe Geuzaine <cgeuzaine@ulg.ac.be>
Date: Fri, 14 Nov 2003 21:20:55 +0000
Subject: [PATCH] Reworked the help strings for all the plugins. Easier to
understand, now, Sean? :-)
---
Common/DefaultOptions.h | 2 +-
Fltk/GUI.cpp | 12 ++++++------
Plugin/CutMap.cpp | 18 ++++++++++--------
Plugin/CutPlane.cpp | 8 +++++---
Plugin/CutSphere.cpp | 9 +++++----
Plugin/DecomposeInSimplex.cpp | 9 +++++----
Plugin/DisplacementRaise.cpp | 18 +++++++++++-------
Plugin/Harmonic2Time.cpp | 17 +++++++++--------
Plugin/Skin.cpp | 8 ++++----
Plugin/Smooth.cpp | 7 ++++---
Plugin/SphericalRaise.cpp | 19 ++++++++++---------
Plugin/Transform.cpp | 12 ++++++++----
Plugin/Triangulate.cpp | 10 ++++++----
13 files changed, 84 insertions(+), 65 deletions(-)
diff --git a/Common/DefaultOptions.h b/Common/DefaultOptions.h
index 4c987dcd7c..476eb9d099 100644
--- a/Common/DefaultOptions.h
+++ b/Common/DefaultOptions.h
@@ -83,7 +83,7 @@ StringXString SolverOptions_String[] = {
"Name of solver 0" },
{ F|O, "Help0" , opt_solver_help0 ,
"A General environment for the treatment of\nDiscrete Problems\n\n"
- "Copyright (c) 1997-2003\nPatrick Dular and Christophe Geuzaine\n\n"
+ "Copyright (C) 1997-2003\nPatrick Dular and Christophe Geuzaine\n\n"
"Visit http://www.geuz.org/getdp/ for more info",
"Help string for solver 0" },
{ F|O, "Executable0" , opt_solver_executable0 ,
diff --git a/Fltk/GUI.cpp b/Fltk/GUI.cpp
index 7d162bd401..a99e4db81b 100644
--- a/Fltk/GUI.cpp
+++ b/Fltk/GUI.cpp
@@ -1,4 +1,4 @@
-// $Id: GUI.cpp,v 1.248 2003-10-29 19:51:43 geuzaine Exp $
+// $Id: GUI.cpp,v 1.249 2003-11-14 21:20:54 geuzaine Exp $
//
// Copyright (C) 1997-2003 C. Geuzaine, J.-F. Remacle
//
@@ -2592,8 +2592,8 @@ PluginDialogBox *GUI::create_plugin_window(GMSH_Plugin * p)
// create window
- int width = 20 * fontsize;
- int height = ((n > 5 ? n : 5) + 2) * BH + 5 * WB;
+ int width = 26 * fontsize;
+ int height = ((n > 8 ? n : 8) + 2) * BH + 5 * WB;
PluginDialogBox *pdb = new PluginDialogBox;
pdb->main_window = new Fl_Window(width, height);
@@ -2631,8 +2631,8 @@ PluginDialogBox *GUI::create_plugin_window(GMSH_Plugin * p)
o->add("");
add_multiline_in_browser(o, "", help);
o->add("");
- add_multiline_in_browser(o, "Author(s): ", author);
- add_multiline_in_browser(o, "Copyright: ", copyright);
+ add_multiline_in_browser(o, "Author: ", author);
+ add_multiline_in_browser(o, "Copyright (C) ", copyright);
g->end();
}
@@ -2874,7 +2874,7 @@ void GUI::create_about_window()
o->add("@c@.A three-dimensional finite element mesh generator");
o->add("@c@.with built-in pre- and post-processing facilities");
o->add("");
- o->add("@c@.Copyright (c) 1997-2003");
+ o->add("@c@.Copyright (C) 1997-2003");
#if defined(__APPLE__)
o->add("@c@.Christophe Geuzaine and Jean-Francois Remacle");
#else
diff --git a/Plugin/CutMap.cpp b/Plugin/CutMap.cpp
index 5becc63538..78dde28c85 100644
--- a/Plugin/CutMap.cpp
+++ b/Plugin/CutMap.cpp
@@ -1,4 +1,4 @@
-// $Id: CutMap.cpp,v 1.30 2003-03-21 00:52:45 geuzaine Exp $
+// $Id: CutMap.cpp,v 1.31 2003-11-14 21:20:55 geuzaine Exp $
//
// Copyright (C) 1997-2003 C. Geuzaine, J.-F. Remacle
//
@@ -27,8 +27,8 @@ extern Context_T CTX;
StringXNumber CutMapOptions_Number[] = {
{GMSH_FULLRC, "A", NULL, 1.},
- {GMSH_FULLRC, "iView", NULL, -1.},
- {GMSH_FULLRC, "iField", NULL, 0.}
+ {GMSH_FULLRC, "iField", NULL, 0.},
+ {GMSH_FULLRC, "iView", NULL, -1.}
};
extern "C"
@@ -56,9 +56,11 @@ void GMSH_CutMapPlugin::getInfos(char *author, char *copyright,
strcpy(author, "J.-F. Remacle (remacle@scorec.rpi.edu)");
strcpy(copyright, "DGR (www.multiphysics.com)");
strcpy(help_text,
- "Extracts the isovalue surface of value A from a\n"
- "3D scalar map and draw ith component of the field on the iso.\n"
- "Script name: Plugin(CutMap).");
+ "Plugin(CutMap) extracts the isovalue surface of\n"
+ "value 'A' from the simplectic 3D scalar view\n"
+ "'iView' and draws the 'iField'-th component of\n"
+ "the field on the iso. If 'iView' < 0, the plugin\n"
+ "is run on the current view.\n");
}
int GMSH_CutMapPlugin::getNbOptions() const
@@ -88,8 +90,8 @@ Post_View *GMSH_CutMapPlugin::execute(Post_View * v)
{
Post_View *vv;
- int iView = (int)CutMapOptions_Number[1].def;
- _ith_field_to_draw_on_the_iso = (int)CutMapOptions_Number[2].def;
+ _ith_field_to_draw_on_the_iso = (int)CutMapOptions_Number[1].def;
+ int iView = (int)CutMapOptions_Number[2].def;
_orientation = ORIENT_MAP;
if(v && iView < 0)
diff --git a/Plugin/CutPlane.cpp b/Plugin/CutPlane.cpp
index d831d3b2b9..b3a43c06c0 100644
--- a/Plugin/CutPlane.cpp
+++ b/Plugin/CutPlane.cpp
@@ -1,4 +1,4 @@
-// $Id: CutPlane.cpp,v 1.26 2003-03-21 00:52:45 geuzaine Exp $
+// $Id: CutPlane.cpp,v 1.27 2003-11-14 21:20:55 geuzaine Exp $
//
// Copyright (C) 1997-2003 C. Geuzaine, J.-F. Remacle
//
@@ -58,8 +58,10 @@ void GMSH_CutPlanePlugin::getInfos(char *author, char *copyright,
strcpy(author, "J.-F. Remacle (remacle@scorec.rpi.edu)");
strcpy(copyright, "DGR (www.multiphysics.com)");
strcpy(help_text,
- "Cuts a 3D scalar view with the plane\n"
- "A*X + B*Y + C*Z + D = 0.\n" "Script name: Plugin(CutPlane).");
+ "Plugin(CutPlane) cuts the simplectic 3D scalar\n"
+ "view 'iView' with the plane 'A'*X + 'B'*Y + 'C'*Z +\n"
+ "'D' = 0. If 'iView' < 0, the plugin is run on the\n"
+ "current view.\n");
}
int GMSH_CutPlanePlugin::getNbOptions() const
diff --git a/Plugin/CutSphere.cpp b/Plugin/CutSphere.cpp
index eaf3c0197e..fc5d44c8c2 100644
--- a/Plugin/CutSphere.cpp
+++ b/Plugin/CutSphere.cpp
@@ -1,4 +1,4 @@
-// $Id: CutSphere.cpp,v 1.25 2003-03-21 00:52:45 geuzaine Exp $
+// $Id: CutSphere.cpp,v 1.26 2003-11-14 21:20:55 geuzaine Exp $
//
// Copyright (C) 1997-2003 C. Geuzaine, J.-F. Remacle
//
@@ -59,9 +59,10 @@ void GMSH_CutSpherePlugin::getInfos(char *author, char *copyright,
strcpy(author, "J.-F. Remacle (remacle@scorec.rpi.edu)");
strcpy(copyright, "DGR (www.multiphysics.com)");
strcpy(help_text,
- "Cuts a 3D scalar view with the sphere\n"
- "(X-Xc)^2 + (Y-Yc)^2 + (Z-Zc)^2 = R^2.\n"
- "Script name: Plugin(CutSphere).");
+ "Plugin(CutSphere) cuts the simplectic 3D scalar\n"
+ "view 'iView' with the sphere (X-'Xc')^2 + (Y-'Yc')^2 +\n"
+ "(Z-'Zc')^2 = 'R'^2. If 'iView' < 0, the plugin is\n"
+ "run on the current view.\n");
}
int GMSH_CutSpherePlugin::getNbOptions() const
diff --git a/Plugin/DecomposeInSimplex.cpp b/Plugin/DecomposeInSimplex.cpp
index bb6957d8c0..83d26b65d4 100644
--- a/Plugin/DecomposeInSimplex.cpp
+++ b/Plugin/DecomposeInSimplex.cpp
@@ -1,4 +1,4 @@
-// $Id: DecomposeInSimplex.cpp,v 1.1 2003-06-18 20:47:41 geuzaine Exp $
+// $Id: DecomposeInSimplex.cpp,v 1.2 2003-11-14 21:20:55 geuzaine Exp $
//
// Copyright (C) 1997-2003 C. Geuzaine, J.-F. Remacle
//
@@ -57,9 +57,10 @@ void GMSH_DecomposeInSimplexPlugin::getInfos(char *author, char *copyright,
strcpy(author, "C. Geuzaine (geuz@geuz.org)");
strcpy(copyright, "DGR (www.multiphysics.com)");
strcpy(help_text,
- "Decompose any non-simplectic elements in\n"
- "the view into simplices.\n"
- "Script name: Plugin(DecomposeInSimplex).\n");
+ "Plugin(DecomposeInSimplex) decomposes any non-\n"
+ "simplectic element in the view 'iView' into\n"
+ "simplices. If 'iView' < 0, the plugin is run on\n"
+ "the current view.\n");
}
int GMSH_DecomposeInSimplexPlugin::getNbOptions() const
diff --git a/Plugin/DisplacementRaise.cpp b/Plugin/DisplacementRaise.cpp
index 9739c0abc8..dba86725f9 100644
--- a/Plugin/DisplacementRaise.cpp
+++ b/Plugin/DisplacementRaise.cpp
@@ -1,4 +1,4 @@
-// $Id: DisplacementRaise.cpp,v 1.3 2003-11-13 19:42:04 geuzaine Exp $
+// $Id: DisplacementRaise.cpp,v 1.4 2003-11-14 21:20:55 geuzaine Exp $
//
// Copyright (C) 1997-2003 C. Geuzaine, J.-F. Remacle
//
@@ -60,12 +60,16 @@ void GMSH_DisplacementRaisePlugin::getInfos(char *author, char *copyright,
strcpy(author, "C. Geuzaine (geuz@geuz.org)");
strcpy(copyright, "DGR (www.multiphysics.com)");
strcpy(help_text,
- "DisplacementRaise transforms the coordinates\n"
- "of the elements in a view (iView) according\n"
- "to the vectorial values (the displacements)\n"
- "associated with the elements of another\n"
- "view (dView).\n"
- "Script name: Plugin(DisplacementRaise).");
+ "Plugin(DisplacementRaise) transforms the\n"
+ "coordinates of the elements in the view 'iView'\n"
+ "according to the vectorial values (the\n"
+ "displacements) associated with the elements of\n"
+ "another view ('dView', using the time step\n"
+ "'TimeStep'). If 'iView' < 0, the plugin is run\n"
+ "on the current view. If 'dview' is less than\n"
+ "zero, the plugin looks for the displacements\n"
+ "in the view located just after 'iView' in the\n"
+ "view list.\n");
}
int GMSH_DisplacementRaisePlugin::getNbOptions() const
diff --git a/Plugin/Harmonic2Time.cpp b/Plugin/Harmonic2Time.cpp
index 571f6caa99..20fe724ec9 100644
--- a/Plugin/Harmonic2Time.cpp
+++ b/Plugin/Harmonic2Time.cpp
@@ -1,4 +1,4 @@
-// $Id: Harmonic2Time.cpp,v 1.5 2003-06-18 20:47:41 geuzaine Exp $
+// $Id: Harmonic2Time.cpp,v 1.6 2003-11-14 21:20:55 geuzaine Exp $
//
// Copyright (C) 1997-2003 C. Geuzaine, J.-F. Remacle
//
@@ -60,13 +60,14 @@ void GMSH_Harmonic2TimePlugin::getInfos(char *author, char *copyright,
strcpy(author, "C. Geuzaine (geuz@geuz.org)");
strcpy(copyright, "DGR (www.multiphysics.com)");
strcpy(help_text,
- "Harmonic2Time takes the values in the time\n"
- "steps 'realPart' and 'imaginaryPart' of the\n"
- "view 'iView', and creates a new view\n"
- "containing 'iView[realPart] * cos(p) -\n"
- "iView[imaginaryPart] * sin(p)', with\n"
- "'p=2*pi*k/nbSteps', 'k=0...nbSteps'\n"
- "Script name: Plugin(Harmonic2Time).");
+ "Plugin(Harmonic2Time) takes the values in the\n"
+ "time steps 'realPart' and 'imaginaryPart' of\n"
+ "the view 'iView', and creates a new view\n"
+ "containing ('iView'['realPart'] * cos(p) -\n"
+ "'iView'['imaginaryPart'] * sin(p)), with\n"
+ "p = 2*Pi*k/'nbSteps', k = 0, ..., 'nbSteps'-1.\n"
+ "If 'iView' < 0, the plugin is run on the\n"
+ "current view.\n");
}
int GMSH_Harmonic2TimePlugin::getNbOptions() const
diff --git a/Plugin/Skin.cpp b/Plugin/Skin.cpp
index 6c934f278e..b194fa6353 100644
--- a/Plugin/Skin.cpp
+++ b/Plugin/Skin.cpp
@@ -1,4 +1,4 @@
-// $Id: Skin.cpp,v 1.17 2003-03-21 00:52:46 geuzaine Exp $
+// $Id: Skin.cpp,v 1.18 2003-11-14 21:20:55 geuzaine Exp $
//
// Copyright (C) 1997-2003 C. Geuzaine, J.-F. Remacle
//
@@ -56,9 +56,9 @@ void GMSH_SkinPlugin::getInfos(char *author, char *copyright, char *help_text) c
strcpy(author, "C. Geuzaine (geuz@geuz.org)");
strcpy(copyright, "DGR (www.multiphysics.com)");
strcpy(help_text,
- "Gets the skin (i.e. the boundary) of a view,\n"
- "eliminating all interior drawing.\n"
- "Script name: Plugin(Skin).\n");
+ "Plugin(Skin) extracts the skin (the boundary) of\n"
+ "the scalar view 'iView'. If 'iView' < 0, the plugin\n"
+ "is run on the current view.\n");
}
int GMSH_SkinPlugin::getNbOptions() const
diff --git a/Plugin/Smooth.cpp b/Plugin/Smooth.cpp
index 6326861cd9..74ca030208 100644
--- a/Plugin/Smooth.cpp
+++ b/Plugin/Smooth.cpp
@@ -1,4 +1,4 @@
-// $Id: Smooth.cpp,v 1.13 2003-03-21 00:52:46 geuzaine Exp $
+// $Id: Smooth.cpp,v 1.14 2003-11-14 21:20:55 geuzaine Exp $
//
// Copyright (C) 1997-2003 C. Geuzaine, J.-F. Remacle
//
@@ -56,8 +56,9 @@ void GMSH_SmoothPlugin::getInfos(char *author, char *copyright,
strcpy(author, "C. Geuzaine (geuz@geuz.org)");
strcpy(copyright, "DGR (www.multiphysics.com)");
strcpy(help_text,
- "Smoothes a discontinuous view by averaging all the values at each node.\n"
- "Script name: Plugin(Smooth).");
+ "Plugin(Smooth) averages the values at the nodes\n"
+ "of the scalar view 'iView'. If 'iView' < 0, the\n"
+ "plugin is run on the current view.\n");
}
int GMSH_SmoothPlugin::getNbOptions() const
diff --git a/Plugin/SphericalRaise.cpp b/Plugin/SphericalRaise.cpp
index cf7d17f5c2..7308993bf9 100644
--- a/Plugin/SphericalRaise.cpp
+++ b/Plugin/SphericalRaise.cpp
@@ -1,4 +1,4 @@
-// $Id: SphericalRaise.cpp,v 1.6 2003-03-21 00:52:46 geuzaine Exp $
+// $Id: SphericalRaise.cpp,v 1.7 2003-11-14 21:20:55 geuzaine Exp $
//
// Copyright (C) 1997-2003 C. Geuzaine, J.-F. Remacle
//
@@ -61,14 +61,15 @@ void GMSH_SphericalRaisePlugin::getInfos(char *author, char *copyright,
strcpy(author, "C. Geuzaine (geuz@geuz.org)");
strcpy(copyright, "DGR (www.multiphysics.com)");
strcpy(help_text,
- "SphericalRaise transforms the coordinates\n"
- "of the elements in a view according to the\n"
- "elements' associated values. Instead of\n"
- "transforming the coordinates along the X,\n"
- "Y, Z axes (as in Options->Offset->Raise),\n"
- "the raise is applied along the radius of\n"
- "a sphere centered at (Xc, Yc, Zc).\n"
- "Script name: Plugin(SphericalRaise).");
+ "Plugin(SphericalRaise) transforms the coordinates\n"
+ "of the elements in the view 'iView' according to\n"
+ "the elements' associated values. Instead of\n"
+ "elevating the nodes along the X, Y and Z axes\n"
+ "as in View['iView'].RaiseX, View['iView'].RaiseY\n"
+ "and View['iView'].RaiseZ, the raise is applied\n"
+ " along the radius of a sphere centered at ('Xc',\n"
+ "'Yc', 'Zc'). If 'iView' < 0, the plugin is run on\n"
+ "the current view.\n");
}
int GMSH_SphericalRaisePlugin::getNbOptions() const
diff --git a/Plugin/Transform.cpp b/Plugin/Transform.cpp
index 2a01d65448..4634e36b13 100644
--- a/Plugin/Transform.cpp
+++ b/Plugin/Transform.cpp
@@ -1,4 +1,4 @@
-// $Id: Transform.cpp,v 1.16 2003-03-21 00:52:46 geuzaine Exp $
+// $Id: Transform.cpp,v 1.17 2003-11-14 21:20:55 geuzaine Exp $
//
// Copyright (C) 1997-2003 C. Geuzaine, J.-F. Remacle
//
@@ -65,9 +65,13 @@ void GMSH_TransformPlugin::getInfos(char *author, char *copyright,
strcpy(author, "C. Geuzaine (geuz@geuz.org)");
strcpy(copyright, "DGR (www.multiphysics.com)");
strcpy(help_text,
- "Transforms a view by the matrix\n"
- "[ [A11 A12 A13] [A21 A22 A23] [A31 A32 A33] ].\n"
- "Script name: Plugin(Transform).");
+ "Plugin(Transforms) transforms the coordinates\n"
+ "of the nodes of the view 'iView' by the matrix\n"
+ "['A11' 'A12' 'A13']\n"
+ "['A21' 'A22' 'A23']\n"
+ "['A31' 'A32' 'A33'].\n"
+ "If 'iView' < 0, the plugin is run on the current\n"
+ "view.\n");
}
int GMSH_TransformPlugin::getNbOptions() const
diff --git a/Plugin/Triangulate.cpp b/Plugin/Triangulate.cpp
index 750570e306..81b43ec9a6 100644
--- a/Plugin/Triangulate.cpp
+++ b/Plugin/Triangulate.cpp
@@ -1,4 +1,4 @@
-// $Id: Triangulate.cpp,v 1.11 2003-03-21 00:52:46 geuzaine Exp $
+// $Id: Triangulate.cpp,v 1.12 2003-11-14 21:20:55 geuzaine Exp $
//
// Copyright (C) 1997-2003 C. Geuzaine, J.-F. Remacle
//
@@ -63,9 +63,11 @@ void GMSH_TriangulatePlugin::getInfos(char *author, char *copyright,
strcpy(author, "C. Geuzaine (geuz@geuz.org)");
strcpy(copyright, "DGR (www.multiphysics.com)");
strcpy(help_text,
- "Triangulates a scalar point view\n"
- "and outputs a scalar triangle view.\n"
- "Script name: Plugin(Triangulate).\n");
+ "Plugin(Triangulate) triangulates the points\n"
+ "in the scalar view 'iView', assuming that all\n"
+ "the points belong to a surface than can be\n"
+ "univoquely projected into a plane. If 'iView'\n"
+ "< 0, the plugin is run on the current view.\n");
}
int GMSH_TriangulatePlugin::getNbOptions() const
--
GitLab