Changeset 402 for trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/LABEL/label_date.html

Timestamp:

07/23/09 11:18:49 (15 years ago)

Author:

smasson

Message:

update documentation

File:

• trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/LABEL/label_date.html (modified) (6 diffs)

trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/LABEL/label_date.html

@@ -90 +90 @@
       
       
-      <font size="-1" color="#006633">required</font>
+      
       
       
@@ -106 +106 @@
       
       
-      <font size="-1" color="#006633">required</font>
+      
       
       
@@ -122 +122 @@
       
       
-      <font size="-1" color="#006633">required</font>
+      
       
       
@@ -152 +152 @@
     
  a format string which may contain the following:
- %M for month (3 character abbr)
- %N for month (2 digit abbr)
+ %M for month (3 characters abbr)
+ %N for month (2 digits abbr)
  %D for day of month,
- %Y for 4 digit year.
+ %Y for 4 digits year.
  %Z for last two digits of year.
   For time:
@@ -225 +225 @@
 
     <h3>Examples</h3><pre>
+
  For example, to plot from Jan 1, 1993, to July 12, 1994:
- Start_date = julday(1, 1, 1993)
- End_date = julday(7, 12, 1994)
- Dummy = LABEL_DATE(DATE_FORMAT='%N/%D')  ;Simple mm/dd
- x = findgen(end_date+1 - start_date) + start_date ;Time axis
- PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1
- (Plot with X axis style set to exact.)
-        
+
+   IDL> Start_date = julday(1, 1, 1993)
+   IDL> End_date = julday(7, 12, 1994)
+   IDL> ; Simple mm/dd
+   IDL> Dummy = LABEL_DATE(DATE_FORMAT='%N/%D')
+   IDL> ;Time axis
+   IDL> x = findgen(end_date+1 - start_date) + start_date
+   IDL> ; Plot with X axis style set to exact
+   IDL> PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1
+
  Example with times:
-        For example, to plot from 3PM, Jan 1, 1993, to 5AM, Jan 3,
-        1993:
-        Start_date = Julday(1,1,1993)   ;Also starting offset
-        Start_time = (3+12)/24.         ;Starting_time less offset
-        End_time = (Julday(1,3,1993) - Start_date) + 5./24. ;Ending
-        ;date/time - offset, note that the order of operations is
-               ; important to avoid loss of precision.
-        Dummy = LABEL_DATE(DATE_FORMAT='%D %M!C%H:%I', $
-                offset=Start_date)       ;MMM NN <new line> HH:MM format
-        x = findgen(20) * (End_time - Start_time) / 19 + start_time ;Time axis
-        PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1
+
+ For example, to plot from 3PM, Jan 1, 1993, to 5AM, Jan 3, 1993:
+
+   IDL> ; Also starting offset
+   IDL> Start_date = Julday(1,1,1993)
+   IDL> ; Starting_time less offset
+   IDL> Start_time = (3+12)/24.
+   IDL> End_time = (Julday(1,3,1993) - Start_date) + 5./24.
+   IDL> ; Ending date/time - offset, note that the order of operations is
+   IDL> ; important to avoid loss of precision
+   IDL> ; MMM NN <new line> HH:MM format
+   IDL> Dummy = LABEL_DATE(DATE_FORMAT='%D %M!C%H:%I', offset=Start_date)
+   IDL> ;Time axis
+   IDL> x = findgen(20) * (End_time - Start_time) / 19 + start_time
+   IDL> PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1
 
     </pre><h3>Version history</h3>
     
     <h4>Version</h4>
- $Id: label_date.pro 327 2007-12-13 16:22:35Z pinsard $
+ $Id: label_date.pro 371 2008-08-07 09:32:02Z pinsard $
 
     <h4>History</h4>
-        DMS, RSI.       April, 1993.    Written.
-        DMS, RSI.       March, 1997.    Added Time format.
+     DMS, RSI.     April, 1993.     Written.
+     DMS, RSI.     March, 1997.     Added Time format.
 
  Copyright (c) 1993-1998, Research Systems, Inc.  All rights reserved.
-        Unauthorized reproduction prohibited.
+     Unauthorized reproduction prohibited.
 
     
@@ -272 +280 @@
     
     <h4>Uses routines</h4>
- LABEL_DATE_COM.