Changeset 264 for trunk/SRC/ToBeReviewed/PLOTS/DESSINE/plt.pro

Timestamp:

08/22/07 16:30:29 (17 years ago)

Author:

pinsard

Message:

typo in some pro files

File:

• trunk/SRC/ToBeReviewed/PLOTS/DESSINE/plt.pro (modified) (9 diffs)

trunk/SRC/ToBeReviewed/PLOTS/DESSINE/plt.pro

@@ -2 +2 @@
 ;
 ; @file_comments
-; Draw horizontal graph (map) with CONTOUR procedure
+; Draw horizontal graph (map) with <proidl>CONTOUR</proidl> procedure
 ;
 ; @categories
@@ -35 +35 @@
 ; 6 elements: The extraction is made on Boxzoom
 ;
-; Where lon1, lon2,lat1,lat2 are global variables defined at the last 
+; Where lon1, lon2, lat1, lat2 are global variables defined at the last
 ; <pro>domdef</pro> !
 ;
 ; @keyword REALCONT
-; Allow to draw continents defined in IDL. REALCONT can have 2 form:
+; Allow to draw continents defined in IDL. REALCONT can have 2 forms:
 ;           /REALCONT: we draw continents in place of the mask
 ;           REALCONT=2 we draw continent's contour over the mask (this allows
@@ -66 +66 @@
 ;
 ; @keyword CONTNLEVEL {default=20}
-; When  CONTOUR is activated, it is the number of contours
+; When CONTOUR is activated, it is the number of contours
 ; traced by a trait for drawing (active if
 ; CONTLABEL=0)
@@ -73 +73 @@
 ; If we want to trace contours of a different field than the one
 ; whose we have the colored drawing (by example E-P in color and QSR in contours).
-; It must be a field respecting same characteristics than the argument number one of plt.
-;
-; @keyword GRIDTYPE 'U','T','V','W' or 'F' to specify possibly the grid on which the field is joined.
+; It must be a field respecting same characteristics than the argument number one of <pro>plt</pro>.
+;
+; @keyword GRIDTYPE
+; 'U','T','V','W' or 'F'
+; to specify possibly the grid on which the field is joined.
 ; Comment: In this case, we should use a structure like field.
 ;
 ; @keyword INTERVALLE
-; Value of an internal between to isoline. If there is none specified min,
-; we choose a min contour which goes well with the specified interval!. If this keyword is not
-; specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated,
-; INTERVALLE only specify the interval between 2 colored isoline. To specify the interval
+; Value of an interval between to isoline. If there is none specified min,
+; we choose a min contour which goes well with the specified interval!
+; If this keyword is not specified, we trace 20 isolines from the min
+; to the max.
+; Comment: When CONTOUR is activated, INTERVALLE only specify the interval
+; between 2 colored isolines. To specify the interval
 ; between 2 isolines traced by a trait, use CONTINTERVALLE.
 ;
@@ -98 +102 @@
 ; We use it when we want to do a projection.
 ; This keyword can be of two types:
-;     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of MAP_SET).
+;     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of <proidl>MAP_SET</proidl>).
 ;     /MAP: In this case, map is automatically calculated have the value:
 ;          map = [0, (lon1+lon2)/2., 0]
 ; Comment: A good way to choose the type of the projection we want to do is to have a look at IDL demo:
 ; IDL> demo
-; Then choose earth sciences and  mapping.
-; Comment2: By default it is a cylindrical projection which is effectuated (with or without the keyword map).
+; Then choose "earth sciences and mappinA"g
+; Comment2: By default it is a cylindrical projection which is done (with or without the keyword map).
 ; If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection.
 ; For example, for a polar projection centered on the south pole:
@@ -111 +115 @@
 ;
 ; @keyword LABMAP {default=labmap=1}
-; Corresponds to label keywords of map_set.
+; Corresponds to LABEL keyword of <proidl>MAP_SET</proidl>.
 ;
 ; @keyword MAXIN
@@ -124 +128 @@
 ;
 ; @keyword NLEVEL {default=20}
-; Number of contour to draw by default =20. active if
-; LABEL=0 or is not specified.
+; Number of contour to draw. Active if LABEL=0 or is not specified.
 ;
 ; @keyword NOFILL
@@ -152 +155 @@
 ; @keyword VECTEUR {type=struct}
 ; It is a structure composed by 2 elements containing the 2 fields U
-; and V of values of the zonal and meridian component of the vector of the fields
+; and V of values of the zonal and meridian components of the vector of the fields
 ; to draw. These fields can be an array or a structure.
 ;       For example: vecteur={matriceu:lec('unsurface'),matricev:lec('vnsurface')}
@@ -271 +274 @@
   IF  strupcase(vargrid) EQ 'W' THEN profond = firstzw NE 0 $
   ELSE profond = firstzt NE 0
-; do we need to extract now the triangulation that will be use for
+; do we need to extract now the triangulation that will be used for
 ; contouring the field?
   if keyword_set(profond) $