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)

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/placedessin.html

    r157 r163  
    721721         
    722722          <p class="header"> 
    723             placedessin<span class="result">, <a href="#_placedessin_param_typedessin">typedessin</a>, <a href="#_placedessin_param_posfenetre">posfenetre</a>, <a href="#_placedessin_param_posbar">posbar</a></span>, <a href="#_placedessin_keyword_BARMARGES">BARMARGES</a>=<span class="result">BARMARGES</span>, <a href="#_placedessin_keyword_NOCOLORBAR">NOCOLORBAR</a>=<span class="result">NOCOLORBAR</span>, <a href="#_placedessin_keyword_NOFILL">NOFILL</a>=<span class="result">NOFILL</span>, <a href="#_placedessin_keyword_COLOR_c">COLOR_c</a>=<span class="result">COLOR_c</span>, <a href="#_placedessin_keyword_CONTOUR">CONTOUR</a>=<span class="result">CONTOUR</span>, <a href="#_placedessin_keyword_VECTEUR">VECTEUR</a>=<span class="result">VECTEUR</span>, <a href="#_placedessin_keyword_PORTRAIT">PORTRAIT</a>=<span class="result">PORTRAIT</span>, <a href="#_placedessin_keyword_LANDSCAPE">LANDSCAPE</a>=<span class="result">LANDSCAPE</span>, <a href="#_placedessin_keyword_SMALL">SMALL</a>=<span class="result">SMALL</span>, <a href="#_placedessin_keyword_MARGES">MARGES</a>=<span class="result">MARGES</span>, <a href="#_placedessin_keyword_MAP">MAP</a>=<span class="result">MAP</span>, <a href="#_placedessin_keyword_REMPLI">REMPLI</a>=<span class="result">REMPLI</span>, <a href="#_placedessin_keyword_POST">POST</a>=<span class="result">POST</span>, <a href="#_placedessin_keyword_WINDOW">WINDOW</a>=<span class="result">WINDOW</span>, <a href="#_placedessin_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_placedessin_keyword_TYPE">TYPE</a>=<span class="result">TYPE</span>, <a href="#_placedessin_keyword_BASICMARGES">BASICMARGES</a>=<span class="result">BASICMARGES</span>, <a href="#_placedessin_keyword_NOERASE">NOERASE</a>=<span class="result">NOERASE</span>, <a href="#_placedessin_keyword_LCT">LCT</a>=<span class="result">LCT</span>, <a href="#_placedessin_keyword_DIREC">DIREC</a>=<span class="result">DIREC</span>, <a href="#_placedessin_keyword_CB_TITLE">CB_TITLE</a>=<span class="result">CB_TITLE</span>, <a href="#_placedessin_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
     723            placedessin<span class="result">, <a href="#_placedessin_param_typedessin">typedessin</a>, <a href="#_placedessin_param_posfenetre">posfenetre</a>, <a href="#_placedessin_param_posbar">posbar</a></span>, <a href="#_placedessin_keyword_BARMARGES">BARMARGES</a>=<span class="result">BARMARGES</span>, <a href="#_placedessin_keyword_NOCOLORBAR">NOCOLORBAR</a>=<span class="result">NOCOLORBAR</span>, <a href="#_placedessin_keyword_NOFILL">NOFILL</a>=<span class="result">NOFILL</span>, <a href="#_placedessin_keyword_COLOR_c">COLOR_c</a>=<span class="result">COLOR_c</span>, <a href="#_placedessin_keyword_CONTOUR">CONTOUR</a>=<span class="result">CONTOUR</span>, <a href="#_placedessin_keyword_VECTEUR">VECTEUR</a>=<span class="result">vector</span>, <a href="#_placedessin_keyword_PORTRAIT">PORTRAIT</a>=<span class="result">PORTRAIT</span>, <a href="#_placedessin_keyword_LANDSCAPE">LANDSCAPE</a>=<span class="result">LANDSCAPE</span>, <a href="#_placedessin_keyword_SMALL">SMALL</a>=<span class="result">SMALL</span>, <a href="#_placedessin_keyword_MARGES">MARGES</a>=<span class="result">MARGES</span>, <a href="#_placedessin_keyword_MAP">MAP</a>=<span class="result">MAP</span>, <a href="#_placedessin_keyword_REMPLI">REMPLI</a>=<span class="result">REMPLI</span>, <a href="#_placedessin_keyword_POST">POST</a>=<span class="result">POST</span>, <a href="#_placedessin_keyword_WINDOW">WINDOW</a>=<span class="result">WINDOW</span>, <a href="#_placedessin_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_placedessin_keyword_TYPE">TYPE</a>=<span class="result">TYPE</span>, <a href="#_placedessin_keyword_BASICMARGES">BASICMARGES</a>=<span class="result">BASICMARGES</span>, <a href="#_placedessin_keyword_NOERASE">NOERASE</a>=<span class="result">NOERASE</span>, <a href="#_placedessin_keyword_LCT">LCT</a>=<span class="result">integer</span>, <a href="#_placedessin_keyword_DIREC">DIREC</a>=<span class="result">DIREC</span>, <a href="#_placedessin_keyword_CB_TITLE">CB_TITLE</a>=<span class="result">CB_TITLE</span>, <a href="#_placedessin_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
    724724         
    725725          <div class="comments"> 
    … …  
    738738               
    739739               
    740                
     740              <span class="attr">type:</span> <span class="value">string</span> 
    741741               
    742742               
    … …  
    744744         
    745745          <div class="comments"> 
    746  It is a chain or characteres specifying what procedure is called by PLACEDESSIN: 'plt', 'pltz' or 'pltt' 
     746 It specify what procedure is called by PLACEDESSIN: 'plt', 'pltz' or 'pltt' 
    747747</div> 
    748748             
    … …  
    753753               
    754754               
    755                
     755              <span class="attr">type:</span> <span class="value">vector</span> 
    756756               
    757757               
    … …  
    760760          <div class="comments"> 
    761761 It is a vector composed by 4 elements containing the position of the frame  
    762  containing captions and the graph in normalized coorinates.  
     762 containing captions and the graph in normalized coordinates.  
    763763 Comment: To position the drawing; we have to do !p.position=posfenetre  
    764764 after the call of the caliber 
    … …  
    771771               
    772772               
    773                
     773              <span class="attr">type:</span> <span class="value">vector</span> 
    774774               
    775775               
    … …  
    860860            <div class="comments">  
    861861 If we want to trace contours of a different field than the one  
    862  whose we have the colored drawing (by examlpe E-P in color and QSR in contours).  
    863  It must be a field respecting same caracteristics than the argument number one of plt. 
     862 whose we have the colored drawing (by example E-P in color and QSR in contours).  
     863 It must be a field respecting same characteristics than the argument number one of plt. 
    864864</div> 
    865865             
    … …  
    870870               
    871871               
    872                
     872              <span class="attr">type:</span> <span class="value">vector</span> 
    873873               
    874874               
    … …  
    905905         
    906906            <div class="comments">  
    907  Force the page or the window on the screen to be in lenthened position. 
     907 Force the page or the window on the screen to be in lengthened position. 
    908908</div> 
    909909             
    … …  
    920920         
    921921            <div class="comments">  
    922  Vector composed of 3 or 4 elements, applyed to make a drawing on a  
     922 Vector composed of 3 or 4 elements, applied to make a drawing on a  
    923923 small portion of a page or screen. It delimit the zone where the drawing will be done. 
    924924     If there is 4 elements: 
    925  then is constituated of coordinates (expressed in cm located from the up and  
    926  left corner of the page or the window (in portrait like in lanscape)) of the bottom  
     925 then is constituted of coordinates (expressed in cm located from the up and  
     926 left corner of the page or the window (in portrait like in landscape)) of the bottom  
    927927 and left corner and of the up and right corner of the drawing zone. 
    928928     If there is 3 elements: 
    … …  
    931931 the number 1 and then, following the writing direction. 
    932932 By default, we make the largest drawing we can do, conserving the aspect rapport  
    933  (exept when REMPLI is activated). 
     933 (except when REMPLI is activated). 
    934934 </div> 
    935935             
    … …  
    961961 We use it when we want to do a projection. 
    962962 This keyword can be of two types: 
    963      MAP=[P0lat,P0lon,Rot]. For the descrption of these 3 values (see the online help of MAP_SET). 
    964      /MAP: In this case, map is automatically caculated have the value:  
     963     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of MAP_SET). 
     964     /MAP: In this case, map is automatically calculated have the value:  
    965965          map = [0, (lon1+lon2)/2., 0] 
    966966 Comment: A good way to choose the type of the projection we want to do is to have a look at IDL demo: 
    967967 IDL> demo 
    968968 Then choose earth sciences and  mapping. 
    969  Comment2: By default it  is a cindrical projection which is effectuated (with or without the keyword map).  
     969 Comment2: By default it is a cylindrical projection which is effectuated (with or without the keyword map).  
    970970 If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection. 
    971971 For example, for a polar projection centered on the south pole: 
    … …  
    10161016            </h4> 
    10171017         
    1018             <div class="comments"> 
     1018            <div class="comments">  
    10191019 Number of the window on which we want to do the graph (Allow to open several windows).  
    10201020 By default, we open 'IDL0' 
    … …  
    10331033         
    10341034            <div class="comments">  
    1035  keyword specifing that we want to make a vertical cut in diagonal. Then coorinated of extremities  
    1036  of these one are difined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
     1035 keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities  
     1036 of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
    10371037 coordinates.  
    10381038</div> 
    … …  
    10851085               
    10861086               
    1087                
    1088                
    1089                
    1090             </h4> 
    1091          
    1092             <div class="comments">  
    1093  Is an integer designating the number of the palette of color we want to use for the plot.  
     1087              <span class="attr">type:</span> <span class="value">integer</span> 
     1088               
     1089               
     1090            </h4> 
     1091         
     1092            <div class="comments"> 
     1093 It designate the number of the palette of color we want to use for the plot.  
    10941094        </div> 
    10951095             
    … …  
    11461146           
    11471147          <h4>Version</h4><div class="preformat"> 
    1148  $Id: placedessin.pro 142 2006-07-21 12:47:49Z navarro $ 
     1148 $Id: placedessin.pro 157 2006-08-21 09:01:50Z navarro $ 
    11491149</div> 
    11501150          <h4>History</h4><div class="preformat"> 
    … …  
    11701170           
    11711171         
     1172          <h3>Statistics</h3> 
     1173          <table class="statistics"> 
     1174            <tr><td>McCabe cyclic</td><td>          32</td></tr> 
     1175            <tr><td>McCabe essential</td><td>           1</td></tr> 
     1176            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1177          </table> 
    11721178           
    11731179         
Note: See TracChangeset for help on using the changeset viewer.