Ignore:
Timestamp:
08/29/06 14:59:46 (18 years ago)
Author:
navarro
Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/Textoidl/textable.html

    r157 r163  
    699699      </div> 
    700700 
    701       <div id="file_comments"></div> 
     701      <div id="file_comments"> 
     702 Returns a translation table from TeX to IDL. 
     703</div> 
    702704 
    703705       
    … …  
    714716        <div class="routine_details" id="_textable"> 
    715717 
    716           <h2><a class="top" href="#container">top</a>textable </h2> 
     718          <h2><a class="top" href="#container">top</a>textable <span class="categories"> 
     719 Text, String 
     720</span></h2> 
    717721         
    718722          <p class="header"> 
    719723            <span class="result">result = </span>textable(<a href="#_textable_keyword_POSTSCRIPT">POSTSCRIPT</a>=<span class="result">POSTSCRIPT</span>, <a href="#_textable_keyword_VECTOR">VECTOR</a>=<span class="result">VECTOR</span>, <a href="#_textable_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p> 
    720724         
    721           <div class="comments"> 
    722  NAME: 
    723        TEXTABLE 
    724  PURPOSE: 
    725        Returns a translation table from TeX to IDL. 
    726  CATEGORY: 
    727        text/strings 
    728  CALLING SEQUENCE: 
    729        table = textable() 
    730  INPUTS: 
    731        None 
    732  KEYWORD PARAMETERS: 
    733        /POSTSCRIPT -- If set, return postscript translation 
    734                       table rather than vector fonts table. 
    735                       Default is translations for vector 
    736                       fonts. 
    737        /HELP       -- Print help and exit. 
    738  OUTPUTS: 
    739        table -- a 2D text array.  table(0,*) contains          out 
    740                 the words to be translated away, table(1,*) 
    741                 contains the words to translate them to.    
    742  COMMON BLOCKS: 
    743  SIDE EFFECTS: 
    744  NOTES: 
    745        To find out what TeX sequences are available, look at 
    746        table(0,*). 
    747  EXAMPLE: 
    748  MODIFICATION HISTORY: 
    749        $Id: textable.pro 134 2006-07-07 10:19:08Z navarro $ 
     725          <div class="comments"></div> 
     726 
     727          <h3>Return value</h3><div class="preformat"> 
     728 a 2D text array.  table(0,*) contains the words to be translated away, table(1,*) 
     729 contains the words to translate them to. 
     730</div> 
     731 
     732           
     733 
     734           
     735 
     736            <h3>Keywords</h3> 
     737             
     738            <h4 id="_textable_keyword_POSTSCRIPT">POSTSCRIPT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     739               
     740               
     741               
     742               
     743               
     744               
     745               
     746               
     747            </h4> 
     748         
     749            <div class="comments"> 
     750 If set, return postscript translation 
     751 table rather than vector fonts table. 
     752 Default is translations for vector fonts. 
     753</div> 
     754             
     755            <h4 id="_textable_keyword_VECTOR">VECTOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     756               
     757               
     758               
     759               
     760               
     761               
     762               
     763               
     764            </h4> 
     765         
     766            <div class="comments"> 
     767 
     768</div> 
     769             
     770            <h4 id="_textable_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     771               
     772               
     773               
     774               
     775               
     776               
     777               
     778               
     779            </h4> 
     780         
     781            <div class="comments"> 
     782 Print help and exit. 
     783</div> 
     784             
     785           
     786 
     787           
     788          <h3>Version history</h3> 
     789           
     790          <h4>Version</h4><div class="preformat"> 
     791 $Id: textable.pro 134 2006-07-07 10:19:08Z navarro $</div> 
     792          <h4>History</h4><div class="preformat"> 
    750793       $Log: textable.pro,v $ 
    751794       Revision 1.8  2004/06/15 17:25:54  mcraig 
    … …  
    753796 
    754797       Revision 1.7  1996/07/22 23:56:08  mcraig 
    755        Added \vartheta. 
     798       Added vartheta. 
    756799 
    757800       Revision 1.6  1996/07/12 21:31:42  mcraig 
    758        Fixed \varphi in vector font, added \circ. 
     801       Fixed varphi in vector font, added circ. 
    759802 
    760803       Revision 1.5  1996/06/14 20:00:27  mcraig 
    … …  
    766809 
    767810       Revision 1.3  1996/02/08 19:49:35  mcraig 
    768        Removed control sequence \perp because the postscript code for it is '^'. 
     811       Removed control sequence perp because the postscript code for it is '^'. 
    769812 
    770813       Revision 1.2  1996/02/08 18:53:38  mcraig 
    … …  
    775818       Initial revision 
    776819 
    777  RELEASE: 
    778        $Name: Rel_2_1_2 $ 
    779  
    780  COPYRIGHT: 
    781820  Copyright (C) 1996 The Regents of the University of California, All 
    782821  Rights Reserved.  Written by Matthew W. Craig. 
    783822  See the file COPYRIGHT for restrictions on distrubting this code. 
    784   This code comes with absolutely NO warranty; see DISCLAIMER for details.</div> 
    785  
    786            
    787  
    788            
    789  
    790            
    791  
    792             <h3>Keywords</h3> 
    793              
    794             <h4 id="_textable_keyword_POSTSCRIPT">POSTSCRIPT&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="_textable_keyword_VECTOR">VECTOR&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             <h4 id="_textable_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    821                
    822                
    823                
    824                
    825                
    826                
    827                
    828                
    829             </h4> 
    830          
    831             <div class="comments"></div> 
    832              
    833            
    834  
    835            
    836            
    837            
    838            
    839            
    840            
    841            
    842            
    843            
    844            
    845            
    846            
    847          
    848            
    849            
    850            
    851            
    852            
    853            
    854            
    855          
     823  This code comes with absolutely NO warranty; see DISCLAIMER for details. 
     824</div> 
     825           
     826           
     827          <h3>Known issues</h3> 
     828           
     829           
     830           
     831          <h4>Restrictions</h4><div class="preformat"> 
     832 To find out what TeX sequences are available, look at table(0,*). 
     833</div> 
     834         
     835           
     836           
     837           
     838           
     839           
     840           
     841           
     842         
     843          <h3>Statistics</h3> 
     844          <table class="statistics"> 
     845            <tr><td>McCabe cyclic</td><td>           3</td></tr> 
     846            <tr><td>McCabe essential</td><td>           1</td></tr> 
     847            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     848          </table> 
    856849           
    857850         
Note: See TracChangeset for help on using the changeset viewer.