Ignore:
Timestamp:
07/12/06 11:52:09 (18 years ago)
Author:
smasson
Message:

update documentation and .idlwave_catalog

Location:
trunk/SRC/Documentation/idldoc_html_output/Utilities
Files:
11 added
10 edited

Legend:

Unmodified
Added
Removed

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

    r121 r138  
    328328table.variables td.image { width: 64px; } 
    329329 
    330 div#file_comments {  
     330div#file_comments { white-space: pre;  
    331331  margin: 2em; 
    332332  font-size: 80%; 
    … …  
    696696      </div> 
    697697 
    698       <div id="file_comments"> write an idl function, compile it and execute it. 
    699  usefull to avoid the use of execute 
     698      <div id="file_comments"> 
     699 write an IDL function, compile it and execute it. 
     700 useful to avoid the use of execute 
    700701</div> 
    701702 
    … …  
    737738            </h4> 
    738739         
    739           <div class="comments"> a scalar string defining the result to be  
    740  given back by the function. (see examples) 
     740          <div class="comments">  
     741 a scalar string defining the result to be given back by the function.  
     742 (see examples) 
    741743</div> 
    742744             
    … …  
    759761            </h4> 
    760762         
    761             <div class="comments">  
     763            <div class="comments"> 
    762764 name of the function to be created. 
    763765</div> 
    … …  
    774776            </h4> 
    775777         
    776             <div class="comments"> a vector string. to specify a list of keywords that 
    777       must be included in the function definition. Warning: the string 
    778       must start with a ',' for example: KWDLIST = ', TOTO = toto' 
     778            <div class="comments">  
     779 a vector string. to specify a list of keywords that must be included in the  
     780 function definition.  
     781 Warning: the string must start with a ','  
     782 for example: KWDLIST = ', TOTO = toto' 
    779783</div> 
    780784             
    … …  
    790794            </h4> 
    791795         
    792             <div class="comments"> used to pass your keywords to the created function. 
     796            <div class="comments">  
     797 used to pass your keywords to the created function. 
    793798</div> 
    794799             
    795800           
    796801 
    797           <h3>Examples</h3><div class="value"> 
    798       IDL> print, createfunc('3*2', filename='test') 
    799       IDL> print, createfunc('3*two', filename = 'test' $ 
    800                                     , kwdlist ='two = two', two = 2) 
     802          <h3>Examples</h3><div class="preformat"> 
     803 IDL> print, createfunc('3*2', filename='test') 
     804 IDL> print, createfunc('3*two', filename = 'test' $ 
     805 IDL>                          , kwdlist ='two = two', two = 2) 
    801806</div> 
    802807          <h3>Version history</h3> 
    803808           
    804           <h4>Version</h4><div class="value"> $Id: createfunc.pro 118 2006-06-27 15:47:06Z pinsard $ 
    805 </div> 
    806           <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     809          <h4>Version</h4><div class="preformat"> $Id: createfunc.pro 136 2006-07-10 15:20:19Z pinsard $ 
     810</div> 
     811          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    807812                      May 2005 
    808813</div> 
    … …  
    813818           
    814819           
    815           <h4>Restrictions</h4><div class="value">  
     820          <h4>Restrictions</h4><div class="preformat"> 
    816821 - arguments can be given only through keywords; 
    817822 - ends the function name with '.pro' if needed. 

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

    r121 r138  
    328328table.variables td.image { width: 64px; } 
    329329 
    330 div#file_comments {  
     330div#file_comments { white-space: pre;  
    331331  margin: 2em; 
    332332  font-size: 80%; 
    … …  
    696696      </div> 
    697697 
    698       <div id="file_comments"> write an idl procedure, compile it and execute it. 
     698      <div id="file_comments"> 
     699 write an idl procedure, compile it and execute it. 
    699700</div> 
    700701 
    … …  
    736737            </h4> 
    737738         
    738           <div class="comments"> a string array defining the procedure to be created. each element will be a line of the created procedure. 
     739          <div class="comments">  
     740 a string array defining the procedure to be created.  
     741 each element will be a line of the created procedure. 
    739742</div> 
    740743             
    … …  
    758761         
    759762            <div class="comments"> 
    760   name of the procedure to be created. 
     763 name of the procedure to be created. 
    761764</div> 
    762765             
    … …  
    772775            </h4> 
    773776         
    774             <div class="comments"> a vector string. to specify a list of keywords that 
    775       must be included in the procedure definition. Warning: the string 
    776       must start with a ',' for example: KWDLIST = ', TOTO = toto' 
     777            <div class="comments">  
     778 a vector string.  
     779 to specify a list of keywords that must be included in the procedure  
     780 definition.  
     781 Warning: the string must start with a ','  
     782 for example: KWDLIST = ', TOTO = toto' 
    777783</div> 
    778784             
    … …  
    788794            </h4> 
    789795         
    790             <div class="comments"> obsolote, please pass directly your keywords through _EXTRA 
     796            <div class="comments">  
     797 obsolete, please pass directly your keywords through _EXTRA 
    791798</div> 
    792799             
    … …  
    802809            </h4> 
    803810         
    804             <div class="comments"> used to pass your keywords to the created procedure. 
     811            <div class="comments">  
     812 used to pass your keywords to the created procedure. 
    805813</div> 
    806814             
    807815           
    808816 
    809           <h3>Examples</h3><div class="value"> 
    810       IDL> createpro, ['print,''OK'''], filename='test' 
    811       IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $ 
    812       IDL>   , filename = 'test', kwdlist =', ok = ok' 
    813       IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $ 
    814       IDL>   , filename = 'test', kwdlist = ', ok = ok', /ok 
    815  
     817          <h3>Examples</h3><div class="preformat"> 
     818 IDL> createpro, ['print,''OK'''], filename='test' 
     819 IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $ 
     820 IDL>   , filename = 'test', kwdlist =', ok = ok' 
     821 IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $ 
     822 IDL>   , filename = 'test', kwdlist = ', ok = ok', /ok 
    816823</div> 
    817824          <h3>Version history</h3> 
    818825           
    819           <h4>Version</h4><div class="value"> $Id: createpro.pro 118 2006-06-27 15:47:06Z pinsard $</div> 
    820           <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     826          <h4>Version</h4><div class="preformat"> $Id: createpro.pro 136 2006-07-10 15:20:19Z pinsard $</div> 
     827          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    821828 cleaning + new keywords: October 2005 
    822829 Feb. 2006: supress keyword "kwdused" and use call_procedure instead of execute 
    … …  
    828835           
    829836           
    830           <h4>Restrictions</h4><div class="value"> 
     837          <h4>Restrictions</h4><div class="preformat"> 
    831838 - is not working with functions, use createfunc instead. 
    832839 - arguments can be given only through keywords. 

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

    r119 r138  
    328328table.variables td.image { width: 64px; } 
    329329 
    330 div#file_comments {  
     330div#file_comments { white-space: pre;  
    331331  margin: 2em; 
    332332  font-size: 80%; 
    … …  
    696696      </div> 
    697697 
    698       <div id="file_comments"> if needed, define and create myuniquetmpdir 
     698      <div id="file_comments"> 
     699 if needed, define and create myuniquetmpdir 
    699700 (common variable from cm_general) and add it to !path 
    700701</div> 
    … …  
    727728           
    728729 
    729           <h3>Examples</h3><div class="value">  
     730          <h3>Examples</h3><div class="preformat"> 
    730731 IDL> def_myuniquetmpdir 
    731732</div> 
    732733          <h3>Version history</h3> 
    733734           
    734           <h4>Version</h4><div class="value"> $Id: def_myuniquetmpdir.pro 118 2006-06-27 15:47:06Z pinsard $ 
     735          <h4>Version</h4><div class="preformat"> $Id: def_myuniquetmpdir.pro 128 2006-07-06 14:32:02Z pinsard $ 
    735736</div> 
    736           <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     737          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    737738                      June 2005 
    738739</div> 
    … …  
    748749           
    749750           
    750           <h4>Uses routines</h4><div class="value"> cm_general 
     751          <h4>Uses routines</h4><div class="preformat"> cm_general 
    751752</div> 
    752753           

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

    r119 r138  
    328328table.variables td.image { width: 64px; } 
    329329 
    330 div#file_comments {  
     330div#file_comments { white-space: pre;  
    331331  margin: 2em; 
    332332  font-size: 80%; 
    … …  
    727727          <h3>Version history</h3> 
    728728           
    729           <h4>Version</h4><div class="value"> $Id: demomode_compatibility.pro 118 2006-06-27 15:47:06Z pinsard $</div> 
     729          <h4>Version</h4><div class="preformat"> $Id: demomode_compatibility.pro 128 2006-07-06 14:32:02Z pinsard $</div> 
    730730           
    731731           
    … …  
    740740           
    741741           
    742           <h4>Uses routines</h4><div class="value"> cm_general</div> 
     742          <h4>Uses routines</h4><div class="preformat"> cm_general</div> 
    743743           
    744744           

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/dir-files.html

    r109 r138  
    7070        <li><a href="demomode_compatibility.html?format=raw" target="file_frame">demomode_compatibility.pro</a></li> 
    7171        <li><a href="find.html?format=raw" target="file_frame">find.pro</a></li> 
     72        <li><a href="fitintobox.html?format=raw" target="file_frame">fitintobox.pro</a></li> 
    7273        <li><a href="isadirectory.html?format=raw" target="file_frame">isadirectory.pro</a></li> 
    7374        <li><a href="isafile.html?format=raw" target="file_frame">isafile.pro</a></li> 
     75        <li><a href="linearequation.html?format=raw" target="file_frame">linearequation.pro</a></li> 
     76        <li><a href="lineintersection.html?format=raw" target="file_frame">lineintersection.pro</a></li> 
    7477        <li><a href="protype.html?format=raw" target="file_frame">protype.pro</a></li> 
     78        <li><a href="pwd.html?format=raw" target="file_frame">pwd.pro</a></li> 
     79        <li><a href="report.html?format=raw" target="file_frame">report.pro</a></li> 
     80        <li><a href="routine_name.html?format=raw" target="file_frame">routine_name.pro</a></li> 
     81        <li><a href="testvar.html?format=raw" target="file_frame">testvar.pro</a></li> 
     82        <li><a href="text_box.html?format=raw" target="file_frame">text_box.pro</a></li> 
     83        <li><a href="undefine.html?format=raw" target="file_frame">undefine.pro</a></li> 
     84        <li><a href="xfile.html?format=raw" target="file_frame">xfile.pro</a></li> 
     85        <li><a href="xhelp.html?format=raw" target="file_frame">xhelp.pro</a></li> 
    7586      </ul> 
    7687 
    77       <div id="tagline">8 files</div> 
     88      <div id="tagline">19 files</div> 
    7889       
    7990 

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

    r121 r138  
    328328table.variables td.image { width: 64px; } 
    329329 
    330 div#file_comments {  
     330div#file_comments { white-space: pre;  
    331331  margin: 2em; 
    332332  font-size: 80%; 
    … …  
    699699       
    700700        <dt><a href="createfunc.html?format=raw">createfunc.pro</a></dt> 
    701         <dd> write an idl function, compile it and execute it.</dd> 
     701        <dd>  write an IDL function, compile it and execute it.</dd> 
    702702       
    703703        <dt><a href="createpro.html?format=raw">createpro.pro</a></dt> 
    704         <dd> write an idl procedure, compile it and execute it.</dd> 
     704        <dd>  write an idl procedure, compile it and execute it.</dd> 
    705705       
    706706        <dt><a href="def_myuniquetmpdir.html?format=raw">def_myuniquetmpdir.pro</a></dt> 
    707         <dd> if needed, define and create myuniquetmpdir  (common variable from cm_general) and add it to !path </dd> 
     707        <dd>  if needed, define and create myuniquetmpdir  (common variable from cm_general) and add it to !path </dd> 
    708708       
    709709        <dt><a href="demomode_compatibility.html?format=raw">demomode_compatibility.pro</a></dt> 
    … …  
    711711       
    712712        <dt><a href="find.html?format=raw">find.pro</a></dt> 
    713         <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> 
     713        <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> 
     714       
     715        <dt><a href="fitintobox.html?format=raw">fitintobox.pro</a></dt> 
     716        <dd>   Check that the input array has size and dimensions  compatible with the domain that was defined with the previous call  of domdef.</dd> 
    714717       
    715718        <dt><a href="isadirectory.html?format=raw">isadirectory.pro</a></dt> 
    716         <dd> check if a directory exists and make sure that it ends           with the directory separator mark.</dd> 
     719        <dd>  check if a directory exists and make sure that it ends  with the directory separator mark.</dd> 
    717720       
    718721        <dt><a href="isafile.html?format=raw">isafile.pro</a></dt> 
    719         <dd> same as find.</dd> 
     722        <dd>  same as find.</dd> 
     723       
     724        <dt><a href="linearequation.html?format=raw">linearequation.pro</a></dt> 
     725        <dd>   Calculate a linear equation of the type ax+by+c=0  thanks to coordinates of 2 points.</dd> 
     726       
     727        <dt><a href="lineintersection.html?format=raw">lineintersection.pro</a></dt> 
     728        <dd>   Calculate coordinates of the intersection between 2 straight lines   or of a succession of 2 straight lines.</dd> 
    720729       
    721730        <dt><a href="protype.html?format=raw">protype.pro</a></dt> 
    722         <dd> test is a ".</dd> 
     731        <dd>  test is a ".</dd> 
     732       
     733        <dt><a href="pwd.html?format=raw">pwd.pro</a></dt> 
     734        <dd>   print the current directory </dd> 
     735       
     736        <dt><a href="report.html?format=raw">report.pro</a></dt> 
     737        <dd>   Like dialog_message.</dd> 
     738       
     739        <dt><a href="routine_name.html?format=raw">routine_name.pro</a></dt> 
     740        <dd>  Give us the name of the routine (procedure or function) where we are.</dd> 
     741       
     742        <dt><a href="testvar.html?format=raw">testvar.pro</a></dt> 
     743        <dd>   A kind of keyword_set but when the value exist, it send it back </dd> 
     744       
     745        <dt><a href="text_box.html?format=raw">text_box.pro</a></dt> 
     746        <dd>   This procedure writes a short text message within a box-shaped  area in a graphics window.</dd> 
     747       
     748        <dt><a href="undefine.html?format=raw">undefine.pro</a></dt> 
     749        <dd>   erase a variable  same thing that delvar but usable in a program and usable   for one variable simultaneously </dd> 
     750       
     751        <dt><a href="xfile.html?format=raw">xfile.pro</a></dt> 
     752        <dd>   display in a widget an ASCII file.</dd> 
     753       
     754        <dt><a href="xhelp.html?format=raw">xhelp.pro</a></dt> 
     755        <dd>   Display an IDL procedure header using widgets and the widget manager.</dd> 
    723756       
    724757      </dl> 

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

    r121 r138  
    328328table.variables td.image { width: 64px; } 
    329329 
    330 div#file_comments {  
     330div#file_comments { white-space: pre;  
    331331  margin: 2em; 
    332332  font-size: 80%; 
    … …  
    681681<div id="secondary_navbar"> 
    682682 
    683 <a href="demomode_compatibility.html?format=raw">&lt;&lt;prev file</a> | <a href="isadirectory.html?format=raw">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="find.html?format=raw" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
     683<a href="demomode_compatibility.html?format=raw">&lt;&lt;prev file</a> | <a href="fitintobox.html?format=raw">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="find.html?format=raw" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
    684684 
    685685</div> 
    … …  
    696696      </div> 
    697697 
    698       <div id="file_comments"> based on file_search, but it is possible to specify 
    699           a set of possibles names and a different set of 
    700           possibles directories names. 
    701           By default look for files included in !path 
     698      <div id="file_comments"> 
     699 based on file_search, but it is possible to specify 
     700 a set of possibles names and a different set of 
     701 possibles directories names. 
     702 By default look for files included in !path 
    702703 
    703704 all file_search keywords can be used. 
    … …  
    725726          <div class="comments"></div> 
    726727 
    727           <h3>Return value</h3><div class="value"> A scalar or array variable of string type, containing the 
    728        name (with the full path of the matching files. If no files 
    729        exist with names matching the input arguments, find returns 
    730        the scalar string : 'NOT FOUND' 
     728          <h3>Return value</h3><div class="preformat">  
     729 A scalar or array variable of string type, containing the 
     730 name (with the full path of the matching files. If no files 
     731 exist with names matching the input arguments, find returns 
     732 the scalar string : 'NOT FOUND' 
    731733</div> 
    732734 
    … …  
    746748            </h4> 
    747749         
    748           <div class="comments"> A scalar or array variable of string type, containing 
    749      file names to match. Input names specifications may contain 
    750      wildcard characters, enabling them to match multiple files 
    751      (see file_search for more informations). By default and if 
    752      necessary, find is looking for filename and also for filename 
    753      completed with '.pro' 
     750          <div class="comments">  
     751 A scalar or array variable of string type, containing 
     752 file names to match. Input names specifications may contain 
     753 wildcard characters, enabling them to match multiple files 
     754 (see file_search for more informations). By default and if 
     755 necessary, find is looking for filename and also for filename 
     756 completed with '.pro' 
    754757</div> 
    755758             
    … …  
    772775            </h4> 
    773776         
    774             <div class="comments"> A scalar or array variable of string type, containing 
    775         directories names where we are looking for the file.   
    776         Different directories can be separated by 
    777         path_sep(/search_path) (':' on unix type machine) as it is done 
    778         to define !path. 
    779         Note that if filename's dirname is different from '.', this 
    780         keyword is not taken into account. 
     777            <div class="comments">  
     778 A scalar or array variable of string type, containing 
     779 directories names where we are looking for the file. 
     780 Different directories can be separated by 
     781 path_sep(/search_path) (':' on unix type machine) as it is done 
     782 to define !path. 
     783 Note that if filename's dirname is different from '.', this 
     784 keyword is not taken into account. 
    781785</div> 
    782786             
    … …  
    792796            </h4> 
    793797         
    794             <div class="comments"> performs recursive searching of directory hierarchies. 
    795         In a recursive search, find looks recursively for any and all  
    796         subdirectories in the file hierarchy rooted at the IODIRECTORY 
    797         argument.  
     798            <div class="comments">  
     799 performs recursive searching of directory hierarchies. 
     800 In a recursive search, find looks recursively for any and all 
     801 subdirectories in the file hierarchy rooted at the IODIRECTORY argument. 
    798802</div> 
    799803             
    … …  
    809813            </h4> 
    810814         
    811             <div class="comments"> obsolete. keep for compatibility, use directory keyword 
     815            <div class="comments">  
     816 obsolete. keep for compatibility, use directory keyword 
    812817</div> 
    813818             
    … …  
    823828            </h4> 
    824829         
    825             <div class="comments"> activate to avoid the automatic search of filename 
    826        completed with '.pro' 
     830            <div class="comments">  
     831 activate to avoid the automatic search of filename completed with '.pro' 
    827832</div> 
    828833             
    … …  
    838843            </h4> 
    839844         
    840             <div class="comments"> force to look only at file ending with .pro 
     845            <div class="comments">  
     846 force to look only at file ending with .pro 
    841847</div> 
    842848             
    … …  
    852858            </h4> 
    853859         
    854             <div class="comments"> force to look only at file ending with .nc 
     860            <div class="comments">  
     861 force to look only at file ending with .nc 
    855862</div> 
    856863             
    … …  
    866873            </h4> 
    867874         
    868             <div class="comments"> activate to make sure that each element of the output 
    869        vector is unique. 
     875            <div class="comments">  
     876 activate to make sure that each element of the output vector is unique. 
    870877</div> 
    871878             
    … …  
    881888            </h4> 
    882889         
    883             <div class="comments"> activate this keyword to stop looking for the file as 
    884        soon as we found one. 
     890            <div class="comments">  
     891 activate this keyword to stop looking for the file as soon as we found one. 
    885892</div> 
    886893             
    … …  
    896903            </h4> 
    897904         
    898             <div class="comments"> activate to look for the file with a recursive search 
    899         in iodir, homedir, !path + the DATA:TestsData directory if it exists. 
     905            <div class="comments">  
     906 activate to look for the file with a recursive search 
     907 in iodir, homedir, !path + the DATA:TestsData directory if it exists. 
    900908</div> 
    901909             
    … …  
    911919            </h4> 
    912920         
    913             <div class="comments"> used to pass your keywords 
    914 </div> 
    915              
    916            
    917  
    918           <h3>Examples</h3><div class="value">  
    919  
    920    IDL> print, find('*loadct')   
     921            <div class="comments">  
     922 used to pass your keywords 
     923</div> 
     924             
     925           
     926 
     927          <h3>Examples</h3><div class="preformat"> 
     928 
     929 IDL> print, find('*loadct') 
    921930   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro 
    922931   /usr/local/rsi/idl_6.0/lib/loadct.pro 
    923    IDL> print, find('*loadct', iodir=!dir,/recursive) 
     932 IDL> print, find('*loadct', iodir=!dir,/recursive) 
    924933   /usr/local/rsi/idl_6.0/lib/loadct.pro 
    925934   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro 
    926    IDL> print, find('*loadct.pro')   
     935 IDL> print, find('*loadct.pro') 
    927936   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro 
    928937   /usr/local/rsi/idl_6.0/lib/loadct.pro 
    929    IDL> print, find('*loadct',/nopro)   
     938 IDL> print, find('*loadct',/nopro) 
    930939   NOT FOUND 
    931    IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib')   
     940 IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib') 
    932941   /usr/local/rsi/idl_6.0/lib/loadct.pro 
    933    IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /test_write)   
     942 IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /test_write) 
    934943   NOT FOUND 
    935    IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /recursive)   
     944 IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /recursive) 
    936945   /usr/local/rsi/idl_6.0/lib/loadct.pro 
    937946   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro 
    938    IDL> print, find('mesh*', iodirectory = [iodir, !path]) 
     947 IDL> print, find('mesh*', iodirectory = [iodir, !path]) 
    939948   /Users/sebastie/DATA/ORCA2/meshmaskORCA2closea.nc 
    940949   /Users/sebastie/IDL/meshmaskclosesea.pro 
    … …  
    945954          <h3>Version history</h3> 
    946955           
    947           <h4>Version</h4><div class="value"> $Id: find.pro 118 2006-06-27 15:47:06Z pinsard $</div> 
    948           <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     956          <h4>Version</h4><div class="preformat"> $Id: find.pro 136 2006-07-10 15:20:19Z pinsard $</div> 
     957          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    949958                       28/4/1999 
    950959                       6/7/1999: compatibility mac and windows 

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

    r119 r138  
    328328table.variables td.image { width: 64px; } 
    329329 
    330 div#file_comments {  
     330div#file_comments { white-space: pre;  
    331331  margin: 2em; 
    332332  font-size: 80%; 
    … …  
    681681<div id="secondary_navbar"> 
    682682 
    683 <a href="find.html?format=raw">&lt;&lt;prev file</a> | <a href="isafile.html?format=raw">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="isadirectory.html?format=raw" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
     683<a href="fitintobox.html?format=raw">&lt;&lt;prev file</a> | <a href="isafile.html?format=raw">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="isadirectory.html?format=raw" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
    684684 
    685685</div> 
    … …  
    696696      </div> 
    697697 
    698       <div id="file_comments"> check if a directory exists and make sure that it ends  
    699          with the directory separator mark. 
    700  
     698      <div id="file_comments"> 
     699 check if a directory exists and make sure that it ends 
     700 with the directory separator mark. 
     701 
     702  
    701703 all dialog_pickfile keywords (like filter) can be used. 
    702704</div> 
    … …  
    723725          <div class="comments"></div> 
    724726 
    725           <h3>Return value</h3><div class="value"> the directory name 
     727          <h3>Return value</h3><div class="preformat">  
     728 the directory name 
    726729</div> 
    727730 
    … …  
    741744            </h4> 
    742745         
    743           <div class="comments"> a proposed directory. If neither dirname  
    744         input parameter of IODIRECTORY keyword are defined, 
    745         the ask the user to choose a directory. 
     746          <div class="comments">  
     747 a proposed directory. If neither dirname 
     748 input parameter of IODIRECTORY keyword are defined, 
     749 the ask the user to choose a directory. 
    746750</div> 
    747751             
    … …  
    764768            </h4> 
    765769         
    766             <div class="comments"> the title of the window 
     770            <div class="comments">  
     771 the title of the window 
    767772</div> 
    768773             
    … …  
    778783            </h4> 
    779784         
    780             <div class="comments"> a proposed directory 
     785            <div class="comments">  
     786 a proposed directory 
    781787</div> 
    782788             
    … …  
    792798            </h4> 
    793799         
    794             <div class="comments"> used to pass your keywords 
     800            <div class="comments">  
     801 used to pass your keywords 
    795802</div> 
    796803             
    797804           
    798805 
    799           <h3>Examples</h3><div class="value">  
    800  
    801     IDL> print, !dir 
     806          <h3>Examples</h3><div class="preformat"> 
     807 
     808 IDL> print, !dir 
    802809    /usr/local/rsi/idl_6.0 
    803     IDL> print, isadirectory(!dir) 
     810 IDL> print, isadirectory(!dir) 
    804811    /usr/local/rsi/idl_6.0/ 
    805     IDL> print, isadirectory(!dir+'notgood') 
     812 IDL> print, isadirectory(!dir+'notgood') 
    806813</div> 
    807814          <h3>Version history</h3> 
    808815           
    809           <h4>Version</h4><div class="value"> $Id: isadirectory.pro 118 2006-06-27 15:47:06Z pinsard $</div> 
    810           <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     816          <h4>Version</h4><div class="preformat"> $Id: isadirectory.pro 136 2006-07-10 15:20:19Z pinsard $</div> 
     817          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    811818                      June 28, 2000 
    812819 June 2005: Sebastien Masson: cleaning, use for file_* functions 

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

    r121 r138  
    328328table.variables td.image { width: 64px; } 
    329329 
    330 div#file_comments {  
     330div#file_comments { white-space: pre;  
    331331  margin: 2em; 
    332332  font-size: 80%; 
    … …  
    681681<div id="secondary_navbar"> 
    682682 
    683 <a href="isadirectory.html?format=raw">&lt;&lt;prev file</a> | <a href="protype.html?format=raw">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="isafile.html?format=raw" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
     683<a href="isadirectory.html?format=raw">&lt;&lt;prev file</a> | <a href="linearequation.html?format=raw">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="isafile.html?format=raw" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
    684684 
    685685</div> 
    … …  
    696696      </div> 
    697697 
    698       <div id="file_comments"> same as find.pro except that as long as the file is 'NOT FOUND', 
    699           isafile calls dialog_pickfile, to ask the user to select a file. 
    700  
     698      <div id="file_comments"> 
     699 same as find.pro except that as long as the file is 'NOT FOUND', 
     700 isafile calls dialog_pickfile, to ask the user to select a file. 
     701 
     702  
    701703 all find, file_search and dialog_pickfile keywords (like title) can be used 
    702704</div> 
    … …  
    716718 
    717719          <h2><a class="top" href="#container">top</a>isafile <span class="categories"> io 
    718  
    719  </span></h2> 
     720</span></h2> 
    720721         
    721722          <p class="header"> 
    … …  
    724725          <div class="comments"></div> 
    725726 
    726           <h3>Return value</h3><div class="value"> the filename with its path 
     727          <h3>Return value</h3><div class="preformat">  
     728 the filename with its path 
    727729</div> 
    728730 
    … …  
    742744            </h4> 
    743745         
    744           <div class="comments"> a proposed name. If neither filein 
    745         input parameter of filename keyword are defined, 
    746        the ask the user to choose a file. 
     746          <div class="comments">  
     747 a proposed name. If neither filein input parameter of filename keyword are  
     748 defined, the ask the user to choose a file. 
    747749</div> 
    748750             
    … …  
    765767            </h4> 
    766768         
    767             <div class="comments"> a proposed filename. 
     769            <div class="comments">  
     770 a proposed filename. 
    768771</div> 
    769772             
    … …  
    779782            </h4> 
    780783         
    781             <div class="comments"> a directory where we look for the file. this 
    782            keyword is taken into account only if the dirname 
    783            of filein or filename is '.' 
     784            <div class="comments">  
     785 a directory where we look for the file. this 
     786 keyword is taken into account only if the dirname 
     787 of filein or filename is '.' 
    784788</div> 
    785789             
    … …  
    795799            </h4> 
    796800         
    797             <div class="comments"> to specify that filename is a new file and that 
    798         we should check only its path 
     801            <div class="comments">  
     802 to specify that filename is a new file and that we should check only its  
     803 path 
    799804</div> 
    800805             
    … …  
    810815            </h4> 
    811816         
    812             <div class="comments"> performs recursive searching of directory hierarchies. 
    813         In a recursive search, find looks recursively for any and all  
    814         subdirectories in the file hierarchy rooted at the IODIRECTORY 
    815         argument.  
     817            <div class="comments">  
     818 performs recursive searching of directory hierarchies. 
     819 In a recursive search, find looks recursively for any and all 
     820 subdirectories in the file hierarchy rooted at the IODIRECTORY argument. 
    816821</div> 
    817822             
    … …  
    827832            </h4> 
    828833         
    829             <div class="comments"> force to look only at file ending with .pro 
     834            <div class="comments">  
     835 force to look only at file ending with .pro 
    830836</div> 
    831837             
    … …  
    841847            </h4> 
    842848         
    843             <div class="comments"> force to look only at file ending with .nc 
     849            <div class="comments">  
     850 force to look only at file ending with .nc 
    844851</div> 
    845852             
    … …  
    855862            </h4> 
    856863         
    857             <div class="comments"> used to pass your keywords 
     864            <div class="comments">  
     865 used to pass your keywords 
    858866</div> 
    859867             
    860868           
    861869 
    862           <h3>Examples</h3><div class="value">  
    863  
    864   IDL> print, isafile('/Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro') 
     870          <h3>Examples</h3><div class="preformat"> 
     871 
     872 IDL> print, isafile('/Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro') 
    865873  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro 
    866   IDL> print, isafile('cm_4mesh.pro', iodir = '/Users/sebastie/SAXO_RD/Commons') 
     874 IDL> print, isafile('cm_4mesh.pro', iodir = '/Users/sebastie/SAXO_RD/Commons') 
    867875  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro 
    868   IDL> print, isafile('cm_4mesh.pro', iodir = !path) 
     876 IDL> print, isafile('cm_4mesh.pro', iodir = !path) 
    869877  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro 
    870   IDL> print, isafile('cm_4mesh.pro', iodir = '/Users/sebastie/SAXO_RD', /recursive) 
     878 IDL> print, isafile('cm_4mesh.pro', iodir = '/Users/sebastie/SAXO_RD', /recursive) 
    871879  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro 
    872   IDL> print, isafile('cm_4mesh.pro', iodir = getenv('HOME'), /recursive) 
     880 IDL> print, isafile('cm_4mesh.pro', iodir = getenv('HOME'), /recursive) 
    873881  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro 
    874   IDL> print, isafile('fake_file.pro') 
     882 IDL> print, isafile('fake_file.pro') 
    875883</div> 
    876884          <h3>Version history</h3> 
    877885           
    878           <h4>Version</h4><div class="value"> $Id: isafile.pro 118 2006-06-27 15:47:06Z pinsard $</div> 
    879           <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     886          <h4>Version</h4><div class="preformat"> $Id: isafile.pro 136 2006-07-10 15:20:19Z pinsard $</div> 
     887          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    880888                      11/2/2000 
    881889 June 2005: Sebastien Masson: cleaning, use for file_* functions 

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

    r119 r138  
    328328table.variables td.image { width: 64px; } 
    329329 
    330 div#file_comments {  
     330div#file_comments { white-space: pre;  
    331331  margin: 2em; 
    332332  font-size: 80%; 
    … …  
    681681<div id="secondary_navbar"> 
    682682 
    683 <a href="isafile.html?format=raw">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="protype.html?format=raw" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
     683<a href="lineintersection.html?format=raw">&lt;&lt;prev file</a> | <a href="pwd.html?format=raw">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="protype.html?format=raw" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
    684684 
    685685</div> 
    … …  
    696696      </div> 
    697697 
    698       <div id="file_comments"> test is a ".pro" file corresponds to an IDL procedure, 
    699          function or batch file. 
     698      <div id="file_comments"> 
     699 test is a ".pro" file corresponds to an IDL procedure, function or batch file. 
    700700</div> 
    701701 
    … …  
    721721          <div class="comments"></div> 
    722722 
    723           <h3>Return value</h3><div class="value"> A scalar of string type: 'proc', 'func' or 'batch' 
     723          <h3>Return value</h3><div class="preformat">  
     724 A scalar of string type: 'proc', 'func' or 'batch' 
    724725</div> 
    725726 
    … …  
    739740            </h4> 
    740741         
    741           <div class="comments"> A scalar of string type, the name of the ".pro" file to be tested 
    742     if necessary, the input name is completed with '.pro' 
    743      and its path found in !path 
     742          <div class="comments">  
     743 A scalar of string type, the name of the ".pro" file to be tested 
     744 if necessary, the input name is completed with '.pro' 
     745 and its path found in !path 
    744746</div> 
    745747             
    … …  
    749751           
    750752 
    751           <h3>Examples</h3><div class="value">  
    752  
    753       IDL> print, protype('protype') 
     753          <h3>Examples</h3><div class="preformat"> 
     754 
     755 IDL> print, protype('protype') 
    754756      func 
    755       IDL> print, protype('protype.pro') 
     757 IDL> print, protype('protype.pro') 
    756758      func 
    757       IDL> print, protype('init') 
     759 IDL> print, protype('init') 
    758760      batch 
    759       IDL> print, protype('plt') 
     761 IDL> print, protype('plt') 
    760762      proc 
    761763</div> 
    762764          <h3>Version history</h3> 
    763765           
    764           <h4>Version</h4><div class="value"> $Id: protype.pro 118 2006-06-27 15:47:06Z pinsard $</div> 
    765           <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     766          <h4>Version</h4><div class="preformat"> $Id: protype.pro 136 2006-07-10 15:20:19Z pinsard $</div> 
     767          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    766768                       Feb 2006 
    767769</div> 
Note: See TracChangeset for help on using the changeset viewer.