Ignore:
Timestamp:
07/21/06 14:47:49 (18 years ago)
Author:
navarro
Message:

english and nicer header (2a)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/strwhere.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 return position *array* for occurence of a character in a string 
     700</div> 
    699701 
    700702       
     
    711713        <div class="routine_details" id="_strwhere"> 
    712714 
    713           <h2><a class="top" href="#container">top</a>strwhere </h2> 
     715          <h2><a class="top" href="#container">top</a>strwhere <span class="categories"> 
     716 string tools 
     717</span></h2> 
    714718         
    715719          <p class="header"> 
     
    717721         
    718722          <div class="comments"> 
    719  NAME: 
    720         STRWHERE  (function) 
    721  
    722  PURPOSE: 
    723         return position *array* for occurence of a character in 
    724         a string 
    725  
    726  CATEGORY: 
    727         string tools 
    728  
    729  CALLING SEQUENCE: 
    730         pos = STRWHERE(str, schar [,Count] ) 
    731  
    732  INPUTS: 
    733         STR -> the string 
    734  
    735         SCHAR -> the character to look for 
    736  
    737  KEYWORD PARAMETERS: 
    738         none. 
    739  
    740  OUTPUTS: 
    741         COUNT -> (optional) The number of matches that were found  
    742  
    743         The function returns an index array similar to the  
    744         result of the where function 
    745  
    746  SUBROUTINES: 
    747  
    748  REQUIREMENTS: 
    749  
    750  NOTES: 
    751  
    752  EXAMPLE: 
     723</div> 
     724 
     725          <h3>Return value</h3><div class="preformat"> COUNT {out}{optional} 
     726 The number of matches that were found  
     727 
     728  The function returns an index array similar to the  
     729  result of the where function 
     730</div> 
     731 
     732           
     733            <h3>Parameters</h3> 
     734         
     735             
     736            <h4 id="_strwhere_param_str">str&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     737              <span class="attr">in</span> 
     738               
     739               
     740              <span class="attr">required</span> 
     741               
     742               
     743               
     744               
     745            </h4> 
     746         
     747          <div class="comments"> 
     748 the string 
     749</div> 
     750             
     751            <h4 id="_strwhere_param_schar">schar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     752              <span class="attr">in</span> 
     753               
     754               
     755              <span class="attr">required</span> 
     756               
     757               
     758               
     759               
     760            </h4> 
     761         
     762          <div class="comments"> 
     763 the character to look for 
     764</div> 
     765             
     766            <h4 id="_strwhere_param_Count">Count&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     767               
     768               
     769               
     770               
     771               
     772               
     773               
     774               
     775            </h4> 
     776         
     777          <div class="comments"></div> 
     778             
     779 
     780           
     781 
     782           
     783 
     784          <h3>Examples</h3><div class="preformat"> 
    753785        ind = strwhere('abcabcabc','a') 
    754786 
    755787        ; returns [ 0, 3, 6 ] 
    756  
    757  MODIFICATION HISTORY: 
     788</div> 
     789          <h3>Version history</h3> 
     790           
     791          <h4>Version</h4><div class="preformat"> 
     792 $Id: strwhere.pro 134 2006-07-07 10:19:08Z navarro $ 
     793</div> 
     794          <h4>History</h4><div class="preformat"> 
    758795        mgs, 02 Jun 1998: VERSION 1.00 
    759796        bmy, 30 Jun 1998: - now returns COUNT, the number  
     
    761798                            analogous to the WHERE command) 
    762799</div> 
    763  
    764            
    765  
    766            
    767             <h3>Parameters</h3> 
    768          
    769              
    770             <h4 id="_strwhere_param_str">str&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    771                
    772                
    773                
    774                
    775                
    776                
    777                
    778                
    779             </h4> 
    780          
    781           <div class="comments"></div> 
    782              
    783             <h4 id="_strwhere_param_schar">schar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    784                
    785                
    786                
    787                
    788                
    789                
    790                
    791                
    792             </h4> 
    793          
    794           <div class="comments"></div> 
    795              
    796             <h4 id="_strwhere_param_Count">Count&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    797                
    798                
    799                
    800                
    801                
    802                
    803                
    804                
    805             </h4> 
    806          
    807           <div class="comments"></div> 
    808              
    809  
    810            
    811  
    812            
    813  
    814            
    815            
    816            
    817            
    818            
    819800           
    820801           
Note: See TracChangeset for help on using the changeset viewer.