Changeset 163 for trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltz.pro

Timestamp:

08/29/06 14:59:46 (18 years ago)

Author:

navarro

Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:

• trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltz.pro (modified) (7 diffs)

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

@@ -16 +16 @@
 ;         If the field is 3d, we extract the section on we average possibly before to do the plot.
 ;         2)  a structure respecting all criterions specified by litchamp.pro. 
-;          See IDL> xhelp,'litchamp'. The array contin in the structure must be 2 or 3d (See case 1)
+;          See IDL> xhelp,'litchamp'. The array contained in the structure must be 2 or 3d (See case 1)
 ;
 ; ces arguments ne sont pas obligatoires:
@@ -44 +44 @@
 ; If this keyword is not specified, we trace 20 isolines from the min to the max. 
 ;
-; @keyword CONTLABEL 
-; It is an integer n. When CONTOUR is actvated, if n
+; @keyword CONTLABEL {type=integer}
+; When CONTOUR is activated, if n
 ; is different of 0, choose the label type corresponding to n cases for 
 ; the traced by a traitisolines. To specify the type of label of the 
 ; colored contour, use LABEL
 ;
-; @keyword CONTMAX 
+; @keyword CONTMAX {default=max of the keyword CONTOUR (on ocean points)}
 ; When CONTOUR is activated, max value we want to consider in the isoline 
-; traced by a trait's line. By default, we take the max (on ocean points) of the array 
-; passed in the keyword CONTOUR.
-;
-; @keyword CONTMIN 
+; traced by a trait's line.
+;
+; @keyword CONTMIN {default=min of the keyword CONTOUR (on ocean points)}
 ; When CONTOUR is activated, min value we want to consider in the isoline 
-; traced by a trait's line. By default, we take the min (on ocean points) of the array 
-; passed in the keyword CONTOUR. 
-;
-; @keyword CONTNLEVEL 
-; When  CONTOUR is activated, it is the numbre of contours
+; traced by a trait's line. 
+;
+; @keyword CONTNLEVEL {default=20}
+; When  CONTOUR is activated, it is the number of contours
 ; traced by a trait for drawing (active if
-; CONTLABEL=0) by default=20.
+; CONTLABEL=0).
 ;
 ; @keyword CONTOUR 
 ; If we want to trace contours of a different field than the one 
-; whose we have the colored drawing (by examlpe E-P in color and QSR in contours). 
-; It must be a field respecting same caracteristics than the argument number one of plt.
+; 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 ENDPOINTS 
-; keyword specifing that we want to make a vertical cut in diagonal. Then coorinated of extremities 
-; of these one are difined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are 
+; keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities 
+; of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are 
 ; coordinates. 
 ;
@@ -86 +84 @@
 ;               (without use the black, the white and the used palette)
 ;
-; @keyword ZRATIO
+; @keyword ZRATIO {default=2./3}
 ; When the drawing has a zoomed part, it is the size rapport between the zoomed part, 
-; hz (zoom height), and the whole drawing, ht (total height). By default =2./3
-;
-; @keyword LABEL 
-; It is an integer n. If n different of 0, it choose the label's type 
-; corresponding to cases n. cf label.pro
+; hz (zoom height), and the whole drawing, ht (total height).
+;
+; @keyword LABEL {default=0}{type=integer}
+; It choose the label's type corresponding to cases in label.pro.
 ; Comment: When CONTOUR is activated, it only specify the label's type for colored isolines. 
-; For tese one traced by a trait, use CONTLABEL. 
+; For these one traced by a trait, use CONTLABEL. 
 ;
 ; @keyword MAXIN 
@@ -106 +103 @@
 ; keyword is retained.
 ;
-; @keyword NLEVEL 
+; @keyword NLEVEL {default=20}
 ; Number of contour to draw by default =20. active if
 ; LABEL=0 or is not specified.
@@ -113 +110 @@
 ; To force not to use the triangulation. Beware, in this case, the 
 ; drawing only works if the grid is undeformed (It means that each point of a longitude 
-; give one latitude and each point of a latitude give one longitude) exept if we use 
+; give one latitude and each point of a latitude give one longitude) except if we use 
 ; the keyword CELL_FILL=2. 
 ; Comment: if the field contain points !values.f_nan, then we even do a triangulation.
@@ -131 +128 @@
 ; specified min and values superior at the specified max in white.
 ;
-; @keyword STYLE 
-; Contour's style to adopt to draw isolines(by default, style=0. see style.pro)
+; @keyword STYLE {default=style=0}
+; Contour's style to adopt to draw isolines
 ;
 ; @keyword WDEPTH 
@@ -144 +141 @@
 ; Force to make a cut following yz
 ;
-; @keyword ZOOM 
-; Depth where i can make our maximum zoom. By default 200m or max depth if it is inferior at 200m
+; @keyword ZOOM  {default=200m or max depth if it is inferior at 200m}
+; Depth where i can make our maximum zoom.
 ;
 ; @uses