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

Last change on this file since 376 was 346, checked in by pinsard, 16 years ago

migration from
\DocBook 4 to \DocBook 5 : production outputs
File size: 15.7 KB
Line 
1<?xml version="1.0" encoding="utf-8"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4  <head>
5    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6    <title>Frequently Asked questions about SAXO</title>
7    <link rel="stylesheet" href="style.css" type="text/css" />
8    <link rel="stylesheet" href="saxo.css" type="text/css" />
9    <link rev="made" href="mailto:saxo-dev_at_forge.ipsl.jussieu.fr" />
10    <meta name="generator" content="DocBook XSL Stylesheets V1.71.1" />
11    <meta name="keywords" content="IDL, SAXO, FAQ" />
12  </head>
13  <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14    <div class="article" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="faqsaxo" id="faqsaxo"></a>Frequently Asked questions about SAXO</h2></div><div><div class="authorgroup">
15      <div class="author"><h3 class="author"><span class="firstname">Sébastien</span> <span class="surname">Masson</span> <code class="email">&lt;<a href="mailto:Sebastien.Masson_at_locean-ipsl.upmc.fr">Sebastien.Masson_at_locean-ipsl.upmc.fr</a>&gt;</code></h3></div>
16      <div class="author"><h3 class="author"><span class="firstname">Françoise</span> <span class="surname">Pinsard</span> <code class="email">&lt;<a href="mailto:Francoise.Pinsard_at_locean-ipsl.upmc.fr">Francoise.Pinsard_at_locean-ipsl.upmc.fr</a>&gt;</code></h3></div>
17    </div></div><div><span class="pubdate">svn Id of xml source file : $Id: faqsaxo.xml 345 2008-04-16 09:15:20Z pinsard $<br /><br /></span></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="2"><b>Revision History</b></th></tr>
18      <tr><td align="left">Revision 0.0</td><td align="left">August 2006</td></tr><tr><td align="left" colspan="2">First draft</td></tr>
19      <tr><td align="left">Revision 0.1</td><td align="left">September 2006</td></tr><tr><td align="left" colspan="2">+ onlinehelp</td></tr>
20      <tr><td align="left">Revision 0.2</td><td align="left">April 2008</td></tr><tr><td align="left" colspan="2">migration from DocBook 4.2 to Docbook 5.0</td></tr>
21    </table></div></div></div><hr /></div>
22
23
24
25 
26
27<div class="qandaset"><dl><dt>1.  <a href="#general">General</a></dt><dd><dl><dt>1.1. <a href="#id2550383">
28What is SAXO ?
29</a></dt><dt>1.2. <a href="#id2550402">
30How can I get help ?
31</a></dt><dt>1.3. <a href="#id2550427">
32How do I get SAXO ?
33</a></dt><dt>1.4. <a href="#id2550452">
34What is the current version of SAXO ?
35</a></dt><dt>1.5. <a href="#id2550477">
36On what systems does SAXO run ?
37</a></dt><dt>1.6. <a href="#id2550497">
38Does SAXO works with GDL instead of IDL ?
39</a></dt><dt>1.7. <a href="#id2550520">
40When is the next version of SAXO due out ?
41</a></dt><dt>1.8. <a href="#id2550540">
42How can I find if a routine to do what I want already exists ?
43</a></dt><dt>1.9. <a href="#id2550560">
44How should SAXO be cited or acknowledged in publication ?
45</a></dt></dl></dd><dt>2.  <a href="#technical">Technical questions</a></dt><dd><dl><dt>2.1. <a href="#id2550587">
46Is there on-line help for SAXO ?
47</a></dt></dl></dd><dt>3.  <a href="#Contributors">Contributors</a></dt><dd><dl><dt>3.1. <a href="#id2550642">
48Is there an SAXO Style Guide available ?
49</a></dt><dt>3.2. <a href="#id2550657">
50Is there any trouble with IDLdoc ?
51</a></dt><dt>3.3. <a href="#id2550833">
52How can I check spelling of XML files ?
53</a></dt><dt>3.4. <a href="#id2550879">
54How can I check spelling of IDL files ?
55</a></dt><dt>3.5. <a href="#id2550977">
56How can I see online help update ?
57</a></dt></dl></dd></dl><p>
58This is a list of Frequently Asked Questions about SAXO.
59</p><p>
60This list is roughly divided into categories: general questions,
61technical questions, contributors questions.
62</p><p>
63Suggestions for corrections or additional sections are welcome -- please email them to <code class="email">&lt;<a href="mailto:saxo-dev@forge.ipsl.jussieu.fr">saxo-dev@forge.ipsl.jussieu.fr</a>&gt;</code>.
64</p><table border="0" summary="Q and A Set"><col align="left" width="1%" /><tbody><tr class="qandadiv"><td align="left" valign="top" colspan="2"><h3 class="title"><a name="general" id="general"></a>1. General</h3></td></tr><tr class="toc"><td align="left" valign="top" colspan="2"><dl><dt>1.1. <a href="#id2550383">
65What is SAXO ?
66</a></dt><dt>1.2. <a href="#id2550402">
67How can I get help ?
68</a></dt><dt>1.3. <a href="#id2550427">
69How do I get SAXO ?
70</a></dt><dt>1.4. <a href="#id2550452">
71What is the current version of SAXO ?
72</a></dt><dt>1.5. <a href="#id2550477">
73On what systems does SAXO run ?
74</a></dt><dt>1.6. <a href="#id2550497">
75Does SAXO works with GDL instead of IDL ?
76</a></dt><dt>1.7. <a href="#id2550520">
77When is the next version of SAXO due out ?
78</a></dt><dt>1.8. <a href="#id2550540">
79How can I find if a routine to do what I want already exists ?
80</a></dt><dt>1.9. <a href="#id2550560">
81How should SAXO be cited or acknowledged in publication ?
82</a></dt></dl></td></tr>
83<tr class="question"><td align="left" valign="top"><a name="id2550383" id="id2550383"></a><a name="id2550385" id="id2550385"></a><b>1.1.</b></td><td align="left" valign="top"><p>
84What is SAXO ?
85</p></td></tr>
86<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
87see document <a href="./whatissaxo.html" target="_top">What is SAXO</a>.
88</p></td></tr>
89
90<tr class="question"><td align="left" valign="top"><a name="id2550402" id="id2550402"></a><a name="id2550412" id="id2550412"></a><b>1.2.</b></td><td align="left" valign="top"><p>
91How can I get help ?
92</p></td></tr>
93<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
94see Support in document <a href="./websaxo.html" target="_top">Main page of SAXO</a>.
95</p></td></tr>
96
97<tr class="question"><td align="left" valign="top"><a name="id2550427" id="id2550427"></a><a name="id2550437" id="id2550437"></a><b>1.3.</b></td><td align="left" valign="top"><p>
98How do I get SAXO ?
99</p></td></tr>
100<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
101see document <a href="./getsaxo.html" target="_top">Get SAXO</a>.
102</p></td></tr>
103
104<tr class="question"><td align="left" valign="top"><a name="id2550452" id="id2550452"></a><a name="id2550462" id="id2550462"></a><b>1.4.</b></td><td align="left" valign="top"><p>
105What is the current version of SAXO ?
106</p></td></tr>
107<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
108</p></td></tr>
109
110<tr class="question"><td align="left" valign="top"><a name="id2550477" id="id2550477"></a><a name="id2550480" id="id2550480"></a><b>1.5.</b></td><td align="left" valign="top"><p>
111On what systems does SAXO run ?
112</p></td></tr>
113<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
114</p></td></tr>
115
116<tr class="question"><td align="left" valign="top"><a name="id2550497" id="id2550497"></a><a name="id2550499" id="id2550499"></a><b>1.6.</b></td><td align="left" valign="top"><p>
117Does SAXO works with GDL instead of IDL ?
118</p></td></tr>
119<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
120Not yet.
121</p></td></tr>
122
123<tr class="question"><td align="left" valign="top"><a name="id2550520" id="id2550520"></a><a name="id2550522" id="id2550522"></a><b>1.7.</b></td><td align="left" valign="top"><p>
124When is the next version of SAXO due out ?
125</p></td></tr>
126<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
127</p></td></tr>
128
129<tr class="question"><td align="left" valign="top"><a name="id2550540" id="id2550540"></a><a name="id2550542" id="id2550542"></a><b>1.8.</b></td><td align="left" valign="top"><p>
130How can I find if a routine to do what I want already exists ?
131</p></td></tr>
132<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
133</p></td></tr>
134
135<tr class="question"><td align="left" valign="top"><a name="id2550560" id="id2550560"></a><a name="id2550562" id="id2550562"></a><b>1.9.</b></td><td align="left" valign="top"><p>
136How should SAXO be cited or acknowledged in publication ?
137</p></td></tr>
138<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
139</p></td></tr>
140<tr class="qandadiv"><td align="left" valign="top" colspan="2"><h3 class="title"><a name="technical" id="technical"></a>2. Technical questions</h3></td></tr><tr class="toc"><td align="left" valign="top" colspan="2"><dl><dt>2.1. <a href="#id2550587">
141Is there on-line help for SAXO ?
142</a></dt></dl></td></tr>
143<tr class="question"><td align="left" valign="top"><a name="id2550587" id="id2550587"></a><a name="id2550589" id="id2550589"></a><b>2.1.</b></td><td align="left" valign="top"><p>
144Is there on-line help for SAXO ?
145</p></td></tr>
146<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
147Yes, if you use at least IDL 6.2. It is produced by <span class="application"><a href="http://www.ittvis.com/codebank/search.asp?FID=100" target="_top">IDLdoc</a></span>. SAXO and IDL online_help have been merged, you can simply get the help by typing:
148     </p><pre class="screen">
149       <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">?</strong></span></code></strong>
150     </pre><p>
151</p></td></tr>
152<tr class="qandadiv"><td align="left" valign="top" colspan="2"><h3 class="title"><a name="Contributors" id="Contributors"></a>3. Contributors</h3></td></tr><tr class="toc"><td align="left" valign="top" colspan="2"><dl><dt>3.1. <a href="#id2550642">
153Is there an SAXO Style Guide available ?
154</a></dt><dt>3.2. <a href="#id2550657">
155Is there any trouble with IDLdoc ?
156</a></dt><dt>3.3. <a href="#id2550833">
157How can I check spelling of XML files ?
158</a></dt><dt>3.4. <a href="#id2550879">
159How can I check spelling of IDL files ?
160</a></dt><dt>3.5. <a href="#id2550977">
161How can I see online help update ?
162</a></dt></dl></td></tr>
163<tr class="question"><td align="left" valign="top"><a name="id2550642" id="id2550642"></a><a name="id2550644" id="id2550644"></a><b>3.1.</b></td><td align="left" valign="top"><p>
164Is there an SAXO Style Guide available ?
165</p></td></tr>
166<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
167There is a template for header <a href="../new_header.txt" target="_top">new_header.txt</a>
168which can be parsed by <span class="application">IDLdoc</span>.
169</p><p>
170This file can be added in <span class="application">Emacs</span> configuration
171<span class="guimenu">IDLWAVE</span> â†’ <span class="guimenuitem">Templates</span> â†’ <span class="guimenuitem">Doc Header</span> (<span><strong class="shortcut">
172    <span class="keysym">C-c</span>-<span class="keysym">C-h</span>
173  </strong></span>).
174in your <code class="filename">${HOME}/.emacs</code> like this :
175</p><pre class="programlisting">
176(add-hook 'idlwave-mode-hook
177  (function
178    (lambda ()
179     (setq idlwave-file-header '("<em class="replaceable"><code>SAXO_basedirectory</code></em>/SAXO_DIR/SRC/Documentation/new_header.txt")
180    ))))
181</pre><p>
182</p></td></tr>
183
184<tr class="question"><td align="left" valign="top"><a name="id2550657" id="id2550657"></a><a name="id2550719" id="id2550719"></a><b>3.2.</b></td><td align="left" valign="top"><p>
185Is there any trouble with <span class="application">IDLdoc</span> ?
186</p></td></tr>
187<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
188Yes, there are some :
189</p><div class="itemizedlist"><ul type="disc"><li>
190<p>
191<code class="literal">\</code> in <code class="filename">*.pro</code> are not written
192in <code class="filename">*.html</code>.
193They must be escaped by an other <code class="literal">\</code> or you can choose an other character.
194</p>
195</li><li>
196<p>
197<span class="guimenu">Search</span> doesn't handle characters like <code class="literal">-</code>
198and <code class="literal">|</code>.
199</p>
200</li><li>
201<p>
202Paragraphs of <code class="filename">*.pro</code> headers are shown with a proportional
203font in the <code class="literal">HTML</code> release.
204</p>
205<p>
206If you need to draw some small figure like grid cell, you can encapsulate
207the block to be shown in constant font
208between
209<code class="literal">; &lt;fixe&gt;</code> and
210<code class="literal">; &lt;/fixe&gt;</code>
211</p>
212</li></ul></div><p>
213</p><p>
214Unfortunately, these troubles may not be fixed because the author does not
215have anymore the opportunity to work on his own work.
216</p><p>
217Bugs can be submitted to IDL but we do not expect answers !
218
219</p></td></tr>
220
221<tr class="question"><td align="left" valign="top"><a name="id2550833" id="id2550833"></a><a name="id2550835" id="id2550835"></a><b>3.3.</b></td><td align="left" valign="top"><p>
222How can I check spelling of XML files ?
223</p></td></tr>
224<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
225There is one way with command line :
226     </p><pre class="screen">
227       <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">aspell</strong></span> <code class="option">--mode=sgml</code> <code class="option">-c</code> <code class="filename"><em class="replaceable"><code>xmlfile</code></em></code></code></strong>
228     </pre><p>
229</p></td></tr>
230
231<tr class="question"><td align="left" valign="top"><a name="id2550879" id="id2550879"></a><a name="id2550881" id="id2550881"></a><b>3.4.</b></td><td align="left" valign="top"><p>
232How can I check spelling of IDL files ?
233</p></td></tr>
234<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
235Not so easy but you can start with something like this :
236     </p><pre class="screen">
237       <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> <code class="filename">${HOME}/SAXO_DIR/SRC/</code></code></strong>
238       <code class="prompt">$</code> <strong class="userinput"><code>list=$(find . -name "*.pro")</code></strong>
239       <code class="prompt">$</code> <strong class="userinput"><code>for file in ${list}; do aspell list &lt; ${file}; done &gt; /tmp/list_word </code></strong>
240       <code class="prompt">$</code> <strong class="userinput"><code>sort -u /tmp/list_word &gt; /tmp/list_sort</code></strong>
241     </pre><p>
242</p><p>
243This will give <code class="filename">/tmp/list_sort</code> a list of sorted word
244used in IDL files that are not in the default dictionnary.
245Some of these words are correct in IDL and SAXO vocabulary, so they do not have to be replaced but some typo can be found.
246</p><p>
247To find occurences of one of these misspelled words, you have to do this :
248     </p><pre class="screen">
249       <code class="prompt">$</code> <strong class="userinput"><code>find . -name "*.pro" -exec grep -h "<em class="replaceable"><code>misspelled_word</code></em>" {} \;</code></strong>
250     </pre><p>
251</p><p>
252We should improve this by providing some IDL and SAXO dictionnary.
253</p></td></tr>
254
255<tr class="question"><td align="left" valign="top"><a name="id2550977" id="id2550977"></a><a name="id2550979" id="id2550979"></a><b>3.5.</b></td><td align="left" valign="top"><p>
256How can I see online help update ?
257</p></td></tr>
258<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>
259You won't see  online help update if you are working with the official distribution because of <code class="varname">!HELP_PATH</code>. To override this problem, when you are in <code class="filename"><em class="replaceable"><code>SAXO_basedirectory</code></em>/SAXO_DIR/SRC/Documentation/xmldoc/</code>,  you can call online help like this :
260     </p><pre class="screen">
261       <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">ONLINE_HELP</strong></span>,<code class="option">book="../idldoc_assistant_output/idldoc-lib.adp"</code></code></strong>
262     </pre><p>
263</p></td></tr>
264</tbody></table></div>
265</div>
266  </body>
267</html>
Note: See TracBrowser for help on using the repository browser.