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/Calendar
Files:
8 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/Calendar/caldat.html

    r210 r234  
    8989      <div id="file_comments"> 
    9090 Return the calendar date and time given julian date. 
    91  This is the inverse of the function JULDAY. 
    92  3 calendars are available according to the value of key_caltype  
     91 This is the inverse of the function 
     92 <a href=".//julday.html">julday</a>. 
     93 3 calendars are available according to the value of key_caltype 
    9394 (variable of the common file cm_4cal): 'greg', '360d', 'noleap' 
    9495</div> 
    … …  
    111112         
    112113          <p class="header"> 
    113             caldat<span class="result">, <a href="#_caldat_param_julian">julian</a>, <a href="#_caldat_param_month">month</a>, <a href="#_caldat_param_day">day</a>, <a href="#_caldat_param_year">year</a>, <a href="#_caldat_param_hour">hour</a>, <a href="#_caldat_param_minute">minute</a>, <a href="#_caldat_param_second">second</a></span>, <a href="#_caldat_keyword_NDAYSPM">NDAYSPM</a>=<span class="result">NDAYSPM</span></p> 
     114            caldat<span class="result">, <a href="#_caldat_param_julian">julian</a>, <a href="#_caldat_param_month">month</a>, <a href="#_caldat_param_day">day</a>, <a href="#_caldat_param_year">year</a>, <a href="#_caldat_param_hour">hour</a>, <a href="#_caldat_param_minute">minute</a>, <a href="#_caldat_param_second">second</a></span>, <a href="#_caldat_keyword_NDAYSPM">NDAYSPM</a>=<span class="result">integer</span></p> 
    114115         
    115116          <div class="comments"> 
    … …  
    128129              <span class="attr">required</span> 
    129130               
    130                
    131                
    132                
    133             </h4> 
    134          
    135           <div class="comments">  
     131              <span class="attr">type:</span> <span class="value">long integer</span> 
     132               
     133               
     134            </h4> 
     135         
     136          <div class="comments"> 
    136137 contains the Julian Day Number (which begins at noon) of the 
    137  specified calendar date.  It should be a long integer. 
     138 specified calendar date. 
    138139</div> 
    139140             
    … …  
    144145               
    145146               
    146                
    147                
    148                
    149             </h4> 
    150          
    151           <div class="comments">  
     147              <span class="attr">type:</span> <span class="value">integer</span> 
     148               
     149               
     150            </h4> 
     151         
     152          <div class="comments"> 
    152153 Number of the desired month (1 = January, ..., 12 = December). 
    153154</div> 
    … …  
    159160               
    160161               
    161                
    162                
    163                
    164             </h4> 
    165          
    166           <div class="comments">  
     162              <span class="attr">type:</span> <span class="value">integer</span> 
     163               
     164               
     165            </h4> 
     166         
     167          <div class="comments"> 
    167168 Number of day of the month. 
    168169</div> 
    … …  
    174175               
    175176               
    176                
    177                
    178                
    179             </h4> 
    180          
    181           <div class="comments">  
     177              <span class="attr">type:</span> <span class="value">integer</span> 
     178               
     179               
     180            </h4> 
     181         
     182          <div class="comments"> 
    182183 Number of the desired year. 
    183184</div> 
    … …  
    189190               
    190191               
    191                
    192                
    193                
    194             </h4> 
    195          
    196           <div class="comments">  
     192              <span class="attr">type:</span> <span class="value">integer</span> 
     193               
     194               
     195            </h4> 
     196         
     197          <div class="comments"> 
    197198 Hour of the day 
    198199</div> 
    … …  
    204205               
    205206               
    206                
    207                
    208                
    209             </h4> 
    210          
    211           <div class="comments">  
     207              <span class="attr">type:</span> <span class="value">integer</span> 
     208               
     209               
     210            </h4> 
     211         
     212          <div class="comments"> 
    212213 Minute of the day 
    213214</div> 
    … …  
    219220               
    220221               
    221                
    222                
    223                
    224             </h4> 
    225          
    226           <div class="comments">  
     222              <span class="attr">type:</span> <span class="value">float</span> 
     223               
     224               
     225            </h4> 
     226         
     227          <div class="comments"> 
    227228 Second (and fractions) of the day. 
    228229</div> 
    … …  
    241242               
    242243               
    243                
     244              <span class="attr">type:</span> <span class="value">integer</span> 
    244245              <span class="attr">default:</span> <span class="value">30</span> 
    245246               
    246247            </h4> 
    247248         
    248             <div class="comments">  
    249  To use a calendar with fixed number of days per months. 
     249            <div class="comments"> 
     250 To use a calendar with fixed number of days per month. 
    250251 see also the use of key_caltype (variable of the common file cm_4cal) 
    251252</div> 
    … …  
    256257          <h3>Version history</h3> 
    257258           
    258           <h4>Version</h4><div class="preformat"> $Id: caldat.pro 205 2007-01-22 07:55:49Z smasson $</div> 
    259           <h4>History</h4><div class="preformat">  
     259          <h4>Version</h4><div class="preformat"> 
     260 $Id: caldat.pro 231 2007-03-19 17:15:51Z pinsard $</div> 
     261          <h4>History</h4><div class="preformat"> 
    260262 Translated from "Numerical Recipies in C", by William H. Press, 
    261263 Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling. 
    … …  
    271273 AB, 3 January 2000, Make seconds output as DOUBLE in array output. 
    272274 
    273  Sebastien Masson, May 2006, add different calendat with key_caltype  
     275 Sebastien Masson, May 2006, add different calendar with key_caltype 
    274276 (variable of the common file cm_4cal) 
    275277</div> 
    … …  
    280282           
    281283           
    282           <h4>Restrictions</h4><div class="preformat">  
    283  Accuracy using IEEE double precision numbers is approximately 1/10000th of a  
     284          <h4>Restrictions</h4><div class="preformat"> 
     285 Accuracy using IEEE double precision numbers is approximately 1/10000th of a 
    284286 second. 
    285287</div> 

  • trunk/SRC/Documentation/idldoc_html_output/Calendar/date2jul.html

    r210 r234  
    128128              <span class="attr">required</span> 
    129129               
    130                
     130              <span class="attr">type:</span> <span class="value">string</span> 
    131131               
    132132               
    133133            </h4> 
    134134         
    135           <div class="comments">  
     135          <div class="comments"> 
    136136 date in yyyymmdd format 
    137137</div> 
    … …  
    172172          <h3>Version history</h3> 
    173173           
    174           <h4>Version</h4><div class="preformat"> $Id: date2jul.pro 205 2007-01-22 07:55:49Z smasson $ 
     174          <h4>Version</h4><div class="preformat"> 
     175 $Id: date2jul.pro 231 2007-03-19 17:15:51Z pinsard $ 
    175176</div> 
    176177          <h4>History</h4><div class="preformat">  

  • trunk/SRC/Documentation/idldoc_html_output/Calendar/date2string.html

    r200 r234  
    104104        <div class="routine_details" id="_date2string"> 
    105105 
    106           <h2><a class="top" href="#container">top</a>date2string <span class="categories">  
     106          <h2><a class="top" href="#container">top</a>date2string <span class="categories"> 
    107107 Calendar, String 
    108108</span></h2> 
    … …  
    129129              <span class="attr">required</span> 
    130130               
    131                
     131              <span class="attr">type:</span> <span class="value">scalor or array</span> 
    132132               
    133133               
    134134            </h4> 
    135135         
    136           <div class="comments">  
    137  the date in the format yyyymmdd. Can be scalar or array 
     136          <div class="comments"> 
     137 the date in the format yyyymmdd. 
    138138</div> 
    139139             
    … …  
    156156            </h4> 
    157157         
    158             <div class="comments">  
    159  used to pass your keywords to other procedures, for example 
    160  keyword FORMAT of string function (see example bellow)  
     158            <div class="comments"> 
     159 Used to pass keywords 
    161160</div> 
    162161             
    … …  
    172171          <h3>Version history</h3> 
    173172           
    174           <h4>Version</h4><div class="preformat"> $Id: date2string.pro 157 2006-08-21 09:01:50Z navarro $ 
     173          <h4>Version</h4><div class="preformat"> 
     174 $Id: date2string.pro 231 2007-03-19 17:15:51Z pinsard $ 
    175175</div> 
    176176          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 

  • trunk/SRC/Documentation/idldoc_html_output/Calendar/daysinmonth.html

    r200 r234  
    109109         
    110110          <p class="header"> 
    111             <span class="result">result = </span>daysinmonth(<span class="result"><a href="#_daysinmonth_param_month">month</a>[, <a href="#_daysinmonth_param_year">year</a>]</span>)</p> 
     111            <span class="result">result = </span>daysinmonth(<span class="result">[<a href="#_daysinmonth_param_month">month</a>][, <a href="#_daysinmonth_param_year">year</a>]</span>)</p> 
    112112         
    113113          <div class="comments"> 
    … …  
    123123             
    124124            <h4 id="_daysinmonth_param_month">month&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    125                
    126                
    127                
    128                
    129                
    130                
     125              <span class="attr">in</span> 
     126               
     127              <span class="attr">optional</span> 
     128               
     129               
     130              <span class="attr">type:</span> <span class="value">integer</span> 
    131131               
    132132               
    133133            </h4> 
    134134         
    135           <div class="comments">  
     135          <div class="comments"> 
     136 month number 
    136137</div> 
    137138             
    … …  
    164165           
    165166          <h4>Version</h4><div class="preformat">  
    166  $Id: daysinmonth.pro 163 2006-08-29 12:59:46Z navarro $ 
     167 $Id: daysinmonth.pro 231 2007-03-19 17:15:51Z pinsard $ 
    167168</div> 
    168169          <h4>History</h4><div class="preformat">  

  • trunk/SRC/Documentation/idldoc_html_output/Calendar/jul2date.html

    r210 r234  
    104104        <div class="routine_details" id="_jul2date"> 
    105105 
    106           <h2><a class="top" href="#container">top</a>jul2date <span class="categories">  
     106          <h2><a class="top" href="#container">top</a>jul2date <span class="categories"> 
    107107 Calendar 
    108108</span></h2> 
    … …  
    114114</div> 
    115115 
    116           <h3>Return value</h3><div class="preformat">  
     116          <h3>Return value</h3><div class="preformat"> 
    117117 date in yyyymmdd format 
    118118</div> 
    … …  
    128128              <span class="attr">required</span> 
    129129               
    130                
     130              <span class="attr">type:</span> <span class="value">double</span> 
    131131               
    132132               
    133133            </h4> 
    134134         
    135           <div class="comments">  
     135          <div class="comments"> 
    136136 Julian day 
    137137</div> 
    … …  
    149149          <h3>Version history</h3> 
    150150           
    151           <h4>Version</h4><div class="preformat"> $Id: jul2date.pro 205 2007-01-22 07:55:49Z smasson $ 
     151          <h4>Version</h4><div class="preformat"> 
     152 $Id: jul2date.pro 231 2007-03-19 17:15:51Z pinsard $ 
    152153</div> 
    153           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     154          <h4>History</h4><div class="preformat"> 
     155 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    154156                       June 2005 
    155157</div> 

  • trunk/SRC/Documentation/idldoc_html_output/Calendar/julday.html

    r210 r234  
    8989      <div id="file_comments"> 
    9090 Calculate the Julian Day Number for a given month, day, and year. 
    91  This is the inverse of the library function CALDAT. 
    92  3 calendars are available according to the value of key_caltype  
     91 This is the inverse of the library function 
     92 <a href=".//CALDAT.html">CALDAT</a>. 
     93 3 calendars are available according to the value of key_caltype 
    9394 (variable of the common file cm_4cal): 'greg', '360d', 'noleap' 
    9495</div> 
    … …  
    107108        <div class="routine_details" id="_julday"> 
    108109 
    109           <h2><a class="top" href="#container">top</a>julday <span class="categories"> Calendar 
     110          <h2><a class="top" href="#container">top</a>julday <span class="categories"> 
     111 Calendar 
    110112</span></h2> 
    111113         
    112114          <p class="header"> 
    113             <span class="result">result = </span>julday(<span class="result"><a href="#_julday_param_MONTH">MONTH</a>, <a href="#_julday_param_DAY">DAY</a>, <a href="#_julday_param_YEARin">YEARin</a>[, <a href="#_julday_param_Hour">Hour</a>][, <a href="#_julday_param_Minute">Minute</a>][, <a href="#_julday_param_Second">Second</a>]</span>, <a href="#_julday_keyword_NDAYSPM">NDAYSPM</a>=<span class="result">NDAYSPM</span>)</p> 
    114          
    115           <div class="comments"> 
    116 </div> 
    117  
    118           <h3>Return value</h3><div class="preformat">  
     115            <span class="result">result = </span>julday(<span class="result"><a href="#_julday_param_MONTH">MONTH</a>, <a href="#_julday_param_DAY">DAY</a>, <a href="#_julday_param_YEARin">YEARin</a>[, <a href="#_julday_param_Hour">Hour</a>][, <a href="#_julday_param_Minute">Minute</a>][, <a href="#_julday_param_Second">Second</a>]</span>, <a href="#_julday_keyword_NDAYSPM">NDAYSPM</a>=<span class="result">integer</span>)</p> 
     116         
     117          <div class="comments"> 
     118</div> 
     119 
     120          <h3>Return value</h3><div class="preformat"> 
    119121 the Julian Day Number (which begins at noon) of the specified calendar date. 
    120  If Hour, Minute, and Second are not specified, then the result will be a  
    121  long integer, otherwise the result is a double precision floating point  
     122 If Hour, Minute, and Second are not specified, then the result will be a 
     123 long integer, otherwise the result is a double precision floating point 
    122124 number. 
    123125</div> 
    … …  
    133135              <span class="attr">required</span> 
    134136               
    135                
    136                
    137                
    138             </h4> 
    139          
    140           <div class="comments">  
    141  Number of the desired month (1 = January, ..., 12 = December).  
    142  Can be scalar or array 
     137              <span class="attr">type:</span> <span class="value">scalar (integer or double) or array of scalars</span> 
     138               
     139               
     140            </h4> 
     141         
     142          <div class="comments"> 
     143 Number of the desired month (1 = January, ..., 12 = December). 
    143144</div> 
    144145             
    … …  
    149150              <span class="attr">required</span> 
    150151               
    151                
    152                
    153                
    154             </h4> 
    155          
    156           <div class="comments">  
    157  Number of day of the month.Can be scalar or array 
     152              <span class="attr">type:</span> <span class="value">scalar (integer or double) or array of scalars</span> 
     153               
     154               
     155            </h4> 
     156         
     157          <div class="comments"> 
     158 Number of day of the month. 
    158159</div> 
    159160             
    … …  
    164165              <span class="attr">required</span> 
    165166               
    166                
    167                
    168                
    169             </h4> 
    170          
    171           <div class="comments">   
     167              <span class="attr">type:</span> <span class="value">scalar (integer or double) or array of scalars</span> 
     168               
     169               
     170            </h4> 
     171         
     172          <div class="comments"> 
    172173 Number of the desired year.Year parameters must be valid 
    173174 values from the civil calendar.  Years B.C.E. are represented 
    … …  
    175176 as positive integers. In particular, note that there is no 
    176177 year 0 in the civil calendar.  1 B.C.E. (-1) is followed by 
    177  1 C.E. (1).  
    178  Change: However for climatological year, we do accept the year  
     178 1 C.E. (1). 
     179 Change: However for climatological year, we do accept the year 
    179180 O but we change it for year 654321L (the same trick is done in 
    180181 caldat so caldat, julday(1,1,0) gives you back Jan 1st of year 0) 
    181  Can be scalar or array 
    182182</div> 
    183183             
    … …  
    188188               
    189189               
    190                
     190              <span class="attr">type:</span> <span class="value">scalar (integer or double) or array of scalars</span> 
    191191              <span class="attr">default:</span> <span class="value">12</span> 
    192192               
    193193            </h4> 
    194194         
    195           <div class="comments">  
    196  Number of the hour of the day. Can be scalar or array 
     195          <div class="comments"> 
     196 Number of the hour of the day. 
    197197</div> 
    198198             
    … …  
    203203               
    204204               
    205                
     205              <span class="attr">type:</span> <span class="value">scalar (integer or double) or array of scalars</span> 
    206206              <span class="attr">default:</span> <span class="value">0</span> 
    207207               
    … …  
    209209         
    210210          <div class="comments"> 
    211  Number of the minute of the hour. Can be scalar or array 
     211 Number of the minute of the hour. 
    212212</div> 
    213213             
    … …  
    218218               
    219219               
    220                
     220              <span class="attr">type:</span> <span class="value">scalar (integer or double) or array of scalars</span> 
    221221              <span class="attr">default:</span> <span class="value">0</span> 
    222222               
    … …  
    224224         
    225225          <div class="comments"> 
    226  Number of the second of the minute. Can be scalar or array 
     226 Number of the second of the minute. 
    227227</div> 
    228228             
    … …  
    240240               
    241241               
    242                
     242              <span class="attr">type:</span> <span class="value">integer</span> 
    243243              <span class="attr">default:</span> <span class="value">30</span> 
    244244               
    245245            </h4> 
    246246         
    247             <div class="comments">  
    248  To use a calendar with fixed number of days per months. 
     247            <div class="comments"> 
     248 To use a calendar with fixed number of days per month. 
    249249 see also the use of key_caltype (variable of the common file cm_4cal) 
    250250</div> 
    … …  
    255255          <h3>Version history</h3> 
    256256           
    257           <h4>Version</h4><div class="preformat"> $Id: julday.pro 205 2007-01-22 07:55:49Z smasson $</div> 
    258           <h4>History</h4><div class="preformat">  
     257          <h4>Version</h4><div class="preformat"> 
     258 $Id: julday.pro 231 2007-03-19 17:15:51Z pinsard $</div> 
     259          <h4>History</h4><div class="preformat"> 
    259260 Translated from "Numerical Recipies in C", by William H. Press, 
    260261 Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling. 
    … …  
    273274 eg. julday(349,1,1970) 
    274275 
    275  Sebastien Masson, May 2006, add diferent calendat with key_caltype  
     276 Sebastien Masson, May 2006, add different calendat with key_caltype 
    276277 (variable of the common file cm_4cal) 
    277278</div> 
    … …  
    282283           
    283284           
    284           <h4>Restrictions</h4><div class="preformat">  
    285  The Result will have the same dimensions as the smallest array, or 
     285          <h4>Restrictions</h4><div class="preformat"> 
     286 The result will have the same dimensions as the smallest array, or 
    286287 will be a scalar if all arguments are scalars. 
    287   
    288   
     288 
     289 
    289290 Accuracy using IEEE double precision numbers is approximately 
    290291 1/10000th of a second, with higher accuracy for smaller (earlier) 
    … …  
    295296           
    296297           
    297           <h4>Uses routines</h4><div class="preformat"> cm_4cal 
     298          <h4>Uses routines</h4><div class="preformat"> 
     299 cm_4cal 
    298300</div> 
    299301           

  • trunk/SRC/Documentation/idldoc_html_output/Calendar/leapyr.html

    r200 r234  
    131131              <span class="attr">required</span> 
    132132               
    133                
     133              <span class="attr">type:</span> <span class="value"> scalar or array</span> 
    134134               
    135135               
    136136            </h4> 
    137137         
    138           <div class="comments">  
    139  year to be tested as a leap year. Can be scalar or array 
     138          <div class="comments"> 
     139 year to be tested as a leap year. 
    140140</div> 
    141141             
    … …  
    150150          <h3>Version history</h3> 
    151151           
    152           <h4>Version</h4><div class="preformat"> $Id: leapyr.pro 157 2006-08-21 09:01:50Z navarro $ 
     152          <h4>Version</h4><div class="preformat"> 
     153 $Id: leapyr.pro 231 2007-03-19 17:15:51Z pinsard $ 
    153154</div> 
    154155          <h4>History</h4><div class="preformat"> 
    … …  
    180181           
    181182           
    182           <h4>Uses routines</h4><div class="preformat"> cm_4cal 
     183          <h4>Uses routines</h4><div class="preformat"> 
     184 cm_4cal 
    183185</div> 
    184186           

  • trunk/SRC/Documentation/idldoc_html_output/Calendar/monthname.html

    r200 r234  
    104104        <div class="routine_details" id="_monthname"> 
    105105 
    106           <h2><a class="top" href="#container">top</a>monthname <span class="categories">  
     106          <h2><a class="top" href="#container">top</a>monthname <span class="categories"> 
    107107 Calendar,String 
    108108</span></h2> 
    … …  
    128128              <span class="attr">required</span> 
    129129               
    130                
     130              <span class="attr">type:</span> <span class="value">scalar or array</span> 
    131131               
    132132               
    133133            </h4> 
    134134         
    135           <div class="comments">  
    136  the month number (from 1 to 12). Can be scalar or array 
     135          <div class="comments"> 
     136 the month number (from 1 to 12). 
    137137</div> 
    138138             
    … …  
    156156         
    157157            <div class="comments"> 
    158  used to pass your keywords to other procedures, for example 
    159  keyword FORMAT of string function (see example bellow)  
     158 Used to pass keywords 
    160159</div> 
    161160             
    … …  
    167166          <h3>Version history</h3> 
    168167           
    169           <h4>Version</h4><div class="preformat"> $Id: monthname.pro 157 2006-08-21 09:01:50Z navarro $ 
    170 </div> 
    171           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     168          <h4>Version</h4><div class="preformat"> 
     169 $Id: monthname.pro 231 2007-03-19 17:15:51Z pinsard $ 
     170</div> 
     171          <h4>History</h4><div class="preformat"> 
     172 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    172173                      1 October 2001 
    173174</div> 
Note: See TracChangeset for help on using the changeset viewer.