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/pltz.html

    r157 r163  
    721721         
    722722          <p class="header"> 
    723             pltz<span class="result">, <a href="#_pltz_param_tab">tab</a>, <a href="#_pltz_param_giventype">giventype</a>, <a href="#_pltz_param_givenmin">givenmin</a>, <a href="#_pltz_param_givenmax">givenmax</a></span>, <a href="#_pltz_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_pltz_keyword_CONTOUR">CONTOUR</a>=<span class="result">CONTOUR</span>, <a href="#_pltz_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_pltz_keyword_INTERVALLE">INTERVALLE</a>=<span class="result">INTERVALLE</span>, <a href="#_pltz_keyword_INV">INV</a>=<span class="result">INV</span>, <a href="#_pltz_keyword_ZRATIO">ZRATIO</a>=<span class="result">ZRATIO</span>, <a href="#_pltz_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<span class="result">CONTINTERVALLE</span>, <a href="#_pltz_keyword_LABEL">LABEL</a>=<span class="result">LABEL</span>, <a href="#_pltz_keyword_CONTLABEL">CONTLABEL</a>=<span class="result">CONTLABEL</span>, <a href="#_pltz_keyword_STYLE">STYLE</a>=<span class="result">STYLE</span>, <a href="#_pltz_keyword_CONTMAX">CONTMAX</a>=<span class="result">CONTMAX</span>, <a href="#_pltz_keyword_SIN">SIN</a>=<span class="result">SIN</span>, <a href="#_pltz_keyword_TYPEIN">TYPEIN</a>=<span class="result">TYPEIN</span>, <a href="#_pltz_keyword_CONTMIN">CONTMIN</a>=<span class="result">CONTMIN</span>, <a href="#_pltz_keyword_NLEVEL">NLEVEL</a>=<span class="result">NLEVEL</span>, <a href="#_pltz_keyword_CONTNLEVEL">CONTNLEVEL</a>=<span class="result">CONTNLEVEL</span>, <a href="#_pltz_keyword_NOTRI">NOTRI</a>=<span class="result">NOTRI</span>, <a href="#_pltz_keyword_USETRI">USETRI</a>=<span class="result">USETRI</span>, <a href="#_pltz_keyword_FILLXDIR">FILLXDIR</a>=<span class="result">FILLXDIR</span>, <a href="#_pltz_keyword_ZOOM">ZOOM</a>=<span class="result">ZOOM</span>, <a href="#_pltz_keyword_XZ">XZ</a>=<span class="result">XZ</span>, <a href="#_pltz_keyword_YZ">YZ</a>=<span class="result">YZ</span>, <a href="#_pltz_keyword_MININ">MININ</a>=<span class="result">MININ</span>, <a href="#_pltz_keyword_MAXIN">MAXIN</a>=<span class="result">MAXIN</span>, <a href="#_pltz_keyword_STRICTFILL">STRICTFILL</a>=<span class="result">STRICTFILL</span>, <a href="#_pltz_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_pltz_keyword_MASKFILL">MASKFILL</a>=<span class="result">MASKFILL</span>, <a href="#_pltz_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_pltz_keyword_REALSECTION">REALSECTION</a>=<span class="result">REALSECTION</span>, <a href="#_pltz_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
     723            pltz<span class="result">, <a href="#_pltz_param_tab">tab</a>, <a href="#_pltz_param_giventype">giventype</a>, <a href="#_pltz_param_givenmin">givenmin</a>, <a href="#_pltz_param_givenmax">givenmax</a></span>, <a href="#_pltz_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_pltz_keyword_CONTOUR">CONTOUR</a>=<span class="result">CONTOUR</span>, <a href="#_pltz_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_pltz_keyword_INTERVALLE">INTERVALLE</a>=<span class="result">INTERVALLE</span>, <a href="#_pltz_keyword_INV">INV</a>=<span class="result">INV</span>, <a href="#_pltz_keyword_ZRATIO">ZRATIO</a>=<span class="result">ZRATIO</span>, <a href="#_pltz_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<span class="result">CONTINTERVALLE</span>, <a href="#_pltz_keyword_LABEL">LABEL</a>=<span class="result">integer</span>, <a href="#_pltz_keyword_CONTLABEL">CONTLABEL</a>=<span class="result">integer</span>, <a href="#_pltz_keyword_STYLE">STYLE</a>=<span class="result">STYLE</span>, <a href="#_pltz_keyword_CONTMAX">CONTMAX</a>=<span class="result">CONTMAX</span>, <a href="#_pltz_keyword_SIN">SIN</a>=<span class="result">SIN</span>, <a href="#_pltz_keyword_TYPEIN">TYPEIN</a>=<span class="result">TYPEIN</span>, <a href="#_pltz_keyword_CONTMIN">CONTMIN</a>=<span class="result">CONTMIN</span>, <a href="#_pltz_keyword_NLEVEL">NLEVEL</a>=<span class="result">NLEVEL</span>, <a href="#_pltz_keyword_CONTNLEVEL">CONTNLEVEL</a>=<span class="result">CONTNLEVEL</span>, <a href="#_pltz_keyword_NOTRI">NOTRI</a>=<span class="result">NOTRI</span>, <a href="#_pltz_keyword_USETRI">USETRI</a>=<span class="result">USETRI</span>, <a href="#_pltz_keyword_FILLXDIR">FILLXDIR</a>=<span class="result">FILLXDIR</span>, <a href="#_pltz_keyword_ZOOM">ZOOM</a>=<span class="result">ZOOM</span>, <a href="#_pltz_keyword_XZ">XZ</a>=<span class="result">XZ</span>, <a href="#_pltz_keyword_YZ">YZ</a>=<span class="result">YZ</span>, <a href="#_pltz_keyword_MININ">MININ</a>=<span class="result">MININ</span>, <a href="#_pltz_keyword_MAXIN">MAXIN</a>=<span class="result">MAXIN</span>, <a href="#_pltz_keyword_STRICTFILL">STRICTFILL</a>=<span class="result">STRICTFILL</span>, <a href="#_pltz_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_pltz_keyword_MASKFILL">MASKFILL</a>=<span class="result">MASKFILL</span>, <a href="#_pltz_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_pltz_keyword_REALSECTION">REALSECTION</a>=<span class="result">REALSECTION</span>, <a href="#_pltz_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
    724724         
    725725          <div class="comments"> 
    … …  
    749749         If the field is 3d, we extract the section on we average possibly before to do the plot. 
    750750         2)  a structure respecting all criterions specified by litchamp.pro.  
    751           See IDL> xhelp,'litchamp'. The array contin in the structure must be 2 or 3d (See case 1) 
     751          See IDL> xhelp,'litchamp'. The array contained in the structure must be 2 or 3d (See case 1) 
    752752 
    753753 ces arguments ne sont pas obligatoires: 
    … …  
    842842            <div class="comments">  
    843843 If we want to trace contours of a different field than the one  
    844  whose we have the colored drawing (by examlpe E-P in color and QSR in contours).  
    845  It must be a field respecting same caracteristics than the argument number one of plt. 
     844 whose we have the colored drawing (by example E-P in color and QSR in contours).  
     845 It must be a field respecting same characteristics than the argument number one of plt. 
    846846</div> 
    847847             
    … …  
    858858         
    859859            <div class="comments">  
    860  keyword specifing that we want to make a vertical cut in diagonal. Then coorinated of extremities  
    861  of these one are difined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
     860 keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities  
     861 of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
    862862 coordinates.  
    863863</div> 
    … …  
    905905               
    906906               
    907                
     907              <span class="attr">default:</span> <span class="value">2./3</span> 
    908908               
    909909            </h4> 
    … …  
    911911            <div class="comments"> 
    912912 When the drawing has a zoomed part, it is the size rapport between the zoomed part,  
    913  hz (zoom height), and the whole drawing, ht (total height). By default =2./3 
     913 hz (zoom height), and the whole drawing, ht (total height). 
    914914</div> 
    915915             
    … …  
    939939               
    940940               
    941                
    942                
    943                
    944             </h4> 
    945          
    946             <div class="comments">  
    947  It is an integer n. If n different of 0, it choose the label's type  
    948  corresponding to cases n. cf label.pro 
     941              <span class="attr">type:</span> <span class="value">integer</span> 
     942              <span class="attr">default:</span> <span class="value">0</span> 
     943               
     944            </h4> 
     945         
     946            <div class="comments"> 
     947 It choose the label's type corresponding to cases in label.pro. 
    949948 Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.  
    950  For tese one traced by a trait, use CONTLABEL.  
     949 For these one traced by a trait, use CONTLABEL.  
    951950</div> 
    952951             
    … …  
    957956               
    958957               
    959                
    960                
    961                
    962             </h4> 
    963          
    964             <div class="comments">  
    965  It is an integer n. When CONTOUR is actvated, if n 
     958              <span class="attr">type:</span> <span class="value">integer</span> 
     959               
     960               
     961            </h4> 
     962         
     963            <div class="comments"> 
     964 When CONTOUR is activated, if n 
    966965 is different of 0, choose the label type corresponding to n cases for  
    967966 the traced by a traitisolines. To specify the type of label of the  
    … …  
    976975               
    977976               
    978                
    979                
    980             </h4> 
    981          
    982             <div class="comments">  
    983  Contour's style to adopt to draw isolines(by default, style=0. see style.pro) 
     977              <span class="attr">default:</span> <span class="value">style</span> 
     978               
     979            </h4> 
     980         
     981            <div class="comments"> 
     982 Contour's style to adopt to draw isolines 
    984983</div> 
    985984             
    … …  
    991990               
    992991               
    993                
    994                
    995             </h4> 
    996          
    997             <div class="comments">  
     992              <span class="attr">default:</span> <span class="value">max of the keyword CONTOUR (on ocean points)</span> 
     993               
     994            </h4> 
     995         
     996            <div class="comments"> 
    998997 When CONTOUR is activated, max value we want to consider in the isoline  
    999  traced by a trait's line. By default, we take the max (on ocean points) of the array  
    1000  passed in the keyword CONTOUR. 
     998 traced by a trait's line. 
    1001999</div> 
    10021000             
    … …  
    10371035               
    10381036               
    1039                
    1040                
    1041             </h4> 
    1042          
    1043             <div class="comments">  
     1037              <span class="attr">default:</span> <span class="value">min of the keyword CONTOUR (on ocean points)</span> 
     1038               
     1039            </h4> 
     1040         
     1041            <div class="comments"> 
    10441042 When CONTOUR is activated, min value we want to consider in the isoline  
    1045  traced by a trait's line. By default, we take the min (on ocean points) of the array  
    1046  passed in the keyword CONTOUR.  
     1043 traced by a trait's line.  
    10471044</div> 
    10481045             
    … …  
    10541051               
    10551052               
    1056                
    1057                
    1058             </h4> 
    1059          
    1060             <div class="comments">  
     1053              <span class="attr">default:</span> <span class="value">20</span> 
     1054               
     1055            </h4> 
     1056         
     1057            <div class="comments"> 
    10611058 Number of contour to draw by default =20. active if 
    10621059 LABEL=0 or is not specified. 
    … …  
    10701067               
    10711068               
    1072                
    1073                
    1074             </h4> 
    1075          
    1076             <div class="comments">  
    1077  When  CONTOUR is activated, it is the numbre of contours 
     1069              <span class="attr">default:</span> <span class="value">20</span> 
     1070               
     1071            </h4> 
     1072         
     1073            <div class="comments"> 
     1074 When  CONTOUR is activated, it is the number of contours 
    10781075 traced by a trait for drawing (active if 
    1079  CONTLABEL=0) by default=20. 
     1076 CONTLABEL=0). 
    10801077</div> 
    10811078             
    … …  
    10941091 To force not to use the triangulation. Beware, in this case, the  
    10951092 drawing only works if the grid is undeformed (It means that each point of a longitude  
    1096  give one latitude and each point of a latitude give one longitude) exept if we use  
     1093 give one latitude and each point of a latitude give one longitude) except if we use  
    10971094 the keyword CELL_FILL=2.  
    10981095 Comment: if the field contain points !values.f_nan, then we even do a triangulation. 
    … …  
    11321129               
    11331130               
    1134                
    1135                
    1136             </h4> 
    1137          
    1138             <div class="comments">  
    1139  Depth where i can make our maximum zoom. By default 200m or max depth if it is inferior at 200m 
     1131              <span class="attr">default:</span> <span class="value">200m or max depth if it is inferior at 200m</span> 
     1132               
     1133            </h4> 
     1134         
     1135            <div class="comments"> 
     1136 Depth where i can make our maximum zoom. 
    11401137</div> 
    11411138             
    … …  
    12991296           
    13001297          <h4>Version</h4><div class="preformat"> 
    1301  $Id: pltz.pro 152 2006-08-10 07:01:35Z smasson $ 
     1298 $Id: pltz.pro 157 2006-08-21 09:01:50Z navarro $ 
    13021299</div> 
    13031300          <h4>History</h4><div class="preformat"> 
    … …  
    13261323           
    13271324         
     1325          <h3>Statistics</h3> 
     1326          <table class="statistics"> 
     1327            <tr><td>McCabe cyclic</td><td>          61</td></tr> 
     1328            <tr><td>McCabe essential</td><td>           3</td></tr> 
     1329            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1330          </table> 
    13281331           
    13291332         
Note: See TracChangeset for help on using the changeset viewer.