Changeset 402 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/xncdf_lec.html

Timestamp:

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

Author:

smasson

Message:

update documentation

File:

• trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/xncdf_lec.html (modified) (14 diffs)

trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/xncdf_lec.html

@@ -99 +99 @@
 
  Procedure called by xmanager when we press a button of the first widget
- created by par xncdf_lec
+ created by xncdf_lec
 </div>
 
@@ -147 +147 @@
           <h3>Return value</h3><div class="preformat">
   2 different cases:
-       1) None attribute has been selected. In this case, res is the array we
-       wanted to read.
-       2) Some attributes has been selected. In this case, res is a structure
-       whose the first element having the name of the variable is the values
-       array and the other arguments are the select arguments.
+  1) None attribute has been selected. In this case, res is the array we
+     wanted to read.
+  2) Some attributes has been selected. In this case, res is a structure
+     whose the first element having the name of the variable is the values
+     array and the other arguments are the select arguments.
 </div>
 
@@ -170 +170 @@
         
           <div class="comments">
- It give the name of the file to be opened. If NAME
+ It give the name of the file to be opened. 
+
+ If NAME
  does not contain the separating character of directories ('/' under
  unix for example), the file will be looked for in the current directory.
@@ -207 +209 @@
         
             <div class="comments">
- An optional vector containing the counts to be used in
- reading Value. COUNT is a 1-based vector with an element for
- each dimension of the data to be written.The default matches
+ An optional vector containing the counts to be used in reading Value. 
+
+ COUNT is a 1-based vector with an element for
+ each dimension of the data to be written.
+
+ The default matches
  the size of the variable so that all data is written out.
 </div>
@@ -225 +230 @@
         
             <div class="comments">
- The widget ID of the widget that calls XNCDF_LEC. When
- this ID is specified, a death of the caller results in a death
+ The widget ID of the widget that calls XNCDF_LEC. 
+
+ When this ID is specified, a death of the caller results in a death
  of XNCDF_LEC.
 </div>
@@ -243 +249 @@
             <div class="comments">
  An optional vector containing the starting position
- for the read. The default start position is [0, 0, ...].
+ for the read.
 </div>
             
@@ -259 +265 @@
             <div class="comments">
  It contains the directory where to go look for the file to be read.
+
  If NAME does not contain the separating character of directories ('/' under
  unix for example), the file will be called iodir+nom_fichier.
@@ -276 +283 @@
             <div class="comments">
  A vector of integers, specifying for each dimension how much we have to shift it.
- By default, it is [0,0,...]. See the function <proidl>shift</proidl> for more explanations. BEWARE,
+
+ See the function <a href="/Applications/itt/idl64/help/online_help/SHIFT.html">SHIFT</a> for more explanations. 
+
+ BEWARE,
  the shift is done on the biggest array before a possible reduction determined
- by OFFSET and COUNT. On the other hand, it is done after the possible extraction
+ by OFFSET and COUNT. 
+
+ On the other hand, it is done after the possible extraction
  created by the STRIDE.
 </div>
@@ -295 +307 @@
             <div class="comments">
  An optional vector containing the strides, or sampling
- intervals, between accessed values of the netCDF variable. The
- default stride vector is that for a contiguous read, [1, 1,...].
+ intervals, between accessed values of the netCDF variable.
 </div>
             
@@ -315 +326 @@
 
           <h3>Examples</h3><div class="preformat">
- IDL> help, xncdf_lec()
+
+   IDL> help, xncdf_lec()
 </div>
           <h3>Version history</h3>
           
           <h4>Version</h4><div class="preformat">
- $Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $
+ $Id: xncdf_lec.pro 378 2008-08-12 12:35:46Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">
@@ -398 +410 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $
+ $Id: xncdf_lec.pro 378 2008-08-12 12:35:46Z pinsard $
 </div>
           
@@ -444 +456 @@
 </div>
 
-          
+          <h3>Return value</h3><div class="preformat">
+ indirectement res (le tableau ou la structure resultat)
+</div>
 
           
@@ -475 +489 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $</div>
+ $Id: xncdf_lec.pro 378 2008-08-12 12:35:46Z pinsard $</div>
           
           
@@ -549 +563 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $
+ $Id: xncdf_lec.pro 378 2008-08-12 12:35:46Z pinsard $
 </div>