Ignore:
Timestamp:
06/12/06 14:54:03 (18 years ago)
Author:
pinsard
Message:

start to modify headers of Postscript *.pro files for better idldoc output + change the title of idldoc output in html to SAXO Documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/Postscript/printps.html

    r89 r104  
    77<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 
    88  <head> 
    9     <title>printps.pro (IDLdoc API documentation)</title> 
     9    <title>printps.pro (SAXO Documentation)</title> 
    1010 
    1111     
     
    1616    <script type="text/javascript"> 
    1717      function setTitle() { 
    18         parent.document.title="printps.pro (IDLdoc API documentation)"; 
     18        parent.document.title="printps.pro (SAXO Documentation)"; 
    1919      } 
    2020    </script> 
     
    2424 
    2525    <div id="navbar_title"> 
    26   <h1>IDLdoc API documentation</h1> 
     26  <h1>SAXO Documentation</h1> 
    2727</div> 
    2828 
     
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> postscript visualisation/archiving/printing 
     90</div> 
    9091 
    9192       
     
    102103           
    103104          <dt><p><a href="#_printps_event">printps_event<span class="result">, event</span></a></p><dt> 
    104           <dd>  NAME:   printps   PURPOSE: postscript visualisation/archiving/printing   CATEGORY: for the postscripts   CALLING SEQUENCE:      imprime [,psfilename]         INPUTS:           psfilename: the name of the postscript file we want to            visualize and/or print and/or archive.</dd>    
    105            
    106           <dt><p><a href="#_printps">printps<span class="result">, psfilename</span></a></p><dt> 
     105          <dd>     - archiving possibilities -    if archive_ps (common variable of cm_4ps) ne 0 then the postscript  can be saved for archiving if it is printed or if the button  "archive ps" is pressed.</dd>        
     106           
     107          <dt><p><a href="#_printps">printps<span class="result">[, psfilename]</span></a></p><dt> 
    107108          <dd></dd>      
    108109                 
     
    116117        <div class="routine_details" id="_printps_event"> 
    117118 
    118           <h2><a class="top" href="#container">top</a>printps_event </h2> 
     119          <h2><a class="top" href="#container">top</a>printps_event <span class="categories"> for the postscripts 
     120</span></h2> 
    119121         
    120122          <p class="header"> 
     
    122124         
    123125          <div class="comments"> 
    124  NAME: 
    125         printps 
    126  
    127  PURPOSE: postscript visualisation/archiving/printing 
    128  
    129  CATEGORY: for the postscripts 
    130  
    131  CALLING SEQUENCE: 
    132         imprime [,psfilename] 
    133        
    134  INPUTS: 
    135    
    136         psfilename: the name of the postscript file we want to 
    137            visualize and/or print and/or archive. It can also refer 
    138            to a gzipped postscript file. If needed, this name will 
    139            be completed by .ps and/or .gz  
    140  
    141  KEYWORD PARAMETERS: None 
    142  
    143  COMMON BLOCKS: cm_4ps 
    144  
    145  SIDE EFFECTS:  
     126 
     127 
    146128 
    147129 - archiving possibilities - 
     
    155137 be changed to number.ps (number automatically found to be 1 larger 
    156138 that any of the existing ps file). 
    157  
    158  RESTRICTIONS: 
     139</div> 
     140 
     141           
     142 
     143           
     144            <h3>Parameters</h3> 
     145         
     146             
     147            <h4 id="_printps_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     148               
     149               
     150               
     151               
     152               
     153               
     154               
     155               
     156            </h4> 
     157         
     158          <div class="comments"></div> 
     159             
     160 
     161           
     162 
     163           
     164 
     165           
     166          <h3>Version history</h3> 
     167           
     168           
     169          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     170                        21/12/98 
     171                       25/8/19999 utilisation des widgets 
     172                       8/9/1999 utilisation de cw_bgroup 
     173 June 2005: Sebastien Masson: cleaning, english version with new commons </div> 
     174           
     175           
     176          <h3>Known issues</h3> 
     177           
     178           
     179           
     180          <h4>Restrictions</h4><div class="value"> 
    159181 
    160182 1) this is working only with unix/linux/osX machines 
     
    168190 or 
    169191     print_command+printer_machine_names[i]+' '+file.ps 
    170  is working. default definition is '\lpr -P' 
    171  
    172  EXAMPLE: IDL> printps 
    173 </div> 
     192 is working. default definition is 'lpr -P' 
     193 
     194</div> 
     195         
     196           
     197           
     198           
     199           
     200           
     201           
     202           
     203         
     204           
     205         
     206        </div> 
     207         
     208 
     209        <div class="routine_details" id="_printps"> 
     210 
     211          <h2><a class="top" href="#container">top</a>printps </h2> 
     212         
     213          <p class="header"> 
     214            printps<span class="result">[, <a href="#_printps_param_psfilename">psfilename</a>]</span></p> 
     215         
     216          <div class="comments"></div> 
    174217 
    175218           
     
    179222         
    180223             
    181             <h4 id="_printps_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    182                
    183                
    184                
     224            <h4 id="_printps_param_psfilename">psfilename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     225              <span class="attr">in</span> 
     226               
     227              <span class="attr">optional</span> 
    185228               
    186229               
     
    190233            </h4> 
    191234         
    192           <div class="comments"></div> 
    193              
    194  
    195            
    196  
    197            
    198  
    199            
    200            
    201            
    202            
    203            
    204            
    205            
    206            
    207            
    208            
    209            
    210            
    211          
    212            
    213            
    214            
    215            
    216            
    217            
    218            
    219          
    220            
    221          
    222         </div> 
    223          
    224  
    225         <div class="routine_details" id="_printps"> 
    226  
    227           <h2><a class="top" href="#container">top</a>printps </h2> 
    228          
    229           <p class="header"> 
    230             printps<span class="result">, <a href="#_printps_param_psfilename">psfilename</a></span></p> 
    231          
    232           <div class="comments"></div> 
    233  
    234            
    235  
    236            
    237             <h3>Parameters</h3> 
    238          
    239              
    240             <h4 id="_printps_param_psfilename">psfilename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    241                
    242                
    243                
    244                
    245                
    246                
    247                
    248                
    249             </h4> 
    250          
    251           <div class="comments"></div> 
    252              
    253  
    254            
    255  
    256            
    257  
    258            
    259            
    260            
    261            
    262            
    263            
    264            
    265            
    266            
    267            
    268            
    269            
    270          
    271            
    272            
    273            
    274            
     235          <div class="comments"> the name of the postscript file we want to 
     236           visualize and/or print and/or archive. It can also refer 
     237           to a gzipped postscript file. If needed, this name will 
     238           be completed by .ps and/or .gz  
     239</div> 
     240             
     241 
     242           
     243 
     244           
     245 
     246          <h3>Examples</h3><div class="value"> 
     247  IDL> printps 
     248</div> 
     249          <h3>Version history</h3> 
     250           
     251           
     252          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     253                        21/12/98 
     254                       25/8/19999 utilisation des widgets 
     255                       8/9/1999 utilisation de cw_bgroup 
     256 June 2005: Sebastien Masson: cleaning, english version with new commons </div> 
     257           
     258           
     259           
     260           
     261           
     262           
     263           
     264         
     265          <h3>Other attributes</h3> 
     266           
     267           
     268          <h4>Uses routines</h4><div class="value"> cm_4ps 
     269</div> 
    275270           
    276271           
Note: See TracChangeset for help on using the changeset viewer.