source: trunk/SRC/Documentation/idldoc_html_output/Utilities/xfile.html @ 242

Last change on this file since 242 was 242, checked in by pinsard, 17 years ago

improvements/corrections of some *.pro headers + replace some message by some report
File size: 4.3 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>xfile.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="xfile.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Utilities//xfile.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="undefine.html">&lt;&lt;prev file</a> | <a href="xhelp.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="xfile.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Utilities/</a></h1>
82      <h2 class="pro_file">xfile.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 display an ASCII file in a widget.
91 It is the same thing that <proidl>xdisplayfile<proidl> but here, we use it
92 to display the content of a procedure or of a function located in the !path
93 ".pro" suffix will be appended if needed.
94</div>
95
96     
97
98     
99
100     
101
102     
103
104      <div id="routine_details">
105       
106
107        <div class="routine_details" id="_xfile">
108
109          <h2><a class="top" href="#container">top</a>xfile <span class="categories">
110 Utilities
111</span></h2>
112       
113          <p class="header">
114            xfile<span class="result">, <a href="#_xfile_param_filename">filename</a></span>, <a href="#_xfile_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
115       
116          <div class="comments">
117</div>
118
119         
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_xfile_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments">
137 It is the name of the procedure or of the function
138 we want to display (with or without .pro at the end).
139</div>
140           
141
142         
143
144         
145
146            <h3>Keywords</h3>
147           
148            <h4 id="_xfile_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149             
150             
151             
152             
153             
154             
155             
156             
157            </h4>
158       
159            <div class="comments">
160 Used to pass keywords to <proidl>xdisplayfile</proidl>
161</div>
162           
163         
164
165          <h3>Examples</h3><div class="preformat">
166 IDL> xfile,'plt'
167</div>
168          <h3>Version history</h3>
169         
170          <h4>Version</h4><div class="preformat">
171 $Id: xfile.pro 239 2007-03-28 06:50:03Z smasson $
172</div>
173          <h4>History</h4><div class="preformat">
174 Sebastien Masson (smasson@lodyc.jussieu.fr)
175 7/1/99
176 6/7/1999: compatibility mac and windows
177</div>
178         
179         
180         
181         
182         
183         
184         
185       
186         
187         
188         
189         
190         
191         
192         
193       
194          <h3>Statistics</h3>
195          <table class="statistics">
196            <tr><td>McCabe cyclic</td><td>           3</td></tr>
197            <tr><td>McCabe essential</td><td>           1</td></tr>
198            <tr><td>McCabe modular design</td><td>           1</td></tr>
199          </table>
200         
201       
202        </div>
203       
204      </div>
205
206     
207
208      <div id="tagline">Produced by IDLdoc 2.0.</div>
209
210    </div>
211
212  </body>
213</html>
Note: See TracBrowser for help on using the repository browser.