1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
---|
2 | <html> |
---|
3 | <head> |
---|
4 | <meta name="generator" content= |
---|
5 | "HTML Tidy for Mac OS X (vers 1 September 2005), see www.w3.org"> |
---|
6 | <meta http-equiv="Content-Type" content= |
---|
7 | "text/html; charset=us-ascii"> |
---|
8 | <title>Frequently Asked questions about SAXO</title> |
---|
9 | <link rel="stylesheet" href="style.css" type="text/css"> |
---|
10 | <link rel="stylesheet" href="saxo.css" type="text/css"> |
---|
11 | <meta name="generator" content="DocBook XSL Stylesheets V1.70.1"> |
---|
12 | <meta name="keywords" content="IDL, SAXO, FAQ"> |
---|
13 | </head> |
---|
14 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" |
---|
15 | alink="#0000FF"> |
---|
16 | <div class="article" lang="en"> |
---|
17 | <div class="titlepage"> |
---|
18 | <div> |
---|
19 | <div> |
---|
20 | <h2 class="title"><a name="d0e2" id="d0e2"></a>Frequently Asked |
---|
21 | questions about SAXO</h2> |
---|
22 | </div> |
---|
23 | <div> |
---|
24 | <div class="authorgroup"> |
---|
25 | <div class="author"> |
---|
26 | <h3 class="author"><span class="firstname">Sébastien</span> |
---|
27 | <span class="surname">Masson</span> <code class= |
---|
28 | "email"><<a href="mailto:Sebastien.Masson_at_locean-ipsl.upmc.fr">Sebastien.Masson_at_locean-ipsl.upmc.fr</a>></code></h3> |
---|
29 | </div> |
---|
30 | <div class="author"> |
---|
31 | <h3 class="author"><span class="firstname">Françoise</span> |
---|
32 | <span class="surname">Pinsard</span> <code class= |
---|
33 | "email"><<a href= |
---|
34 | "mailto:Francoise.Pinsard_at_locean-ipsl.upmc.fr">Francoise.Pinsard_at_locean-ipsl.upmc.fr</a>></code></h3> |
---|
35 | </div> |
---|
36 | </div> |
---|
37 | </div> |
---|
38 | <div><span class="pubdate">svn Id of xml source file : $Id: |
---|
39 | faqsaxo.xml 188 2006-09-21 12:59:48Z pinsard $<br> |
---|
40 | <br></span></div> |
---|
41 | <div> |
---|
42 | <div class="revhistory"> |
---|
43 | <table border="1" width="100%" summary="Revision history"> |
---|
44 | <tr> |
---|
45 | <th align="left" valign="top" colspan="2"><b>Revision |
---|
46 | History</b></th> |
---|
47 | </tr> |
---|
48 | <tr> |
---|
49 | <td align="left">Revision 0.0</td> |
---|
50 | <td align="left">August 2006</td> |
---|
51 | </tr> |
---|
52 | <tr> |
---|
53 | <td align="left" colspan="2">First draft</td> |
---|
54 | </tr> |
---|
55 | <tr> |
---|
56 | <td align="left">Revision 0.1</td> |
---|
57 | <td align="left">September 2006</td> |
---|
58 | </tr> |
---|
59 | <tr> |
---|
60 | <td align="left" colspan="2">+ onlinehelp</td> |
---|
61 | </tr> |
---|
62 | </table> |
---|
63 | </div> |
---|
64 | </div> |
---|
65 | </div> |
---|
66 | <hr></div> |
---|
67 | <div class="qandaset"> |
---|
68 | <dl> |
---|
69 | <dt>1. <a href="#intro">Introduction</a></dt> |
---|
70 | <dt>2. <a href="#general">General</a></dt> |
---|
71 | <dd> |
---|
72 | <dl> |
---|
73 | <dt>2.1. <a href="#d0e66">What is SAXO ?</a></dt> |
---|
74 | <dt>2.2. <a href="#d0e76">How can I get help ?</a></dt> |
---|
75 | <dt>2.3. <a href="#d0e86">How do I get SAXO ?</a></dt> |
---|
76 | <dt>2.4. <a href="#d0e96">What is the current version of SAXO |
---|
77 | ?</a></dt> |
---|
78 | <dt>2.5. <a href="#d0e103">On what systems does SAXO run ?</a></dt> |
---|
79 | <dt>2.6. <a href="#d0e110">Does SAXO works with GDL instead of IDL |
---|
80 | ?</a></dt> |
---|
81 | <dt>2.7. <a href="#d0e119">When is the next version of SAXO due out |
---|
82 | ?</a></dt> |
---|
83 | <dt>2.8. <a href="#d0e126">How can I find if a routine to do what I |
---|
84 | want already exists ?</a></dt> |
---|
85 | <dt>2.9. <a href="#d0e133">How should SAXO be cited or acknowledged |
---|
86 | in publication ?</a></dt> |
---|
87 | </dl> |
---|
88 | </dd> |
---|
89 | <dt>3. <a href="#technical">Technical questions</a></dt> |
---|
90 | <dd> |
---|
91 | <dl> |
---|
92 | <dt>3.1. <a href="#d0e143">Is there on-line help for SAXO |
---|
93 | ?</a></dt> |
---|
94 | </dl> |
---|
95 | </dd> |
---|
96 | <dt>4. <a href="#Contributors">Contributors</a></dt> |
---|
97 | <dd> |
---|
98 | <dl> |
---|
99 | <dt>4.1. <a href="#d0e167">Is there an SAXO Style Guide available |
---|
100 | ?</a></dt> |
---|
101 | <dt>4.2. <a href="#d0e208">Is there any trouble with IDLdoc |
---|
102 | ?</a></dt> |
---|
103 | <dt>4.3. <a href="#d0e272">How can I check spelling of xml files |
---|
104 | ?</a></dt> |
---|
105 | <dt>4.4. <a href="#d0e300">How can I see online help update |
---|
106 | ?</a></dt> |
---|
107 | </dl> |
---|
108 | </dd> |
---|
109 | </dl> |
---|
110 | <table border="0" summary="Q and A Set"> |
---|
111 | <col align="left" width="1%"> |
---|
112 | <tbody> |
---|
113 | <tr class="qandadiv"> |
---|
114 | <td align="left" valign="top" colspan="2"> |
---|
115 | <h3 class="title"><a name="intro" id="intro"></a>1. |
---|
116 | Introduction</h3> |
---|
117 | </td> |
---|
118 | </tr> |
---|
119 | <tr class="toc"> |
---|
120 | <td align="left" valign="top" colspan="2"></td> |
---|
121 | </tr> |
---|
122 | <tr class="toc"> |
---|
123 | <td align="left" valign="top" colspan="2"> |
---|
124 | <p>This is a list of Frequently Asked Questions about SAXO.</p> |
---|
125 | <p>This list is roughly divided into categories: general questions, |
---|
126 | technical questions, contributors questions.</p> |
---|
127 | <p>Suggestions for corrections or additional sections are welcome |
---|
128 | -- please email them to <code class="email"><<a href= |
---|
129 | "mailto:saxo-dev@forge.ipsl.jussieu.fr">saxo-dev@forge.ipsl.jussieu.fr</a>></code>.</p> |
---|
130 | </td> |
---|
131 | </tr> |
---|
132 | <tr class="qandadiv"> |
---|
133 | <td align="left" valign="top" colspan="2"> |
---|
134 | <h3 class="title"><a name="general" id="general"></a>2. |
---|
135 | General</h3> |
---|
136 | </td> |
---|
137 | </tr> |
---|
138 | <tr class="toc"> |
---|
139 | <td align="left" valign="top" colspan="2"> |
---|
140 | <dl> |
---|
141 | <dt>2.1. <a href="#d0e66">What is SAXO ?</a></dt> |
---|
142 | <dt>2.2. <a href="#d0e76">How can I get help ?</a></dt> |
---|
143 | <dt>2.3. <a href="#d0e86">How do I get SAXO ?</a></dt> |
---|
144 | <dt>2.4. <a href="#d0e96">What is the current version of SAXO |
---|
145 | ?</a></dt> |
---|
146 | <dt>2.5. <a href="#d0e103">On what systems does SAXO run ?</a></dt> |
---|
147 | <dt>2.6. <a href="#d0e110">Does SAXO works with GDL instead of IDL |
---|
148 | ?</a></dt> |
---|
149 | <dt>2.7. <a href="#d0e119">When is the next version of SAXO due out |
---|
150 | ?</a></dt> |
---|
151 | <dt>2.8. <a href="#d0e126">How can I find if a routine to do what I |
---|
152 | want already exists ?</a></dt> |
---|
153 | <dt>2.9. <a href="#d0e133">How should SAXO be cited or acknowledged |
---|
154 | in publication ?</a></dt> |
---|
155 | </dl> |
---|
156 | </td> |
---|
157 | </tr> |
---|
158 | <tr class="question"> |
---|
159 | <td align="left" valign="top"><a name="d0e66" id= |
---|
160 | "d0e66"></a><a name="d0e67" id="d0e67"></a><b>2.1.</b></td> |
---|
161 | <td align="left" valign="top"> |
---|
162 | <p>What is SAXO ?</p> |
---|
163 | </td> |
---|
164 | </tr> |
---|
165 | <tr class="answer"> |
---|
166 | <td align="left" valign="top"></td> |
---|
167 | <td align="left" valign="top"> |
---|
168 | <p>see document <a href="./whatissaxo.html" target="_top">What is |
---|
169 | SAXO</a>.</p> |
---|
170 | </td> |
---|
171 | </tr> |
---|
172 | <tr class="question"> |
---|
173 | <td align="left" valign="top"><a name="d0e76" id= |
---|
174 | "d0e76"></a><a name="d0e77" id="d0e77"></a><b>2.2.</b></td> |
---|
175 | <td align="left" valign="top"> |
---|
176 | <p>How can I get help ?</p> |
---|
177 | </td> |
---|
178 | </tr> |
---|
179 | <tr class="answer"> |
---|
180 | <td align="left" valign="top"></td> |
---|
181 | <td align="left" valign="top"> |
---|
182 | <p>see Support in document <a href="./websaxo.html" target= |
---|
183 | "_top">Main page of SAXO</a>.</p> |
---|
184 | </td> |
---|
185 | </tr> |
---|
186 | <tr class="question"> |
---|
187 | <td align="left" valign="top"><a name="d0e86" id= |
---|
188 | "d0e86"></a><a name="d0e87" id="d0e87"></a><b>2.3.</b></td> |
---|
189 | <td align="left" valign="top"> |
---|
190 | <p>How do I get SAXO ?</p> |
---|
191 | </td> |
---|
192 | </tr> |
---|
193 | <tr class="answer"> |
---|
194 | <td align="left" valign="top"></td> |
---|
195 | <td align="left" valign="top"> |
---|
196 | <p>see document <a href="./getsaxo.html" target="_top">Get |
---|
197 | SAXO</a>.</p> |
---|
198 | </td> |
---|
199 | </tr> |
---|
200 | <tr class="question"> |
---|
201 | <td align="left" valign="top"><a name="d0e96" id= |
---|
202 | "d0e96"></a><a name="d0e97" id="d0e97"></a><b>2.4.</b></td> |
---|
203 | <td align="left" valign="top"> |
---|
204 | <p>What is the current version of SAXO ?</p> |
---|
205 | </td> |
---|
206 | </tr> |
---|
207 | <tr class="answer"> |
---|
208 | <td align="left" valign="top"></td> |
---|
209 | <td align="left" valign="top"></td> |
---|
210 | </tr> |
---|
211 | <tr class="question"> |
---|
212 | <td align="left" valign="top"><a name="d0e103" id= |
---|
213 | "d0e103"></a><a name="d0e104" id="d0e104"></a><b>2.5.</b></td> |
---|
214 | <td align="left" valign="top"> |
---|
215 | <p>On what systems does SAXO run ?</p> |
---|
216 | </td> |
---|
217 | </tr> |
---|
218 | <tr class="answer"> |
---|
219 | <td align="left" valign="top"></td> |
---|
220 | <td align="left" valign="top"></td> |
---|
221 | </tr> |
---|
222 | <tr class="question"> |
---|
223 | <td align="left" valign="top"><a name="d0e110" id= |
---|
224 | "d0e110"></a><a name="d0e111" id="d0e111"></a><b>2.6.</b></td> |
---|
225 | <td align="left" valign="top"> |
---|
226 | <p>Does SAXO works with GDL instead of IDL ?</p> |
---|
227 | </td> |
---|
228 | </tr> |
---|
229 | <tr class="answer"> |
---|
230 | <td align="left" valign="top"></td> |
---|
231 | <td align="left" valign="top"> |
---|
232 | <p>Not yet.</p> |
---|
233 | </td> |
---|
234 | </tr> |
---|
235 | <tr class="question"> |
---|
236 | <td align="left" valign="top"><a name="d0e119" id= |
---|
237 | "d0e119"></a><a name="d0e120" id="d0e120"></a><b>2.7.</b></td> |
---|
238 | <td align="left" valign="top"> |
---|
239 | <p>When is the next version of SAXO due out ?</p> |
---|
240 | </td> |
---|
241 | </tr> |
---|
242 | <tr class="answer"> |
---|
243 | <td align="left" valign="top"></td> |
---|
244 | <td align="left" valign="top"></td> |
---|
245 | </tr> |
---|
246 | <tr class="question"> |
---|
247 | <td align="left" valign="top"><a name="d0e126" id= |
---|
248 | "d0e126"></a><a name="d0e127" id="d0e127"></a><b>2.8.</b></td> |
---|
249 | <td align="left" valign="top"> |
---|
250 | <p>How can I find if a routine to do what I want already exists |
---|
251 | ?</p> |
---|
252 | </td> |
---|
253 | </tr> |
---|
254 | <tr class="answer"> |
---|
255 | <td align="left" valign="top"></td> |
---|
256 | <td align="left" valign="top"></td> |
---|
257 | </tr> |
---|
258 | <tr class="question"> |
---|
259 | <td align="left" valign="top"><a name="d0e133" id= |
---|
260 | "d0e133"></a><a name="d0e134" id="d0e134"></a><b>2.9.</b></td> |
---|
261 | <td align="left" valign="top"> |
---|
262 | <p>How should SAXO be cited or acknowledged in publication ?</p> |
---|
263 | </td> |
---|
264 | </tr> |
---|
265 | <tr class="answer"> |
---|
266 | <td align="left" valign="top"></td> |
---|
267 | <td align="left" valign="top"></td> |
---|
268 | </tr> |
---|
269 | <tr class="qandadiv"> |
---|
270 | <td align="left" valign="top" colspan="2"> |
---|
271 | <h3 class="title"><a name="technical" id="technical"></a>3. |
---|
272 | Technical questions</h3> |
---|
273 | </td> |
---|
274 | </tr> |
---|
275 | <tr class="toc"> |
---|
276 | <td align="left" valign="top" colspan="2"> |
---|
277 | <dl> |
---|
278 | <dt>3.1. <a href="#d0e143">Is there on-line help for SAXO |
---|
279 | ?</a></dt> |
---|
280 | </dl> |
---|
281 | </td> |
---|
282 | </tr> |
---|
283 | <tr class="question"> |
---|
284 | <td align="left" valign="top"><a name="d0e143" id= |
---|
285 | "d0e143"></a><a name="d0e144" id="d0e144"></a><b>3.1.</b></td> |
---|
286 | <td align="left" valign="top"> |
---|
287 | <p>Is there on-line help for SAXO ?</p> |
---|
288 | </td> |
---|
289 | </tr> |
---|
290 | <tr class="answer"> |
---|
291 | <td align="left" valign="top"></td> |
---|
292 | <td align="left" valign="top"> |
---|
293 | <p>Yes, if you use at least IDL 6.2. It is produced by <span class= |
---|
294 | "application"><a href= |
---|
295 | "http://www.ittvis.com/codebank/search.asp?FID=100" target= |
---|
296 | "_top">IDLdoc</a></span>. SAXO and IDL online_help have been |
---|
297 | merged, you can simply get the help by typing:</p> |
---|
298 | <pre class="screen"> |
---|
299 | <code class="prompt">idl></code> <strong class= |
---|
300 | "userinput"><code><span><strong class= |
---|
301 | "command">?</strong></span></code></strong> |
---|
302 | |
---|
303 | </pre></td> |
---|
304 | </tr> |
---|
305 | <tr class="qandadiv"> |
---|
306 | <td align="left" valign="top" colspan="2"> |
---|
307 | <h3 class="title"><a name="Contributors" id="Contributors"></a>4. |
---|
308 | Contributors</h3> |
---|
309 | </td> |
---|
310 | </tr> |
---|
311 | <tr class="toc"> |
---|
312 | <td align="left" valign="top" colspan="2"> |
---|
313 | <dl> |
---|
314 | <dt>4.1. <a href="#d0e167">Is there an SAXO Style Guide available |
---|
315 | ?</a></dt> |
---|
316 | <dt>4.2. <a href="#d0e208">Is there any trouble with IDLdoc |
---|
317 | ?</a></dt> |
---|
318 | <dt>4.3. <a href="#d0e272">How can I check spelling of xml files |
---|
319 | ?</a></dt> |
---|
320 | <dt>4.4. <a href="#d0e300">How can I see online help update |
---|
321 | ?</a></dt> |
---|
322 | </dl> |
---|
323 | </td> |
---|
324 | </tr> |
---|
325 | <tr class="question"> |
---|
326 | <td align="left" valign="top"><a name="d0e167" id= |
---|
327 | "d0e167"></a><a name="d0e168" id="d0e168"></a><b>4.1.</b></td> |
---|
328 | <td align="left" valign="top"> |
---|
329 | <p>Is there an SAXO Style Guide available ?</p> |
---|
330 | </td> |
---|
331 | </tr> |
---|
332 | <tr class="answer"> |
---|
333 | <td align="left" valign="top"></td> |
---|
334 | <td align="left" valign="top"> |
---|
335 | <p>There is a template for header <a href="../new_header.txt" |
---|
336 | target="_top">new_header.txt</a> which can be parsed by |
---|
337 | <span class="application">IDLdoc</span>.</p> |
---|
338 | <p>This file can be added in <span class="application">Emacs</span> |
---|
339 | configuration <span class="guimenu">IDLWAVE</span> → |
---|
340 | <span class="guimenuitem">Templates</span> → <span class= |
---|
341 | "guimenuitem">Doc Header</span> (<span><strong class= |
---|
342 | "shortcut"><span class="keysym">C-c</span>-<span class= |
---|
343 | "keysym">C-h</span></strong></span>). in your <code class= |
---|
344 | "filename">${HOME}/.emacs</code> like this :</p> |
---|
345 | <pre class="programlisting"> |
---|
346 | (add-hook 'idlwave-mode-hook |
---|
347 | (function |
---|
348 | (lambda () |
---|
349 | (setq idlwave-file-header '("<em class= |
---|
350 | "replaceable"><code>SAXO_basedirectory</code></em>/SAXO_DIR/SRC/Documentation/new_header.txt") |
---|
351 | )))) |
---|
352 | </pre></td> |
---|
353 | </tr> |
---|
354 | <tr class="question"> |
---|
355 | <td align="left" valign="top"><a name="d0e208" id= |
---|
356 | "d0e208"></a><a name="d0e209" id="d0e209"></a><b>4.2.</b></td> |
---|
357 | <td align="left" valign="top"> |
---|
358 | <p>Is there any trouble with <span class= |
---|
359 | "application">IDLdoc</span> ?</p> |
---|
360 | </td> |
---|
361 | </tr> |
---|
362 | <tr class="answer"> |
---|
363 | <td align="left" valign="top"></td> |
---|
364 | <td align="left" valign="top"> |
---|
365 | <p>Yes, there are some :</p> |
---|
366 | <div class="itemizedlist"> |
---|
367 | <ul type="disc"> |
---|
368 | <li> |
---|
369 | <p><code class="literal">\</code> in <code class= |
---|
370 | "filename">*.pro</code> are not written in <code class= |
---|
371 | "filename">*.html</code>. They must be escaped by an other |
---|
372 | <code class="literal">\</code> or you can choose an other |
---|
373 | character.</p> |
---|
374 | </li> |
---|
375 | <li> |
---|
376 | <p><span class="guimenu">Search</span> doesn't handle characters |
---|
377 | like <code class="literal">-</code> and <code class= |
---|
378 | "literal">|</code>.</p> |
---|
379 | </li> |
---|
380 | <li> |
---|
381 | <p>Paragraphs of <code class="filename">*.pro</code> headers are |
---|
382 | shown with a proportional font in the <code class= |
---|
383 | "literal">HTML</code> release.</p> |
---|
384 | <p>If you need to draw some small figure like grid cell, you can |
---|
385 | encapsulate between the block to be shown in constant font between |
---|
386 | <code class="literal">; <fixe></code> and <code class= |
---|
387 | "literal">; </fixe></code></p> |
---|
388 | </li> |
---|
389 | </ul> |
---|
390 | </div> |
---|
391 | <p>Unfortunately, these troubles may not be fixed because the |
---|
392 | author does not have anymore the opportunity to work on his own |
---|
393 | work.</p> |
---|
394 | <p>Bugs can be submitted to IDL but we do not expect answers !</p> |
---|
395 | </td> |
---|
396 | </tr> |
---|
397 | <tr class="question"> |
---|
398 | <td align="left" valign="top"><a name="d0e272" id= |
---|
399 | "d0e272"></a><a name="d0e273" id="d0e273"></a><b>4.3.</b></td> |
---|
400 | <td align="left" valign="top"> |
---|
401 | <p>How can I check spelling of xml files ?</p> |
---|
402 | </td> |
---|
403 | </tr> |
---|
404 | <tr class="answer"> |
---|
405 | <td align="left" valign="top"></td> |
---|
406 | <td align="left" valign="top"> |
---|
407 | <p>There is one way with command line :</p> |
---|
408 | <pre class="screen"> |
---|
409 | <code class="prompt">$</code> <strong class= |
---|
410 | "userinput"><code><span><strong class= |
---|
411 | "command">aspell</strong></span> <code class= |
---|
412 | "option">--mode=sgml</code> <code class= |
---|
413 | "option">-c</code> <em class="parameter"><code><code class= |
---|
414 | "filename"><em class= |
---|
415 | "replaceable"><code>xmlfile</code></em></code></code></em></code></strong> |
---|
416 | |
---|
417 | </pre></td> |
---|
418 | </tr> |
---|
419 | <tr class="question"> |
---|
420 | <td align="left" valign="top"><a name="d0e300" id= |
---|
421 | "d0e300"></a><a name="d0e301" id="d0e301"></a><b>4.4.</b></td> |
---|
422 | <td align="left" valign="top"> |
---|
423 | <p>How can I see online help update ?</p> |
---|
424 | </td> |
---|
425 | </tr> |
---|
426 | <tr class="answer"> |
---|
427 | <td align="left" valign="top"></td> |
---|
428 | <td align="left" valign="top"> |
---|
429 | <p>You won't see online help update if you are working with the |
---|
430 | official distribution because of <code class= |
---|
431 | "varname">!HELP_PATH</code>. To override this problem, when you are |
---|
432 | in <code class="filename"><em class= |
---|
433 | "replaceable"><code>SAXO_basedirectory</code></em>/SAXO_DIR/SRC/Documentation/xmldoc/</code>, |
---|
434 | you can call online help like this :</p> |
---|
435 | <pre class="screen"> |
---|
436 | <code class="prompt">IDL</code> <strong class= |
---|
437 | "userinput"><code><span><strong class= |
---|
438 | "command">ONLINE_HELP</strong></span>,<code class= |
---|
439 | "option">book="../idldoc_assistant_output/idldoc-lib.adp"</code></code></strong> |
---|
440 | |
---|
441 | </pre></td> |
---|
442 | </tr> |
---|
443 | </tbody> |
---|
444 | </table> |
---|
445 | </div> |
---|
446 | </div> |
---|
447 | </body> |
---|
448 | </html> |
---|