Ignore:
Timestamp:
04/06/07 10:35:17 (17 years ago)
Author:
pinsard
Message:

improvements/corrections of some *.pro headers + replace some message by some report

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

Legend:

Unmodified
Added
Removed

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

    r234 r242  
    108108         
    109109          <p class="header"> 
    110             <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> 
     110            <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">vector string</span>, <a href="#_createfunc_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 
    111111         
    112112          <div class="comments"> 
    … …  
    125125              <span class="attr">required</span> 
    126126               
    127                
    128                
    129                
    130             </h4> 
    131          
    132           <div class="comments">  
    133  a scalar string defining the result to be given back by the function.  
     127              <span class="attr">type:</span> <span class="value">scalar string</span> 
     128               
     129               
     130            </h4> 
     131         
     132          <div class="comments"> 
     133 defining the result to be given back by the function.  
    134134 (see examples) 
    135135</div> 
    … …  
    163163               
    164164               
    165                
     165              <span class="attr">type:</span> <span class="value">vector string</span> 
    166166               
    167167               
    … …  
    169169         
    170170            <div class="comments">  
    171  a vector string. to specify a list of keywords that must be included in the  
     171 to specify a list of keywords that must be included in the  
    172172 function definition.  
    173173 Warning: the string must start with a ','  
    … …  
    200200           
    201201          <h4>Version</h4><div class="preformat"> 
    202  $Id: createfunc.pro 231 2007-03-19 17:15:51Z pinsard $ 
     202 $Id: createfunc.pro 239 2007-03-28 06:50:03Z smasson $ 
    203203</div> 
    204204          <h4>History</h4><div class="preformat"> 
    … …  
    227227          <h3>Statistics</h3> 
    228228          <table class="statistics"> 
    229             <tr><td>McCabe cyclic</td><td>           7</td></tr> 
     229            <tr><td>McCabe cyclic</td><td>           8</td></tr> 
    230230            <tr><td>McCabe essential</td><td>           1</td></tr> 
    231231            <tr><td>McCabe modular design</td><td>           1</td></tr> 

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

    r234 r242  
    107107         
    108108          <p class="header"> 
    109             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> 
     109            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">vector string</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         
    111111          <div class="comments"> 
    … …  
    130130         
    131131          <div class="comments"> 
    132  a string array defining the procedure to be created.  
     132 array defining the procedure to be created.  
    133133 each element will be a line of the created procedure. 
    134134</div> 
    … …  
    162162               
    163163               
    164                
    165                
    166                
    167             </h4> 
    168          
    169             <div class="comments">  
    170  a vector string.  
     164              <span class="attr">type:</span> <span class="value">vector string</span> 
     165               
     166               
     167            </h4> 
     168         
     169            <div class="comments"> 
    171170 to specify a list of keywords that must be included in the procedure  
    172171 definition.  
    … …  
    217216           
    218217          <h4>Version</h4><div class="preformat"> 
    219  $Id: createpro.pro 232 2007-03-20 16:59:36Z pinsard $</div> 
     218 $Id: createpro.pro 239 2007-03-28 06:50:03Z smasson $ 
     219</div> 
    220220          <h4>History</h4><div class="preformat"> 
    221221 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    230230           
    231231          <h4>Restrictions</h4><div class="preformat"> 
    232  - is not working with functions, use createfunc instead. 
     232 - is not working with functions, use <a href=".//createfunc.html">createfunc</a> instead. 
    233233 - arguments can be given only through keywords. 
    234234 - ends the procedure name with '.pro' if needed. 
    … …  
    245245          <h3>Statistics</h3> 
    246246          <table class="statistics"> 
    247             <tr><td>McCabe cyclic</td><td>           7</td></tr> 
     247            <tr><td>McCabe cyclic</td><td>           8</td></tr> 
    248248            <tr><td>McCabe essential</td><td>           1</td></tr> 
    249249            <tr><td>McCabe modular design</td><td>           1</td></tr> 

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

    r234 r242  
    127127           
    128128          <h4>Version</h4><div class="preformat"> 
    129  $Id: def_myuniquetmpdir.pro 231 2007-03-19 17:15:51Z pinsard $ 
     129 $Id: def_myuniquetmpdir.pro 239 2007-03-28 06:50:03Z smasson $ 
    130130</div> 
    131131          <h4>History</h4><div class="preformat"> 

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

    r234 r242  
    111111       
    112112        <dt><a href="isafile.html">isafile.pro</a></dt> 
    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> 
     113        <dd>  same as <a href=".//find</pro> except that as long as the file is 'NOT FOUND',  <pro>isafile.html">find</pro> except that as long as the file is 'NOT FOUND',  <pro>isafile</a> calls   <proidl>dialog_pickfile</proidl>, to ask the user to select a file.</dd> 
    114114       
    115115        <dt><a href="linearequation.html">linearequation.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 <proidl>keyword_set</proidl> 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 graphic 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 like <proidl>delvar</proidl> 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 an ASCII file in a widget.</dd> 
    147147       
    148148        <dt><a href="xhelp.html">xhelp.pro</a></dt> 

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

    r234 r242  
    9393 By default look for files included in !path 
    9494 
    95  all file_search keywords can be used. 
     95 all <proidl>file_search</proidl> keywords can be used. 
    9696</div> 
    9797 
    … …  
    109109        <div class="routine_details" id="_find"> 
    110110 
    111           <h2><a class="top" href="#container">top</a>find <span class="categories">  
     111          <h2><a class="top" href="#container">top</a>find <span class="categories"> 
    112112 find a file 
    113113</span></h2> 
    114114         
    115115          <p class="header"> 
    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> 
     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">scalar string or array of strings</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> 
    117117         
    118118          <div class="comments"> 
    119119</div> 
    120120 
    121           <h3>Return value</h3><div class="preformat">  
     121          <h3>Return value</h3><div class="preformat"> 
    122122 A scalar or array variable of string type, containing the 
    123123 name (with the full path of the matching files. If no files 
    124  exist with names matching the input arguments, find returns 
     124 exist with names matching the input arguments, <a href=".//find.html">find</a> returns 
    125125 the scalar string : 'NOT FOUND' 
    126126</div> 
    … …  
    136136              <span class="attr">required</span> 
    137137               
    138                
    139                
    140                
    141             </h4> 
    142          
    143           <div class="comments">  
    144  A scalar or array variable of string type, containing 
    145  file names to match. Input names specifications may contain 
     138              <span class="attr">type:</span> <span class="value">scalar string or array of strings</span> 
     139               
     140               
     141            </h4> 
     142         
     143          <div class="comments"> 
     144 File name[s] to match. Input names specifications may contain 
    146145 wildcard characters, enabling them to match multiple files 
    147  (see file_search for more informations). By default and if 
    148  necessary, find is looking for filename and also for filename 
     146 (see <proidl>file_search</proidl> for more informations). By default and if 
     147 necessary, <a href=".//find.html">find</a> is looking for filename and also for filename 
    149148 completed with '.pro' 
    150149</div> 
    … …  
    163162               
    164163               
    165                
     164              <span class="attr">type:</span> <span class="value">scalar string or array of strings</span> 
    166165              <span class="attr">default:</span> <span class="value">['.',!path]</span> 
    167166               
    168167            </h4> 
    169168         
    170             <div class="comments">  
    171  A scalar or array variable of string type, containing 
    172  directories names where we are looking for the file. 
     169            <div class="comments"> 
     170 Directories names where we are looking for the file. 
    173171 Different directories can be separated by 
    174172 path_sep(/search_path) (':' on unix type machine) as it is done 
    … …  
    189187            </h4> 
    190188         
    191             <div class="comments">  
     189            <div class="comments"> 
    192190 performs recursive searching of directory hierarchies. 
    193  In a recursive search, find looks recursively for any and all 
     191 In a recursive search, <a href=".//find.html">find</a> looks recursively for any and all 
    194192 subdirectories in the file hierarchy rooted at the IODIRECTORY argument. 
    195193</div> 
    … …  
    206204            </h4> 
    207205         
    208             <div class="comments">  
    209  obsolete. keep for compatibility, use directory keyword 
     206            <div class="comments"> 
     207 obsolete. keep for compatibility, use IODIRECTORY keyword 
    210208</div> 
    211209             
    … …  
    221219            </h4> 
    222220         
    223             <div class="comments">  
     221            <div class="comments"> 
    224222 activate to avoid the automatic search of filename completed with '.pro' 
    225223</div> 
    … …  
    236234            </h4> 
    237235         
    238             <div class="comments">  
     236            <div class="comments"> 
    239237 force to look only at file ending with .pro 
    240238</div> 
    … …  
    251249            </h4> 
    252250         
    253             <div class="comments">  
     251            <div class="comments"> 
    254252 force to look only at file ending with .nc 
    255253</div> 
    … …  
    266264            </h4> 
    267265         
    268             <div class="comments">  
     266            <div class="comments"> 
    269267 activate to make sure that each element of the output vector is unique. 
    270268</div> 
    … …  
    281279            </h4> 
    282280         
    283             <div class="comments">  
     281            <div class="comments"> 
    284282 activate this keyword to stop looking for the file as soon as we found one. 
    285283</div> 
    … …  
    296294            </h4> 
    297295         
    298             <div class="comments">  
     296            <div class="comments"> 
    299297 activate to look for the file (with a recursive search if needed) 
    300298 in . iodir, homedir, !path + the DATA:TestsData directory if it exists. 
    … …  
    312310            </h4> 
    313311         
    314             <div class="comments">  
    315  if the file was not found and this keyword is activated, find will call 
     312            <div class="comments"> 
     313 if the file was not found and this keyword is activated, <a href=".//find.html">find</a>  
     314 will call 
    316315 itself with the keywords /LOOKALLDIR and /FIRSTFOUND to try to find 
    317316 the file we are looking for. Note that if the file was found at the 
    318  first try this keyword as no effect (which is not the case with LOOKALLDIR)  
     317 first try this keyword as no effect (which is not the case with LOOKALLDIR) 
    319318</div> 
    320319             
    … …  
    330329            </h4> 
    331330         
    332             <div class="comments">  
     331            <div class="comments"> 
    333332 Used to pass keywords 
    334333</div> 
    … …  
    337336 
    338337          <h3>Examples</h3><div class="preformat"> 
    339  
    340338 IDL> print, find('*loadct') 
    341339   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro 
    … …  
    366364           
    367365          <h4>Version</h4><div class="preformat"> 
    368  $Id: find.pro 232 2007-03-20 16:59:36Z pinsard $</div> 
     366 $Id: find.pro 239 2007-03-28 06:50:03Z smasson $ 
     367</div> 
    369368          <h4>History</h4><div class="preformat"> 
    370369 Sebastien Masson (smasson@lodyc.jussieu.fr) 

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

    r234 r242  
    138138          <div class="comments"> 
    139139 an array or a structure that can be read by the function 
    140  <a href=".//../../ToBeReviewed/LECTURE/litchamp.html">litchamp</a> 
     140 <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> 
    141141</div> 
    142142             
    … …  
    148148               
    149149               
    150               <span class="attr">default:</span> <span class="value">define by <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></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 <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></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 <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></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 <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></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 <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></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 <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></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 <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></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 <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></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 <a href=".//../../ToBeReviewed/GRILLE/grille.html">grille</a></span> 
     262              <span class="attr">default:</span> <span class="value">define by <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a></span> 
    263263               
    264264            </h4> 
    … …  
    297297 Error: 
    298298 the array dimensions [180,148,78] are incompatible 
    299  with the the domain dimensions 
     299 with the domain dimensions 
    300300 [jpi/nx, jpj/ny, jpk/nz, jpt] = [180/41, 148/3, 31/31, 1] 
    301301 <Expression>    INT       =       -1 
    … …  
    304304           
    305305          <h4>Version</h4><div class="preformat"> 
    306  $Id: fitintobox.pro 231 2007-03-19 17:15:51Z pinsard $</div> 
     306 $Id: fitintobox.pro 238 2007-03-27 13:43:18Z pinsard $ 
     307</div> 
    307308          <h4>History</h4><div class="preformat"> 
    308309 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    321322           
    322323           
    323           <h4>Uses routines</h4><div class="preformat">  
     324          <h4>Uses routines</h4><div class="preformat"> 
    324325 cm_4mesh 
    325326 cm_4cal 

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

    r234 r242  
    137137 a proposed directory. If neither dirname 
    138138 input parameter of IODIRECTORY keyword are defined, 
    139  the ask the user to choose a directory. 
     139 we ask the user to choose a directory. 
    140140</div> 
    141141             
    … …  
    189189         
    190190            <div class="comments"> 
    191  Used to pass keywords 
    192  
    193  all dialog_pickfile keywords (like filter) can be used. 
     191 Used to pass keywords to <proidl>dialog_pickfile</proidl> 
    194192</div> 
    195193             
    … …  
    207205           
    208206          <h4>Version</h4><div class="preformat"> 
    209  $Id: isadirectory.pro 232 2007-03-20 16:59:36Z pinsard $</div> 
     207 $Id: isadirectory.pro 237 2007-03-26 15:37:03Z pinsard $ 
     208</div> 
    210209          <h4>History</h4><div class="preformat"> 
    211210 Sebastien Masson (smasson@lodyc.jussieu.fr) 

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

    r234 r242  
    8989      <div id="file_comments"> 
    9090 same as <a href=".//find.html">find</a> except that as long as the file is 'NOT FOUND', 
    91  isafile calls dialog_pickfile, to ask the user to select a file. 
     91 <a href=".//isafile.html">isafile</a> calls  
     92 <proidl>dialog_pickfile</proidl>, to ask the user to select a file. 
    9293</div> 
    9394 
    … …  
    105106        <div class="routine_details" id="_isafile"> 
    106107 
    107           <h2><a class="top" href="#container">top</a>isafile <span class="categories">  
     108          <h2><a class="top" href="#container">top</a>isafile <span class="categories"> 
    108109 io 
    109110</span></h2> 
    … …  
    136137          <div class="comments"> 
    137138 a proposed name. If neither filein input parameter of filename keyword are 
    138  defined, the ask the user to choose a file. 
     139 defined, we ask the user to choose a file. 
    139140</div> 
    140141             
    … …  
    207208            <div class="comments"> 
    208209 performs recursive searching of directory hierarchies. 
    209  In a recursive search, find looks recursively for any and all 
     210 In a recursive search, <a href=".//find.html">find</a> looks recursively for any and all 
    210211 subdirectories in the file hierarchy rooted at the IODIRECTORY argument. 
    211212</div> 
    … …  
    253254         
    254255            <div class="comments"> 
    255  Used to pass keywords 
    256  
    257  all find, file_search and dialog_pickfile keywords (like title) can be used 
     256 Used to pass keywords to <a href=".//find.html">find</a>, 
     257 <proidl>file_search</proidl> and 
     258 <proidl>dialog_pickfile</proidl> 
    258259</div> 
    259260             
    … …  
    261262 
    262263          <h3>Examples</h3><div class="preformat"> 
    263  
    264264 IDL> print, isafile('/Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro') 
    265265  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro 
    … …  
    277277           
    278278          <h4>Version</h4><div class="preformat"> 
    279  $Id: isafile.pro 232 2007-03-20 16:59:36Z pinsard $</div> 
     279 $Id: isafile.pro 237 2007-03-26 15:37:03Z pinsard $ 
     280</div> 
    280281          <h4>History</h4><div class="preformat"> 
    281282 Sebastien Masson (smasson@lodyc.jussieu.fr) 

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

    r234 r242  
    138138         
    139139          <div class="comments"> 
    140  This is the first point of(the) straight line(s) whose we want to calculate 
     140 This is the first point of (the) straight line(s) whose we want to calculate 
    141141 equation(s) 
    142142</div> 
    … …  
    154154         
    155155          <div class="comments"> 
    156  This is the second point of(the) straight line(s) whose we want to calculate 
     156 This is the second point of (the) straight line(s) whose we want to calculate 
    157157 equation(s) 
    158158 

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

    r234 r242  
    119119      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, 
     121      2) if FLOAT is activated, it is a array of reals of dimension 2, 
    122122         number_of_pairs_of_straight_lines whose each row is the coordinates 
    123123         of the intersection point of a pair of straight line. 
    … …  
    141141          <div class="comments"> 
    142142 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 
     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> 
    … …  
    158158          <div class="comments"> 
    159159 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 
     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> 
    … …  
    211211           
    212212          <h4>Restrictions</h4><div class="preformat"> 
    213  If the 2 straight line are parallel, we return coordinates 
     213 If the 2 straight lines are parallel, we return coordinates 
    214214 (!values.f_nan,!values.f_nan) 
    215215 

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

    r234 r242  
    124124           
    125125          <h4>Version</h4><div class="preformat"> 
    126  $Id: mergeonline_help.pro 231 2007-03-19 17:15:51Z pinsard $</div> 
     126 $Id: mergeonline_help.pro 239 2007-03-28 06:50:03Z smasson $ 
     127</div> 
    127128          <h4>History</h4><div class="preformat"> 
    128129 Sept 2006: Sebastien Masson (smasson@lodyc.jussieu.fr) 

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

    r234 r242  
    159159           
    160160          <h4>Version</h4><div class="preformat"> 
    161  $Id: protype.pro 231 2007-03-19 17:15:51Z pinsard $</div> 
     161 $Id: protype.pro 231 2007-03-19 17:15:51Z pinsard $ 
     162</div> 
    162163          <h4>History</h4><div class="preformat"> 
    163164 Sebastien Masson (smasson@lodyc.jussieu.fr) 

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

    r234 r242  
    9090 Like <proidl>dialog_message</proidl> if there is already some widget 
    9191 active or like <proidl>message</proidl> if there is not any widget active. 
    92  To ask a question whose answer is not yes/no,use xquestion. 
     92 To ask a question whose answer is not yes/no, use xquestion. 
    9393</div> 
    9494 
    … …  
    129129              <span class="attr">required</span> 
    130130               
    131                
     131              <span class="attr">type:</span> <span class="value">scalar string or arrays of string</span> 
    132132               
    133133               
    … …  
    135135         
    136136          <div class="comments"> 
    137  one string or one vector of string. Si le string ne 
     137 If TEXT is a scalar string, we look for the line feed characters "!C" 
    138138 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 
    … …  
    207207            <div class="comments"> 
    208208 activate to print only the message without the name 
    209  and the line of the routine (defined by calling routine_name) 
    210  
    211  
     209 and the line of the routine (defined by calling <a href=".//routine_name.html">routine_name</a>) 
     210 or++  
    212211 Activate to print the error message without printing the routine name with 
    213212 its full path. 
    … …  
    251250           
    252251          <h4>Version</h4><div class="preformat"> 
    253  $Id: report.pro 232 2007-03-20 16:59:36Z pinsard $ 
     252 $Id: report.pro 239 2007-03-28 06:50:03Z smasson $ 
    254253</div> 
    255254          <h4>History</h4><div class="preformat"> 
    … …  
    275274          <h3>Statistics</h3> 
    276275          <table class="statistics"> 
    277             <tr><td>McCabe cyclic</td><td>          15</td></tr> 
     276            <tr><td>McCabe cyclic</td><td>          16</td></tr> 
    278277            <tr><td>McCabe essential</td><td>           1</td></tr> 
    279278            <tr><td>McCabe modular design</td><td>           1</td></tr> 

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

    r234 r242  
    172172           
    173173          <h4>Restrictions</h4><div class="preformat"> 
    174  This function use the keyword OUTPUT in help.pro and it is specified 
     174 This function use the keyword OUTPUT in <proidl>help</proidl> and  
     175 it is specified 
    175176 in the on-line help that the return syntax of this word can change in 
    176177 function of the version of the code. This version works with IDL 5.2. 

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

    r234 r242  
    8888 
    8989      <div id="file_comments"> 
    90  A kind of keyword_set but when the value exist, it send it back. 
     90 A kind of <proidl>keyword_set</proidl> but when the value exist, it  
     91 send it back. 
    9192</div> 
    9293 

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

    r234 r242  
    8989      <div id="file_comments"> 
    9090 This procedure writes a short text message within a box-shaped 
    91  area in a graphics window. The message may be split at word 
     91 area in a graphic 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. 
    … …  
    127127              <span class="attr">required</span> 
    128128               
    129                
     129              <span class="attr">type:</span> <span class="value">string</span> 
    130130               
    131131               
    … …  
    133133         
    134134          <div class="comments"> 
    135  ASCII text string containing the message. 
     135 message in ASCII. 
    136136</div> 
    137137             
    … …  
    155155         
    156156            <div class="comments"> 
    157  4 element vector specifying the box position and size 
    158  pos[0],pos[1] specify the lower left corner coordinate 
    159  pos[2],pos[3] specify the upper right corner coordinate 
    160  data window normalized coordinates are use 
     157 4 elements vector specifying the box position and size 
     158 pos[0],pos[1] specify the lower left corner coordinate, 
     159 pos[2],pos[3] specify the upper right corner coordinate, 
     160 data window normalized coordinates are used. 
    161161</div> 
    162162             
    … …  
    237237         
    238238            <div class="comments"> 
    239  activate to show the box on graphics window. 
     239 activate to show the box on graphic window. 
    240240</div> 
    241241             

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

    r234 r242  
    8989      <div id="file_comments"> 
    9090 erase a variable 
    91  same thing that delvar but usable in a program and usable 
     91 same thing like <proidl>delvar</proidl> but usable in a program and usable 
    9292 for one variable simultaneously 
    9393</div> 
    … …  
    158158 <a href="http://www.dfanning.com"/> : 
    159159QUESTION: How do I make an IDL variable have a type "undefined"? 
    160 ANSWER: At the main IDL level you can use the IDL procedure DELVAR to 
     160ANSWER: At the main IDL level you can use the IDL procedure <proidl>DELVAR</proidl> to 
    161161delete an IDL variable and make it undefined. Inside of procedures 
    162 and functions, I use this little program named UNDEFINE that I got 
     162and functions, I use this little program named <a href=".//UNDEFINE.html">UNDEFINE</a> that I got 
    163163from Andrew Cool at the DSTO High Frequency Radar Division in 
    164164Adelaide, Australia. 

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

    r234 r242  
    8888 
    8989      <div id="file_comments"> 
    90  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, 
    93  even if it is not in the current directory (thanks to the path). 
     90 display an ASCII file in a widget. 
     91 It is the same thing that <proidl>xdisplayfile<proidl> but here, we use it 
     92 to display the content of a procedure or of a function located in the !path 
     93 ".pro" suffix will be appended if needed. 
    9494</div> 
    9595 
    … …  
    158158         
    159159            <div class="comments"> 
    160  Used to pass keywords 
     160 Used to pass keywords to <proidl>xdisplayfile</proidl> 
    161161</div> 
    162162             
    … …  
    169169           
    170170          <h4>Version</h4><div class="preformat"> 
    171  $Id: xfile.pro 232 2007-03-20 16:59:36Z pinsard $ 
     171 $Id: xfile.pro 239 2007-03-28 06:50:03Z smasson $ 
    172172</div> 
    173173          <h4>History</h4><div class="preformat"> 
    … …  
    194194          <h3>Statistics</h3> 
    195195          <table class="statistics"> 
    196             <tr><td>McCabe cyclic</td><td>          10</td></tr> 
     196            <tr><td>McCabe cyclic</td><td>           3</td></tr> 
    197197            <tr><td>McCabe essential</td><td>           1</td></tr> 
    198198            <tr><td>McCabe modular design</td><td>           1</td></tr> 

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

    r234 r242  
    126126              <span class="attr">required</span> 
    127127               
    128                
     128              <span class="attr">type:</span> <span class="value">scalar string</span> 
    129129               
    130130               
    … …  
    132132         
    133133          <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 
    136  search for the file in the current working directory and then each of the 
    137  directories listed in !PATH environment variable.  The 
    138  ".pro" file suffix will be appended if it is not supplied. 
     134 the name of the file to display. 
     135 FILENAME should be located in !path. 
     136 ".pro" suffix will be appended if needed. 
    139137</div> 
    140138             
    … …  
    158156         
    159157            <div class="comments"> 
    160  Used to pass keywords 
     158 Used to pass keywords to <proidl>xdisplayfile</proidl> 
    161159</div> 
    162160             
    … …  
    169167           
    170168          <h4>Version</h4><div class="preformat"> 
    171  $Id: xhelp.pro 232 2007-03-20 16:59:36Z pinsard $ 
     169 $Id: xhelp.pro 239 2007-03-28 06:50:03Z smasson $ 
    172170</div> 
    173171          <h4>History</h4><div class="preformat"> 
    … …  
    189187           
    190188          <h4>Restrictions</h4><div class="preformat"> 
    191  Triggers the XMANAGER if it is not already in use. 
     189 Triggers the <proidl>XMANAGER</proidl> if it is not already in use. 
    192190</div> 
    193191         
    … …  
    202200          <h3>Statistics</h3> 
    203201          <table class="statistics"> 
    204             <tr><td>McCabe cyclic</td><td>          16</td></tr> 
     202            <tr><td>McCabe cyclic</td><td>           8</td></tr> 
    205203            <tr><td>McCabe essential</td><td>           1</td></tr> 
    206204            <tr><td>McCabe modular design</td><td>           1</td></tr> 
Note: See TracChangeset for help on using the changeset viewer.