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

english and nicer header (3b)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRUCTURE/struct2string.html

    r138 r151  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 Convert a structure to an "executable string" 
     700</div> 
    699701 
    700702       
     
    711713        <div class="routine_details" id="_struct2string"> 
    712714 
    713           <h2><a class="top" href="#container">top</a>struct2string </h2> 
     715          <h2><a class="top" href="#container">top</a>struct2string <span class="categories"> 
     716 utilities 
     717 </span></h2> 
    714718         
    715719          <p class="header"> 
     
    717721         
    718722          <div class="comments"> 
    719  NAME:struct2string 
    720  
    721  PURPOSE:convert a structure to an "executable string" 
    722  
    723  CATEGORY:bidouille 
    724  
    725  CALLING SEQUENCE:sting=struct2string(struct) 
    726   
    727  INPUTS:struct: a structure 
    728  
    729  KEYWORD PARAMETERS: 
    730  
    731       MAX_STRUCT_LENGTH : the maximum length of the structure 
    732       permetted to convert the structure to string. Default is 
    733       10000l. 
    734  
    735       /DIRECT2STRING: to get a string instead an "executable string" 
    736  
    737       /CUT_IN_STRING: try it 
    738  
    739  OUTPUTS: 
    740  
    741  SIDE EFFECTS:use tostr.pro, cf this function header! 
    742  
    743  RESTRICTIONS:use tostr.pro, cf this function header! 
    744  
    745  EXAMPLE: 
     723 </div> 
     724 
     725           
     726 
     727           
     728            <h3>Parameters</h3> 
     729         
     730             
     731            <h4 id="_struct2string_param_struct">struct&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     732              <span class="attr">in</span> 
     733               
     734               
     735              <span class="attr">required</span> 
     736               
     737               
     738               
     739               
     740            </h4> 
     741         
     742          <div class="comments"> 
     743 A structure 
     744</div> 
     745             
     746 
     747           
     748 
     749           
     750 
     751            <h3>Keywords</h3> 
     752             
     753            <h4 id="_struct2string_keyword_CUT_IN_STRING">CUT_IN_STRING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     754               
     755               
     756               
     757               
     758               
     759               
     760               
     761               
     762            </h4> 
     763         
     764            <div class="comments"> 
     765 Try it 
     766</div> 
     767             
     768            <h4 id="_struct2string_keyword_MAX_STRUCT_LENGTH">MAX_STRUCT_LENGTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     769               
     770               
     771               
     772               
     773               
     774               
     775               
     776               
     777            </h4> 
     778         
     779            <div class="comments"> 
     780 The maximum length of the structure 
     781 permetted to convert the structure to string. Default is 
     782 10000l. 
     783</div> 
     784             
     785            <h4 id="_struct2string_keyword_DIRECT2STRING">DIRECT2STRING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     786               
     787               
     788               
     789               
     790               
     791               
     792               
     793               
     794            </h4> 
     795         
     796            <div class="comments"> 
     797 To get a string instead an "executable string" 
     798</div> 
     799             
     800           
     801 
     802          <h3>Examples</h3><div class="preformat"> 
    746803 
    747804      IDL> print, struct2string(!d) 
     
    752809      ,[0,0],'ZOOM',[1,1]) 
    753810</div> 
    754  
    755            
    756  
    757            
    758             <h3>Parameters</h3> 
    759          
    760              
    761             <h4 id="_struct2string_param_struct">struct&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    762                
    763                
    764                
    765                
    766                
    767                
    768                
    769                
    770             </h4> 
    771          
    772           <div class="comments"></div> 
    773              
    774  
    775            
    776  
    777            
    778  
    779             <h3>Keywords</h3> 
    780              
    781             <h4 id="_struct2string_keyword_CUT_IN_STRING">CUT_IN_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="_struct2string_keyword_MAX_STRUCT_LENGTH">MAX_STRUCT_LENGTH&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             <h4 id="_struct2string_keyword_DIRECT2STRING">DIRECT2STRING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    808                
    809                
    810                
    811                
    812                
    813                
    814                
    815                
    816             </h4> 
    817          
    818             <div class="comments"></div> 
    819              
    820            
    821  
    822            
    823            
    824            
    825            
    826            
    827            
    828            
    829            
    830            
    831            
    832            
    833            
     811          <h3>Version history</h3> 
     812           
     813          <h4>Version</h4><div class="preformat"> 
     814 $Id: struct2string.pro 150 2006-08-09 10:12:54Z navarro $ 
     815</div> 
     816          <h4>History</h4><div class="preformat"></div> 
     817           
     818           
     819          <h3>Known issues</h3> 
     820           
     821           
     822           
     823          <h4>Restrictions</h4><div class="preformat"> 
     824 Use tostr.pro, cf this function header! 
     825</div> 
    834826         
    835827           
Note: See TracChangeset for help on using the changeset viewer.