source: trunk/SRC/Documentation/xmldoc/faqsaxo.html @ 255

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

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