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

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 4.8 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 <a href="/Applications/itt/idl64/help/online_help/XDISPLAYFILE.html">XDISPLAYFILE</a> 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 Widget
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              <span class="attr">type:</span> <span class="value">scalar string</span>
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 FILENAME should be located in !path.
140 ".pro" suffix will be appended if needed.
141</div>
142           
143
144         
145
146         
147
148            <h3>Keywords</h3>
149           
150            <h4 id="_xfile_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
151             
152             
153             
154             
155             
156             
157             
158             
159            </h4>
160       
161            <div class="comments">
162 Used to pass keywords to <a href="/Applications/itt/idl64/help/online_help/XDISPLAYFILE.html">XDISPLAYFILE</a>
163</div>
164           
165         
166
167          <h3>Examples</h3><div class="preformat">
168 IDL> xfile,'plt'
169</div>
170          <h3>Version history</h3>
171         
172          <h4>Version</h4><div class="preformat">
173 $Id: xfile.pro 327 2007-12-13 16:22:35Z pinsard $
174</div>
175          <h4>History</h4><div class="preformat">
176 Sebastien Masson (smasson@lodyc.jussieu.fr)
177 7/1/99
178 6/7/1999: compatibility mac and windows
179</div>
180         
181         
182          <h3>Known issues</h3>
183         
184         
185         
186          <h4>Restrictions</h4><div class="preformat">
187 Triggers the <a href="/Applications/itt/idl64/help/online_help/XMANAGER.html">XMANAGER</a> if it is not already in use.
188</div>
189       
190         
191         
192         
193         
194         
195         
196         
197       
198          <h3>Statistics</h3>
199          <table class="statistics">
200            <tr><td>McCabe cyclic</td><td>           5</td></tr>
201            <tr><td>McCabe essential</td><td>           1</td></tr>
202            <tr><td>McCabe modular design</td><td>           1</td></tr>
203          </table>
204         
205       
206        </div>
207       
208      </div>
209
210     
211
212      <div id="tagline">Produced by IDLdoc 2.0.</div>
213
214    </div>
215
216  </body>
217</html>
Note: See TracBrowser for help on using the repository browser.