Changeset 234 for trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/INIT/initncdf.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_assistant_output/ToBeReviewed/INIT/initncdf.html (modified) (10 diffs)

trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/INIT/initncdf.html

@@ -73 +73 @@
       <h2>initncdf  <font size="-1" color="#006633">
  Grid
- </font></h2>
-
-      <p><font face="Courier">initncdf<i>, <a href="#_initncdf_keyword_ncfilein">ncfilein</a></i>, <a href="#_initncdf_keyword_XAXISNAME">XAXISNAME</a>=<i>scalar string</i>, <a href="#_initncdf_keyword_YAXISNAME">YAXISNAME</a>=<i>scalar string</i>, <a href="#_initncdf_keyword_ZAXISNAME">ZAXISNAME</a>=<i>scalar string</i>, <a href="#_initncdf_keyword_MASKNAME">MASKNAME</a>=<i>string</i>, <a href="#_initncdf_keyword_INVMASK">INVMASK</a>=<i>scalar: 0 or 1</i>, <a href="#_initncdf_keyword_USEASMASK">USEASMASK</a>=<i>scalar string</i>, <a href="#_initncdf_keyword_MISSING_VALUE">MISSING_VALUE</a>=<i>scalar</i>, <a href="#_initncdf_keyword_START1">START1</a>=<i>scalar: 0 or 1</i>, <a href="#_initncdf_keyword_XYINDEX">XYINDEX</a>=<i>scalar: 0 or 1</i>, <a href="#_initncdf_keyword_ZINDEX">ZINDEX</a>=<i>scalar: 0 or 1</i>, <a href="#_initncdf_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
+</font></h2>
+
+      <p><font face="Courier">initncdf<i>, <a href="#_initncdf_keyword_ncfilein">ncfilein</a></i>, <a href="#_initncdf_keyword_ZAXISNAME">ZAXISNAME</a>=<i>scalar string</i>, <a href="#_initncdf_keyword_MASKNAME">MASKNAME</a>=<i>string</i>, <a href="#_initncdf_keyword_INVMASK">INVMASK</a>=<i>scalar: 0 or 1</i>, <a href="#_initncdf_keyword_USEASMASK">USEASMASK</a>=<i>scalar string</i>, <a href="#_initncdf_keyword_MISSING_VALUE">MISSING_VALUE</a>=<i>scalar</i>, <a href="#_initncdf_keyword_START1">START1</a>=<i>scalar: 0 or 1</i>, <a href="#_initncdf_keyword_XYINDEX">XYINDEX</a>=<i>scalar: 0 or 1</i>, <a href="#_initncdf_keyword_ZINDEX">ZINDEX</a>=<i>scalar: 0 or 1</i>, <a href="#_initncdf_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
 
     
@@ -108 +108 @@
 
     
-    <a name="#_initncdf_keyword_XAXISNAME"></a>
-    <h4>XAXISNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-      
-      
-      
-      
-      
-      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
-      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'x', 'longitude', 'nav_lon', 'lon', 'lon_rho' or 'NbLongitudes'</i></font>
-      
-    </h4>
-
-    
- A string giving the name of the variable in the file 
- that contains the [xyz]axis. 
-      
-    
-    <a name="#_initncdf_keyword_YAXISNAME"></a>
-    <h4>YAXISNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-      
-      
-      
-      
-      
-      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
-      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'y', 'latitude', 'nav_lat','lat', 'lat_rho' or 'NbLatitudes'</i></font>
-      
-    </h4>
-
-    
- A string giving the name of the variable in the file 
- that contains the [xyz]axis. 
-
-    
     <a name="#_initncdf_keyword_ZAXISNAME"></a>
     <h4>ZAXISNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -155 +121 @@
 
     
- A string giving the name of the variable in the file 
- that contains the [xyz]axis. 
+ A string giving the name of the variable in the file
+ that contains the [xyz]axis.
 
     
@@ -172 +138 @@
 
     
- A string giving the name of the variable in the file 
+ A string giving the name of the variable in the file
  that contains the land/sea mask
 
@@ -205 +171 @@
 
     
- A string giving the name of the variable in the file 
+ A string giving the name of the variable in the file
  that will be used to build the land/sea mask. In this case the
  mask is based on the first record (if record dimension
@@ -246 +212 @@
     
  Index the axis from 1 instead of 0 when using
- /xyindex and/or zindex
+ /xyindex and/or /zindex
 
     
@@ -263 +229 @@
     
  To define the x/y axis with index instead of using
- the values contained in X/YAXISNAME. 
- x/yaxis = keyword_set(start1) + findgen(jpi/jpj) 
+ the values contained in X/YAXISNAME.
+ x/yaxis = keyword_set(start1) + findgen(jpi/jpj)
  this forces key_onearth = 0
 
@@ -282 +248 @@
     
  To define the z axis with index instead of using
- the values contained in ZAXISNAME. 
- zaxis = keyword_set(start1) + findgen(jpk) 
- 
+ the values contained in ZAXISNAME.
+ zaxis = keyword_set(start1) + findgen(jpk)
+
     
     <a name="#_initncdf_keyword__EXTRA"></a>
@@ -299 +265 @@
 
     
- Used to pass keywords to computegrid
-
-    
-    
-
-    <h3>Examples</h3>
-  IDL> initncdf,'toto.nc',glam=[-180,180]
-
-    <h3>Version history</h3>
+ Used to pass keywords to <a href=".//../../../Grid/computegrid.html">computegrid</a> and 
+ <a href=".//../../../ReadWrite/ncdf_getaxis.html">ncdf_getaxis</a>
+
+    
+    
+
+    <h3>Examples</h3><pre>
+ IDL> initncdf,'toto.nc',glam=[-180,180]
+
+    </pre><h3>Version history</h3>
     
     <h4>Version</h4>
- $Id: initncdf.pro 192 2006-09-22 09:37:08Z smasson $
+ $Id: initncdf.pro 232 2007-03-20 16:59:36Z pinsard $
 
     <h4>History</h4>
@@ -323 +290 @@
     
     <h4>Restrictions</h4>
- Change the grid parameters (see computegrid)
-
-
- the file must contain an x and an y axis. (1 ou 2 dimentional array)
+ Change the grid parameters (see <a href=".//../../../Grid/computegrid.html">computegrid</a>)
+
+
+ the file must contain an x and an y axis. (1 ou 2 dimensional array)