Ignore:
Timestamp:
03/21/07 10:14:37 (17 years ago)
Author:
pinsard
Message:

new idldoc html and assistant outputs

Location:
trunk/SRC/Documentation/idldoc_html_output/Utilities
Files:
21 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/createfunc.html

    r200 r234  
    110110            <span class="result">result = </span>createfunc(<span class="result"><a href="#_createfunc_param_command">command</a></span>, <a href="#_createfunc_keyword_FILENAMEIN">FILENAMEIN</a>=<span class="result">FILENAMEIN</span>, <a href="#_createfunc_keyword_KWDLIST">KWDLIST</a>=<span class="result">KWDLIST</span>, <a href="#_createfunc_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 
    111111         
    112           <div class="comments"></div> 
     112          <div class="comments"> 
     113</div> 
    113114 
    114115           
    … …  
    186187         
    187188            <div class="comments">  
    188  used to pass your keywords to the created function. 
     189 Used to pass keywords to the created function. 
    189190</div> 
    190191             
    … …  
    198199          <h3>Version history</h3> 
    199200           
    200           <h4>Version</h4><div class="preformat"> $Id: createfunc.pro 136 2006-07-10 15:20:19Z pinsard $ 
    201 </div> 
    202           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     201          <h4>Version</h4><div class="preformat"> 
     202 $Id: createfunc.pro 231 2007-03-19 17:15:51Z pinsard $ 
     203</div> 
     204          <h4>History</h4><div class="preformat"> 
     205 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    203206                      May 2005 
    204207</div> 
    … …  
    224227          <h3>Statistics</h3> 
    225228          <table class="statistics"> 
    226             <tr><td>McCabe cyclic</td><td>           6</td></tr> 
     229            <tr><td>McCabe cyclic</td><td>           7</td></tr> 
    227230            <tr><td>McCabe essential</td><td>           1</td></tr> 
    228231            <tr><td>McCabe modular design</td><td>           1</td></tr> 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/createpro.html

    r200 r234  
    109109            createpro<span class="result">, <a href="#_createpro_param_command">command</a></span>, <a href="#_createpro_keyword_FILENAMEIN">FILENAMEIN</a>=<span class="result">FILENAMEIN</span>, <a href="#_createpro_keyword_KWDLIST">KWDLIST</a>=<span class="result">KWDLIST</span>, <a href="#_createpro_keyword_KWDUSED">KWDUSED</a>=<span class="result">KWDUSED</span>, <a href="#_createpro_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
    110110         
    111           <div class="comments"></div> 
     111          <div class="comments"> 
     112</div> 
    112113 
    113114           
    … …  
    201202         
    202203            <div class="comments">  
    203  used to pass your keywords to the created procedure. 
     204 Used to pass keywords to the created procedure. 
    204205</div> 
    205206             
    … …  
    215216          <h3>Version history</h3> 
    216217           
    217           <h4>Version</h4><div class="preformat"> $Id: createpro.pro 163 2006-08-29 12:59:46Z navarro $</div> 
    218           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     218          <h4>Version</h4><div class="preformat"> 
     219 $Id: createpro.pro 232 2007-03-20 16:59:36Z pinsard $</div> 
     220          <h4>History</h4><div class="preformat"> 
     221 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    219222 cleaning + new keywords: October 2005 
    220223 Feb. 2006: supress keyword "kwdused" and use call_procedure instead of execute 
    … …  
    242245          <h3>Statistics</h3> 
    243246          <table class="statistics"> 
    244             <tr><td>McCabe cyclic</td><td>           6</td></tr> 
     247            <tr><td>McCabe cyclic</td><td>           7</td></tr> 
    245248            <tr><td>McCabe essential</td><td>           1</td></tr> 
    246249            <tr><td>McCabe modular design</td><td>           1</td></tr> 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/def_myuniquetmpdir.html

    r200 r234  
    112112            def_myuniquetmpdir</p> 
    113113         
    114           <div class="comments"></div> 
     114          <div class="comments"> 
     115</div> 
    115116 
    116117           
    … …  
    125126          <h3>Version history</h3> 
    126127           
    127           <h4>Version</h4><div class="preformat"> $Id: def_myuniquetmpdir.pro 157 2006-08-21 09:01:50Z navarro $ 
     128          <h4>Version</h4><div class="preformat"> 
     129 $Id: def_myuniquetmpdir.pro 231 2007-03-19 17:15:51Z pinsard $ 
    128130</div> 
    129           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     131          <h4>History</h4><div class="preformat"> 
     132 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    130133                      June 2005 
    131134</div> 
    … …  
    141144           
    142145           
    143           <h4>Uses routines</h4><div class="preformat"> cm_general 
     146          <h4>Uses routines</h4><div class="preformat"> 
     147 cm_general 
    144148</div> 
    145149           

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/demomode_compatibility.html

    r200 r234  
    102102        <div class="routine_details" id="_demomode_compatibility"> 
    103103 
    104           <h2><a class="top" href="#container">top</a>demomode_compatibility <span class="categories"> Utilities</span></h2> 
     104          <h2><a class="top" href="#container">top</a>demomode_compatibility <span class="categories"> 
     105 Utilities 
     106</span></h2> 
    105107         
    106108          <p class="header"> 
    107109            demomode_compatibility</p> 
    108110         
    109           <div class="comments"></div> 
     111          <div class="comments"> 
     112</div> 
    110113 
    111114           
    … …  
    118121          <h3>Version history</h3> 
    119122           
    120           <h4>Version</h4><div class="preformat"> $Id: demomode_compatibility.pro 157 2006-08-21 09:01:50Z navarro $</div> 
     123          <h4>Version</h4><div class="preformat"> 
     124 $Id: demomode_compatibility.pro 231 2007-03-19 17:15:51Z pinsard $</div> 
    121125           
    122126           
    … …  
    131135           
    132136           
    133           <h4>Uses routines</h4><div class="preformat"> cm_general</div> 
     137          <h4>Uses routines</h4><div class="preformat"> 
     138 cm_general 
     139</div> 
    134140           
    135141           

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/directory-overview.html

    r200 r234  
    102102       
    103103        <dt><a href="find.html">find.pro</a></dt> 
    104         <dd>  based on file_search, but it is possible to specify  a set of possibles names and a different set of  possibles directories names.</dd> 
     104        <dd>  based on <proidl>file_search</proidl>, but it is possible to specify  a set of possibles names and a different set of  possibles directories names.</dd> 
    105105       
    106106        <dt><a href="fitintobox.html">fitintobox.pro</a></dt> 
    107         <dd>   Check that the input array has size and dimensions  compatible with the domain that was defined with the previous call  of domdef.</dd> 
     107        <dd>  Check that the input array has size and dimensions  compatible with the domain that was defined with the previous call  of domdef.</dd> 
    108108       
    109109        <dt><a href="isadirectory.html">isadirectory.pro</a></dt> 
    … …  
    111111       
    112112        <dt><a href="isafile.html">isafile.pro</a></dt> 
    113         <dd>  same as find.</dd> 
     113        <dd>  same as <a href=".//find.html">find</a> except that as long as the file is 'NOT FOUND',  isafile calls dialog_pickfile, to ask the user to select a file.</dd> 
    114114       
    115115        <dt><a href="linearequation.html">linearequation.pro</a></dt> 
    116         <dd>   Calculate a linear equation of the type ax+by+c=0  thanks to coordinates of 2 points.</dd> 
     116        <dd>  Calculate a linear equation of the type ax+by+c=0  thanks to coordinates of 2 points.</dd> 
    117117       
    118118        <dt><a href="lineintersection.html">lineintersection.pro</a></dt> 
    119         <dd>   Calculate coordinates of the intersection between 2 straight lines   or of a succession of 2 straight lines.</dd> 
     119        <dd>  Calculate coordinates of the intersection between 2 straight lines  or of a succession of 2 straight lines.</dd> 
    120120       
    121121        <dt><a href="mergeonline_help.html">mergeonline_help.pro</a></dt> 
    … …  
    126126       
    127127        <dt><a href="pwd.html">pwd.pro</a></dt> 
    128         <dd>   print the current directory </dd> 
     128        <dd>  print the current directory </dd> 
    129129       
    130130        <dt><a href="report.html">report.pro</a></dt> 
    131         <dd>   Like dialog_message.</dd> 
     131        <dd>  Like <proidl>dialog_message</proidl> if there is already some widget  active or like <proidl>message</proidl> if there is not any widget active.</dd> 
    132132       
    133133        <dt><a href="routine_name.html">routine_name.pro</a></dt> 
    … …  
    135135       
    136136        <dt><a href="testvar.html">testvar.pro</a></dt> 
    137         <dd>   A kind of keyword_set but when the value exist, it send it back </dd> 
     137        <dd>  A kind of keyword_set but when the value exist, it send it back.</dd> 
    138138       
    139139        <dt><a href="text_box.html">text_box.pro</a></dt> 
    140         <dd>   This procedure writes a short text message within a box-shaped  area in a graphics window.</dd> 
     140        <dd>  This procedure writes a short text message within a box-shaped  area in a graphics window.</dd> 
    141141       
    142142        <dt><a href="undefine.html">undefine.pro</a></dt> 
    143         <dd>   erase a variable  same thing that delvar but usable in a program and usable   for one variable simultaneously </dd> 
     143        <dd>  erase a variable  same thing that delvar but usable in a program and usable  for one variable simultaneously </dd> 
    144144       
    145145        <dt><a href="xfile.html">xfile.pro</a></dt> 
    146         <dd>   display in a widget an ASCII file.</dd> 
     146        <dd>  display in a widget an ASCII file.</dd> 
    147147       
    148148        <dt><a href="xhelp.html">xhelp.pro</a></dt> 
    149         <dd>   Display an IDL procedure header using widgets and the widget manager.</dd> 
     149        <dd>  Display an IDL procedure header using widgets and the widget manager.</dd> 
    150150       
    151151      </dl> 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/find.html

    r200 r234  
    8888 
    8989      <div id="file_comments"> 
    90  based on file_search, but it is possible to specify 
     90 based on <proidl>file_search</proidl>, but it is possible to specify 
    9191 a set of possibles names and a different set of 
    9292 possibles directories names. 
    … …  
    109109        <div class="routine_details" id="_find"> 
    110110 
    111           <h2><a class="top" href="#container">top</a>find <span class="categories"> find a file 
     111          <h2><a class="top" href="#container">top</a>find <span class="categories">  
     112 find a file 
    112113</span></h2> 
    113114         
    114115          <p class="header"> 
    115             <span class="result">result = </span>find(<span class="result"><a href="#_find_param_filein">filein</a></span>, <a href="#_find_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_find_keyword_RECURSIVE">RECURSIVE</a>=<span class="result">RECURSIVE</span>, <a href="#_find_keyword_REPERTOIRE">REPERTOIRE</a>=<span class="result">REPERTOIRE</span>, <a href="#_find_keyword_NOPRO">NOPRO</a>=<span class="result">NOPRO</span>, <a href="#_find_keyword_ONLYPRO">ONLYPRO</a>=<span class="result">ONLYPRO</span>, <a href="#_find_keyword_ONLYNC">ONLYNC</a>=<span class="result">ONLYNC</span>, <a href="#_find_keyword_UNIQUE">UNIQUE</a>=<span class="result">UNIQUE</span>, <a href="#_find_keyword_FIRSTFOUND">FIRSTFOUND</a>=<span class="result">FIRSTFOUND</span>, <a href="#_find_keyword_LOOKALLDIR">LOOKALLDIR</a>=<span class="result">LOOKALLDIR</span>, <a href="#_find_keyword_TRYFIND">TRYFIND</a>=<span class="result">TRYFIND</span>, <a href="#_find_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 
    116          
    117           <div class="comments"></div> 
     116            <span class="result">result = </span>find(<span class="result"><a href="#_find_param_filein">filein</a></span>, <a href="#_find_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_find_keyword_RECURSIVE">RECURSIVE</a>=<span class="result">RECURSIVE</span>, <a href="#_find_keyword_REPERTOIRE">REPERTOIRE</a>=<span class="result">REPERTOIRE</span>, <a href="#_find_keyword_NOPRO">NOPRO</a>=<span class="result">NOPRO</span>, <a href="#_find_keyword_ONLYPRO">ONLYPRO</a>=<span class="result">ONLYPRO</span>, <a href="#_find_keyword_ONLYNC">ONLYNC</a>=<span class="result">ONLYNC</span>, <a href="#_find_keyword_UNIQUE">UNIQUE</a>=<span class="result">UNIQUE</span>, <a href="#_find_keyword_FIRSTFOUND">FIRSTFOUND</a>=<span class="result">FIRSTFOUND</span>, <a href="#_find_keyword_LOOKALLDIR">LOOKALLDIR</a>=<span class="result">LOOKALLDIR</span>, <a href="#_find_keyword_TRYFIND">TRYFIND</a>=<span class="result">TRYFIND</span>, <a href="#_find_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 
     117         
     118          <div class="comments"> 
     119</div> 
    118120 
    119121          <h3>Return value</h3><div class="preformat">  
    … …  
    317319</div> 
    318320             
    319             <h4 id="_find_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    320                
    321                
    322                
    323                
    324                
    325                
    326                
    327                
    328             </h4> 
    329          
    330             <div class="comments">  
    331  used to pass your keywords 
     321            <h4 id="_find_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     322               
     323               
     324               
     325               
     326               
     327               
     328               
     329               
     330            </h4> 
     331         
     332            <div class="comments">  
     333 Used to pass keywords 
    332334</div> 
    333335             
    … …  
    363365          <h3>Version history</h3> 
    364366           
    365           <h4>Version</h4><div class="preformat"> $Id: find.pro 163 2006-08-29 12:59:46Z navarro $</div> 
    366           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     367          <h4>Version</h4><div class="preformat"> 
     368 $Id: find.pro 232 2007-03-20 16:59:36Z pinsard $</div> 
     369          <h4>History</h4><div class="preformat"> 
     370 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    367371                       28/4/1999 
    368372                       6/7/1999: compatibility mac and windows 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/fitintobox.html

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 Check that the input array has size and dimensions 
    9191 compatible with the domain that was defined with the previous call 
    … …  
    106106        <div class="routine_details" id="_fitintobox"> 
    107107 
    108           <h2><a class="top" href="#container">top</a>fitintobox <span class="categories">  
     108          <h2><a class="top" href="#container">top</a>fitintobox <span class="categories"> 
    109109 Compatibility 
    110110</span></h2> 
    … …  
    116116</div> 
    117117 
    118           <h3>Return value</h3><div class="preformat">  
     118          <h3>Return value</h3><div class="preformat"> 
    119119 an array with dimensions matching the domain 
    120120 or -1 if there is an error... 
    … …  
    137137         
    138138          <div class="comments"> 
    139  an array or a structure that can be read by the function                 
    140  litchamp.pro 
    141  </div> 
     139 an array or a structure that can be read by the function 
     140 <a href=".//../../ToBeReviewed/LECTURE/litchamp.html">litchamp</a> 
     141</div> 
    142142             
    143143            <h4 id="_fitintobox_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    148148               
    149149               
    150               <span class="attr">default:</span> <span class="value">define by grille.pro</span> 
     150              <span class="attr">default:</span> <span class="value">define by <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></span> 
    151151               
    152152            </h4> 
    … …  
    162162               
    163163               
    164               <span class="attr">default:</span> <span class="value">define by grille.pro</span> 
     164              <span class="attr">default:</span> <span class="value">define by <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></span> 
    165165               
    166166            </h4> 
    … …  
    176176               
    177177               
    178               <span class="attr">default:</span> <span class="value">define by grille.pro</span> 
     178              <span class="attr">default:</span> <span class="value">define by <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></span> 
    179179               
    180180            </h4> 
    … …  
    190190               
    191191               
    192               <span class="attr">default:</span> <span class="value">define by grille.pro</span> 
     192              <span class="attr">default:</span> <span class="value">define by <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></span> 
    193193               
    194194            </h4> 
    … …  
    204204               
    205205               
    206               <span class="attr">default:</span> <span class="value">define by grille.pro</span> 
     206              <span class="attr">default:</span> <span class="value">define by <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></span> 
    207207               
    208208            </h4> 
    … …  
    218218               
    219219               
    220               <span class="attr">default:</span> <span class="value">define by grille.pro</span> 
     220              <span class="attr">default:</span> <span class="value">define by <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></span> 
    221221               
    222222            </h4> 
    … …  
    232232               
    233233               
    234               <span class="attr">default:</span> <span class="value">define by grille.pro</span> 
     234              <span class="attr">default:</span> <span class="value">define by <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></span> 
    235235               
    236236            </h4> 
    … …  
    246246               
    247247               
    248               <span class="attr">default:</span> <span class="value">define by grille.pro</span> 
     248              <span class="attr">default:</span> <span class="value">define by <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></span> 
    249249               
    250250            </h4> 
    … …  
    260260               
    261261               
    262               <span class="attr">default:</span> <span class="value">define by grille.pro</span> 
     262              <span class="attr">default:</span> <span class="value">define by <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></span> 
    263263               
    264264            </h4> 
    … …  
    285285            </h4> 
    286286         
    287             <div class="comments">  
     287            <div class="comments"> 
    288288 To specify that we are at W level 
    289289</div> 
    … …  
    291291           
    292292 
    293           <h3>Examples</h3><div class="preformat">  
     293          <h3>Examples</h3><div class="preformat"> 
    294294 IDL> help, fitintobox(findgen(jpi,jpj)) 
    295295 <Expression>    FLOAT     = Array[41, 3] 
    296296 IDL> help, fitintobox(findgen(jpi,jpj,78)) 
    297  Error:  
     297 Error: 
    298298 the array dimensions [180,148,78] are incompatible 
    299  with the the domain dimensions  
     299 with the the domain dimensions 
    300300 [jpi/nx, jpj/ny, jpk/nz, jpt] = [180/41, 148/3, 31/31, 1] 
    301301 <Expression>    INT       =       -1 
    … …  
    303303          <h3>Version history</h3> 
    304304           
    305           <h4>Version</h4><div class="preformat"> $Id: fitintobox.pro 163 2006-08-29 12:59:46Z navarro $</div> 
    306           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     305          <h4>Version</h4><div class="preformat"> 
     306 $Id: fitintobox.pro 231 2007-03-19 17:15:51Z pinsard $</div> 
     307          <h4>History</h4><div class="preformat"> 
     308 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    307309          10 juin 2000. 
    308310          June 2005: S. Masson rewrite all. 
    … …  
    319321           
    320322           
    321           <h4>Uses routines</h4><div class="preformat"> cm_4mesh 
     323          <h4>Uses routines</h4><div class="preformat">  
     324 cm_4mesh 
    322325 cm_4cal 
    323326</div> 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/isadirectory.html

    r200 r234  
    9090 check if a directory exists and make sure that it ends 
    9191 with the directory separator mark. 
    92  
    93   
    94  all dialog_pickfile keywords (like filter) can be used. 
    9592</div> 
    9693 
    … …  
    108105        <div class="routine_details" id="_isadirectory"> 
    109106 
    110           <h2><a class="top" href="#container">top</a>isadirectory <span class="categories"> io 
     107          <h2><a class="top" href="#container">top</a>isadirectory <span class="categories"> 
     108 io 
    111109</span></h2> 
    112110         
    113111          <p class="header"> 
    114             <span class="result">result = </span>isadirectory(<span class="result">[<a href="#_isadirectory_param_directoryin">directoryin</a>]</span>, <a href="#_isadirectory_keyword_TITLE">TITLE</a>=<span class="result">TITLE</span>, <a href="#_isadirectory_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_isadirectory_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 
    115          
    116           <div class="comments"></div> 
    117  
    118           <h3>Return value</h3><div class="preformat">  
     112            <span class="result">result = </span>isadirectory(<span class="result">[<a href="#_isadirectory_param_directoryin">directoryin</a>]</span>, <a href="#_isadirectory_keyword_TITLE">TITLE</a>=<span class="result">TITLE</span>, <a href="#_isadirectory_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_isadirectory_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 
     113         
     114          <div class="comments"> 
     115</div> 
     116 
     117          <h3>Return value</h3><div class="preformat"> 
    119118 the directory name 
    120119</div> 
    … …  
    135134            </h4> 
    136135         
    137           <div class="comments">  
     136          <div class="comments"> 
    138137 a proposed directory. If neither dirname 
    139138 input parameter of IODIRECTORY keyword are defined, 
    … …  
    159158            </h4> 
    160159         
    161             <div class="comments">  
     160            <div class="comments"> 
    162161 the title of the window 
    163162</div> 
    … …  
    174173            </h4> 
    175174         
    176             <div class="comments">  
     175            <div class="comments"> 
    177176 a proposed directory 
    178177</div> 
    179178             
    180             <h4 id="_isadirectory_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     179            <h4 id="_isadirectory_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    181180               
    182181               
    … …  
    189188            </h4> 
    190189         
    191             <div class="comments">  
    192  used to pass your keywords 
     190            <div class="comments"> 
     191 Used to pass keywords 
     192 
     193 all dialog_pickfile keywords (like filter) can be used. 
    193194</div> 
    194195             
    … …  
    205206          <h3>Version history</h3> 
    206207           
    207           <h4>Version</h4><div class="preformat"> $Id: isadirectory.pro 163 2006-08-29 12:59:46Z navarro $</div> 
    208           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     208          <h4>Version</h4><div class="preformat"> 
     209 $Id: isadirectory.pro 232 2007-03-20 16:59:36Z pinsard $</div> 
     210          <h4>History</h4><div class="preformat"> 
     211 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    209212                      June 28, 2000 
    210213 June 2005: Sebastien Masson: cleaning, use for file_* functions 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/isafile.html

    r200 r234  
    8888 
    8989      <div id="file_comments"> 
    90  same as find.pro except that as long as the file is 'NOT FOUND', 
     90 same as <a href=".//find.html">find</a> except that as long as the file is 'NOT FOUND', 
    9191 isafile calls dialog_pickfile, to ask the user to select a file. 
    92  
    93   
    94  all find, file_search and dialog_pickfile keywords (like title) can be used 
    9592</div> 
    9693 
    … …  
    108105        <div class="routine_details" id="_isafile"> 
    109106 
    110           <h2><a class="top" href="#container">top</a>isafile <span class="categories"> io 
     107          <h2><a class="top" href="#container">top</a>isafile <span class="categories">  
     108 io 
    111109</span></h2> 
    112110         
    113111          <p class="header"> 
    114             <span class="result">result = </span>isafile(<span class="result">[<a href="#_isafile_param_filein">filein</a>]</span>, <a href="#_isafile_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_isafile_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_isafile_keyword_NEW">NEW</a>=<span class="result">NEW</span>, <a href="#_isafile_keyword_RECURSIVE">RECURSIVE</a>=<span class="result">RECURSIVE</span>, <a href="#_isafile_keyword_ONLYPRO">ONLYPRO</a>=<span class="result">ONLYPRO</span>, <a href="#_isafile_keyword_ONLYNC">ONLYNC</a>=<span class="result">ONLYNC</span>, <a href="#_isafile_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 
    115          
    116           <div class="comments"></div> 
    117  
    118           <h3>Return value</h3><div class="preformat">  
     112            <span class="result">result = </span>isafile(<span class="result">[<a href="#_isafile_param_filein">filein</a>]</span>, <a href="#_isafile_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_isafile_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_isafile_keyword_NEW">NEW</a>=<span class="result">NEW</span>, <a href="#_isafile_keyword_RECURSIVE">RECURSIVE</a>=<span class="result">RECURSIVE</span>, <a href="#_isafile_keyword_ONLYPRO">ONLYPRO</a>=<span class="result">ONLYPRO</span>, <a href="#_isafile_keyword_ONLYNC">ONLYNC</a>=<span class="result">ONLYNC</span>, <a href="#_isafile_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 
     113         
     114          <div class="comments"> 
     115</div> 
     116 
     117          <h3>Return value</h3><div class="preformat"> 
    119118 the filename with its path 
    120119</div> 
    … …  
    135134            </h4> 
    136135         
    137           <div class="comments">  
    138  a proposed name. If neither filein input parameter of filename keyword are  
     136          <div class="comments"> 
     137 a proposed name. If neither filein input parameter of filename keyword are 
    139138 defined, the ask the user to choose a file. 
    140139</div> 
    … …  
    158157            </h4> 
    159158         
    160             <div class="comments">  
     159            <div class="comments"> 
    161160 a proposed filename. 
    162161</div> 
    … …  
    173172            </h4> 
    174173         
    175             <div class="comments">  
     174            <div class="comments"> 
    176175 a directory where we look for the file. this 
    177176 keyword is taken into account only if the dirname 
    … …  
    190189            </h4> 
    191190         
    192             <div class="comments">  
    193  to specify that filename is a new file and that we should check only its  
     191            <div class="comments"> 
     192 to specify that filename is a new file and that we should check only its 
    194193 path 
    195194</div> 
    … …  
    206205            </h4> 
    207206         
    208             <div class="comments">  
     207            <div class="comments"> 
    209208 performs recursive searching of directory hierarchies. 
    210209 In a recursive search, find looks recursively for any and all 
    … …  
    223222            </h4> 
    224223         
    225             <div class="comments">  
     224            <div class="comments"> 
    226225 force to look only at file ending with .pro 
    227226</div> 
    … …  
    238237            </h4> 
    239238         
    240             <div class="comments">  
     239            <div class="comments"> 
    241240 force to look only at file ending with .nc 
    242241</div> 
    243242             
    244             <h4 id="_isafile_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    245                
    246                
    247                
    248                
    249                
    250                
    251                
    252                
    253             </h4> 
    254          
    255             <div class="comments">  
    256  used to pass your keywords 
     243            <h4 id="_isafile_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     244               
     245               
     246               
     247               
     248               
     249               
     250               
     251               
     252            </h4> 
     253         
     254            <div class="comments"> 
     255 Used to pass keywords 
     256 
     257 all find, file_search and dialog_pickfile keywords (like title) can be used 
    257258</div> 
    258259             
    … …  
    275276          <h3>Version history</h3> 
    276277           
    277           <h4>Version</h4><div class="preformat"> $Id: isafile.pro 163 2006-08-29 12:59:46Z navarro $</div> 
    278           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     278          <h4>Version</h4><div class="preformat"> 
     279 $Id: isafile.pro 232 2007-03-20 16:59:36Z pinsard $</div> 
     280          <h4>History</h4><div class="preformat"> 
     281 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    279282                      11/2/2000 
    280283 June 2005: Sebastien Masson: cleaning, use for file_* functions 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/linearequation.html

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 Calculate a linear equation of the type ax+by+c=0 
    9191 thanks to coordinates of 2 points. 
    … …  
    106106        <div class="routine_details" id="_linearequation"> 
    107107 
    108           <h2><a class="top" href="#container">top</a>linearequation <span class="categories">  
    109 Utilities 
    110  </span></h2> 
     108          <h2><a class="top" href="#container">top</a>linearequation <span class="categories"> 
     109 Utilities 
     110</span></h2> 
    111111         
    112112          <p class="header"> 
    … …  
    116116</div> 
    117117 
    118           <h3>Return value</h3><div class="preformat">  
    119  abc is a table of dimension 3, number_of_straight_line,  
     118          <h3>Return value</h3><div class="preformat"> 
     119 abc is a table of dimension 3, number_of_straight_line, 
    120120 where for each line of the table we obtain the 3 parameters 
    121121 a, b and c of the linear equation ax+by+c=0 
    … …  
    137137            </h4> 
    138138         
    139           <div class="comments">  
    140  This is the first point of(the) straight line(s) whose we want to calculate  
     139          <div class="comments"> 
     140 This is the first point of(the) straight line(s) whose we want to calculate 
    141141 equation(s) 
    142142</div> 
    … …  
    153153            </h4> 
    154154         
    155           <div class="comments">  
     155          <div class="comments"> 
    156156 This is the second point of(the) straight line(s) whose we want to calculate 
    157157 equation(s) 
    … …  
    168168           
    169169 
    170           <h3>Examples</h3><div class="preformat">  
     170          <h3>Examples</h3><div class="preformat"> 
    171171 IDL> abc=linearequation(complex(1,2),[3,4]) 
    172172 IDL> print, abc[0]*1+abc[1]*2+abc[2] 
    … …  
    175175          <h3>Version history</h3> 
    176176           
    177           <h4>Version</h4><div class="preformat"> $Id: linearequation.pro 163 2006-08-29 12:59:46Z navarro $ 
    178 </div> 
    179           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     177          <h4>Version</h4><div class="preformat"> 
     178 $Id: linearequation.pro 231 2007-03-19 17:15:51Z pinsard $ 
     179</div> 
     180          <h4>History</h4><div class="preformat"> 
     181 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    180182          10 juin 2000 
    181183</div> 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/lineintersection.html

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
    90  Calculate coordinates of the intersection between 2 straight lines  
     89      <div id="file_comments"> 
     90 Calculate coordinates of the intersection between 2 straight lines 
    9191 or of a succession of 2 straight lines. 
    9292</div> 
    … …  
    105105        <div class="routine_details" id="_lineintersection"> 
    106106 
    107           <h2><a class="top" href="#container">top</a>lineintersection <span class="categories">  
     107          <h2><a class="top" href="#container">top</a>lineintersection <span class="categories"> 
    108108 Utilities 
    109  </span></h2> 
     109</span></h2> 
    110110         
    111111          <p class="header"> 
    … …  
    115115</div> 
    116116 
    117           <h3>Return value</h3><div class="preformat">  
     117          <h3>Return value</h3><div class="preformat"> 
    118118 2 possibilities: 
    119       1) by default: it is a vector of complex whose each element is the coordinates  
     119      1) by default: it is a vector of complex whose each element is the coordinates 
    120120                     of the intersection point of a pair of straight lines. 
    121       2) if FLOAT is activated, it is a array of reels of dimension 2,  
    122          number_of_pairs_of_straight_lines whose each row is the coordinates  
     121      2) if FLOAT is activated, it is a array of reels of dimension 2, 
     122         number_of_pairs_of_straight_lines whose each row is the coordinates 
    123123         of the intersection point of a pair of straight line. 
    124124</div> 
    … …  
    140140         
    141141          <div class="comments"> 
    142  is the first array of dimension 3, number_of_pairs_of_straight_lines,  
    143  whose each line contain the 3 parameters a,b and c of the first linear  
     142 is the first array of dimension 3, number_of_pairs_of_straight_lines, 
     143 whose each line contain the 3 parameters a,b and c of the first linear 
    144144 equation of the type ax+by+c=0 
    145145</div> 
    … …  
    157157         
    158158          <div class="comments"> 
    159  is second array of dimension 3, number_of_pairs_of_straight_lines,  
    160  whose each line contain the 3 parameters a,b and c of the second linear  
     159 is second array of dimension 3, number_of_pairs_of_straight_lines, 
     160 whose each line contain the 3 parameters a,b and c of the second linear 
    161161 equation of the type ax+by+c=0 
    162162</div> 
    … …  
    180180            </h4> 
    181181         
    182             <div class="comments">  
    183  To return the output as a array of real numbers instead of vectors of  
     182            <div class="comments"> 
     183 To return the output as a array of real numbers instead of vectors of 
    184184 complex (by default) 
    185185</div> 
    … …  
    187187           
    188188 
    189           <h3>Examples</h3><div class="preformat">  
     189          <h3>Examples</h3><div class="preformat"> 
    190190 IDL> abc1=linearequation(complex(1,2),[3,4]) 
    191191 IDL> abc2=linearequation(complex(1,2),[8,15]) 
    … …  
    197197          <h3>Version history</h3> 
    198198           
    199           <h4>Version</h4><div class="preformat"> $Id: lineintersection.pro 163 2006-08-29 12:59:46Z navarro $ 
    200 </div> 
    201           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     199          <h4>Version</h4><div class="preformat"> 
     200 $Id: lineintersection.pro 231 2007-03-19 17:15:51Z pinsard $ 
     201</div> 
     202          <h4>History</h4><div class="preformat"> 
     203 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    202204          10 juin 2000 
    203205</div> 
    … …  
    208210           
    209211           
    210           <h4>Restrictions</h4><div class="preformat">  
    211  If the 2 straight line are parallel, we return coordinates  
     212          <h4>Restrictions</h4><div class="preformat"> 
     213 If the 2 straight line are parallel, we return coordinates 
    212214 (!values.f_nan,!values.f_nan) 
    213215 
    214   
    215  Beware of the precision of the machine which make  
    216  that calculated coordinates may not exactly verify  
     216 Beware of the precision of the machine which make 
     217 that calculated coordinates may not exactly verify 
    217218 equations of the pair of straight lines. 
    218219</div> 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/mergeonline_help.html

    r200 r234  
    111111            mergeonline_help</p> 
    112112         
    113           <div class="comments"></div> 
     113          <div class="comments"> 
     114</div> 
    114115 
    115116           
    … …  
    123124           
    124125          <h4>Version</h4><div class="preformat"> 
    125  $Id: mergeonline_help.pro 197 2006-10-26 10:45:17Z smasson $</div> 
     126 $Id: mergeonline_help.pro 231 2007-03-19 17:15:51Z pinsard $</div> 
    126127          <h4>History</h4><div class="preformat"> 
    127128 Sept 2006: Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    134135           
    135136          <h4>Restrictions</h4><div class="preformat"> 
    136  Needs at least version 6.2  
     137 Needs at least version 6.2 
    137138</div> 
    138139         

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/protype.html

    r200 r234  
    104104        <div class="routine_details" id="_protype"> 
    105105 
    106           <h2><a class="top" href="#container">top</a>protype <span class="categories">  
     106          <h2><a class="top" href="#container">top</a>protype <span class="categories"> 
    107107 Utilities 
    108108</span></h2> 
    … …  
    111111            <span class="result">result = </span>protype(<span class="result"><a href="#_protype_param_file">file</a></span>)</p> 
    112112         
    113           <div class="comments"></div> 
    114  
    115           <h3>Return value</h3><div class="preformat">  
     113          <div class="comments"> 
     114</div> 
     115 
     116          <h3>Return value</h3><div class="preformat"> 
     117 -1 if not found 
    116118 A scalar of string type: 'proc', 'func' or 'batch' 
    117119</div> 
    … …  
    125127               
    126128               
    127                
    128                
    129                
     129              <span class="attr">required</span> 
     130               
     131              <span class="attr">type:</span> <span class="value">string</span> 
    130132               
    131133               
    132134            </h4> 
    133135         
    134           <div class="comments">  
    135  A scalar of string type, the name of the ".pro" file to be tested 
     136          <div class="comments"> 
     137 the name of the ".pro" file to be tested. 
    136138 if necessary, the input name is completed with '.pro' 
    137139 and its path found in !path 
    … …  
    156158          <h3>Version history</h3> 
    157159           
    158           <h4>Version</h4><div class="preformat"> $Id: protype.pro 163 2006-08-29 12:59:46Z navarro $</div> 
    159           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     160          <h4>Version</h4><div class="preformat"> 
     161 $Id: protype.pro 231 2007-03-19 17:15:51Z pinsard $</div> 
     162          <h4>History</h4><div class="preformat"> 
     163 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    160164                       Feb 2006 
    161165</div> 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/pwd.html

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 print the current directory 
    9191</div> 
    … …  
    104104        <div class="routine_details" id="_pwd"> 
    105105 
    106           <h2><a class="top" href="#container">top</a>pwd <span class="categories"> like unix function 
    107  </span></h2> 
     106          <h2><a class="top" href="#container">top</a>pwd <span class="categories"> 
     107 like unix function 
     108</span></h2> 
    108109         
    109110          <p class="header"> 
    … …  
    122123          <h3>Version history</h3> 
    123124           
    124           <h4>Version</h4><div class="preformat"> $Id: pwd.pro 136 2006-07-10 15:20:19Z pinsard $ 
     125          <h4>Version</h4><div class="preformat"> 
     126 $Id: pwd.pro 231 2007-03-19 17:15:51Z pinsard $ 
    125127</div> 
    126           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     128          <h4>History</h4><div class="preformat"> 
     129 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    127130</div> 
    128131           

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/report.html

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
    90  Like dialog_message.pro if there is already some widget  
    91  active or like message.pro if there is not any widget active.  
     89      <div id="file_comments"> 
     90 Like <proidl>dialog_message</proidl> if there is already some widget 
     91 active or like <proidl>message</proidl> if there is not any widget active. 
    9292 To ask a question whose answer is not yes/no,use xquestion. 
    9393</div> 
    … …  
    109109         
    110110          <p class="header"> 
    111             <span class="result">result = </span>report(<span class="result"><a href="#_report_param_text">text</a></span>, <a href="#_report_keyword_DEFAULT_NO">DEFAULT_NO</a>=<span class="result">DEFAULT_NO</span>, <a href="#_report_keyword_PARENT">PARENT</a>=<span class="result">PARENT</span>, <a href="#_report_keyword_QUESTION">QUESTION</a>=<span class="result">QUESTION</span>, <a href="#_report_keyword_SIMPLE">SIMPLE</a>=<span class="result">SIMPLE</span>, <a href="#_report_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 
     111            <span class="result">result = </span>report(<span class="result"><a href="#_report_param_text">text</a></span>, <a href="#_report_keyword_DEFAULT_NO">DEFAULT_NO</a>=<span class="result">DEFAULT_NO</span>, <a href="#_report_keyword_PARENT">PARENT</a>=<span class="result">PARENT</span>, <a href="#_report_keyword_QUESTION">QUESTION</a>=<span class="result">QUESTION</span>, <a href="#_report_keyword_SIMPLE">SIMPLE</a>=<span class="result">SIMPLE</span>, <a href="#_report_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 
    112112         
    113113          <div class="comments"> 
    114114</div> 
    115115 
    116           <h3>Return value</h3><div class="preformat">  
     116          <h3>Return value</h3><div class="preformat"> 
    117117 -1 if the keyword QUESTION is not activated 
    118  If the keyword is activated, return 1 for yes and 0 for no. 
    119  </div> 
     118 If the keyword QUESTION is activated, return 1 for yes and 0 for no. 
     119</div> 
    120120 
    121121           
    … …  
    134134            </h4> 
    135135         
    136           <div class="comments">  
     136          <div class="comments"> 
    137137 one string or one vector of string. Si le string ne 
    138  comporte qu''un element, on cherche les eventuels characteres de 
     138 comporte qu''un element, on cherche les eventuels caracteres de 
    139139 retour a la ligne: '!C'. If text is set to an array of strings, each 
    140140 array element is displayed as a separate line of text. 
    … …  
    160160         
    161161            <div class="comments"> 
    162  Set this keyword to make the "No" button the default selection for  
    163  "Question" dialog.  
     162 Set this keyword to make the "No" button the default selection for 
     163 "Question" dialog. 
    164164</div> 
    165165             
    … …  
    175175            </h4> 
    176176         
    177             <div class="comments">  
    178  same as DIALOG_PARENT de dialog_message.pro 
     177            <div class="comments"> 
     178 same as DIALOG_PARENT of <proidl>dialog_message</proidl> 
    179179</div> 
    180180             
    … …  
    205205            </h4> 
    206206         
    207             <div class="comments">  
     207            <div class="comments"> 
    208208 activate to print only the message without the name 
    209209 and the line of the routine (defined by calling routine_name) 
    210210 
    211   
    212  Activate to print the error message without printing  the routine name with  
     211 
     212 Activate to print the error message without printing the routine name with 
    213213 its full path. 
    214214</div> 
    215215             
    216             <h4 id="_report_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    217                
    218                
    219                
    220                
    221                
    222                
    223                
    224                
    225             </h4> 
    226          
    227             <div class="comments">  
    228  used to pass keywords from dialog_message.pro and message.pro 
    229 </div> 
    230              
    231            
    232  
    233           <h3>Examples</h3><div class="preformat">  
     216            <h4 id="_report_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     217               
     218               
     219               
     220               
     221               
     222               
     223               
     224               
     225            </h4> 
     226         
     227            <div class="comments"> 
     228 Used to pass keywords to <proidl>dialog_message</proidl> and  
     229 <proidl>message</proidl> 
     230</div> 
     231             
     232           
     233 
     234          <h3>Examples</h3><div class="preformat"> 
    234235 If there is not any widget activated: 
    235236 
    … …  
    249250          <h3>Version history</h3> 
    250251           
    251           <h4>Version</h4><div class="preformat"> $Id: report.pro 163 2006-08-29 12:59:46Z navarro $ 
    252 </div> 
    253           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     252          <h4>Version</h4><div class="preformat"> 
     253 $Id: report.pro 232 2007-03-20 16:59:36Z pinsard $ 
     254</div> 
     255          <h4>History</h4><div class="preformat"> 
     256 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    254257                      21/10/1999 
    255258</div> 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/routine_name.html

    r200 r234  
    104104        <div class="routine_details" id="_routine_name"> 
    105105 
    106           <h2><a class="top" href="#container">top</a>routine_name <span class="categories">  
     106          <h2><a class="top" href="#container">top</a>routine_name <span class="categories"> 
    107107 Utilities 
    108108</span></h2> 
    … …  
    158158          <h3>Version history</h3> 
    159159           
    160           <h4>Version</h4><div class="preformat"> $Id: routine_name.pro 163 2006-08-29 12:59:46Z navarro $ 
    161 </div> 
    162           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     160          <h4>Version</h4><div class="preformat"> 
     161 $Id: routine_name.pro 231 2007-03-19 17:15:51Z pinsard $ 
     162</div> 
     163          <h4>History</h4><div class="preformat"> 
     164 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    163165                      21/10/1999 
    164166</div> 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/testvar.html

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
    90  A kind of keyword_set but when the value exist, it send it back 
     89      <div id="file_comments"> 
     90 A kind of keyword_set but when the value exist, it send it back. 
    9191</div> 
    9292 
    … …  
    104104        <div class="routine_details" id="_testvar"> 
    105105 
    106           <h2><a class="top" href="#container">top</a>testvar <span class="categories">  
     106          <h2><a class="top" href="#container">top</a>testvar <span class="categories"> 
    107107 Utilities 
    108108</span></h2> 
    … …  
    114114</div> 
    115115 
    116           <h3>Return value</h3><div class="preformat">  
    117  0 if the variable does not exist  
     116          <h3>Return value</h3><div class="preformat"> 
     117 0 if the variable does not exist 
    118118</div> 
    119119 
    … …  
    135135            </h4> 
    136136         
    137             <div class="comments">  
     137            <div class="comments"> 
    138138 any kind of 
    139139</div> 
    … …  
    141141           
    142142 
    143           <h3>Examples</h3><div class="preformat">  
     143          <h3>Examples</h3><div class="preformat"> 
    144144 IDL> print, testvar(var=toto) 
    145145 0 
    … …  
    149149          <h3>Version history</h3> 
    150150           
    151           <h4>Version</h4><div class="preformat"> $Id: testvar.pro 163 2006-08-29 12:59:46Z navarro $ 
     151          <h4>Version</h4><div class="preformat"> 
     152 $Id: testvar.pro 231 2007-03-19 17:15:51Z pinsard $ 
    152153</div> 
    153           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     154          <h4>History</h4><div class="preformat"> 
     155 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    154156                      14/12/1999 
    155157</div> 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/text_box.html

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 This procedure writes a short text message within a box-shaped 
    9191 area in a graphics window.  The message may be split at word 
    9292 boundaries into several lines, and the character size and 
    9393 orientation may be adjusted for the text to fit within the box. 
    94    </div> 
     94</div> 
    9595 
    9696       
    … …  
    132132            </h4> 
    133133         
    134           <div class="comments">  
     134          <div class="comments"> 
    135135 ASCII text string containing the message. 
    136136</div> 
    … …  
    154154            </h4> 
    155155         
    156             <div class="comments">   
     156            <div class="comments"> 
    157157 4 element vector specifying the box position and size 
    158158 pos[0],pos[1] specify the lower left corner coordinate 
    … …  
    187187            </h4> 
    188188         
    189             <div class="comments">  
    190  background color. Setting BG_COLOR erases the area  
     189            <div class="comments"> 
     190 background color. Setting BG_COLOR erases the area 
    191191               covered by the text box (filling it with color BG_COLOR) 
    192192               prior to writing the text.  If both BG_COLOR and !p.color 
    193193               are zero then the background color is reset to 255 to 
    194                gaurantee a readability. 
    195                </div> 
     194               guarantee a readability. 
     195</div> 
    196196             
    197197            <h4 id="_text_box_keyword_center">center&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    206206            </h4> 
    207207         
    208             <div class="comments">  
     208            <div class="comments"> 
    209209 if set, center the text 
    210210</div> 
    … …  
    221221            </h4> 
    222222         
    223             <div class="comments">  
     223            <div class="comments"> 
    224224 if set, right justify text 
    225225</div> 
    … …  
    236236            </h4> 
    237237         
    238             <div class="comments">  
     238            <div class="comments"> 
    239239 activate to show the box on graphics window. 
    240240</div> 
    … …  
    266266            </h4> 
    267267         
    268             <div class="comments">  
    269  used to pass your keyword 
     268            <div class="comments"> 
     269 Used to pass keywords 
    270270</div> 
    271271             
    … …  
    275275          <h3>Version history</h3> 
    276276           
    277           <h4>Version</h4><div class="preformat"> $Id: text_box.pro 163 2006-08-29 12:59:46Z navarro $ 
    278 </div> 
    279           <h4>History</h4><div class="preformat">  Paul Ricchiazzi                            7Jul93 
     277          <h4>Version</h4><div class="preformat"> 
     278 $Id: text_box.pro 231 2007-03-19 17:15:51Z pinsard $ 
     279</div> 
     280          <h4>History</h4><div class="preformat"> 
     281 Paul Ricchiazzi                            7Jul93 
    280282           Institute for Computational Earth System Science 
    281283           University of California, Santa Barbara 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/undefine.html

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 erase a variable 
    91  same thing that delvar but usable in a program and usable  
     91 same thing that delvar but usable in a program and usable 
    9292 for one variable simultaneously 
    9393</div> 
    … …  
    106106        <div class="routine_details" id="_undefine"> 
    107107 
    108           <h2><a class="top" href="#container">top</a>undefine <span class="categories">  
    109  Utilities   
    110  </span></h2> 
     108          <h2><a class="top" href="#container">top</a>undefine <span class="categories"> 
     109 Utilities 
     110</span></h2> 
    111111         
    112112          <p class="header"> 
    … …  
    133133            </h4> 
    134134         
    135           <div class="comments">  
     135          <div class="comments"> 
    136136 The name of the variable we want erase 
    137137</div> 
    … …  
    151151          <h3>Version history</h3> 
    152152           
    153           <h4>Version</h4><div class="preformat"> $Id: undefine.pro 163 2006-08-29 12:59:46Z navarro $ 
    154 </div> 
    155           <h4>History</h4><div class="preformat"> trouve sur la page web de D.Fanning  
    156  http://www.dfanning.com : 
    157 QUESTION: How do I make an IDL variable have a type "undefined"?  
     153          <h4>Version</h4><div class="preformat"> 
     154 $Id: undefine.pro 232 2007-03-20 16:59:36Z pinsard $ 
     155</div> 
     156          <h4>History</h4><div class="preformat"> 
     157 trouve sur la page web de D.Fanning 
     158 <a href="http://www.dfanning.com"/> : 
     159QUESTION: How do I make an IDL variable have a type "undefined"? 
    158160ANSWER: At the main IDL level you can use the IDL procedure DELVAR to 
    159161delete an IDL variable and make it undefined. Inside of procedures 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/xfile.html

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 display in a widget an ASCII file. 
    91  It is the same thing that xdisplayfile but here, we use it  
    92  to display the content of a procedure or of a function,  
     91 It is the same thing that xdisplayfile but here, we use it 
     92 to display the content of a procedure or of a function, 
    9393 even if it is not in the current directory (thanks to the path). 
    9494</div> 
    … …  
    107107        <div class="routine_details" id="_xfile"> 
    108108 
    109           <h2><a class="top" href="#container">top</a>xfile <span class="categories">  
     109          <h2><a class="top" href="#container">top</a>xfile <span class="categories"> 
    110110 Utilities 
    111111</span></h2> 
    112112         
    113113          <p class="header"> 
    114             xfile<span class="result">, <a href="#_xfile_param_filename">filename</a></span>, <a href="#_xfile_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
     114            xfile<span class="result">, <a href="#_xfile_param_filename">filename</a></span>, <a href="#_xfile_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
    115115         
    116116          <div class="comments"> 
    … …  
    134134            </h4> 
    135135         
    136           <div class="comments">  
    137  It is the name of the procedure or of the function  
     136          <div class="comments"> 
     137 It is the name of the procedure or of the function 
    138138 we want to display (with or without .pro at the end). 
    139139</div> 
    … …  
    146146            <h3>Keywords</h3> 
    147147             
    148             <h4 id="_xfile_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     148            <h4 id="_xfile_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    149149               
    150150               
    … …  
    157157            </h4> 
    158158         
    159             <div class="comments">  
    160  used to pass your keywords 
    161 </div> 
    162              
    163            
    164  
    165           <h3>Examples</h3><div class="preformat"> xfile,'plt' 
     159            <div class="comments"> 
     160 Used to pass keywords 
     161</div> 
     162             
     163           
     164 
     165          <h3>Examples</h3><div class="preformat"> 
     166 IDL> xfile,'plt' 
    166167</div> 
    167168          <h3>Version history</h3> 
    168169           
    169           <h4>Version</h4><div class="preformat"> $Id: xfile.pro 163 2006-08-29 12:59:46Z navarro $ 
    170 </div> 
    171           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    172                        7/1/99 
    173                        6/7/1999: compatibility mac and windows 
     170          <h4>Version</h4><div class="preformat"> 
     171 $Id: xfile.pro 232 2007-03-20 16:59:36Z pinsard $ 
     172</div> 
     173          <h4>History</h4><div class="preformat"> 
     174 Sebastien Masson (smasson@lodyc.jussieu.fr) 
     175 7/1/99 
     176 6/7/1999: compatibility mac and windows 
    174177</div> 
    175178           

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/xhelp.html

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 Display an IDL procedure header using widgets and the widget manager. 
    9191</div> 
    … …  
    109109         
    110110          <p class="header"> 
    111             xhelp<span class="result">, <a href="#_xhelp_param_filename">filename</a></span>, <a href="#_xhelp_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
     111            xhelp<span class="result">, <a href="#_xhelp_param_filename">filename</a></span>, <a href="#_xhelp_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
    112112         
    113113          <div class="comments"> 
    … …  
    131131            </h4> 
    132132         
    133           <div class="comments">  
    134  A scalar string that contains the filename of the file to display.   
    135  If FILENAME does not include a complete path specification, xhelp will  
     133          <div class="comments"> 
     134 A scalar string that contains the filename of the file to display. 
     135 If FILENAME does not include a complete path specification, xhelp will 
    136136 search for the file in the current working directory and then each of the 
    137137 directories listed in !PATH environment variable.  The 
    … …  
    146146            <h3>Keywords</h3> 
    147147             
    148             <h4 id="_xhelp_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     148            <h4 id="_xhelp_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    149149               
    150150               
    … …  
    157157            </h4> 
    158158         
    159             <div class="comments">  
    160  used to pass your keywords 
    161 </div> 
    162              
    163            
    164  
    165           <h3>Examples</h3><div class="preformat">  
    166  Open a file and create a widget to display its contents. 
     159            <div class="comments"> 
     160 Used to pass keywords 
     161</div> 
     162             
     163           
     164 
     165          <h3>Examples</h3><div class="preformat"> 
     166 IDL> xhelp,'plt' 
    167167</div> 
    168168          <h3>Version history</h3> 
    169169           
    170           <h4>Version</h4><div class="preformat"> $Id: xhelp.pro 163 2006-08-29 12:59:46Z navarro $ 
    171 </div> 
    172           <h4>History</h4><div class="preformat"> Written By Steve Richards, December 1990 
     170          <h4>Version</h4><div class="preformat"> 
     171 $Id: xhelp.pro 232 2007-03-20 16:59:36Z pinsard $ 
     172</div> 
     173          <h4>History</h4><div class="preformat"> 
     174 Written By Steve Richards, December 1990 
    173175        Graceful error recovery, DMS, Feb, 1992. 
    174176       Modified to extract .pro documentation headers, PJR/ESRG mar94 
    … …  
    186188           
    187189           
    188           <h4>Restrictions</h4><div class="preformat">  
     190          <h4>Restrictions</h4><div class="preformat"> 
    189191 Triggers the XMANAGER if it is not already in use. 
    190192</div> 
Note: See TracChangeset for help on using the changeset viewer.