source: trunk/SRC/Documentation/xmldoc/wiki/FaqSaxo @ 347

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

add wiki production tools and outputs
File size: 14.8 KB
Line 
1{{{
2#!html
3<div xmlns="http://www.w3.org/1999/xhtml" class="article" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="faqsaxo" id="faqsaxo"/>Frequently Asked questions about SAXO</h2></div><div><div class="authorgroup">
4      <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>
5      <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>
6    </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>
7      <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>
8      <tr><td align="left">Revision 0.1</td><td align="left">September 2006</td></tr><tr><td align="left" colspan="2">+ onlinehelp</td></tr>
9      <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>
10    </table></div></div></div><hr/></div>
11
12
13
14 
15
16<div class="qandaset"><dl><dt>1.  <a href="#general">General</a></dt><dd><dl><dt>1.1. <a href="#id2550383">
17What is SAXO ?
18</a></dt><dt>1.2. <a href="#id2550402">
19How can I get help ?
20</a></dt><dt>1.3. <a href="#id2550427">
21How do I get SAXO ?
22</a></dt><dt>1.4. <a href="#id2550452">
23What is the current version of SAXO ?
24</a></dt><dt>1.5. <a href="#id2550477">
25On what systems does SAXO run ?
26</a></dt><dt>1.6. <a href="#id2550497">
27Does SAXO works with GDL instead of IDL ?
28</a></dt><dt>1.7. <a href="#id2550520">
29When is the next version of SAXO due out ?
30</a></dt><dt>1.8. <a href="#id2550540">
31How can I find if a routine to do what I want already exists ?
32</a></dt><dt>1.9. <a href="#id2550560">
33How should SAXO be cited or acknowledged in publication ?
34</a></dt></dl></dd><dt>2.  <a href="#technical">Technical questions</a></dt><dd><dl><dt>2.1. <a href="#id2550587">
35Is there on-line help for SAXO ?
36</a></dt></dl></dd><dt>3.  <a href="#Contributors">Contributors</a></dt><dd><dl><dt>3.1. <a href="#id2550642">
37Is there an SAXO Style Guide available ?
38</a></dt><dt>3.2. <a href="#id2550657">
39Is there any trouble with IDLdoc ?
40</a></dt><dt>3.3. <a href="#id2550833">
41How can I check spelling of XML files ?
42</a></dt><dt>3.4. <a href="#id2550879">
43How can I check spelling of IDL files ?
44</a></dt><dt>3.5. <a href="#id2550977">
45How can I see online help update ?
46</a></dt></dl></dd></dl><p>
47This is a list of Frequently Asked Questions about SAXO.
48</p><p>
49This list is roughly divided into categories: general questions,
50technical questions, contributors questions.
51</p><p>
52Suggestions 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>.
53</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"/>1. General</h3></td></tr><tr class="toc"><td align="left" valign="top" colspan="2"><dl><dt>1.1. <a href="#id2550383">
54What is SAXO ?
55</a></dt><dt>1.2. <a href="#id2550402">
56How can I get help ?
57</a></dt><dt>1.3. <a href="#id2550427">
58How do I get SAXO ?
59</a></dt><dt>1.4. <a href="#id2550452">
60What is the current version of SAXO ?
61</a></dt><dt>1.5. <a href="#id2550477">
62On what systems does SAXO run ?
63</a></dt><dt>1.6. <a href="#id2550497">
64Does SAXO works with GDL instead of IDL ?
65</a></dt><dt>1.7. <a href="#id2550520">
66When is the next version of SAXO due out ?
67</a></dt><dt>1.8. <a href="#id2550540">
68How can I find if a routine to do what I want already exists ?
69</a></dt><dt>1.9. <a href="#id2550560">
70How should SAXO be cited or acknowledged in publication ?
71</a></dt></dl></td></tr>
72<tr class="question"><td align="left" valign="top"><a name="id2550383" id="id2550383"/><a name="id2550385" id="id2550385"/><b>1.1.</b></td><td align="left" valign="top"><p>
73What is SAXO ?
74</p></td></tr>
75<tr class="answer"><td align="left" valign="top"/><td align="left" valign="top"><p>
76see document <a href="./whatissaxo.html" target="_top">What is SAXO</a>.
77</p></td></tr>
78
79<tr class="question"><td align="left" valign="top"><a name="id2550402" id="id2550402"/><a name="id2550412" id="id2550412"/><b>1.2.</b></td><td align="left" valign="top"><p>
80How can I get help ?
81</p></td></tr>
82<tr class="answer"><td align="left" valign="top"/><td align="left" valign="top"><p>
83see Support in document <a href="./websaxo.html" target="_top">Main page of SAXO</a>.
84</p></td></tr>
85
86<tr class="question"><td align="left" valign="top"><a name="id2550427" id="id2550427"/><a name="id2550437" id="id2550437"/><b>1.3.</b></td><td align="left" valign="top"><p>
87How do I get SAXO ?
88</p></td></tr>
89<tr class="answer"><td align="left" valign="top"/><td align="left" valign="top"><p>
90see document <a href="./getsaxo.html" target="_top">Get SAXO</a>.
91</p></td></tr>
92
93<tr class="question"><td align="left" valign="top"><a name="id2550452" id="id2550452"/><a name="id2550462" id="id2550462"/><b>1.4.</b></td><td align="left" valign="top"><p>
94What is the current version of SAXO ?
95</p></td></tr>
96<tr class="answer"><td align="left" valign="top"/><td align="left" valign="top"><p>
97</p></td></tr>
98
99<tr class="question"><td align="left" valign="top"><a name="id2550477" id="id2550477"/><a name="id2550480" id="id2550480"/><b>1.5.</b></td><td align="left" valign="top"><p>
100On what systems does SAXO run ?
101</p></td></tr>
102<tr class="answer"><td align="left" valign="top"/><td align="left" valign="top"><p>
103</p></td></tr>
104
105<tr class="question"><td align="left" valign="top"><a name="id2550497" id="id2550497"/><a name="id2550499" id="id2550499"/><b>1.6.</b></td><td align="left" valign="top"><p>
106Does SAXO works with GDL instead of IDL ?
107</p></td></tr>
108<tr class="answer"><td align="left" valign="top"/><td align="left" valign="top"><p>
109Not yet.
110</p></td></tr>
111
112<tr class="question"><td align="left" valign="top"><a name="id2550520" id="id2550520"/><a name="id2550522" id="id2550522"/><b>1.7.</b></td><td align="left" valign="top"><p>
113When is the next version of SAXO due out ?
114</p></td></tr>
115<tr class="answer"><td align="left" valign="top"/><td align="left" valign="top"><p>
116</p></td></tr>
117
118<tr class="question"><td align="left" valign="top"><a name="id2550540" id="id2550540"/><a name="id2550542" id="id2550542"/><b>1.8.</b></td><td align="left" valign="top"><p>
119How can I find if a routine to do what I want already exists ?
120</p></td></tr>
121<tr class="answer"><td align="left" valign="top"/><td align="left" valign="top"><p>
122</p></td></tr>
123
124<tr class="question"><td align="left" valign="top"><a name="id2550560" id="id2550560"/><a name="id2550562" id="id2550562"/><b>1.9.</b></td><td align="left" valign="top"><p>
125How should SAXO be cited or acknowledged in publication ?
126</p></td></tr>
127<tr class="answer"><td align="left" valign="top"/><td align="left" valign="top"><p>
128</p></td></tr>
129<tr class="qandadiv"><td align="left" valign="top" colspan="2"><h3 class="title"><a name="technical" id="technical"/>2. Technical questions</h3></td></tr><tr class="toc"><td align="left" valign="top" colspan="2"><dl><dt>2.1. <a href="#id2550587">
130Is there on-line help for SAXO ?
131</a></dt></dl></td></tr>
132<tr class="question"><td align="left" valign="top"><a name="id2550587" id="id2550587"/><a name="id2550589" id="id2550589"/><b>2.1.</b></td><td align="left" valign="top"><p>
133Is there on-line help for SAXO ?
134</p></td></tr>
135<tr class="answer"><td align="left" valign="top"/><td align="left" valign="top"><p>
136Yes, 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:
137     </p><pre class="screen">
138       <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">?</strong></span></code></strong>
139     </pre><p>
140</p></td></tr>
141<tr class="qandadiv"><td align="left" valign="top" colspan="2"><h3 class="title"><a name="Contributors" id="Contributors"/>3. Contributors</h3></td></tr><tr class="toc"><td align="left" valign="top" colspan="2"><dl><dt>3.1. <a href="#id2550642">
142Is there an SAXO Style Guide available ?
143</a></dt><dt>3.2. <a href="#id2550657">
144Is there any trouble with IDLdoc ?
145</a></dt><dt>3.3. <a href="#id2550833">
146How can I check spelling of XML files ?
147</a></dt><dt>3.4. <a href="#id2550879">
148How can I check spelling of IDL files ?
149</a></dt><dt>3.5. <a href="#id2550977">
150How can I see online help update ?
151</a></dt></dl></td></tr>
152<tr class="question"><td align="left" valign="top"><a name="id2550642" id="id2550642"/><a name="id2550644" id="id2550644"/><b>3.1.</b></td><td align="left" valign="top"><p>
153Is there an SAXO Style Guide available ?
154</p></td></tr>
155<tr class="answer"><td align="left" valign="top"/><td align="left" valign="top"><p>
156There is a template for header <a href="../new_header.txt" target="_top">new_header.txt</a>
157which can be parsed by <span class="application">IDLdoc</span>.
158</p><p>
159This file can be added in <span class="application">Emacs</span> configuration
160<span class="guimenu">IDLWAVE</span> â†’ <span class="guimenuitem">Templates</span> â†’ <span class="guimenuitem">Doc Header</span> (<span><strong class="shortcut">
161    <span class="keysym">C-c</span>-<span class="keysym">C-h</span>
162  </strong></span>).
163in your <code class="filename">${HOME}/.emacs</code> like this :
164</p><pre class="programlisting">
165(add-hook 'idlwave-mode-hook
166  (function
167    (lambda ()
168     (setq idlwave-file-header '("<em class="replaceable"><code>SAXO_basedirectory</code></em>/SAXO_DIR/SRC/Documentation/new_header.txt")
169    ))))
170</pre><p>
171</p></td></tr>
172
173<tr class="question"><td align="left" valign="top"><a name="id2550657" id="id2550657"/><a name="id2550719" id="id2550719"/><b>3.2.</b></td><td align="left" valign="top"><p>
174Is there any trouble with <span class="application">IDLdoc</span> ?
175</p></td></tr>
176<tr class="answer"><td align="left" valign="top"/><td align="left" valign="top"><p>
177Yes, there are some :
178</p><div class="itemizedlist"><ul type="disc"><li>
179<p>
180<code class="literal">\</code> in <code class="filename">*.pro</code> are not written
181in <code class="filename">*.html</code>.
182They must be escaped by an other <code class="literal">\</code> or you can choose an other character.
183</p>
184</li><li>
185<p>
186<span class="guimenu">Search</span> doesn't handle characters like <code class="literal">-</code>
187and <code class="literal">|</code>.
188</p>
189</li><li>
190<p>
191Paragraphs of <code class="filename">*.pro</code> headers are shown with a proportional
192font in the <code class="literal">HTML</code> release.
193</p>
194<p>
195If you need to draw some small figure like grid cell, you can encapsulate
196the block to be shown in constant font
197between
198<code class="literal">; &lt;fixe&gt;</code> and
199<code class="literal">; &lt;/fixe&gt;</code>
200</p>
201</li></ul></div><p>
202</p><p>
203Unfortunately, these troubles may not be fixed because the author does not
204have anymore the opportunity to work on his own work.
205</p><p>
206Bugs can be submitted to IDL but we do not expect answers !
207
208</p></td></tr>
209
210<tr class="question"><td align="left" valign="top"><a name="id2550833" id="id2550833"/><a name="id2550835" id="id2550835"/><b>3.3.</b></td><td align="left" valign="top"><p>
211How can I check spelling of XML files ?
212</p></td></tr>
213<tr class="answer"><td align="left" valign="top"/><td align="left" valign="top"><p>
214There is one way with command line :
215     </p><pre class="screen">
216       <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>
217     </pre><p>
218</p></td></tr>
219
220<tr class="question"><td align="left" valign="top"><a name="id2550879" id="id2550879"/><a name="id2550881" id="id2550881"/><b>3.4.</b></td><td align="left" valign="top"><p>
221How can I check spelling of IDL files ?
222</p></td></tr>
223<tr class="answer"><td align="left" valign="top"/><td align="left" valign="top"><p>
224Not so easy but you can start with something like this :
225     </p><pre class="screen">
226       <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>
227       <code class="prompt">$</code> <strong class="userinput"><code>list=$(find . -name "*.pro")</code></strong>
228       <code class="prompt">$</code> <strong class="userinput"><code>for file in ${list}; do aspell list &lt; ${file}; done &gt; /tmp/list_word </code></strong>
229       <code class="prompt">$</code> <strong class="userinput"><code>sort -u /tmp/list_word &gt; /tmp/list_sort</code></strong>
230     </pre><p>
231</p><p>
232This will give <code class="filename">/tmp/list_sort</code> a list of sorted word
233used in IDL files that are not in the default dictionnary.
234Some of these words are correct in IDL and SAXO vocabulary, so they do not have to be replaced but some typo can be found.
235</p><p>
236To find occurences of one of these misspelled words, you have to do this :
237     </p><pre class="screen">
238       <code class="prompt">$</code> <strong class="userinput"><code>find . -name "*.pro" -exec grep -h "<em class="replaceable"><code>misspelled_word</code></em>" {} \;</code></strong>
239     </pre><p>
240</p><p>
241We should improve this by providing some IDL and SAXO dictionnary.
242</p></td></tr>
243
244<tr class="question"><td align="left" valign="top"><a name="id2550977" id="id2550977"/><a name="id2550979" id="id2550979"/><b>3.5.</b></td><td align="left" valign="top"><p>
245How can I see online help update ?
246</p></td></tr>
247<tr class="answer"><td align="left" valign="top"/><td align="left" valign="top"><p>
248You 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 :
249     </p><pre class="screen">
250       <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>
251     </pre><p>
252</p></td></tr>
253</tbody></table></div>
254</div>
255
256}}}
Note: See TracBrowser for help on using the repository browser.