Ignore:
Timestamp:
08/21/06 11:01:50 (18 years ago)
Author:
navarro
Message:

header improvements + xxx doc

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/ReadWrite/idl-NetCDF/ncdf_quickread/ncdf_quickread_helper.html

    r138 r157  
    3333 
    3434/* Main styles --------------------------------------------------------------- */ 
     35p.preformat { 
     36  font-family: Courier; 
     37} 
    3538 
    3639body { 
    … …  
    696699      </div> 
    697700 
    698       <div id="file_comments"></div> 
     701      <div id="file_comments"> 
     702 This function returns the filename name from the full path. 
     703 
     704 
     705 This function returns the directory name from the full path. 
     706 
     707 
     708 This routine ensures that the given name does not start with a number, 
     709 nor contain a dash.  IDL cannot accept a variable starting with a  
     710 number or containing a dash.  If the name starts with a number, an  
     711 underscore is prepended to the name, and if it contains a dash, the  
     712 dash is replaced with an underscore.   
     713 
     714 
     715 This procedure creates a script to read the data in a given netCDF 
     716 file into IDL.  The default output file is the name of the netCDF 
     717 file with idl replacing any existing suffix.  The default output is 
     718 variable data only. 
     719</div> 
    699720 
    700721       
    … …  
    731752        <div class="routine_details" id="_ncdf_quickread_getFile"> 
    732753 
    733           <h2><a class="top" href="#container">top</a>ncdf_quickread_getFile </h2> 
     754          <h2><a class="top" href="#container">top</a>ncdf_quickread_getFile <span class="categories"> 
     755 
     756</span></h2> 
    734757         
    735758          <p class="header"> 
    … …  
    738761          <div class="comments"></div> 
    739762 
    740            
     763          <h3>Return value</h3><div class="preformat"> 
     764 file - filename 
     765</div> 
    741766 
    742767           
    … …  
    755780            </h4> 
    756781         
    757           <div class="comments"></div> 
     782          <div class="comments"> 
     783 full directory+file path 
     784</div> 
    758785             
    759786 
    … …  
    775802            </h4> 
    776803         
    777             <div class="comments"></div> 
    778              
    779            
    780  
    781            
    782            
    783            
    784            
    785            
    786            
    787            
    788            
    789            
    790            
    791            
    792            
     804            <div class="comments"> 
     805 include inptu suffix in output file name 
     806</div> 
     807             
     808           
     809 
     810          <h3>Examples</h3><div class="preformat"> 
     811 Call: file = ncdf_quickread_getfile(fullpath) 
     812 </div> 
     813          <h3>Version history</h3> 
     814           
     815          <h4>Version</h4><div class="preformat"> 
     816 $Id$</div> 
     817          <h4>History</h4><div class="preformat"> 
     818 
     819</div> 
     820           
     821           
     822          <h3>Known issues</h3> 
     823           
     824           
     825           
     826          <h4>Restrictions</h4><div class="preformat"> 
     827 
     828</div> 
    793829         
    794830           
    … …  
    807843        <div class="routine_details" id="_ncdf_quickread_getDir"> 
    808844 
    809           <h2><a class="top" href="#container">top</a>ncdf_quickread_getDir </h2> 
     845          <h2><a class="top" href="#container">top</a>ncdf_quickread_getDir <span class="categories"> 
     846 
     847</span></h2> 
    810848         
    811849          <p class="header"> 
    … …  
    814852          <div class="comments"></div> 
    815853 
    816            
     854          <h3>Return value</h3><div class="preformat"> 
     855 directory path 
     856</div> 
    817857 
    818858           
    … …  
    831871            </h4> 
    832872         
    833           <div class="comments"></div> 
    834              
    835  
    836            
    837  
    838            
    839  
    840            
    841            
    842            
    843            
    844            
    845            
    846            
    847            
    848            
    849            
    850            
    851            
     873          <div class="comments"> 
     874 full directory+file path 
     875</div> 
     876             
     877 
     878           
     879 
     880           
     881 
     882          <h3>Examples</h3><div class="preformat"> 
     883 Call: dir = ncdf_quickread_getdir(fullpath) 
     884 </div> 
     885          <h3>Version history</h3> 
     886           
     887          <h4>Version</h4><div class="preformat"> 
     888 $Id$</div> 
     889          <h4>History</h4><div class="preformat"> 
     890 
     891</div> 
     892           
     893           
     894          <h3>Known issues</h3> 
     895           
     896           
     897           
     898          <h4>Restrictions</h4><div class="preformat"> 
     899 
     900</div> 
    852901         
    853902           
    … …  
    866915        <div class="routine_details" id="_ncdf_quickread_validateName"> 
    867916 
    868           <h2><a class="top" href="#container">top</a>ncdf_quickread_validateName </h2> 
     917          <h2><a class="top" href="#container">top</a>ncdf_quickread_validateName <span class="categories"> 
     918 
     919</span></h2> 
    869920         
    870921          <p class="header"> 
    … …  
    873924          <div class="comments"></div> 
    874925 
    875            
     926          <h3>Return value</h3><div class="preformat"> 
     927 
     928</div> 
    876929 
    877930           
    … …  
    890943            </h4> 
    891944         
    892           <div class="comments"></div> 
    893              
    894  
    895            
    896  
    897            
    898  
    899            
    900            
    901            
    902            
    903            
    904            
    905            
    906            
    907            
    908            
    909            
    910            
     945          <div class="comments"> 
     946 The name of the variable to be read 
     947  
     948</div> 
     949             
     950 
     951           
     952 
     953           
     954 
     955          <h3>Examples</h3><div class="preformat"> 
     956  
     957 </div> 
     958          <h3>Version history</h3> 
     959           
     960          <h4>Version</h4><div class="preformat"> 
     961 $Id$</div> 
     962          <h4>History</h4><div class="preformat"> 
     963 
     964</div> 
     965           
     966           
     967          <h3>Known issues</h3> 
     968           
     969           
     970           
     971          <h4>Restrictions</h4><div class="preformat"> 
     972 
     973</div> 
    911974         
    912975           
    … …  
    925988        <div class="routine_details" id="_ncdf_quickread_helper"> 
    926989 
    927           <h2><a class="top" href="#container">top</a>ncdf_quickread_helper </h2> 
     990          <h2><a class="top" href="#container">top</a>ncdf_quickread_helper <span class="categories"> 
     991 
     992</span></h2> 
    928993         
    929994          <p class="header"> 
    … …  
    932997          <div class="comments"></div> 
    933998 
    934            
     999          <h3>Return value</h3><div class="preformat"> 
     1000 array of commands to run at top level 
     1001</div> 
    9351002 
    9361003           
    … …  
    9491016            </h4> 
    9501017         
    951           <div class="comments"></div> 
     1018          <div class="comments"> 
     1019 full path to netCDF file of interest 
     1020</div> 
    9521021             
    9531022 
    … …  
    9691038            </h4> 
    9701039         
    971             <div class="comments"></div> 
     1040            <div class="comments">   
     1041 Set this keyword to return an error message in case of an error. 
     1042</div> 
    9721043             
    9731044            <h4 id="_ncdf_quickread_helper_keyword_prefix">prefix&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    9821053            </h4> 
    9831054         
    984             <div class="comments"></div> 
     1055            <div class="comments"> 
     1056 see changelog above. 
     1057</div> 
    9851058             
    9861059            <h4 id="_ncdf_quickread_helper_keyword_fields">fields&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    9951068            </h4> 
    9961069         
    997             <div class="comments"></div> 
     1070            <div class="comments"> 
     1071 
     1072</div> 
    9981073             
    9991074            <h4 id="_ncdf_quickread_helper_keyword_reform">reform&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    10081083            </h4> 
    10091084         
    1010             <div class="comments"></div> 
    1011              
    1012            
    1013  
    1014            
    1015            
    1016            
    1017            
    1018            
    1019            
    1020            
    1021            
    1022            
    1023            
    1024            
    1025            
     1085            <div class="comments"> 
     1086 see changelog above.  
     1087</div> 
     1088             
     1089           
     1090 
     1091          <h3>Examples</h3><div class="preformat"> 
     1092  
     1093 </div> 
     1094          <h3>Version history</h3> 
     1095           
     1096          <h4>Version</h4><div class="preformat"> 
     1097 $Id$ 
     1098</div> 
     1099          <h4>History</h4><div class="preformat"> 
     1100 
     1101</div> 
     1102           
     1103           
     1104          <h3>Known issues</h3> 
     1105           
     1106           
     1107           
     1108          <h4>Restrictions</h4><div class="preformat"> 
     1109 
     1110</div> 
    10261111         
    10271112           
Note: See TracChangeset for help on using the changeset viewer.