Changeset 234 for trunk/SRC/Documentation/idldoc_html_output/Calendar/julday.html

Timestamp:

03/21/07 10:14:37 (17 years ago)

Author:

pinsard

Message:

new idldoc html and assistant outputs

File:

• trunk/SRC/Documentation/idldoc_html_output/Calendar/julday.html (modified) (16 diffs)

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

@@ -89 +89 @@
       <div id="file_comments">
  Calculate the Julian Day Number for a given month, day, and year.
- This is the inverse of the library function CALDAT.
- 3 calendars are available according to the value of key_caltype 
+ This is the inverse of the library function
+ <a href=".//CALDAT.html">CALDAT</a>.
+ 3 calendars are available according to the value of key_caltype
  (variable of the common file cm_4cal): 'greg', '360d', 'noleap'
 </div>
@@ -107 +108 @@
         <div class="routine_details" id="_julday">
 
-          <h2><a class="top" href="#container">top</a>julday <span class="categories"> Calendar
+          <h2><a class="top" href="#container">top</a>julday <span class="categories">
+ Calendar
 </span></h2>
         
           <p class="header">
-            <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>
-        
-          <div class="comments">
-</div>
-
-          <h3>Return value</h3><div class="preformat"> 
+            <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>
+        
+          <div class="comments">
+</div>
+
+          <h3>Return value</h3><div class="preformat">
  the Julian Day Number (which begins at noon) of the specified calendar date.
- If Hour, Minute, and Second are not specified, then the result will be a 
- long integer, otherwise the result is a double precision floating point 
+ If Hour, Minute, and Second are not specified, then the result will be a
+ long integer, otherwise the result is a double precision floating point
  number.
 </div>
@@ -133 +135 @@
               <span class="attr">required</span>
               
-              
-              
-              
-            </h4>
-        
-          <div class="comments"> 
- Number of the desired month (1 = January, ..., 12 = December). 
- Can be scalar or array
+              <span class="attr">type:</span> <span class="value">scalar (integer or double) or array of scalars</span>
+              
+              
+            </h4>
+        
+          <div class="comments">
+ Number of the desired month (1 = January, ..., 12 = December).
 </div>
             
@@ -149 +150 @@
               <span class="attr">required</span>
               
-              
-              
-              
-            </h4>
-        
-          <div class="comments"> 
- Number of day of the month.Can be scalar or array
+              <span class="attr">type:</span> <span class="value">scalar (integer or double) or array of scalars</span>
+              
+              
+            </h4>
+        
+          <div class="comments">
+ Number of day of the month.
 </div>
             
@@ -164 +165 @@
               <span class="attr">required</span>
               
-              
-              
-              
-            </h4>
-        
-          <div class="comments">  
+              <span class="attr">type:</span> <span class="value">scalar (integer or double) or array of scalars</span>
+              
+              
+            </h4>
+        
+          <div class="comments">
  Number of the desired year.Year parameters must be valid
  values from the civil calendar.  Years B.C.E. are represented
@@ -175 +176 @@
  as positive integers. In particular, note that there is no
  year 0 in the civil calendar.  1 B.C.E. (-1) is followed by
- 1 C.E. (1). 
- Change: However for climatological year, we do accept the year 
+ 1 C.E. (1).
+ Change: However for climatological year, we do accept the year
  O but we change it for year 654321L (the same trick is done in
  caldat so caldat, julday(1,1,0) gives you back Jan 1st of year 0)
- Can be scalar or array
 </div>
             
@@ -188 +188 @@
               
               
-              
+              <span class="attr">type:</span> <span class="value">scalar (integer or double) or array of scalars</span>
               <span class="attr">default:</span> <span class="value">12</span>
               
             </h4>
         
-          <div class="comments"> 
- Number of the hour of the day. Can be scalar or array
+          <div class="comments">
+ Number of the hour of the day.
 </div>
             
@@ -203 +203 @@
               
               
-              
+              <span class="attr">type:</span> <span class="value">scalar (integer or double) or array of scalars</span>
               <span class="attr">default:</span> <span class="value">0</span>
               
@@ -209 +209 @@
         
           <div class="comments">
- Number of the minute of the hour. Can be scalar or array
+ Number of the minute of the hour.
 </div>
             
@@ -218 +218 @@
               
               
-              
+              <span class="attr">type:</span> <span class="value">scalar (integer or double) or array of scalars</span>
               <span class="attr">default:</span> <span class="value">0</span>
               
@@ -224 +224 @@
         
           <div class="comments">
- Number of the second of the minute. Can be scalar or array
+ Number of the second of the minute.
 </div>
             
@@ -240 +240 @@
               
               
-              
+              <span class="attr">type:</span> <span class="value">integer</span>
               <span class="attr">default:</span> <span class="value">30</span>
               
             </h4>
         
-            <div class="comments"> 
- To use a calendar with fixed number of days per months.
+            <div class="comments">
+ To use a calendar with fixed number of days per month.
  see also the use of key_caltype (variable of the common file cm_4cal)
 </div>
@@ -255 +255 @@
           <h3>Version history</h3>
           
-          <h4>Version</h4><div class="preformat"> $Id: julday.pro 205 2007-01-22 07:55:49Z smasson $</div>
-          <h4>History</h4><div class="preformat"> 
+          <h4>Version</h4><div class="preformat">
+ $Id: julday.pro 231 2007-03-19 17:15:51Z pinsard $</div>
+          <h4>History</h4><div class="preformat">
  Translated from "Numerical Recipies in C", by William H. Press,
  Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling.
@@ -273 +274 @@
  eg. julday(349,1,1970)
 
- Sebastien Masson, May 2006, add diferent calendat with key_caltype 
+ Sebastien Masson, May 2006, add different calendat with key_caltype
  (variable of the common file cm_4cal)
 </div>
@@ -282 +283 @@
           
           
-          <h4>Restrictions</h4><div class="preformat"> 
- The Result will have the same dimensions as the smallest array, or
+          <h4>Restrictions</h4><div class="preformat">
+ The result will have the same dimensions as the smallest array, or
  will be a scalar if all arguments are scalars.
- 
- 
+
+
  Accuracy using IEEE double precision numbers is approximately
  1/10000th of a second, with higher accuracy for smaller (earlier)
@@ -295 +296 @@
           
           
-          <h4>Uses routines</h4><div class="preformat"> cm_4cal
+          <h4>Uses routines</h4><div class="preformat">
+ cm_4cal
 </div>