source: trunk/SRC/Documentation/idldoc_html_output/Utilities/createpro.html @ 89

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 5.4 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>createpro.pro (IDLdoc API 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="createpro.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../idldoc-help.html?format=raw" 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="createfunc.html">&lt;&lt;prev file</a> | <a href="def_myuniquetmpdir.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="createpro.html" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" 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?format=raw">Utilities/</a></h1>
82      <h2 class="pro_file">createpro.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_createpro">
103
104          <h2><a class="top" href="#container">top</a>createpro </h2>
105       
106          <p class="header">
107            createpro<span class="result">, <a href="#_createpro_param_command">command</a></span>, <a href="#_createpro_keyword_FILENAMEIN">FILENAMEIN</a>=<span class="result">FILENAMEIN</span>, <a href="#_createpro_keyword_KWDLIST">KWDLIST</a>=<span class="result">KWDLIST</span>, <a href="#_createpro_keyword_KWDUSED">KWDUSED</a>=<span class="result">KWDUSED</span>, <a href="#_createpro_keyword__extra">_extra</a>=<span class="result">_extra</span></p>
108       
109          <div class="comments">
110 NAME:createpro
111
112 PURPOSE: write an idl procedure, compile it and execute it.
113
114 CATEGORY:
115
116 CALLING SEQUENCE:createpro, command
117 
118 INPUTS:
119      command: a string array defining the procedure to be created.
120      each element will be a line of the created procedure.
121
122 KEYWORD PARAMETERS:
123
124      FILENAMEIN: name of the procedure to be created.
125      'for_createpro.pro' by default
126
127      KWDLIST: a vector string. to specify a list of keywords that
128      must be included in the procedure definition. Warning: the string
129      must start with a ',' for example: KWDLIST = ', TOTO = toto'
130
131      _EXTRA: used to pass your keywords to the created procedure.
132
133 OUTPUTS: none
134
135 COMMON BLOCKS: none
136
137 SIDE EFFECTS: ends the procedure name with '.pro' if needed
138
139 RESTRICTIONS:is not working with functions, use createfunc instead.
140              arguments can be given only through keywords
141
142 EXAMPLE:
143      IDL> createpro, ['print,''OK'''], filename='test'
144      IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $
145      IDL>   , filename = 'test', kwdlist =', ok = ok'
146      IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $
147      IDL>   , filename = 'test', kwdlist = ', ok = ok', /ok
148
149</div>
150
151         
152
153         
154            <h3>Parameters</h3>
155       
156           
157            <h4 id="_createpro_param_command">command&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
158             
159             
160             
161             
162             
163             
164             
165             
166            </h4>
167       
168          <div class="comments"></div>
169           
170
171         
172
173         
174
175            <h3>Keywords</h3>
176           
177            <h4 id="_createpro_keyword_FILENAMEIN">FILENAMEIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178             
179             
180             
181             
182             
183             
184             
185             
186            </h4>
187       
188            <div class="comments"></div>
189           
190            <h4 id="_createpro_keyword_KWDLIST">KWDLIST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
191             
192             
193             
194             
195             
196             
197             
198             
199            </h4>
200       
201            <div class="comments"></div>
202           
203            <h4 id="_createpro_keyword_KWDUSED">KWDUSED&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
204             
205             
206             
207             
208             
209             
210             
211             
212            </h4>
213       
214            <div class="comments"></div>
215           
216            <h4 id="_createpro_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
217             
218             
219             
220             
221             
222             
223             
224             
225            </h4>
226       
227            <div class="comments"></div>
228           
229         
230
231         
232         
233         
234         
235         
236         
237         
238         
239         
240         
241         
242         
243       
244         
245         
246         
247         
248         
249         
250         
251       
252         
253       
254        </div>
255       
256      </div>
257
258     
259
260      <div id="tagline">Produced by IDLdoc 2.0.</div>
261
262    </div>
263
264  </body>
265</html>
Note: See TracBrowser for help on using the repository browser.