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

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 Retrieve portion of string up to token. 
     700 </div> 
    699701 
    700702       
    … …  
    711713        <div class="routine_details" id="_Strtok"> 
    712714 
    713           <h2><a class="top" href="#container">top</a>Strtok </h2> 
     715          <h2><a class="top" href="#container">top</a>Strtok <span class="categories"> 
     716 text/strings 
     717</span></h2> 
    714718         
    715719          <p class="header"> 
    … …  
    717721         
    718722          <div class="comments"> 
    719  NAME: 
    720        STRTOK 
    721  PURPOSE: 
    722        Retrieve portion of string up to token. 
    723  CATEGORY: 
    724        text/strings 
    725  CALLING SEQUENCE: 
    726        new = strtok( old, token ) 
    727  INPUTS: 
    728        old   -- String to be split.  Contains text after    in, out 
    729                 token on output. 
    730        token -- Token to use in splitting old.              in 
    731  KEYWORD PARAMETERS: 
    732        /TRIM -- set to remove leading blanks from old  
    733                 before returning. 
    734        /HELP -- print useful message and exit. 
    735  OUTPUTS: 
    736        new   -- portion of string up to token.              out 
    737        old   -- portion of old after token.                 out, in 
    738  COMMON BLOCKS: 
    739  SIDE EFFECTS: 
    740        Input parameter old is modified. 
    741  NOTES: 
    742        Token may be one or more characters. 
    743        If token is not found, returns old and sets old to ''. 
    744  EXAMPLE: 
     723</div> 
     724 
     725          <h3>Return value</h3><div class="preformat"> 
     726 new   -- portion of string up to token.              out 
     727 old   -- portion of old after token.                 out, in 
     728</div> 
     729 
     730           
     731            <h3>Parameters</h3> 
     732         
     733             
     734            <h4 id="_Strtok_param_string">string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     735              <span class="attr">in</span> 
     736               
     737               
     738              <span class="attr">required</span> 
     739               
     740               
     741               
     742               
     743            </h4> 
     744         
     745          <div class="comments"> 
     746 String to be split.  Contains text after    in, out 
     747 token on output. 
     748 </div> 
     749             
     750            <h4 id="_Strtok_param_token">token&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     751              <span class="attr">in</span> 
     752               
     753               
     754              <span class="attr">required</span> 
     755               
     756               
     757               
     758               
     759            </h4> 
     760         
     761          <div class="comments"> 
     762 Token to use in splitting old.        
     763</div> 
     764             
     765 
     766           
     767 
     768           
     769 
     770            <h3>Keywords</h3> 
     771             
     772            <h4 id="_Strtok_keyword_TRIM">TRIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     773               
     774               
     775               
     776               
     777               
     778               
     779               
     780               
     781            </h4> 
     782         
     783            <div class="comments">  
     784 set to remove leading blanks from old  
     785 before returning. 
     786</div> 
     787             
     788            <h4 id="_Strtok_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     789               
     790               
     791               
     792               
     793               
     794               
     795               
     796               
     797            </h4> 
     798         
     799            <div class="comments"> 
     800 print useful message and exit. 
     801 </div> 
     802             
     803           
     804 
     805          <h3>Examples</h3><div class="preformat"> 
    745806       If old is 'foo44 bar', then strtok( old, '44' ) would return 
    746807       'foo', and upon return, old will be left with ' bar'.  If /TRIM 
    … …  
    749810       If old='xyz', then new=strtok(old,'a') would return with 
    750811       new='xyz' and old=''. 
    751  THANKS: 
    752        To D. Linder who wrote GETTOK, part of the goddard library, 
    753        upon which this is based. 
    754  MODIFICATION HISTORY: 
    755        $Id: strtok.pro 134 2006-07-07 10:19:08Z navarro $ 
     812</div> 
     813          <h3>Version history</h3> 
     814           
     815          <h4>Version</h4><div class="preformat"> 
     816 $Id: strtok.pro 134 2006-07-07 10:19:08Z navarro $ 
     817</div> 
     818          <h4>History</h4><div class="preformat"> 
    756819       $Log: strtok.pro,v $ 
    757820       Revision 1.3  1996/06/14 20:00:27  mcraig 
    … …  
    764827       Initial revision 
    765828 
    766  RELEASE: 
     829 Thanks: 
     830       To D. Linder who wrote GETTOK, part of the goddard library, 
     831       upon which this is based. 
     832 
     833 Release: 
    767834       $Name: Rel_1_2 $ 
    768835 
    769  COPYRIGHT: 
     836 Copyright: 
    770837  Copyright (C) 1996 The Regents of the University of California, All 
    771838  Rights Reserved.  Written by Matthew W. Craig. 
    772839  See the file COPYRIGHT for restrictions on distrubting this code. 
    773   This code comes with absolutely NO warranty; see DISCLAIMER for details.</div> 
    774  
    775            
    776  
    777            
    778             <h3>Parameters</h3> 
    779          
    780              
    781             <h4 id="_Strtok_param_string">string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    782                
    783                
    784                
    785                
    786                
    787                
    788                
    789                
    790             </h4> 
    791          
    792           <div class="comments"></div> 
    793              
    794             <h4 id="_Strtok_param_token">token&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    795                
    796                
    797                
    798                
    799                
    800                
    801                
    802                
    803             </h4> 
    804          
    805           <div class="comments"></div> 
    806              
    807  
    808            
    809  
    810            
    811  
    812             <h3>Keywords</h3> 
    813              
    814             <h4 id="_Strtok_keyword_TRIM">TRIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    815                
    816                
    817                
    818                
    819                
    820                
    821                
    822                
    823             </h4> 
    824          
    825             <div class="comments"></div> 
    826              
    827             <h4 id="_Strtok_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    828                
    829                
    830                
    831                
    832                
    833                
    834                
    835                
    836             </h4> 
    837          
    838             <div class="comments"></div> 
    839              
    840            
    841  
    842            
    843            
    844            
    845            
    846            
    847            
    848            
    849            
    850            
    851            
    852            
    853            
     840  This code comes with absolutely NO warranty; see DISCLAIMER for details. 
     841</div> 
     842           
     843           
     844          <h3>Known issues</h3> 
     845           
     846           
     847           
     848          <h4>Restrictions</h4><div class="preformat"> 
     849 Input parameter old is modified. 
     850 Token may be one or more characters. 
     851 If token is not found, returns old and sets old to ''. 
     852 </div> 
    854853         
    855854           
Note: See TracChangeset for help on using the changeset viewer.