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

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

Location:
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION
Files:
16 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/ciseauxtri.html

    r157 r163  
    702702 Delete arrays which do not have to be drawn thanks to 2 tests: 
    703703     1) Corners of the array must be in the window 
    704      2) Lenghtes of side of triangles expressed in normalized  
    705         coordinates must not surpass a sill lenght.  
     704     2) Lengthes of side of triangles expressed in normalized  
     705        coordinates must not surpass a sill length.  
    706706</div> 
    707707 
    … …  
    817817           
    818818          <h4>Version</h4><div class="preformat"> 
    819  $Id: ciseauxtri.pro 150 2006-08-09 10:12:54Z navarro $ 
     819 $Id: ciseauxtri.pro 157 2006-08-21 09:01:50Z navarro $ 
    820820 </div> 
    821821          <h4>History</h4><div class="preformat"> 
    … …  
    841841           
    842842         
     843          <h3>Statistics</h3> 
     844          <table class="statistics"> 
     845            <tr><td>McCabe cyclic</td><td>          26</td></tr> 
     846            <tr><td>McCabe essential</td><td>           1</td></tr> 
     847            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     848          </table> 
    843849           
    844850         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/completecointerre.html

    r157 r163  
    721721          <dd> </dd>     
    722722           
    723           <dt><p><a href="#_completecointerre">completecointerre, COINMONTE=<span class="result">COINMONTE</span>, COINDESCEND=<span class="result">COINDESCEND</span>, CONT_COLOR=<span class="result">CONT_COLOR</span>, INDICEZOOM=<span class="result">INDICEZOOM</span>, _extra=<span class="result">_extra</span></a></p><dt> 
     723          <dt><p><a href="#_completecointerre">completecointerre, COINMONTE=<span class="result">array</span>, COINDESCEND=<span class="result">array</span>, CONT_COLOR=<span class="result">CONT_COLOR</span>, INDICEZOOM=<span class="result">INDICEZOOM</span>, _extra=<span class="result">_extra</span></a></p><dt> 
    724724          <dd> </dd>     
    725725                 
    … …  
    808808               
    809809               
    810                
     810              <span class="attr">default:</span> <span class="value">(!d.n_colors - 1) < 255 </span> 
    811811               
    812812            </h4> 
    813813         
    814814            <div class="comments"> 
    815  The color of the continent. defaut value is 
    816  (!d.n_colors - 1) < 255 => white 
     815 The color of the continent. 
    817816</div> 
    818817             
    … …  
    838837           
    839838          <h4>Version</h4><div class="preformat"> 
    840  $Id: completecointerre.pro 150 2006-08-09 10:12:54Z navarro $ 
     839 $Id: completecointerre.pro 157 2006-08-21 09:01:50Z navarro $ 
    841840</div> 
    842841          <h4>History</h4><div class="preformat"> 
    … …  
    862861           
    863862         
     863          <h3>Statistics</h3> 
     864          <table class="statistics"> 
     865            <tr><td>McCabe cyclic</td><td>           3</td></tr> 
     866            <tr><td>McCabe essential</td><td>           1</td></tr> 
     867            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     868          </table> 
    864869           
    865870         
    … …  
    874879         
    875880          <p class="header"> 
    876             completecointerre, <a href="#_completecointerre_keyword_COINMONTE">COINMONTE</a>=<span class="result">COINMONTE</span>, <a href="#_completecointerre_keyword_COINDESCEND">COINDESCEND</a>=<span class="result">COINDESCEND</span>, <a href="#_completecointerre_keyword_CONT_COLOR">CONT_COLOR</a>=<span class="result">CONT_COLOR</span>, <a href="#_completecointerre_keyword_INDICEZOOM">INDICEZOOM</a>=<span class="result">INDICEZOOM</span>, <a href="#_completecointerre_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
     881            completecointerre, <a href="#_completecointerre_keyword_COINMONTE">COINMONTE</a>=<span class="result">array</span>, <a href="#_completecointerre_keyword_COINDESCEND">COINDESCEND</a>=<span class="result">array</span>, <a href="#_completecointerre_keyword_CONT_COLOR">CONT_COLOR</a>=<span class="result">CONT_COLOR</span>, <a href="#_completecointerre_keyword_INDICEZOOM">INDICEZOOM</a>=<span class="result">INDICEZOOM</span>, <a href="#_completecointerre_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
    877882         
    878883          <div class="comments"> 
    … …  
    893898               
    894899               
    895                
     900              <span class="attr">type:</span> <span class="value">array</span> 
    896901               
    897902               
    … …  
    899904         
    900905            <div class="comments"> 
    901  It is an array. To obtain the array of "ascending land corner"  
     906 To obtain the array of "ascending land corner"  
    902907 to be treated with completecointerre.pro in the variable array  
    903908 instead of make it pass by the global variable twin_corners_up. 
    … …  
    910915               
    911916               
    912                
     917              <span class="attr">type:</span> <span class="value">array</span> 
    913918               
    914919               
    … …  
    916921         
    917922            <div class="comments"> 
    918  It is an array. See COINMONTE 
     923 See COINMONTE 
    919924</div> 
    920925             
    … …  
    931936         
    932937            <div class="comments"> 
    933  The color of the continent. defaut value is 
     938 The color of the continent. default value is 
    934939 (!d.n_colors - 1) < 255 => white 
    935940</div> 
    … …  
    971976           
    972977          <h4>Version</h4><div class="preformat"> 
    973  $Id: completecointerre.pro 150 2006-08-09 10:12:54Z navarro $ 
     978 $Id: completecointerre.pro 157 2006-08-21 09:01:50Z navarro $ 
    974979</div> 
    975980          <h4>History</h4><div class="preformat"> 
    … …  
    9951000           
    9961001         
     1002          <h3>Statistics</h3> 
     1003          <table class="statistics"> 
     1004            <tr><td>McCabe cyclic</td><td>          20</td></tr> 
     1005            <tr><td>McCabe essential</td><td>           1</td></tr> 
     1006            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1007          </table> 
    9971008           
    9981009         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/definetri.html

    r157 r163  
    707707 triangles. cf. figure above 
    708708 
    709  <fixe> 
     709<p class="preformat"> 
    710710      ny-1*---*---*. . . . . .*---*---* 
    711711          |  +|  +|           |  +|  +|       
    … …  
    717717          .       .           .       . 
    718718         1*---*---*. . . . . .*---*---* 
    719           |  + |  +|          |  +|  +| 
    720           | +  | + |          | + | + | 
    721           |+   |+  |          |+  |+  | 
     719          |  +|  +|           |  +|  +| 
     720          | + | + |           | + | + | 
     721          |+  |+  |           |+  |+  | 
    722722         0*---*---*. . . . . .*---*---*   
    723723           0   1   2        nx-3  nx-2 nx-1 
    724  </fixe> 
     724</p> 
    725725 
    726726  You have 2 ways to cut a rectangle: 
    727727      1) the upward diagonal       2) the downward diagonal 
    728728 
    729  <fixe> 
     729<p class="preformat"> 
    730730          *---*                        *---* 
    731731          |  +|                        |+  | 
    … …  
    733733          |+  |                        |  +| 
    734734          *---*                        *---*   
    735  </fixe> 
     735</p> 
    736736</div> 
    737737 
    … …  
    843843           
    844844          <h4>Version</h4><div class="preformat"> 
    845  $Id: definetri.pro 150 2006-08-09 10:12:54Z navarro $</div> 
     845 $Id: definetri.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    846846          <h4>History</h4><div class="preformat"> 
    847847 sebastien Masson (smlod@ipsl.jussieu.fr) 
    … …  
    864864           
    865865         
     866          <h3>Statistics</h3> 
     867          <table class="statistics"> 
     868            <tr><td>McCabe cyclic</td><td>           6</td></tr> 
     869            <tr><td>McCabe essential</td><td>           1</td></tr> 
     870            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     871          </table> 
    866872           
    867873         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/definetri_e.html

    r157 r163  
    808808           
    809809          <h4>Version</h4><div class="preformat"> 
    810  $Id$</div> 
     810 $Id: definetri_e.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    811811          <h4>History</h4><div class="preformat"> 
    812812 
    … …  
    830830           
    831831         
     832          <h3>Statistics</h3> 
     833          <table class="statistics"> 
     834            <tr><td>McCabe cyclic</td><td>           1</td></tr> 
     835            <tr><td>McCabe essential</td><td>           1</td></tr> 
     836            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     837          </table> 
    832838           
    833839         
    … …  
    935941           
    936942          <h4>Version</h4><div class="preformat"> 
    937  $Id: definetri_e.pro 150 2006-08-09 10:12:54Z navarro $ 
     943 $Id: definetri_e.pro 157 2006-08-21 09:01:50Z navarro $ 
    938944</div> 
    939945          <h4>History</h4><div class="preformat"> 
    … …  
    958964           
    959965         
     966          <h3>Statistics</h3> 
     967          <table class="statistics"> 
     968            <tr><td>McCabe cyclic</td><td>           4</td></tr> 
     969            <tr><td>McCabe essential</td><td>           1</td></tr> 
     970            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     971          </table> 
    960972           
    961973         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/dessinetri.html

    r157 r163  
    843843         
    844844            <div class="comments"> 
    845  =n. To change the color of each traingle. n colors 
     845 =n. To change the color of each triangle. n colors 
    846846 will be used and repeted if necessary. 
    847847</div> 
    … …  
    866866           
    867867          <h4>Version</h4><div class="preformat"> 
    868  $Id: dessinetri.pro 150 2006-08-09 10:12:54Z navarro $ 
     868 $Id: dessinetri.pro 157 2006-08-21 09:01:50Z navarro $ 
    869869</div> 
    870870          <h4>History</h4><div class="preformat"> 
    … …  
    889889           
    890890         
     891          <h3>Statistics</h3> 
     892          <table class="statistics"> 
     893            <tr><td>McCabe cyclic</td><td>          16</td></tr> 
     894            <tr><td>McCabe essential</td><td>           1</td></tr> 
     895            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     896          </table> 
    891897           
    892898         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/directory-overview.html

    r157 r163  
    702702       
    703703        <dt><a href="ciseauxtri.html?format=raw">ciseauxtri.pro</a></dt> 
    704         <dd>   Delete arrays which do not have to be drawn thanks to 2 tests:      1) Corners of the array must be in the window      2) Lenghtes of side of triangles expressed in normalized          coordinates must not surpass a sill lenght.</dd> 
     704        <dd>   Delete arrays which do not have to be drawn thanks to 2 tests:      1) Corners of the array must be in the window      2) Lengthes of side of triangles expressed in normalized          coordinates must not surpass a sill length.</dd> 
    705705       
    706706        <dt><a href="completecointerre.html?format=raw">completecointerre.pro</a></dt> 
    … …  
    738738       
    739739        <dt><a href="triangule.html?format=raw">triangule.pro</a></dt> 
    740         <dd></dd> 
     740        <dd>  </dd> 
    741741       
    742742        <dt><a href="triangule_c.html?format=raw">triangule_c.pro</a></dt> 
    … …  
    744744       
    745745        <dt><a href="triangule_e.html?format=raw">triangule_e.pro</a></dt> 
    746         <dd>  Buid the triangulation for a E-grid type </dd> 
     746        <dd>  Build the triangulation for a E-grid type </dd> 
    747747       
    748748      </dl> 

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/drawcoast_c.html

    r157 r163  
    822822               
    823823               
    824                
     824              <span class="attr">default:</span> <span class="value">0</span> 
    825825               
    826826            </h4> 
    … …  
    828828            <div class="comments"> 
    829829 The color of the coastline. 
    830  defaut value is 0 => black 
     830 Default is black (0). 
    831831</div> 
    832832             
    … …  
    838838               
    839839               
    840                
     840              <span class="attr">default:</span> <span class="value">1</span> 
    841841               
    842842            </h4> 
    … …  
    844844            <div class="comments"> 
    845845 The thick of the trait to trace continents 
    846  By default, it is 1. 
    847846</div> 
    848847             
    … …  
    869868               
    870869               
    871                
     870              <span class="attr">default:</span> <span class="value">5</span> 
    872871               
    873872            </h4> 
    … …  
    876875 To eliminate segments of coasts which are to big (which link points which can  
    877876 be close on the sphere but distant on the drawing). We delete all segments  
    878  whose the size surpass the size of the window following X/XSEUIL. By default,  
    879  XSEUIL=5. But it can be to big if we do a big zoom or a little one for some  
     877 whose the size surpass the size of the window following X/XSEUIL.  
     878 But it can be to big if we do a big zoom or a little one for some  
    880879 projections... We specify it the keyword thanks to this keyword! 
    881880</div> 
    … …  
    930929           
    931930         
     931          <h3>Statistics</h3> 
     932          <table class="statistics"> 
     933            <tr><td>McCabe cyclic</td><td>          16</td></tr> 
     934            <tr><td>McCabe essential</td><td>           1</td></tr> 
     935            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     936          </table> 
    932937           
    933938         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/drawcoast_e.html

    r157 r163  
    822822               
    823823               
    824                
     824              <span class="attr">default:</span> <span class="value">0</span> 
    825825               
    826826            </h4> 
    … …  
    828828            <div class="comments"> 
    829829 The color of the coastline. 
    830  defaut value is 0 => black 
     830 Default is black (0). 
    831831</div> 
    832832             
    … …  
    838838               
    839839               
    840                
     840              <span class="attr">default:</span> <span class="value">1</span> 
    841841               
    842842            </h4> 
    … …  
    844844            <div class="comments"> 
    845845 The thick of the trait to trace continents 
    846  By default, it is 1. 
    847846</div> 
    848847             
    … …  
    869868               
    870869               
    871                
     870              <span class="attr">default:</span> <span class="value">5</span> 
    872871               
    873872            </h4> 
    … …  
    876875 To eliminate segments of coasts which are to big (which link points which can  
    877876 be close on the sphere but distant on the drawing). We delete all segments  
    878  whose the size surpass the size of the window following X/XSEUIL. By default,  
    879  XSEUIL=5. But it can be to big if we do a big zoom or a little one for some  
     877 whose the size surpass the size of the window following X/XSEUIL. 
     878 But it can be to big if we do a big zoom or a little one for some  
    880879 projections... We specify it the keyword thanks to this keyword! 
    881880</div> 
    … …  
    943942           
    944943         
     944          <h3>Statistics</h3> 
     945          <table class="statistics"> 
     946            <tr><td>McCabe cyclic</td><td>          11</td></tr> 
     947            <tr><td>McCabe essential</td><td>           1</td></tr> 
     948            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     949          </table> 
    945950           
    946951         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/drawsectionbottom.html

    r157 r163  
    735735               
    736736               
    737                
     737              <span class="attr">required</span> 
    738738               
    739739               
    … …  
    749749               
    750750               
    751                
     751              <span class="attr">required</span> 
    752752               
    753753               
    … …  
    763763               
    764764               
    765                
     765              <span class="attr">required</span> 
    766766               
    767767               
    … …  
    787787               
    788788               
    789                
     789              <span class="attr">default:</span> <span class="value">0</span> 
    790790               
    791791            </h4> 
    … …  
    793793            <div class="comments"> 
    794794 The color of the coastline. 
    795  defaut value is 0 => black 
     795 Default is black (0). 
    796796</div> 
    797797             
    … …  
    803803               
    804804               
    805                
     805              <span class="attr">default:</span> <span class="value">1</span> 
    806806               
    807807            </h4> 
    … …  
    809809            <div class="comments"> 
    810810 The thickness of the coastline. 
    811  defaut value is 1 
    812811</div> 
    813812             
    … …  
    819818               
    820819               
    821                
     820              <span class="attr">default:</span> <span class="value">(!d.n_colors - 1) < 255</span> 
    822821               
    823822            </h4> 
    824823         
    825824            <div class="comments"> 
    826  The color of the continent. defaut value is 
    827  (!d.n_colors - 1) < 255 => white 
     825 The color of the continent. Default value is 
     826 Default is white (0). 
    828827</div> 
    829828             
    … …  
    873872           
    874873          <h4>Version</h4><div class="preformat"> 
    875  $Id: drawsectionbottom.pro 150 2006-08-09 10:12:54Z navarro $ 
     874 $Id: drawsectionbottom.pro 157 2006-08-21 09:01:50Z navarro $ 
    876875</div> 
    877876          <h4>History</h4><div class="preformat"> 
    … …  
    901900           
    902901         
     902          <h3>Statistics</h3> 
     903          <table class="statistics"> 
     904            <tr><td>McCabe cyclic</td><td>          16</td></tr> 
     905            <tr><td>McCabe essential</td><td>           1</td></tr> 
     906            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     907          </table> 
    903908           
    904909         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/fillcornermask.html

    r157 r163  
    798798               
    799799               
    800                
     800              <span class="attr">default:</span> <span class="value">(!d.n_colors - 1) < 255 </span> 
    801801               
    802802            </h4> 
    803803         
    804804            <div class="comments"> 
    805  The color of the continent. defaut value is 
    806  (!d.n_colors - 1) < 255 => white 
     805 The color of the continent. 
    807806</div> 
    808807             
    … …  
    841840           
    842841          <h4>Version</h4><div class="preformat"> 
    843  $Id: fillcornermask.pro 150 2006-08-09 10:12:54Z navarro $ 
     842 $Id: fillcornermask.pro 157 2006-08-21 09:01:50Z navarro $ 
    844843</div> 
    845844          <h4>History</h4><div class="preformat"> 
    … …  
    865864           
    866865         
     866          <h3>Statistics</h3> 
     867          <table class="statistics"> 
     868            <tr><td>McCabe cyclic</td><td>          14</td></tr> 
     869            <tr><td>McCabe essential</td><td>           1</td></tr> 
     870            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     871          </table> 
    867872           
    868873         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/section.html

    r157 r163  
    952952           
    953953         
     954          <h3>Statistics</h3> 
     955          <table class="statistics"> 
     956            <tr><td>McCabe cyclic</td><td>          48</td></tr> 
     957            <tr><td>McCabe essential</td><td>           1</td></tr> 
     958            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     959          </table> 
    954960           
    955961         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/tracecote.html

    r157 r163  
    747747            <div class="comments"> 
    748748 To draw the surface coast line instead of 
    749  the coast line at level firstz[tw]. Usefull only for deep 
     749 the coast line at level firstz[tw]. Useful only for deep 
    750750 plots! 
    751751</div> 
    … …  
    772772           
    773773          <h4>Version</h4><div class="preformat"> 
    774  $Id: tracecote.pro 150 2006-08-09 10:12:54Z navarro $ 
     774 $Id: tracecote.pro 157 2006-08-21 09:01:50Z navarro $ 
    775775</div> 
    776776          <h4>History</h4><div class="preformat"> 
    … …  
    796796           
    797797         
     798          <h3>Statistics</h3> 
     799          <table class="statistics"> 
     800            <tr><td>McCabe cyclic</td><td>          15</td></tr> 
     801            <tr><td>McCabe essential</td><td>           1</td></tr> 
     802            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     803          </table> 
    798804           
    799805         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/tracemask.html

    r157 r163  
    744744         
    745745          <div class="comments"> 
    746  2d array specifing the mask 
     746 2d array specifying the mask 
    747747 </div> 
    748748             
    … …  
    759759         
    760760          <div class="comments">, 
    761  2d array specifing longitude coordinates. 
     761 2d array specifying longitude coordinates. 
    762762 </div> 
    763763             
    … …  
    774774         
    775775          <div class="comments">, 
    776  2d array specifing latitude coordinates. 
     776 2d array specifying latitude coordinates. 
    777777</div> 
    778778             
    … …  
    791791               
    792792               
    793                
     793              <span class="attr">default:</span> <span class="value">0</span> 
    794794               
    795795            </h4> 
    … …  
    797797            <div class="comments"> 
    798798 The color of the coastline. 
    799  defaut value is 0 => black 
     799 Default is black (0). 
    800800</div> 
    801801             
    … …  
    807807               
    808808               
    809                
     809              <span class="attr">default:</span> <span class="value">1</span> 
    810810               
    811811            </h4> 
    … …  
    813813            <div class="comments"> 
    814814 The thick of the trait to trace continents 
    815  It is 1 by default. 
    816815</div> 
    817816             
    … …  
    852851           
    853852          <h4>Version</h4><div class="preformat"> 
    854  $Id: tracemask.pro 150 2006-08-09 10:12:54Z navarro $ 
     853 $Id: tracemask.pro 157 2006-08-21 09:01:50Z navarro $ 
    855854</div> 
    856855          <h4>History</h4><div class="preformat"> 
    … …  
    875874           
    876875         
     876          <h3>Statistics</h3> 
     877          <table class="statistics"> 
     878            <tr><td>McCabe cyclic</td><td>          26</td></tr> 
     879            <tr><td>McCabe essential</td><td>           1</td></tr> 
     880            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     881          </table> 
    877882           
    878883         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/triangule.html

    r157 r163  
    699699      </div> 
    700700 
    701       <div id="file_comments"></div> 
     701      <div id="file_comments"> 
     702 
     703</div> 
    702704 
    703705       
    … …  
    714716        <div class="routine_details" id="_triangule"> 
    715717 
    716           <h2><a class="top" href="#container">top</a>triangule </h2> 
     718          <h2><a class="top" href="#container">top</a>triangule <span class="categories"> 
     719 
     720</span></h2> 
    717721         
    718722          <p class="header"> 
    719             <span class="result">result = </span>triangule(<span class="result"><a href="#_triangule_param_maskentree">maskentree</a></span>, <a href="#_triangule_keyword_BASIC">BASIC</a>=<span class="result">BASIC</span>, <a href="#_triangule_keyword_COINMONTE">COINMONTE</a>=<span class="result">COINMONTE</span>, <a href="#_triangule_keyword_COINDESCEND">COINDESCEND</a>=<span class="result">COINDESCEND</span>, <a href="#_triangule_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 
    720          
    721           <div class="comments"> 
    722 </div> 
    723  
    724            
     723            <span class="result">result = </span>triangule(<span class="result">[<a href="#_triangule_param_maskentree">maskentree</a>]</span>, <a href="#_triangule_keyword_BASIC">BASIC</a>=<span class="result">BASIC</span>, <a href="#_triangule_keyword_COINMONTE">COINMONTE</a>=<span class="result">array</span>, <a href="#_triangule_keyword_COINDESCEND">COINDESCEND</a>=<span class="result">array</span>, <a href="#_triangule_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 
     724         
     725          <div class="comments"></div> 
     726 
     727          <h3>Return value</h3><div class="preformat"> 
     728 
     729</div> 
    725730 
    726731           
    … …  
    729734             
    730735            <h4 id="_triangule_param_maskentree">maskentree&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    731                
    732                
    733                
    734                
    735                
    736                
     736              <span class="attr">in</span> 
     737               
     738              <span class="attr">optional</span> 
     739               
     740               
     741              <span class="attr">type:</span> <span class="value">2d array</span> 
    737742               
    738743               
    739744            </h4> 
    740745         
    741           <div class="comments"></div> 
     746          <div class="comments"> 
     747 It is a 2d array which will serve to mask the field we will trace after with CONTOUR,  
     748 ...TRIANGULATION=triangule(mask) 
     749 If this argument is not specified, the function use tmask 
     750</div> 
    742751             
    743752 
    … …  
    759768            </h4> 
    760769         
    761             <div class="comments"></div> 
     770            <div class="comments"> 
     771 Specify that the mask is on a basic grid (use the triangulation for vertical cuts and hovmoellers) 
     772</div> 
    762773             
    763774            <h4 id="_triangule_keyword_COINMONTE">COINMONTE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    767778               
    768779               
    769                
     780              <span class="attr">type:</span> <span class="value">array</span> 
    770781               
    771782               
    772783            </h4> 
    773784         
    774             <div class="comments"></div> 
     785            <div class="comments"> 
     786 To obtain the array of "ascending land corner" to be treated with  
     787 completecointerre.pro in the variable array instead of make it pass by the global  
     788 variable twin_corners_up. 
     789</div> 
    775790             
    776791            <h4 id="_triangule_keyword_COINDESCEND">COINDESCEND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    780795               
    781796               
    782                
     797              <span class="attr">type:</span> <span class="value">array</span> 
    783798               
    784799               
    785800            </h4> 
    786801         
    787             <div class="comments"></div> 
     802            <div class="comments"> 
     803 See COINMONTE 
     804</div> 
    788805             
    789806            <h4 id="_triangule_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    798815            </h4> 
    799816         
    800             <div class="comments"></div> 
     817            <div class="comments"> 
     818 Used to pass your keywords 
     819</div> 
    801820             
    802821           
    803822 
    804            
    805            
    806            
    807            
    808            
     823          <h3>Examples</h3><div class="preformat"> 
     824 
     825</div> 
     826          <h3>Version history</h3> 
     827           
     828          <h4>Version</h4><div class="preformat"> 
     829 $Id$ 
     830</div> 
     831          <h4>History</h4><div class="preformat"> 
     832 
     833</div> 
    809834           
    810835           
    … …  
    815840 seb 
    816841</div> 
    817            
    818          
    819            
    820            
    821            
    822            
    823            
    824            
    825            
    826          
     842          <h4>Restrictions</h4><div class="preformat"> 
     843 
     844</div> 
     845         
     846          <h3>Other attributes</h3> 
     847           
     848           
     849          <h4>Uses routines</h4><div class="preformat"> 
     850 
     851</div> 
     852           
     853           
     854           
     855         
     856          <h3>Statistics</h3> 
     857          <table class="statistics"> 
     858            <tr><td>McCabe cyclic</td><td>          10</td></tr> 
     859            <tr><td>McCabe essential</td><td>           1</td></tr> 
     860            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     861          </table> 
    827862           
    828863         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/triangule_c.html

    r157 r163  
    709709 rectangular matrix). A easy way to do triangles between all points is then:  
    710710 
    711      for each point (i,j) of the matrix -exept those of the last line and of 
     711     for each point (i,j) of the matrix -except those of the last line and of 
    712712     the last column- we call rectangle (i,j) the rectangle made of the four 
    713713     points (i,j), (i+1,j), (i,j+1), (i+1,j+1). To trace all triangle, we just 
    … …  
    742742         
    743743          <p class="header"> 
    744             <span class="result">result = </span>triangule_c(<span class="result">[<a href="#_triangule_c_param_maskentree">maskentree</a>]</span>, <a href="#_triangule_c_keyword_COINMONTE">COINMONTE</a>=<span class="result">COINMONTE</span>, <a href="#_triangule_c_keyword_COINDESCEND">COINDESCEND</a>=<span class="result">COINDESCEND</span>, <a href="#_triangule_c_keyword_BASIC">BASIC</a>=<span class="result">BASIC</span>, <a href="#_triangule_c_keyword_KEEP_CONT">KEEP_CONT</a>=<span class="result">KEEP_CONT</span>)</p> 
     744            <span class="result">result = </span>triangule_c(<span class="result">[<a href="#_triangule_c_param_maskentree">maskentree</a>]</span>, <a href="#_triangule_c_keyword_COINMONTE">COINMONTE</a>=<span class="result">array</span>, <a href="#_triangule_c_keyword_COINDESCEND">COINDESCEND</a>=<span class="result">array</span>, <a href="#_triangule_c_keyword_BASIC">BASIC</a>=<span class="result">BASIC</span>, <a href="#_triangule_c_keyword_KEEP_CONT">KEEP_CONT</a>=<span class="result">KEEP_CONT</span>)</p> 
    745745         
    746746          <div class="comments"> 
    … …  
    749749          <h3>Return value</h3><div class="preformat"> 
    750750 res: tableau 2d (3,nbre de triangles). 
    751  Each line of res represent indexes of points constituing summits of a triangle.  
     751 Each line of res represent indexes of points constituting summits of a triangle.  
    752752 See how we trace triangles in definetri.pro 
    753753</div> 
    … …  
    763763               
    764764               
    765                
     765              <span class="attr">type:</span> <span class="value">2d array</span> 
    766766               
    767767               
    … …  
    787787               
    788788               
    789                
     789              <span class="attr">type:</span> <span class="value">array</span> 
    790790               
    791791               
    … …  
    793793         
    794794            <div class="comments"> 
    795  It is an array. To obtain the array of "ascending land corner" to be treated with  
     795 To obtain the array of "ascending land corner" to be treated with  
    796796 completecointerre.pro in the variable array instead of make it pass by the global  
    797797 variable twin_corners_up. 
    … …  
    804804               
    805805               
    806                
     806              <span class="attr">type:</span> <span class="value">array</span> 
    807807               
    808808               
    … …  
    810810         
    811811            <div class="comments"> 
    812  It is an array. See COINMONTE 
     812 See COINMONTE 
    813813</div> 
    814814             
    … …  
    849849           
    850850          <h4>Version</h4><div class="preformat"> 
    851  $Id: triangule_c.pro 150 2006-08-09 10:12:54Z navarro $ 
     851 $Id: triangule_c.pro 157 2006-08-21 09:01:50Z navarro $ 
    852852</div> 
    853853          <h4>History</h4><div class="preformat"> 
    … …  
    881881           
    882882         
     883          <h3>Statistics</h3> 
     884          <table class="statistics"> 
     885            <tr><td>McCabe cyclic</td><td>          41</td></tr> 
     886            <tr><td>McCabe essential</td><td>           1</td></tr> 
     887            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     888          </table> 
    883889           
    884890         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/triangule_e.html

    r157 r163  
    700700 
    701701      <div id="file_comments"> 
    702  Buid the triangulation for a E-grid type 
     702 Build the triangulation for a E-grid type 
    703703</div> 
    704704 
    … …  
    721721         
    722722          <p class="header"> 
    723             <span class="result">result = </span>triangule_e(<span class="result">[<a href="#_triangule_e_param_maskentree">maskentree</a>]</span>, <a href="#_triangule_e_keyword_COINMONTE">COINMONTE</a>=<span class="result">COINMONTE</span>, <a href="#_triangule_e_keyword_COINDESCEND">COINDESCEND</a>=<span class="result">COINDESCEND</span>, <a href="#_triangule_e_keyword_SHIFTED">SHIFTED</a>=<span class="result">SHIFTED</span>, <a href="#_triangule_e_keyword_BASIC">BASIC</a>=<span class="result">BASIC</span>)</p> 
     723            <span class="result">result = </span>triangule_e(<span class="result">[<a href="#_triangule_e_param_maskentree">maskentree</a>]</span>, <a href="#_triangule_e_keyword_COINMONTE">COINMONTE</a>=<span class="result">array</span>, <a href="#_triangule_e_keyword_COINDESCEND">COINDESCEND</a>=<span class="result">array</span>, <a href="#_triangule_e_keyword_SHIFTED">SHIFTED</a>=<span class="result">SHIFTED</span>, <a href="#_triangule_e_keyword_BASIC">BASIC</a>=<span class="result">BASIC</span>)</p> 
    724724         
    725725          <div class="comments"></div> 
    … …  
    737737               
    738738               
    739                
     739              <span class="attr">type:</span> <span class="value">2d array</span> 
    740740               
    741741               
    … …  
    761761               
    762762               
    763                
     763              <span class="attr">type:</span> <span class="value">array</span> 
    764764               
    765765               
    766766            </h4> 
    767767         
    768             <div class="comments"> 
    769  It is an array. To obtain the array of "ascending land corner" to be treated with  
     768            <div class="comments">  
     769 To obtain the array of "ascending land corner" to be treated with  
    770770 completecointerre.pro in the variable array instead of make it pass by the global  
    771771 variable twin_corners_up. 
    … …  
    778778               
    779779               
    780                
     780              <span class="attr">type:</span> <span class="value">array</span> 
    781781               
    782782               
    … …  
    784784         
    785785            <div class="comments"> 
    786  It is an array. See COINMONTE 
     786 See COINMONTE 
    787787</div> 
    788788             
    … …  
    822822           
    823823          <h4>Version</h4><div class="preformat">  
    824  $Id: triangule_e.pro 150 2006-08-09 10:12:54Z navarro $ 
     824 $Id: triangule_e.pro 157 2006-08-21 09:01:50Z navarro $ 
    825825 </div> 
    826826          <h4>History</h4><div class="preformat"> 
    … …  
    848848           
    849849         
     850          <h3>Statistics</h3> 
     851          <table class="statistics"> 
     852            <tr><td>McCabe cyclic</td><td>          12</td></tr> 
     853            <tr><td>McCabe essential</td><td>           1</td></tr> 
     854            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     855          </table> 
    850856           
    851857         
Note: See TracChangeset for help on using the changeset viewer.