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/LECTURE/GRIB/read_gribtable.html

    r157 r163  
    699699      </div> 
    700700 
    701       <div id="file_comments"></div> 
     701      <div id="file_comments"> 
     702 Read contents of a gribtable. Gribtables are located 
     703 in the gribtables subdirectory of HIPHOP 
     704</div> 
    702705 
    703706       
     
    714717        <div class="routine_details" id="_read_gribtable"> 
    715718 
    716           <h2><a class="top" href="#container">top</a>read_gribtable </h2> 
     719          <h2><a class="top" href="#container">top</a>read_gribtable <span class="categories"> 
     720 
     721</span></h2> 
    717722         
    718723          <p class="header"> 
    719724            read_gribtable<span class="result">, <a href="#_read_gribtable_param_tablename">tablename</a></span>, <a href="#_read_gribtable_keyword_parmtabl">parmtabl</a>=<span class="result">parmtabl</span>, <a href="#_read_gribtable_keyword_center">center</a>=<span class="result">center</span>, <a href="#_read_gribtable_keyword_subcenter">subcenter</a>=<span class="result">subcenter</span>, <a href="#_read_gribtable_keyword_tablnum">tablnum</a>=<span class="result">tablnum</span></p> 
    720725         
    721           <div class="comments"> 
    722  NAME: 
    723         read_gribtable 
    724  
    725  PURPOSE: 
    726        Read contents of a gribtable. Gribtables are located 
    727        in the gribtables subdirectory of HIPHOP 
    728     
    729  CATEGORY: 
    730         HIPHOP, GRIB, ECMWF 
    731  
    732  CALLING SEQUENCE: 
    733        read_gribtable,tablename,parmtabl=parmtabl 
    734  
    735  EXAMPLE: 
    736        tablename='ectab_128' 
    737  
    738  INPUTS: 
    739         tablename : the full path name of a gribtable file 
    740  
    741  OPTIONAL INPUT PARAMETERS: 
    742  
    743  KEYWORD INPUT PARAMETERS: 
    744  
    745  OUTPUTS: 
    746         parmtable : the parameter table 
    747  
    748  COMMON BLOCKS: 
    749  
    750  SIDE EFFECTS: 
    751  
    752  RESTRICTIONS: 
    753  
    754  PROCEDURE: 
    755          
    756  MODIFICATION HISTORY: 
    757  
    758  Dominik Brunner, Apr 2000</div> 
    759  
    760            
     726          <div class="comments"></div> 
     727 
     728          <h3>Return value</h3><div class="preformat"> 
     729 
     730</div> 
    761731 
    762732           
     
    765735             
    766736            <h4 id="_read_gribtable_param_tablename">tablename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    767                
    768                
    769                
    770                
     737              <span class="attr">in</span> 
     738               
     739               
     740              <span class="attr">required</span> 
    771741               
    772742               
     
    775745            </h4> 
    776746         
    777           <div class="comments"></div> 
     747          <div class="comments"> 
     748 The full path name of a gribtable file 
     749</div> 
    778750             
    779751 
     
    795767            </h4> 
    796768         
    797             <div class="comments"></div> 
     769            <div class="comments"> 
     770 
     771</div> 
    798772             
    799773            <h4 id="_read_gribtable_keyword_center">center&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    808782            </h4> 
    809783         
    810             <div class="comments"></div> 
     784            <div class="comments"> 
     785 
     786</div> 
    811787             
    812788            <h4 id="_read_gribtable_keyword_subcenter">subcenter&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    821797            </h4> 
    822798         
    823             <div class="comments"></div> 
     799            <div class="comments"> 
     800 
     801</div> 
    824802             
    825803            <h4 id="_read_gribtable_keyword_tablnum">tablnum&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    834812            </h4> 
    835813         
    836             <div class="comments"></div> 
     814            <div class="comments"> 
     815 
     816</div> 
    837817             
    838818           
    839819 
    840            
    841            
    842            
    843            
    844            
    845            
    846            
    847            
    848            
    849            
    850            
    851            
    852          
    853            
    854            
    855            
    856            
    857            
    858            
    859            
    860          
     820          <h3>Examples</h3><div class="preformat"> 
     821 tablename='ectab_128' 
     822</div> 
     823          <h3>Version history</h3> 
     824           
     825          <h4>Version</h4><div class="preformat"> 
     826 $Id$</div> 
     827          <h4>History</h4><div class="preformat"> 
     828 Dominik Brunner, Apr 2000 
     829</div> 
     830           
     831           
     832          <h3>Known issues</h3> 
     833           
     834           
     835           
     836          <h4>Restrictions</h4><div class="preformat"> 
     837 
     838</div> 
     839         
     840          <h3>Other attributes</h3> 
     841           
     842           
     843          <h4>Uses routines</h4><div class="preformat"> 
     844 
     845</div> 
     846           
     847           
     848           
     849         
     850          <h3>Statistics</h3> 
     851          <table class="statistics"> 
     852            <tr><td>McCabe cyclic</td><td>           0</td></tr> 
     853            <tr><td>McCabe essential</td><td>           0</td></tr> 
     854            <tr><td>McCabe modular design</td><td>           0</td></tr> 
     855          </table> 
    861856           
    862857         
Note: See TracChangeset for help on using the changeset viewer.