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

    r157 r163  
    699699      </div> 
    700700 
    701       <div id="file_comments"></div> 
     701      <div id="file_comments"> 
     702 
     703</div> 
    702704 
    703705       
    … …  
    714716        <div class="routine_details" id="_pltsc"> 
    715717 
    716           <h2><a class="top" href="#container">top</a>pltsc </h2> 
     718          <h2><a class="top" href="#container">top</a>pltsc <span class="categories"> 
     719 
     720</span></h2> 
    717721         
    718722          <p class="header"> 
    719723            pltsc<span class="result">, <a href="#_pltsc_param_tab1">tab1</a>, <a href="#_pltsc_param_tab2">tab2</a>, <a href="#_pltsc_param_min1">min1</a>, <a href="#_pltsc_param_max1">max1</a>, <a href="#_pltsc_param_min2">min2</a>, <a href="#_pltsc_param_max2">max2</a>, <a href="#_pltsc_param_varname2">varname2</a></span>, <a href="#_pltsc_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_pltsc_keyword_COL1D">COL1D</a>=<span class="result">COL1D</span>, <a href="#_pltsc_keyword_STY1D">STY1D</a>=<span class="result">STY1D</span>, <a href="#_pltsc_keyword_OV1D">OV1D</a>=<span class="result">OV1D</span>, <a href="#_pltsc_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
    720724         
     725          <div class="comments"></div> 
     726 
     727          <h3>Return value</h3><div class="preformat"> 
     728 
     729</div> 
     730 
     731           
     732            <h3>Parameters</h3> 
     733         
     734             
     735            <h4 id="_pltsc_param_tab1">tab1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     736               
     737               
     738               
     739               
     740               
     741               
     742               
     743               
     744            </h4> 
     745         
    721746          <div class="comments"> 
    722 </div> 
    723  
    724            
    725  
    726            
    727             <h3>Parameters</h3> 
    728          
    729              
    730             <h4 id="_pltsc_param_tab1">tab1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    731                
    732                
    733                
    734                
    735                
    736                
    737                
    738                
    739             </h4> 
    740          
    741           <div class="comments"></div> 
     747 
     748</div> 
    742749             
    743750            <h4 id="_pltsc_param_tab2">tab2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    752759            </h4> 
    753760         
    754           <div class="comments"></div> 
     761          <div class="comments"> 
     762 
     763</div> 
    755764             
    756765            <h4 id="_pltsc_param_min1">min1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    765774            </h4> 
    766775         
    767           <div class="comments"></div> 
     776          <div class="comments"> 
     777 
     778</div> 
    768779             
    769780            <h4 id="_pltsc_param_max1">max1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    778789            </h4> 
    779790         
    780           <div class="comments"></div> 
     791          <div class="comments"> 
     792 
     793</div> 
    781794             
    782795            <h4 id="_pltsc_param_min2">min2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    791804            </h4> 
    792805         
    793           <div class="comments"></div> 
     806          <div class="comments"> 
     807 
     808</div> 
    794809             
    795810            <h4 id="_pltsc_param_max2">max2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    804819            </h4> 
    805820         
    806           <div class="comments"></div> 
     821          <div class="comments"> 
     822 
     823</div> 
    807824             
    808825            <h4 id="_pltsc_param_varname2">varname2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    817834            </h4> 
    818835         
    819           <div class="comments"></div> 
     836          <div class="comments"> 
     837 
     838</div> 
    820839             
    821840 
    … …  
    837856            </h4> 
    838857         
    839             <div class="comments"></div> 
     858            <div class="comments"> 
     859 Vector indicating the geographic zone on which we want to cut the map.  
     860  If BOXZOOM has : 
     861 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]] 
     862 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]] 
     863 4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])] 
     864 5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]] 
     865 6 elements: The extraction is made on Boxzoom 
     866</div> 
    840867             
    841868            <h4 id="_pltsc_keyword_COL1D">COL1D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    850877            </h4> 
    851878         
    852             <div class="comments"></div> 
     879            <div class="comments"> 
     880 
     881</div> 
    853882             
    854883            <h4 id="_pltsc_keyword_STY1D">STY1D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    863892            </h4> 
    864893         
    865             <div class="comments"></div> 
     894            <div class="comments"> 
     895 
     896</div> 
    866897             
    867898            <h4 id="_pltsc_keyword_OV1D">OV1D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    876907            </h4> 
    877908         
    878             <div class="comments"></div> 
     909            <div class="comments"> 
     910 
     911</div> 
    879912             
    880913            <h4 id="_pltsc_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    889922            </h4> 
    890923         
    891             <div class="comments"></div> 
    892              
    893            
    894  
    895            
    896            
    897            
    898            
    899            
     924            <div class="comments"> 
     925 Used to pass your keywords 
     926</div> 
     927             
     928           
     929 
     930          <h3>Examples</h3><div class="preformat"> 
     931 
     932</div> 
     933          <h3>Version history</h3> 
     934           
     935          <h4>Version</h4><div class="preformat"> 
     936 $Id$ 
     937</div> 
     938          <h4>History</h4><div class="preformat"> 
     939 
     940</div> 
    900941           
    901942           
    … …  
    905946          <h4>Todo items</h4><div class="preformat"> seb 
    906947</div> 
    907            
    908          
    909            
    910            
    911            
    912            
    913            
    914            
    915            
    916          
     948          <h4>Restrictions</h4><div class="preformat"> 
     949 
     950</div> 
     951         
     952          <h3>Other attributes</h3> 
     953           
     954           
     955          <h4>Uses routines</h4><div class="preformat"> 
     956 
     957</div> 
     958           
     959           
     960           
     961         
     962          <h3>Statistics</h3> 
     963          <table class="statistics"> 
     964            <tr><td>McCabe cyclic</td><td>          24</td></tr> 
     965            <tr><td>McCabe essential</td><td>           3</td></tr> 
     966            <tr><td>McCabe modular design</td><td>           3</td></tr> 
     967          </table> 
    917968           
    918969         
Note: See TracChangeset for help on using the changeset viewer.