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

new idldoc html and assistant outputs

Location:
trunk/SRC/Documentation/idldoc_html_output/Colors
Files:
8 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/Colors/color24.html

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 The purpose of this function is to convert a RGB color triple 
    91  into the equivalent 24-big long integer.  
     91 into the equivalent 24-big long integer. 
     92 This routine was written to be used with routines like COLORS or 
     93 <a href=".//GETCOLOR.html">GETCOLOR</a>. 
    9294</div> 
    9395 
    … …  
    105107        <div class="routine_details" id="_color24"> 
    106108 
    107           <h2><a class="top" href="#container">top</a>color24 <span class="categories"> Graphics, Color 
     109          <h2><a class="top" href="#container">top</a>color24 <span class="categories"> 
     110 Graphics, Color 
    108111</span></h2> 
    109112         
    … …  
    114117</div> 
    115118 
    116           <h3>Return value</h3><div class="preformat">  
    117  a 24-bit long integer that is equivalent the input color.  
     119          <h3>Return value</h3><div class="preformat"> 
     120 a 24-bit long integer that is equivalent the input color. 
    118121 The color is described in terms of a hexadecimal number (e.g., FF206A) 
    119  where the left two digits represent the blue color, the  
    120  middle two digits represent the green color, and the right  
     122 where the left two digits represent the blue color, the 
     123 middle two digits represent the green color, and the right 
    121124 two digits represent the red color. 
    122125</div> 
    … …  
    137140            </h4> 
    138141         
    139           <div class="comments">  
    140  A three-element column or row array representing  
     142          <div class="comments"> 
     143 A three-element column or row array representing 
    141144 a color triple. The values of the elements must be between 0 and 255. 
    142145</div> 
    … …  
    147150           
    148151 
    149           <h3>Examples</h3><div class="preformat">  
    150  To convert the color triple for the color YELLOW,  
    151  (255, 255, 0), to the hexadecimal value '00FFFF'x  
     152          <h3>Examples</h3><div class="preformat"> 
     153 To convert the color triple for the color YELLOW, 
     154 (255, 255, 0), to the hexadecimal value '00FFFF'x 
    152155 or the decimal number 65535, type: 
    153156 
    154157 IDL> color = COLOR24([255, 255, 0]) 
    155         
    156  This routine was written to be used with routines like COLORS or GETCOLOR 
     158 
    157159</div> 
    158160          <h3>Version history</h3> 
    159161           
    160           <h4>Version</h4><div class="preformat"> $Id: color24.pro 163 2006-08-29 12:59:46Z navarro $ 
     162          <h4>Version</h4><div class="preformat"> 
     163 $Id: color24.pro 231 2007-03-19 17:15:51Z pinsard $ 
    161164</div> 
    162165          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/Colors/colorbar.html

    r200 r234  
    105105        <div class="routine_details" id="_colorbar"> 
    106106 
    107           <h2><a class="top" href="#container">top</a>colorbar <span class="categories"> Graphics, Widget 
     107          <h2><a class="top" href="#container">top</a>colorbar <span class="categories"> 
     108 Graphics, Widget 
    108109</span></h2> 
    109110         
    … …  
    209210            </h4> 
    210211         
    211             <div class="comments">  
     212            <div class="comments"> 
    212213 Vector which contain color's indexes to trace in a color bar. Therefore 
    213  we obtain a discrete colorbar which contains only the specified colors  
     214 we obtain a discrete colorbar which contains only the specified colors 
    214215 in the order they appear in the vector 
    215216</div> 
    … …  
    455456          <h3>Version history</h3> 
    456457           
    457           <h4>Version</h4><div class="preformat"> $Id: colorbar.pro 163 2006-08-29 12:59:46Z navarro $ 
    458 </div> 
    459           <h4>History</h4><div class="preformat">  
     458          <h4>Version</h4><div class="preformat"> 
     459 $Id: colorbar.pro 231 2007-03-19 17:15:51Z pinsard $ 
     460</div> 
     461          <h4>History</h4><div class="preformat"> 
    460462 Written by: David Fanning, 10 JUNE 96. 
    461463 10/27/96: Added the ability to send output to PostScript. DWF 

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

    r200 r234  
    9090       
    9191        <dt><a href="color24.html">color24.pro</a></dt> 
    92         <dd>   The purpose of this function is to convert a RGB color triple  into the equivalent 24-big long integer.</dd> 
     92        <dd>  The purpose of this function is to convert a RGB color triple  into the equivalent 24-big long integer.</dd> 
    9393       
    9494        <dt><a href="colorbar.html">colorbar.pro</a></dt> 
    … …  
    9696       
    9797        <dt><a href="getcolor.html">getcolor.pro</a></dt> 
    98         <dd>   The original purpose of this function was to enable the  user to specify one of the 16 colors supported by the  McIDAS color map by name.</dd> 
     98        <dd>  The original purpose of this function was to enable the  user to specify one of the 16 colors supported by the  McIDAS color map by name.</dd> 
    9999       
    100100        <dt><a href="lct.html">lct.pro</a></dt> 
    101         <dd>   Fastest than type loadct, file = 'palette.</dd> 
     101        <dd>  Fastest than type loadct, file = 'palette.</dd> 
    102102       
    103103        <dt><a href="newpalette.html">newpalette.pro</a></dt> 
    104         <dd>   Allows to save the palette which is on the screen  in a same type file than the one given by default in IDL  'colors1.</dd> 
     104        <dd>  Allows to save the palette which is on the screen  in a same type file than the one given by default in IDL  'colors1.</dd> 
    105105       
    106106        <dt><a href="xlct.html">xlct.pro</a></dt> 
    107         <dd>   Like xloadct but fastest to write and call by default the palette   palette.</dd> 
     107        <dd>  Like xloadct but fastest to write and call by default the palette  palette.</dd> 
    108108       
    109109        <dt><a href="xpal.html">xpal.pro</a></dt> 
    110         <dd>  like xpalette but shorter to write and, moreover,  possess a hotkey save which (thanks to the newpalette routine)  allows to save the routine that we have just done.</dd> 
     110        <dd>  Choose the best foreground and background colors for  the current color maps and set !P appropriately.</dd> 
    111111       
    112112      </dl> 

  • trunk/SRC/Documentation/idldoc_html_output/Colors/getcolor.html

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 The original purpose of this function was to enable the 
    9191 user to specify one of the 16 colors supported by the 
    … …  
    115115        <div class="routine_details" id="_getcolor"> 
    116116 
    117           <h2><a class="top" href="#container">top</a>getcolor <span class="categories"> Graphics, Color 
     117          <h2><a class="top" href="#container">top</a>getcolor <span class="categories"> 
     118 Graphics, Color 
    118119</span></h2> 
    119120         
    … …  
    165166            </h4> 
    166167         
    167           <div class="comments">  
     168          <div class="comments"> 
    168169 A string with the "name" of the color. Valid names are: 
    169170           black 
    … …  
    186187 The color YELLOW is returned if the color name can't be resolved. 
    187188 Case is unimportant. 
    188  
    189189</div> 
    190190             
    … …  
    200200            </h4> 
    201201         
    202           <div class="comments">  
     202          <div class="comments"> 
    203203 The color table index where the specified color should be loaded. 
    204204</div> 
    … …  
    222222            </h4> 
    223223         
    224             <div class="comments">   
     224            <div class="comments"> 
    225225 If this keyword is set, the specified color triple is returned 
    226226 as a 24-bit integer equivalent. The lowest 8 bits correspond to 
    … …  
    242242            </h4> 
    243243         
    244             <div class="comments">  
     244            <div class="comments"> 
    245245 If this keyword is set, the return value of the function is 
    246246 a 16-element string array containing the names of the colors. 
    … …  
    263263            </h4> 
    264264         
    265             <div class="comments">   
     265            <div class="comments"> 
    266266 If this keyword is set, all 16 colors are automatically loaded 
    267267 starting at the color index specified by the START keyword. 
    … …  
    297297           
    298298 
    299           <h3>Examples</h3><div class="preformat">  
     299          <h3>Examples</h3><div class="preformat"> 
    300300 To load a yellow color in color index 100 and plot in yellow, type: 
    301301 
    … …  
    363363          <h3>Version history</h3> 
    364364           
    365           <h4>Version</h4><div class="preformat"> $Id: getcolor.pro 163 2006-08-29 12:59:46Z navarro $</div> 
    366           <h4>History</h4><div class="preformat">  
     365          <h4>Version</h4><div class="preformat"> 
     366 $Id: getcolor.pro 231 2007-03-19 17:15:51Z pinsard $</div> 
     367          <h4>History</h4><div class="preformat"> 
    367368 Written by: David Fanning, 10 February 96. 
    368369 Fixed a bug in which N_ELEMENTS was spelled wrong. 7 Dec 96. DWF 
    … …  
    380381           
    381382           
    382           <h4>Restrictions</h4><div class="preformat">  
     383          <h4>Restrictions</h4><div class="preformat"> 
    383384 The TRUE keyword causes the START keyword to be ignored. 
    384  The NAMES keyword causes the COLOR, INDEX, START, and TRUE parameters to be  
     385 The NAMES keyword causes the COLOR, INDEX, START, and TRUE parameters to be 
    385386 ignored. 
    386387 The COLOR parameter is ignored if the LOAD keyword is used. 

  • trunk/SRC/Documentation/idldoc_html_output/Colors/lct.html

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 Fastest than type loadct, file = 'palette.tbl' 
    9191</div> 
    … …  
    104104        <div class="routine_details" id="_lct"> 
    105105 
    106           <h2><a class="top" href="#container">top</a>lct <span class="categories">  
     106          <h2><a class="top" href="#container">top</a>lct <span class="categories"> 
    107107 Graphics, Color 
    108108</span></h2> 
    … …  
    184184            </h4> 
    185185         
    186             <div class="comments">  
     186            <div class="comments"> 
    187187 a scalar used to change the Lightness of the color 
    188188 palette to be able to adjust according to the printer we use, 
    189  the media (paper or slide)...  
     189 the media (paper or slide)... 
    190190               lightness < 1 to get lighter colors 
    191191                         > 1 to get darker colors 
    … …  
    204204         
    205205            <div class="comments"> 
    206  Used to pass loadct keywords 
     206 Used to pass keywords to <proidl>loadct</proidl> 
    207207</div> 
    208208             
    … …  
    212212          <h3>Version history</h3> 
    213213           
    214           <h4>Version</h4><div class="preformat"> $Id: lct.pro 163 2006-08-29 12:59:46Z navarro $ 
     214          <h4>Version</h4><div class="preformat"> 
     215 $Id: lct.pro 232 2007-03-20 16:59:36Z pinsard $ 
    215216</div> 
    216217          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/Colors/newpalette.html

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 Allows to save the palette which is on the screen 
    9191 in a same type file than the one given by default in IDL 
    … …  
    106106        <div class="routine_details" id="_newpalette"> 
    107107 
    108           <h2><a class="top" href="#container">top</a>newpalette <span class="categories">  
     108          <h2><a class="top" href="#container">top</a>newpalette <span class="categories"> 
    109109 Color 
    110110</span></h2> 
    … …  
    134134         
    135135          <div class="comments"> 
    136  a string containing the name of the new palette we want to write. 
     136 the name of the new palette we want to write. 
    137137</div> 
    138138             
    … …  
    170170            </h4> 
    171171         
    172             <div class="comments">  
    173  the number of the palette we want to replace 
     172            <div class="comments"> 
     173 the number of the palette we want to replace. 
    174174</div> 
    175175             
    … …  
    185185            </h4> 
    186186         
    187             <div class="comments">  
    188  Used to pass modifyct keywords 
     187            <div class="comments"> 
     188 Used to pass keywords to <proidl>modifyct</proidl> 
    189189</div> 
    190190             
    … …  
    194194          <h3>Version history</h3> 
    195195           
    196           <h4>Version</h4><div class="preformat"> $Id: newpalette.pro 163 2006-08-29 12:59:46Z navarro $ 
    197 </div> 
    198           <h4>History</h4><div class="preformat"> Guillaume Roulet (gr@lodyc.jussieu.fr) 
     196          <h4>Version</h4><div class="preformat"> 
     197 $Id: newpalette.pro 232 2007-03-20 16:59:36Z pinsard $ 
     198</div> 
     199          <h4>History</h4><div class="preformat">  
     200 Guillaume Roulet (gr@lodyc.jussieu.fr) 
    199201 30/3/1999 s.masson, add _extra, research of the full name, OVER 
    200202                       5/5/1999 s.masson 

  • trunk/SRC/Documentation/idldoc_html_output/Colors/xlct.html

    r200 r234  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
    90  Like xloadct but fastest to write and call by default the palette  
     89      <div id="file_comments"> 
     90 Like xloadct but fastest to write and call by default the palette 
    9191 palette.tbl which can be in any directory 
    9292</div> 
    … …  
    105105        <div class="routine_details" id="_xlct"> 
    106106 
    107           <h2><a class="top" href="#container">top</a>xlct <span class="categories"> Widget, Color 
     107          <h2><a class="top" href="#container">top</a>xlct <span class="categories"> 
     108 Widget, Color 
    108109</span></h2> 
    109110         
    … …  
    132133            </h4> 
    133134         
    134             <div class="comments">  
     135            <div class="comments"> 
    135136 Normally, no informational message is printed when a color map 
    136137 is loaded. If this keyword is present and zero, this message is printed. 
    … …  
    148149            </h4> 
    149150         
    150             <div class="comments">  
     151            <div class="comments"> 
    151152 The widget ID of the widget that calls Xlct. When  this ID is 
    152153 specified, a death of the caller results in a death of Xlct 
    … …  
    302303          <h3>Version history</h3> 
    303304           
    304           <h4>Version</h4><div class="preformat"> $Id: xlct.pro 163 2006-08-29 12:59:46Z navarro $ 
    305 </div> 
    306           <h4>History</h4><div class="preformat"> 5/5/1999 copy of xloadct par Sebastien Masson (smasson@lodyc.jussieu.fr) 
     305          <h4>Version</h4><div class="preformat"> 
     306 $Id: xlct.pro 231 2007-03-19 17:15:51Z pinsard $ 
     307</div> 
     308          <h4>History</h4><div class="preformat"> 
     309 5/5/1999 copy of xloadct par Sebastien Masson (smasson@lodyc.jussieu.fr) 
    307310</div> 
    308311           

  • trunk/SRC/Documentation/idldoc_html_output/Colors/xpal.html

    r200 r234  
    8888 
    8989      <div id="file_comments"> 
     90 Choose the best foreground and background colors for 
     91 the current color maps and set !P appropriately. 
     92 
     93 
    9094 like xpalette but shorter to write and, moreover, 
    9195 possess a hotkey save which (thanks to the newpalette routine) 
    … …  
    281285          <h3>Version history</h3> 
    282286           
    283            
    284           <h4>History</h4><div class="preformat">  
     287          <h4>Version</h4><div class="preformat"> 
     288 $Id: xpal.pro 233 2007-03-20 17:04:40Z pinsard $ 
     289</div> 
     290          <h4>History</h4><div class="preformat"> 
    285291 Adaptation of xpalette to add a save button by 
    286292          Grima Nicolas (nglod@ipsl.jussieu.fr) and by Masson 
    287293          Sebastien (smlod@ipsl.jussieu.fr) 
    288  
    289  $Id: xpal.pro 163 2006-08-29 12:59:46Z navarro $ 
    290294</div> 
    291295           
Note: See TracChangeset for help on using the changeset viewer.