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/HOPE/read_hope.html

    r157 r163  
    721721          <dd></dd>      
    722722           
    723           <dt><p><a href="#_read_hope"><span class="result">result = </span>read_hope(<span class="result">typein, varnamein</span>, FILENAME=<span class="result">FILENAME</span>, XLIMITS=<span class="result">XLIMITS</span>, YLIMITS=<span class="result">YLIMITS</span>, ZLIMITS=<span class="result">ZLIMITS</span>, TLIMITS=<span class="result">TLIMITS</span>, ODDPT=<span class="result">ODDPT</span>, ODDEVENPT=<span class="result">ODDEVENPT</span>, EVENPT=<span class="result">EVENPT</span>, _extra=<span class="result">_extra</span>)</a></p><dt> 
     723          <dt><p><a href="#_read_hope"><span class="result">result = </span>read_hope(<span class="result">typein, varnamein</span>, FILENAME=<span class="result">string</span>, XLIMITS=<span class="result">vector</span>, YLIMITS=<span class="result">vector</span>, ZLIMITS=<span class="result">vector</span>, TLIMITS=<span class="result">vector</span>, ODDPT=<span class="result">ODDPT</span>, ODDEVENPT=<span class="result">ODDEVENPT</span>, EVENPT=<span class="result">EVENPT</span>, _extra=<span class="result">_extra</span>)</a></p><dt> 
    724724          <dd> </dd>     
    725725                 
    … …  
    776776           
    777777          <h4>Version</h4><div class="preformat"> 
    778  $Id$ 
     778 $Id: read_hope.pro 157 2006-08-21 09:01:50Z navarro $ 
    779779</div> 
    780780          <h4>History</h4><div class="preformat"> 
    … …  
    799799           
    800800         
     801          <h3>Statistics</h3> 
     802          <table class="statistics"> 
     803            <tr><td>McCabe cyclic</td><td>          39</td></tr> 
     804            <tr><td>McCabe essential</td><td>           1</td></tr> 
     805            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     806          </table> 
    801807           
    802808         
    … …  
    811817         
    812818          <p class="header"> 
    813             <span class="result">result = </span>read_hope(<span class="result"><a href="#_read_hope_param_typein">typein</a>, <a href="#_read_hope_param_varnamein">varnamein</a></span>, <a href="#_read_hope_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_read_hope_keyword_XLIMITS">XLIMITS</a>=<span class="result">XLIMITS</span>, <a href="#_read_hope_keyword_YLIMITS">YLIMITS</a>=<span class="result">YLIMITS</span>, <a href="#_read_hope_keyword_ZLIMITS">ZLIMITS</a>=<span class="result">ZLIMITS</span>, <a href="#_read_hope_keyword_TLIMITS">TLIMITS</a>=<span class="result">TLIMITS</span>, <a href="#_read_hope_keyword_ODDPT">ODDPT</a>=<span class="result">ODDPT</span>, <a href="#_read_hope_keyword_ODDEVENPT">ODDEVENPT</a>=<span class="result">ODDEVENPT</span>, <a href="#_read_hope_keyword_EVENPT">EVENPT</a>=<span class="result">EVENPT</span>, <a href="#_read_hope_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 
     819            <span class="result">result = </span>read_hope(<span class="result"><a href="#_read_hope_param_typein">typein</a>, <a href="#_read_hope_param_varnamein">varnamein</a></span>, <a href="#_read_hope_keyword_FILENAME">FILENAME</a>=<span class="result">string</span>, <a href="#_read_hope_keyword_XLIMITS">XLIMITS</a>=<span class="result">vector</span>, <a href="#_read_hope_keyword_YLIMITS">YLIMITS</a>=<span class="result">vector</span>, <a href="#_read_hope_keyword_ZLIMITS">ZLIMITS</a>=<span class="result">vector</span>, <a href="#_read_hope_keyword_TLIMITS">TLIMITS</a>=<span class="result">vector</span>, <a href="#_read_hope_keyword_ODDPT">ODDPT</a>=<span class="result">ODDPT</span>, <a href="#_read_hope_keyword_ODDEVENPT">ODDEVENPT</a>=<span class="result">ODDEVENPT</span>, <a href="#_read_hope_keyword_EVENPT">EVENPT</a>=<span class="result">EVENPT</span>, <a href="#_read_hope_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 
    814820         
    815821          <div class="comments"> 
    … …  
    821827 
    822828 A structure which but be read by litchamp.pro and is 
    823  necessary to complute the grid associated to the data (see 
     829 necessary to complete the grid associated to the data (see 
    824830 the example). 
    825831</div> 
    … …  
    835841              <span class="attr">required</span> 
    836842               
    837                
     843              <span class="attr">type:</span> <span class="value">string</span> 
    838844               
    839845               
    … …  
    841847         
    842848          <div class="comments"> 
    843  A string specifing from which type of section the 4D 
     849 A string specifying from which type of section the 4D 
    844850 array based: 'xy, 'xz', 'yz' 
    845851</div> 
    846852             
    847853            <h4 id="_read_hope_param_varnamein">varnamein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    848                
    849                
    850                
    851                
    852                
    853                
     854              <span class="attr">in</span> 
     855               
     856               
     857              <span class="attr">required</span> 
     858               
     859              <span class="attr">type:</span> <span class="value">string</span> 
    854860               
    855861               
    … …  
    857863         
    858864          <div class="comments"> 
    859  A string the name of the cariable to be read (in 
     865 A string the name of the variable to be read (in 
    860866 lower or upper case) 
    861867</div> 
    … …  
    874880               
    875881               
    876                
     882              <span class="attr">type:</span> <span class="value">string</span> 
    877883               
    878884               
    … …  
    889895               
    890896               
    891                
     897              <span class="attr">type:</span> <span class="value">vector</span> 
    892898               
    893899               
    … …  
    895901         
    896902            <div class="comments"> 
    897  A two elements vertor [lonmin, lonmax]] 
    898  the bondary of the longitudes (from 0 to 360) 
     903 A two elements vector [lonmin, lonmax]] 
     904 the boundary of the longitudes (from 0 to 360) 
    899905</div> 
    900906             
    … …  
    905911               
    906912               
    907                
     913              <span class="attr">type:</span> <span class="value">vector</span> 
    908914               
    909915               
    … …  
    911917         
    912918            <div class="comments"> 
    913  A two elements vertor [latmin, latmax]] 
    914  the bondary of the latitudes (from -90 to 90) 
     919 A two elements vector [latmin, latmax]] 
     920 the boundary of the latitudes (from -90 to 90) 
    915921</div> 
    916922             
    … …  
    921927               
    922928               
    923                
     929              <span class="attr">type:</span> <span class="value">vector</span> 
    924930               
    925931               
    … …  
    927933         
    928934            <div class="comments"> 
    929  A two elements vertor [depthmin, depthmax]] 
    930  the bondary of the depth 
     935 A two elements vector [depthmin, depthmax]] 
     936 the boundary of the depth 
    931937</div> 
    932938             
    … …  
    937943               
    938944               
    939                
     945              <span class="attr">type:</span> <span class="value">vector</span> 
    940946               
    941947               
    … …  
    943949         
    944950            <div class="comments"> 
    945  A two elements vertor [date1, date2]] 
    946  the bondary of the calendar with date1 and date2 
    947  folowing the syntaxe yyyymmdd 
     951 A two elements vector [date1, date2]] 
     952 the boundary of the calendar with date1 and date2 
     953 folowing the syntax yyyymmdd 
    948954</div> 
    949955             
    … …  
    10081014         
    10091015            <div class="comments"> 
    1010  Used to pass yor keywords 
     1016 Used to pass your keywords 
    10111017</div> 
    10121018             
    … …  
    10401046           
    10411047          <h4>Version</h4><div class="preformat"> 
    1042  $Id: read_hope.pro 142 2006-07-21 12:47:49Z navarro $ 
     1048 $Id: read_hope.pro 157 2006-08-21 09:01:50Z navarro $ 
    10431049</div> 
    10441050          <h4>History</h4><div class="preformat"> 
    … …  
    10541060          <h4>Restrictions</h4><div class="preformat"> 
    10551061 'x', 'y', 'z', 't', 'xt', 'yt' and 'zt' section not coded, xconv 
    1056  must be able to works with this kind of fonction. 
    1057  The grib file has no zoom possibilities on horizontal dimensions. 
    1058  
    1059  
    1060  
    1061  When typein and varnamein are defined, the methode to find the 
    1062  godd variable is: 
     1062 must be able to works with this kind of function. 
     1063 The grid file has no zoom possibilities on horizontal dimensions. 
     1064 
     1065 
     1066 
     1067 When typein and varnamein are defined, the method to find the 
     1068 good variable is: 
    10631069  1) find the variables which are available on this type of 
    1064  sections woth this name 
     1070 sections with this name 
    10651071  2) if ODDPT, EVENPT or ODDEVENPT are specified, consider only 
    10661072 these types of sections 
    … …  
    10781084           
    10791085          <h4>Uses routines</h4><div class="preformat"> 
    1080  common.pro (usefull only for the definition of iodir) 
    1081 </div> 
    1082            
    1083            
    1084            
    1085          
     1086 common.pro (useful only for the definition of iodir) 
     1087</div> 
     1088           
     1089           
     1090           
     1091         
     1092          <h3>Statistics</h3> 
     1093          <table class="statistics"> 
     1094            <tr><td>McCabe cyclic</td><td>          41</td></tr> 
     1095            <tr><td>McCabe essential</td><td>           1</td></tr> 
     1096            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1097          </table> 
    10861098           
    10871099         
Note: See TracChangeset for help on using the changeset viewer.