1 | |
---|
2 | |
---|
3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
4 | <head> |
---|
5 | <title>xhelp.pro (SAXO Documentation Assistant)</title> |
---|
6 | </head> |
---|
7 | |
---|
8 | <body text="#000000" bgcolor="#FFFFFF"> |
---|
9 | |
---|
10 | |
---|
11 | <!-- Navbar template takes a structure with the following fields: |
---|
12 | overview_href : |
---|
13 | overview_selected : |
---|
14 | dir_overview_href : |
---|
15 | dir_overview_selected : |
---|
16 | categories_href : |
---|
17 | categories_selected : |
---|
18 | index_href : |
---|
19 | index_selected : |
---|
20 | search_href : |
---|
21 | search_selected : |
---|
22 | file_selected : |
---|
23 | source_href : |
---|
24 | source_selected : |
---|
25 | help_href : |
---|
26 | help_selected : |
---|
27 | etc_selected : |
---|
28 | |
---|
29 | prev_file_href : |
---|
30 | next_file_href : |
---|
31 | |
---|
32 | view_single_page_href : |
---|
33 | view_frames_href : |
---|
34 | |
---|
35 | summary_fields_href : |
---|
36 | summary_routine_href : |
---|
37 | details_routine_href : |
---|
38 | |
---|
39 | title : |
---|
40 | subtitle : |
---|
41 | user : |
---|
42 | --> |
---|
43 | |
---|
44 | |
---|
45 | <table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom"> |
---|
46 | <tr> |
---|
47 | <td width="10%"> |
---|
48 | <a href="xfile.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td> |
---|
49 | <td width="80%" align="center" valign="center"> |
---|
50 | <font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td> |
---|
51 | <td width="10%" align="right"> |
---|
52 | <a href=""><img src="./../next.gif" border="0" alt="Next"></a></td> |
---|
53 | </tr> |
---|
54 | </table> |
---|
55 | |
---|
56 | |
---|
57 | <h1><font size="-2">Utilities/</font></h1> |
---|
58 | <h2>xhelp.pro</h2> |
---|
59 | |
---|
60 | <dl> |
---|
61 | </dl> |
---|
62 | |
---|
63 | |
---|
64 | Display an IDL procedure header using widgets and the widget manager. |
---|
65 | |
---|
66 | |
---|
67 | |
---|
68 | |
---|
69 | |
---|
70 | <a name="#_xhelp"></a> |
---|
71 | |
---|
72 | <h2>xhelp <font size="-1" color="#006633"> |
---|
73 | Utilities Widget |
---|
74 | </font></h2> |
---|
75 | |
---|
76 | <p><font face="Courier">xhelp<i>, <a href="#_xhelp_keyword_filename">filename</a></i>, <a href="#_xhelp_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p> |
---|
77 | |
---|
78 | |
---|
79 | |
---|
80 | |
---|
81 | |
---|
82 | |
---|
83 | |
---|
84 | <h3>Parameters</h3> |
---|
85 | |
---|
86 | |
---|
87 | <a name="#_xhelp_keyword_filename"></a> |
---|
88 | <h4>filename |
---|
89 | <font size="-1" color="#006633">in</font> |
---|
90 | |
---|
91 | |
---|
92 | <font size="-1" color="#006633">required</font> |
---|
93 | |
---|
94 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font> |
---|
95 | |
---|
96 | |
---|
97 | </h4> |
---|
98 | |
---|
99 | |
---|
100 | It is the name of the procedure or of the function |
---|
101 | we want to display (with or without .pro at the end). |
---|
102 | FILENAME should be located in !path. |
---|
103 | ".pro" suffix will be appended if needed. |
---|
104 | |
---|
105 | |
---|
106 | |
---|
107 | |
---|
108 | |
---|
109 | <h3>Keywords</h3> |
---|
110 | |
---|
111 | |
---|
112 | <a name="#_xhelp_keyword__EXTRA"></a> |
---|
113 | <h4>_EXTRA |
---|
114 | |
---|
115 | |
---|
116 | |
---|
117 | |
---|
118 | |
---|
119 | |
---|
120 | |
---|
121 | |
---|
122 | </h4> |
---|
123 | |
---|
124 | |
---|
125 | Used to pass keywords to <a href="/Applications/itt/idl64/help/online_help/XDISPLAYFILE.html">XDISPLAYFILE</a> |
---|
126 | |
---|
127 | |
---|
128 | |
---|
129 | |
---|
130 | <h3>Examples</h3><pre> |
---|
131 | |
---|
132 | IDL> xhelp,'plt' |
---|
133 | |
---|
134 | </pre><h3>Version history</h3> |
---|
135 | |
---|
136 | <h4>Version</h4> |
---|
137 | $Id: xhelp.pro 378 2008-08-12 12:35:46Z pinsard $ |
---|
138 | |
---|
139 | <h4>History</h4> |
---|
140 | Written By Steve Richards, December 1990 |
---|
141 | Graceful error recovery, DMS, Feb, 1992. |
---|
142 | Modified to extract .pro documentation headers, PJR/ESRG mar94 |
---|
143 | Paul Ricchiazzi jun93 |
---|
144 | Institute for Computational Earth System Science |
---|
145 | University of California, Santa Barbara |
---|
146 | - 7/1/99 : legeres modification par Sebastien Masson : utilisation de |
---|
147 | <a href="/Applications/itt/idl64/help/online_help/XDISPLAYFILE.html">XDISPLAYFILE</a>, de <a href="/Applications/itt/idl64/help/online_help/FINDFILE.html">FINDFILE</a> et de _extra. |
---|
148 | - 6/7/1999: compatibility mac and windows |
---|
149 | |
---|
150 | |
---|
151 | |
---|
152 | <h3>Known issues</h3> |
---|
153 | |
---|
154 | |
---|
155 | |
---|
156 | <h4>Restrictions</h4> |
---|
157 | Triggers the <a href="/Applications/itt/idl64/help/online_help/XMANAGER.html">XMANAGER</a> if it is not already in use. |
---|
158 | |
---|
159 | |
---|
160 | |
---|
161 | |
---|
162 | |
---|
163 | |
---|
164 | |
---|
165 | |
---|
166 | |
---|
167 | |
---|
168 | <font size="-3"><p> </p></font> |
---|
169 | <hr size="1" color="#CCCCCC"/> |
---|
170 | |
---|
171 | |
---|
172 | |
---|
173 | |
---|
174 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
---|
175 | |
---|
176 | </body> |
---|
177 | </html> |
---|