Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DESSINE/pltt.html

    r157 r163  
    720720         
    721721          <p class="header"> 
    722             pltt<span class="result">, <a href="#_pltt_param_tab">tab</a>, <a href="#_pltt_param_giventype">giventype</a>, <a href="#_pltt_param_givenmin">givenmin</a>, <a href="#_pltt_param_givenmax">givenmax</a>, <a href="#_pltt_param_datmin">datmin</a>, <a href="#_pltt_param_datmax">datmax</a></span>, <a href="#_pltt_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_pltt_keyword_CONTOUR">CONTOUR</a>=<span class="result">CONTOUR</span>, <a href="#_pltt_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_pltt_keyword_INTERVALLE">INTERVALLE</a>=<span class="result">INTERVALLE</span>, <a href="#_pltt_keyword_INV">INV</a>=<span class="result">INV</span>, <a href="#_pltt_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<span class="result">CONTINTERVALLE</span>, <a href="#_pltt_keyword_LABEL">LABEL</a>=<span class="result">LABEL</span>, <a href="#_pltt_keyword_CONTLABEL">CONTLABEL</a>=<span class="result">CONTLABEL</span>, <a href="#_pltt_keyword_STYLE">STYLE</a>=<span class="result">STYLE</span>, <a href="#_pltt_keyword_CONTMAX">CONTMAX</a>=<span class="result">CONTMAX</span>, <a href="#_pltt_keyword_CONTMIN">CONTMIN</a>=<span class="result">CONTMIN</span>, <a href="#_pltt_keyword_NLEVEL">NLEVEL</a>=<span class="result">NLEVEL</span>, <a href="#_pltt_keyword_CONTNLEVEL">CONTNLEVEL</a>=<span class="result">CONTNLEVEL</span>, <a href="#_pltt_keyword_COL1D">COL1D</a>=<span class="result">COL1D</span>, <a href="#_pltt_keyword_STY1D">STY1D</a>=<span class="result">STY1D</span>, <a href="#_pltt_keyword_MININ">MININ</a>=<span class="result">MININ</span>, <a href="#_pltt_keyword_MAXIN">MAXIN</a>=<span class="result">MAXIN</span>, <a href="#_pltt_keyword_OV1D">OV1D</a>=<span class="result">OV1D</span>, <a href="#_pltt_keyword_FILTER">FILTER</a>=<span class="result">FILTER</span>, <a href="#_pltt_keyword_TREND_TYPE">TREND_TYPE</a>=<span class="result">TREND_TYPE</span>, <a href="#_pltt_keyword_REPEAT_C">REPEAT_C</a>=<span class="result">REPEAT_C</span>, <a href="#_pltt_keyword_TYPEIN">TYPEIN</a>=<span class="result">TYPEIN</span>, <a href="#_pltt_keyword_XT">XT</a>=<span class="result">XT</span>, <a href="#_pltt_keyword_YT">YT</a>=<span class="result">YT</span>, <a href="#_pltt_keyword_ZT">ZT</a>=<span class="result">ZT</span>, <a href="#_pltt_keyword_TT">TT</a>=<span class="result">TT</span>, <a href="#_pltt_keyword_STRICTFILL">STRICTFILL</a>=<span class="result">STRICTFILL</span>, <a href="#_pltt_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_pltt_keyword_EXCHANGE_XY">EXCHANGE_XY</a>=<span class="result">EXCHANGE_XY</span>, <a href="#_pltt_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
     722            pltt<span class="result">, <a href="#_pltt_param_tab">tab</a>, <a href="#_pltt_param_giventype">giventype</a>, <a href="#_pltt_param_givenmin">givenmin</a>, <a href="#_pltt_param_givenmax">givenmax</a>, <a href="#_pltt_param_datmin">datmin</a>, <a href="#_pltt_param_datmax">datmax</a></span>, <a href="#_pltt_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_pltt_keyword_CONTOUR">CONTOUR</a>=<span class="result">CONTOUR</span>, <a href="#_pltt_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_pltt_keyword_INTERVALLE">INTERVALLE</a>=<span class="result">INTERVALLE</span>, <a href="#_pltt_keyword_INV">INV</a>=<span class="result">INV</span>, <a href="#_pltt_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<span class="result">CONTINTERVALLE</span>, <a href="#_pltt_keyword_LABEL">LABEL</a>=<span class="result">integer</span>, <a href="#_pltt_keyword_CONTLABEL">CONTLABEL</a>=<span class="result">integer</span>, <a href="#_pltt_keyword_STYLE">STYLE</a>=<span class="result">STYLE</span>, <a href="#_pltt_keyword_CONTMAX">CONTMAX</a>=<span class="result">CONTMAX</span>, <a href="#_pltt_keyword_CONTMIN">CONTMIN</a>=<span class="result">CONTMIN</span>, <a href="#_pltt_keyword_NLEVEL">NLEVEL</a>=<span class="result">NLEVEL</span>, <a href="#_pltt_keyword_CONTNLEVEL">CONTNLEVEL</a>=<span class="result">CONTNLEVEL</span>, <a href="#_pltt_keyword_COL1D">COL1D</a>=<span class="result">COL1D</span>, <a href="#_pltt_keyword_STY1D">STY1D</a>=<span class="result">STY1D</span>, <a href="#_pltt_keyword_MININ">MININ</a>=<span class="result">MININ</span>, <a href="#_pltt_keyword_MAXIN">MAXIN</a>=<span class="result">MAXIN</span>, <a href="#_pltt_keyword_OV1D">OV1D</a>=<span class="result">OV1D</span>, <a href="#_pltt_keyword_FILTER">FILTER</a>=<span class="result">FILTER</span>, <a href="#_pltt_keyword_TREND_TYPE">TREND_TYPE</a>=<span class="result">TREND_TYPE</span>, <a href="#_pltt_keyword_REPEAT_C">REPEAT_C</a>=<span class="result">REPEAT_C</span>, <a href="#_pltt_keyword_TYPEIN">TYPEIN</a>=<span class="result">TYPEIN</span>, <a href="#_pltt_keyword_XT">XT</a>=<span class="result">XT</span>, <a href="#_pltt_keyword_YT">YT</a>=<span class="result">YT</span>, <a href="#_pltt_keyword_ZT">ZT</a>=<span class="result">ZT</span>, <a href="#_pltt_keyword_TT">TT</a>=<span class="result">TT</span>, <a href="#_pltt_keyword_STRICTFILL">STRICTFILL</a>=<span class="result">STRICTFILL</span>, <a href="#_pltt_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_pltt_keyword_EXCHANGE_XY">EXCHANGE_XY</a>=<span class="result">EXCHANGE_XY</span>, <a href="#_pltt_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
    723723         
    724724          <div class="comments"> 
    … …  
    750750            be masked at the value valmask) and nevertheless,type must be specified  
    751751            to we know of which trace it is about. 
    752             To have a correct caption, respecify the  xctraction zone via BOXZOOM. 
     752            To have a correct caption, respecify the  extraction zone via BOXZOOM. 
    753753          * 1d: only for traces of the 't' type. Nevertheless, type must be specified  
    754754            to we know of which trace it is about. 
    755             To have a correct caption, respecify the  xctraction zone via BOXZOOM. 
     755            To have a correct caption, respecify the  extraction zone via BOXZOOM. 
    756756       2) a structure respecting all criterions specified by litchamp.pro.  
    757757          See IDL> xhelp,'litchamp'. The array contained in the structure  
    … …  
    857857         
    858858            <div class="comments"> 
    859  Vector indicating the geographique zone (3d) on which the extraction of the field must  
     859 Vector indicating the geographic zone (3d) on which the extraction of the field must  
    860860 be done to do the hovmoeller. 
    861861  If BOXZOOM has : 
    … …  
    882882            <div class="comments">  
    883883 If we want to trace contours of a different field than the one  
    884  whose we have the colored drawing (by examlpe E-P in color and QSR in contours).  
    885  It must be a field respecting same caracteristics than the argument number one of pltt. 
     884 whose we have the colored drawing (by example E-P in color and QSR in contours).  
     885 It must be a field respecting same characteristics than the argument number one of pltt. 
    886886</div> 
    887887             
    … …  
    898898         
    899899            <div class="comments">  
    900  keyword specifing that we want to make a vertical cut in diagonal. Then coorinated of extremities  
    901  of these one are difined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
     900 keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities  
     901 of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
    902902 coordinates.  
    903903</div> 
    … …  
    963963               
    964964               
    965                
    966                
    967                
    968             </h4> 
    969          
    970             <div class="comments">  
    971  It is an integer n. If n different of 0, it choose the label's type  
     965              <span class="attr">type:</span> <span class="value">integer</span> 
     966               
     967               
     968            </h4> 
     969         
     970            <div class="comments"> 
     971 If n different of 0, it choose the label's type  
    972972 corresponding to cases n. cf label.pro 
    973973 Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.  
    974  For tese one traced by a trait, use CONTLABEL.  
     974 For these one traced by a trait, use CONTLABEL.  
    975975</div> 
    976976             
    … …  
    981981               
    982982               
    983                
    984                
    985                
    986             </h4> 
    987          
    988             <div class="comments">  
    989  It is an integer n. When CONTOUR is actvated, if n 
     983              <span class="attr">type:</span> <span class="value">integer</span> 
     984               
     985               
     986            </h4> 
     987         
     988            <div class="comments"> 
     989 When CONTOUR is activated, if n 
    990990 is different of 0, choose the label type corresponding to n cases for  
    991991 the traced by a traitisolines. To specify the type of label of the  
    … …  
    10001000               
    10011001               
    1002                
    1003                
    1004             </h4> 
    1005          
    1006             <div class="comments">  
    1007  Contour's style to adopt to draw isolines(by default, style=0. see style.pro) 
     1002              <span class="attr">default:</span> <span class="value">style</span> 
     1003               
     1004            </h4> 
     1005         
     1006            <div class="comments"> 
     1007 Contour's style to adopt to draw isolines 
    10081008</div> 
    10091009             
    … …  
    10151015               
    10161016               
    1017                
    1018                
    1019             </h4> 
    1020          
    1021             <div class="comments">  
     1017              <span class="attr">default:</span> <span class="value">we take the max of the array passed in the keyword CONTOUR (on ocean points)</span> 
     1018               
     1019            </h4> 
     1020         
     1021            <div class="comments"> 
    10221022 When CONTOUR is activated, max value we want to consider in the isoline  
    1023  traced by a trait's line. By default, we take the max (on ocean points) of the array  
    1024  passed in the keyword CONTOUR.  
     1023 traced by a trait's line.  
    10251024</div> 
    10261025             
    … …  
    10321031               
    10331032               
    1034                
    1035                
    1036             </h4> 
    1037          
    1038             <div class="comments">  
     1033              <span class="attr">default:</span> <span class="value">we take the min of the array passed in the keyword CONTOUR (on ocean points)</span> 
     1034               
     1035            </h4> 
     1036         
     1037            <div class="comments"> 
    10391038 When CONTOUR is activated, min value we want to consider in the isoline  
    1040  traced by a trait's line. By default, we take the min (on ocean points) of the array  
    1041  passed in the keyword CONTOUR.  
     1039 traced by a trait's line.  
    10421040</div> 
    10431041             
    … …  
    10491047               
    10501048               
    1051                
    1052                
    1053             </h4> 
    1054          
    1055             <div class="comments">  
     1049              <span class="attr">default:</span> <span class="value">20</span> 
     1050               
     1051            </h4> 
     1052         
     1053            <div class="comments"> 
    10561054 Number of contour to draw by default =20. active if 
    10571055 LABEL=0 or is not specified. 
    … …  
    10651063               
    10661064               
    1067                
    1068                
    1069             </h4> 
    1070          
    1071             <div class="comments">  
    1072  When  CONTOUR is activated, it is the numbre of contours 
     1065              <span class="attr">default:</span> <span class="value">20</span> 
     1066               
     1067            </h4> 
     1068         
     1069            <div class="comments"> 
     1070 When  CONTOUR is activated, it is the number of contours 
    10731071 traced by a trait for drawing (active if 
    1074  CONTLABEL=0) by default=20. 
    1075  
    1076   
    1077  When  CONTOUR is activated, it is the numbre of contours 
     1072 CONTLABEL=0). 
     1073 
     1074 
     1075 When  CONTOUR is activated, it is the number of contours 
    10781076 traced by a trait for drawing (active if 
    1079  CONTLABEL=0) by default=20. 
     1077 CONTLABEL=0). 
    10801078</div> 
    10811079             
    … …  
    12201218 allows to specify the type of hovmoller we want to do 
    12211219             'xt','yt','zt','t'   
    1222  with help of a keyword rather than the argument type. If the argument andthe  
     1220 with help of a keyword rather than the argument type. If the argument and the  
    12231221 keyword are specified in the same time, it is the value specified by the  
    12241222 keyword which is retained. 
    … …  
    13371335            </h4> 
    13381336         
    1339             <div class="comments"></div> 
     1337            <div class="comments"> 
     1338 Used to pass your keywords 
     1339</div> 
    13401340             
    13411341           
    … …  
    13451345           
    13461346          <h4>Version</h4><div class="preformat">  
    1347  $Id: pltt.pro 152 2006-08-10 07:01:35Z smasson $ 
     1347 $Id: pltt.pro 157 2006-08-21 09:01:50Z navarro $ 
    13481348</div> 
    13491349          <h4>History</h4><div class="preformat">  
    … …  
    13801380           
    13811381         
     1382          <h3>Statistics</h3> 
     1383          <table class="statistics"> 
     1384            <tr><td>McCabe cyclic</td><td>          88</td></tr> 
     1385            <tr><td>McCabe essential</td><td>           8</td></tr> 
     1386            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1387          </table> 
    13821388           
    13831389         
Note: See TracChangeset for help on using the changeset viewer.