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

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

Modif for html documentations : hellip entity instead of ..., path relative to xmldoc in url attribute, spell chekcking, enlight mousse button, status checking of xml processing in shell scripts (2/2)
File size: 11.8 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 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"
15alink="#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
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">Sebastien.Masson_at_locean-ipsl.upmc.fr</a>&gt;</code></h3>
29</div>
30<div class="author">
31<h3 class="author"><span class="firstname">Fran&ccedil;oise</span>
32<span class="surname">Pinsard</span> <code class=
33"email">&lt;<a href=
34"mailto:Francoise.Pinsard_at_locean-ipsl.upmc.fr">Francoise.Pinsard_at_locean-ipsl.upmc.fr</a>&gt;</code></h3>
35</div>
36</div>
37</div>
38<div><span class="pubdate">svn Id of xml source file : $Id:
39faqsaxo.xml 183 2006-09-18 13:49:14Z 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
46History</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
84want already exists ?</a></dt>
85<dt>2.9. <a href="#d0e133">How should SAXO be cited or acknowledged
86in 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</dl>
104</dd>
105</dl>
106<table border="0" summary="Q and A Set">
107<col align="left" width="1%">
108<tbody>
109<tr class="qandadiv">
110<td align="left" valign="top" colspan="2">
111<h3 class="title"><a name="intro" id="intro"></a>1.
112Introduction</h3>
113</td>
114</tr>
115<tr class="toc">
116<td align="left" valign="top" colspan="2"></td>
117</tr>
118<tr class="toc">
119<td align="left" valign="top" colspan="2">
120<p>This is a list of Frequently Asked Questions about SAXO.</p>
121<p>This list is roughly divided into categories: general questions,
122technical questions, contributors questions.</p>
123<p>Suggestions for corrections or additional sections are welcome
124-- please email them to <code class="email">&lt;<a href=
125"mailto:saxo-dev@forge.ipsl.jussieu.fr">saxo-dev@forge.ipsl.jussieu.fr</a>&gt;</code>.</p>
126</td>
127</tr>
128<tr class="qandadiv">
129<td align="left" valign="top" colspan="2">
130<h3 class="title"><a name="general" id="general"></a>2.
131General</h3>
132</td>
133</tr>
134<tr class="toc">
135<td align="left" valign="top" colspan="2">
136<dl>
137<dt>2.1. <a href="#d0e66">What is SAXO ?</a></dt>
138<dt>2.2. <a href="#d0e76">How can I get help ?</a></dt>
139<dt>2.3. <a href="#d0e86">How do I get SAXO ?</a></dt>
140<dt>2.4. <a href="#d0e96">What is the current version of SAXO
141?</a></dt>
142<dt>2.5. <a href="#d0e103">On what systems does SAXO run ?</a></dt>
143<dt>2.6. <a href="#d0e110">Does SAXO works with GDL instead of IDL
144?</a></dt>
145<dt>2.7. <a href="#d0e119">When is the next version of SAXO due out
146?</a></dt>
147<dt>2.8. <a href="#d0e126">How can I find if a routine to do what I
148want already exists ?</a></dt>
149<dt>2.9. <a href="#d0e133">How should SAXO be cited or acknowledged
150in publication ?</a></dt>
151</dl>
152</td>
153</tr>
154<tr class="question">
155<td align="left" valign="top"><a name="d0e66" id=
156"d0e66"></a><a name="d0e67" id="d0e67"></a><b>2.1.</b></td>
157<td align="left" valign="top">
158<p>What is SAXO ?</p>
159</td>
160</tr>
161<tr class="answer">
162<td align="left" valign="top"></td>
163<td align="left" valign="top">
164<p>see document <a href="./whatissaxo.html?format=raw" target=
165"_top">What is SAXO</a>.</p>
166</td>
167</tr>
168<tr class="question">
169<td align="left" valign="top"><a name="d0e76" id=
170"d0e76"></a><a name="d0e77" id="d0e77"></a><b>2.2.</b></td>
171<td align="left" valign="top">
172<p>How can I get help ?</p>
173</td>
174</tr>
175<tr class="answer">
176<td align="left" valign="top"></td>
177<td align="left" valign="top">
178<p>see Support in document <a href="./websaxo.html?format=raw"
179target="_top">Main page of SAXO</a>.</p>
180</td>
181</tr>
182<tr class="question">
183<td align="left" valign="top"><a name="d0e86" id=
184"d0e86"></a><a name="d0e87" id="d0e87"></a><b>2.3.</b></td>
185<td align="left" valign="top">
186<p>How do I get SAXO ?</p>
187</td>
188</tr>
189<tr class="answer">
190<td align="left" valign="top"></td>
191<td align="left" valign="top">
192<p>see document <a href="./getsaxo.html?format=raw" target=
193"_top">Get SAXO</a>.</p>
194</td>
195</tr>
196<tr class="question">
197<td align="left" valign="top"><a name="d0e96" id=
198"d0e96"></a><a name="d0e97" id="d0e97"></a><b>2.4.</b></td>
199<td align="left" valign="top">
200<p>What is the current version of SAXO ?</p>
201</td>
202</tr>
203<tr class="answer">
204<td align="left" valign="top"></td>
205<td align="left" valign="top"></td>
206</tr>
207<tr class="question">
208<td align="left" valign="top"><a name="d0e103" id=
209"d0e103"></a><a name="d0e104" id="d0e104"></a><b>2.5.</b></td>
210<td align="left" valign="top">
211<p>On what systems does SAXO run ?</p>
212</td>
213</tr>
214<tr class="answer">
215<td align="left" valign="top"></td>
216<td align="left" valign="top"></td>
217</tr>
218<tr class="question">
219<td align="left" valign="top"><a name="d0e110" id=
220"d0e110"></a><a name="d0e111" id="d0e111"></a><b>2.6.</b></td>
221<td align="left" valign="top">
222<p>Does SAXO works with GDL instead of IDL ?</p>
223</td>
224</tr>
225<tr class="answer">
226<td align="left" valign="top"></td>
227<td align="left" valign="top">
228<p>Not yet.</p>
229</td>
230</tr>
231<tr class="question">
232<td align="left" valign="top"><a name="d0e119" id=
233"d0e119"></a><a name="d0e120" id="d0e120"></a><b>2.7.</b></td>
234<td align="left" valign="top">
235<p>When is the next version of SAXO due out ?</p>
236</td>
237</tr>
238<tr class="answer">
239<td align="left" valign="top"></td>
240<td align="left" valign="top"></td>
241</tr>
242<tr class="question">
243<td align="left" valign="top"><a name="d0e126" id=
244"d0e126"></a><a name="d0e127" id="d0e127"></a><b>2.8.</b></td>
245<td align="left" valign="top">
246<p>How can I find if a routine to do what I want already exists
247?</p>
248</td>
249</tr>
250<tr class="answer">
251<td align="left" valign="top"></td>
252<td align="left" valign="top"></td>
253</tr>
254<tr class="question">
255<td align="left" valign="top"><a name="d0e133" id=
256"d0e133"></a><a name="d0e134" id="d0e134"></a><b>2.9.</b></td>
257<td align="left" valign="top">
258<p>How should SAXO be cited or acknowledged in publication ?</p>
259</td>
260</tr>
261<tr class="answer">
262<td align="left" valign="top"></td>
263<td align="left" valign="top"></td>
264</tr>
265<tr class="qandadiv">
266<td align="left" valign="top" colspan="2">
267<h3 class="title"><a name="technical" id="technical"></a>3.
268Technical questions</h3>
269</td>
270</tr>
271<tr class="toc">
272<td align="left" valign="top" colspan="2">
273<dl>
274<dt>3.1. <a href="#d0e143">Is there on-line help for SAXO
275?</a></dt>
276</dl>
277</td>
278</tr>
279<tr class="question">
280<td align="left" valign="top"><a name="d0e143" id=
281"d0e143"></a><a name="d0e144" id="d0e144"></a><b>3.1.</b></td>
282<td align="left" valign="top">
283<p>Is there on-line help for SAXO ?</p>
284</td>
285</tr>
286<tr class="answer">
287<td align="left" valign="top"></td>
288<td align="left" valign="top">
289<p>Yes, if you use at least IDL 6.2. It is produced by <span class=
290"application"><a href=
291"http://www.ittvis.com/codebank/search.asp?FID=100" target=
292"_top">IDLdoc</a></span>. SAXO and IDL online_help have been
293merged, you can simply get the help by typing:</p>
294<pre class="screen">
295       <code class="prompt">idl&gt;</code> <strong class=
296"userinput"><code><span><strong class=
297"command">?</strong></span></code></strong>
298     
299</pre></td>
300</tr>
301<tr class="qandadiv">
302<td align="left" valign="top" colspan="2">
303<h3 class="title"><a name="Contributors" id="Contributors"></a>4.
304Contributors</h3>
305</td>
306</tr>
307<tr class="toc">
308<td align="left" valign="top" colspan="2">
309<dl>
310<dt>4.1. <a href="#d0e167">Is there an SAXO Style Guide available
311?</a></dt>
312<dt>4.2. <a href="#d0e208">Is there any trouble with IDLdoc
313?</a></dt>
314</dl>
315</td>
316</tr>
317<tr class="question">
318<td align="left" valign="top"><a name="d0e167" id=
319"d0e167"></a><a name="d0e168" id="d0e168"></a><b>4.1.</b></td>
320<td align="left" valign="top">
321<p>Is there an SAXO Style Guide available ?</p>
322</td>
323</tr>
324<tr class="answer">
325<td align="left" valign="top"></td>
326<td align="left" valign="top">
327<p>There is a template for header <a href=
328"../new_header.txt?format=raw" target="_top">new_header.txt</a>
329which can be parsed by <span class="application">IDLdoc</span>.</p>
330<p>This file can be added in <span class="application">Emacs</span>
331configuration <span class="guimenu">IDLWAVE</span> &rarr;
332<span class="guimenuitem">Templates</span> &rarr; <span class=
333"guimenuitem">Doc Header</span> (<span><strong class=
334"shortcut"><span class="keysym">C-c</span>-<span class=
335"keysym">C-h</span></strong></span>). in your <code class=
336"filename">${HOME}/.emacs</code> like this :</p>
337<pre class="programlisting">
338(add-hook 'idlwave-mode-hook
339  (function
340    (lambda ()
341     (setq idlwave-file-header '("<em class=
342"replaceable"><code>SAXO_basedirectory</code></em>/SAXO_DIR/SRC/Documentation/new_header.txt")
343    ))))
344</pre></td>
345</tr>
346<tr class="question">
347<td align="left" valign="top"><a name="d0e208" id=
348"d0e208"></a><a name="d0e209" id="d0e209"></a><b>4.2.</b></td>
349<td align="left" valign="top">
350<p>Is there any trouble with <span class=
351"application">IDLdoc</span> ?</p>
352</td>
353</tr>
354<tr class="answer">
355<td align="left" valign="top"></td>
356<td align="left" valign="top">
357<p>Yes, there are some :</p>
358<div class="itemizedlist">
359<ul type="disc">
360<li>
361<p><code class="literal">\</code> in <code class=
362"filename">*.pro</code> are not written in <code class=
363"filename">*.html</code>. They must be escaped by an other
364<code class="literal">\</code> or you can choose an other
365character.</p>
366</li>
367<li>
368<p><span class="guimenu">Search</span> does'nt handle characters
369like <code class="literal">-</code> and <code class=
370"literal">|</code>.</p>
371</li>
372<li>
373<p>Paragraphs of <code class="filename">*.pro</code> headers are
374shown with a proportional font in the <code class=
375"literal">HTML</code> release.</p>
376<p>If you need to draw some small figure like grid cell, you can
377encapsulate between the block to be shown in constant font between
378<code class="literal">; &lt;fixe&gt;</code> and <code class=
379"literal">; &lt;/fixe&gt;</code></p>
380</li>
381</ul>
382</div>
383<p>Unfortunately, these troubles may not be fixed because the
384author does not have anymore the opportunity to work on his own
385work.</p>
386<p>Bugs can be submitted to IDL but we do not expect answers !</p>
387</td>
388</tr>
389</tbody>
390</table>
391</div>
392</div>
393</body>
394</html>
Note: See TracBrowser for help on using the repository browser.