Ignore:
Timestamp:
06/12/06 16:49:30 (18 years ago)
Author:
pinsard
Message:

start to modify headers of ReadWrite? *.pro files for better idldoc output

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/ReadWrite/write_oasis.html

    r104 r106  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> write an Oasis file (version < 2.5) 
     90</div> 
    9091 
    9192       
     
    108109         
    109110          <div class="comments"> 
    110  NAME:write_oasis 
    111  
    112  PURPOSE:write an Oasis file (version < 2.5) 
    113  
    114  CATEGORY: 
    115  
    116  CALLING SEQUENCE:write_oasis, filename, varname, z2d 
    117   
    118  INPUTS: 
    119         filename:the filename 
    120         varname: the name of the variable to be written 
    121         z2d: the variable (2D array) to be written 
    122  
    123  KEYWORD PARAMETERS: 
    124         /I2, /I4, /I8, /R4: to change the defaut format (R8) of the data to  
    125         be written. 
    126  
    127         /APPEND: to open the file with the file pointer at the end of 
     111</div> 
     112 
     113           
     114 
     115           
     116            <h3>Parameters</h3> 
     117         
     118             
     119            <h4 id="_write_oasis_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     120              <span class="attr">in</span> 
     121               
     122               
     123              <span class="attr">required</span> 
     124               
     125               
     126               
     127               
     128            </h4> 
     129         
     130          <div class="comments"> the filename</div> 
     131             
     132            <h4 id="_write_oasis_param_varname">varname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     133              <span class="attr">in</span> 
     134               
     135               
     136              <span class="attr">required</span> 
     137               
     138               
     139               
     140               
     141            </h4> 
     142         
     143          <div class="comments"> the name of the variable to be written</div> 
     144             
     145            <h4 id="_write_oasis_param_z2d">z2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     146              <span class="attr">in</span> 
     147               
     148               
     149              <span class="attr">required</span> 
     150               
     151               
     152               
     153               
     154            </h4> 
     155         
     156          <div class="comments"> the variable (2D array) to be written 
     157</div> 
     158             
     159            <h4 id="_write_oasis_param_I2">I2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     160               
     161               
     162               
     163               
     164               
     165               
     166               
     167               
     168            </h4> 
     169         
     170          <div class="comments"></div> 
     171             
     172 
     173           
     174 
     175           
     176 
     177            <h3>Keywords</h3> 
     178             
     179            <h4 id="_write_oasis_keyword_I4">I4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     180               
     181               
     182               
     183               
     184               
     185               
     186               
     187               
     188            </h4> 
     189         
     190            <div class="comments"></div> 
     191             
     192            <h4 id="_write_oasis_keyword_I8">I8&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     193               
     194               
     195               
     196               
     197               
     198               
     199               
     200               
     201            </h4> 
     202         
     203            <div class="comments"></div> 
     204             
     205            <h4 id="_write_oasis_keyword_R4">R4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     206               
     207               
     208               
     209               
     210               
     211               
     212               
     213               
     214            </h4> 
     215         
     216            <div class="comments"> 
     217 to change the defaut format (R8) of the data to be written. 
     218</div> 
     219             
     220            <h4 id="_write_oasis_keyword_APPEND">APPEND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     221               
     222               
     223               
     224               
     225               
     226               
     227               
     228               
     229            </h4> 
     230         
     231            <div class="comments"> to open the file with the file pointer at the end of 
    128232        the file, ready for data to be appended. 
    129233 
    130  OUTPUTS: 
    131  
    132  COMMON BLOCKS: 
    133  
    134  SIDE EFFECTS:varname is automatically written as a "charactere*8" 
     234</div> 
     235             
     236           
     237 
     238           
     239          <h3>Version history</h3> 
     240           
     241           
     242          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     243                      July 01, 2002</div> 
     244           
     245           
     246          <h3>Known issues</h3> 
     247           
     248           
     249           
     250          <h4>Restrictions</h4><div class="value"> varname is automatically written as a "charactere*8" 
    135251              by defaut z2d is written as an R8 array 
    136  
    137  RESTRICTIONS: 
    138  
    139  EXAMPLE: 
    140 </div> 
    141  
    142            
    143  
    144            
    145             <h3>Parameters</h3> 
    146          
    147              
    148             <h4 id="_write_oasis_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    149                
    150                
    151                
    152                
    153                
    154                
    155                
    156                
    157             </h4> 
    158          
    159           <div class="comments"></div> 
    160              
    161             <h4 id="_write_oasis_param_varname">varname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    162                
    163                
    164                
    165                
    166                
    167                
    168                
    169                
    170             </h4> 
    171          
    172           <div class="comments"></div> 
    173              
    174             <h4 id="_write_oasis_param_z2d">z2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    175                
    176                
    177                
    178                
    179                
    180                
    181                
    182                
    183             </h4> 
    184          
    185           <div class="comments"></div> 
    186              
    187             <h4 id="_write_oasis_param_I2">I2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    188                
    189                
    190                
    191                
    192                
    193                
    194                
    195                
    196             </h4> 
    197          
    198           <div class="comments"></div> 
    199              
    200  
    201            
    202  
    203            
    204  
    205             <h3>Keywords</h3> 
    206              
    207             <h4 id="_write_oasis_keyword_I4">I4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    208                
    209                
    210                
    211                
    212                
    213                
    214                
    215                
    216             </h4> 
    217          
    218             <div class="comments"></div> 
    219              
    220             <h4 id="_write_oasis_keyword_I8">I8&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    221                
    222                
    223                
    224                
    225                
    226                
    227                
    228                
    229             </h4> 
    230          
    231             <div class="comments"></div> 
    232              
    233             <h4 id="_write_oasis_keyword_R4">R4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    234                
    235                
    236                
    237                
    238                
    239                
    240                
    241                
    242             </h4> 
    243          
    244             <div class="comments"></div> 
    245              
    246             <h4 id="_write_oasis_keyword_APPEND">APPEND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    247                
    248                
    249                
    250                
    251                
    252                
    253                
    254                
    255             </h4> 
    256          
    257             <div class="comments"></div> 
    258              
    259            
    260  
    261            
    262            
    263            
    264            
    265            
    266            
    267            
    268            
    269            
    270            
    271            
    272            
     252</div> 
    273253         
    274254           
Note: See TracChangeset for help on using the changeset viewer.