1 | <?xml version="1.0" encoding="iso-8859-1"?> |
---|
2 | <!DOCTYPE article [ |
---|
3 | <!ENTITY promptidl "idl>"> |
---|
4 | ]> |
---|
5 | |
---|
6 | <article version="5.0" |
---|
7 | xmlns="http://docbook.org/ns/docbook" |
---|
8 | xmlns:xl="http://www.w3.org/1999/xlink" |
---|
9 | xml:lang="en" |
---|
10 | xml:id="faqsaxo"> |
---|
11 | |
---|
12 | <!-- |
---|
13 | en s'inspirant de |
---|
14 | http://www.csc.fi/math_topics/Mail/FAQ/msg00069.html |
---|
15 | pour les questions |
---|
16 | on pourra aussi s'inspirer de http://idlastro.gsfc.nasa.gov/idlfaq.html |
---|
17 | |
---|
18 | !! on notera l'utilisation hypersioux de xinclude xpointer pour ne pas répéter |
---|
19 | (avec des erreurs, forcément) ce qui est déjà écrit dans un autre document |
---|
20 | !! |
---|
21 | cf http://www.zvon.org/xxl/XIncludeTutorial/Output/example9.html |
---|
22 | cf http://www.zvon.org/xxl/XIncludeTutorial/Output/example12.html |
---|
23 | bon finalement c'est pas si hyper rusé parce qu'on hérite du plan (sect1 par |
---|
24 | exemple de l'entité incluse) |
---|
25 | --> |
---|
26 | <title>Frequently Asked Questions about SAXO</title> |
---|
27 | <info> |
---|
28 | <authorgroup> |
---|
29 | <author><personname><firstname>Sébastien</firstname> <surname>Masson</surname></personname> <email>Sebastien.Masson_at_locean-ipsl.upmc.fr</email></author> |
---|
30 | <author><personname><firstname>Françoise</firstname> <surname>Pinsard</surname></personname> <email>Francoise.Pinsard_at_locean-ipsl.upmc.fr</email></author> |
---|
31 | </authorgroup> |
---|
32 | <keywordset> |
---|
33 | <keyword>IDL</keyword> |
---|
34 | <keyword>SAXO</keyword> |
---|
35 | <keyword>FAQ</keyword> |
---|
36 | </keywordset> |
---|
37 | <revhistory> |
---|
38 | <revision> |
---|
39 | <revnumber>0.0</revnumber> |
---|
40 | <date>August 2006</date> |
---|
41 | <revremark>First draft</revremark> |
---|
42 | </revision> |
---|
43 | <revision> |
---|
44 | <revnumber>0.1</revnumber> |
---|
45 | <date>September 2006</date> |
---|
46 | <revremark>+ onlinehelp</revremark> |
---|
47 | </revision> |
---|
48 | <revision> |
---|
49 | <revnumber>0.2</revnumber> |
---|
50 | <date>April 2008</date> |
---|
51 | <revremark>migration from DocBook 4.2 to Docbook 5.0</revremark> |
---|
52 | </revision> |
---|
53 | </revhistory> |
---|
54 | <pubdate>$Id$</pubdate> |
---|
55 | </info> |
---|
56 | |
---|
57 | <qandaset> |
---|
58 | <para> |
---|
59 | This is a list of Frequently Asked Questions about SAXO. |
---|
60 | </para> |
---|
61 | <para> |
---|
62 | This list is roughly divided into categories: general questions, |
---|
63 | technical questions, contributors questions. |
---|
64 | </para> |
---|
65 | <para> |
---|
66 | Suggestions for corrections or additional sections are welcome -- please email them to <email>saxo-dev@forge.ipsl.jussieu.fr</email>. |
---|
67 | </para> |
---|
68 | <qandadiv xml:id="general"> |
---|
69 | <title>General</title> |
---|
70 | <qandaentry> |
---|
71 | <question> |
---|
72 | <para> |
---|
73 | What is SAXO ? |
---|
74 | </para> |
---|
75 | </question> |
---|
76 | <answer> |
---|
77 | <para> |
---|
78 | see document <link xl:href="./whatissaxo.html">What is SAXO</link>. |
---|
79 | </para> |
---|
80 | </answer> |
---|
81 | </qandaentry> |
---|
82 | <qandaentry> |
---|
83 | <question> |
---|
84 | <para> |
---|
85 | How can I get help ? |
---|
86 | </para> |
---|
87 | </question> |
---|
88 | <answer> |
---|
89 | <para> |
---|
90 | see Support in document <link xl:href="./websaxo.html">Main page of SAXO</link>. |
---|
91 | </para> |
---|
92 | </answer> |
---|
93 | </qandaentry> |
---|
94 | <qandaentry> |
---|
95 | <question> |
---|
96 | <para> |
---|
97 | How do I get SAXO ? |
---|
98 | </para> |
---|
99 | </question> |
---|
100 | <answer> |
---|
101 | <para> |
---|
102 | see document <link xl:href="./getsaxo.html">Get SAXO</link>. |
---|
103 | </para> |
---|
104 | </answer> |
---|
105 | </qandaentry> |
---|
106 | <qandaentry> |
---|
107 | <question> |
---|
108 | <para> |
---|
109 | What is the current version of SAXO ? |
---|
110 | </para> |
---|
111 | </question> |
---|
112 | <answer> |
---|
113 | <para> |
---|
114 | </para> |
---|
115 | </answer> |
---|
116 | </qandaentry> |
---|
117 | <qandaentry> |
---|
118 | <question> |
---|
119 | <para> |
---|
120 | On what systems does SAXO run ? |
---|
121 | </para> |
---|
122 | </question> |
---|
123 | <answer> |
---|
124 | <para> |
---|
125 | </para> |
---|
126 | </answer> |
---|
127 | </qandaentry> |
---|
128 | <qandaentry> |
---|
129 | <question> |
---|
130 | <para> |
---|
131 | Does SAXO works with GDL instead of IDL ? |
---|
132 | </para> |
---|
133 | </question> |
---|
134 | <answer> |
---|
135 | <para> |
---|
136 | Not yet. <!-- et de toute façon GDL est pour l'instant équivalent à la version |
---|
137 | 6.0 de IDL donc peut-etre que tout SAXO ne fonctionnerait pas --> |
---|
138 | </para> |
---|
139 | </answer> |
---|
140 | </qandaentry> |
---|
141 | <qandaentry> |
---|
142 | <question> |
---|
143 | <para> |
---|
144 | When is the next version of SAXO due out ? |
---|
145 | </para> |
---|
146 | </question> |
---|
147 | <answer> |
---|
148 | <para> |
---|
149 | </para> |
---|
150 | </answer> |
---|
151 | </qandaentry> |
---|
152 | <qandaentry> |
---|
153 | <question> |
---|
154 | <para> |
---|
155 | How can I find if a routine to do what I want already exists ? |
---|
156 | </para> |
---|
157 | </question> |
---|
158 | <answer> |
---|
159 | <para> |
---|
160 | </para> |
---|
161 | </answer> |
---|
162 | </qandaentry> |
---|
163 | <qandaentry> |
---|
164 | <question> |
---|
165 | <para> |
---|
166 | How should SAXO be cited or acknowledged in publication ? |
---|
167 | </para> |
---|
168 | </question> |
---|
169 | <answer> |
---|
170 | <para> |
---|
171 | </para> |
---|
172 | </answer> |
---|
173 | </qandaentry> |
---|
174 | </qandadiv> |
---|
175 | <qandadiv xml:id="technical"> |
---|
176 | <title>Technical questions</title> |
---|
177 | <qandaentry> |
---|
178 | <question> |
---|
179 | <para> |
---|
180 | Is there on-line help for SAXO ? |
---|
181 | </para> |
---|
182 | </question> |
---|
183 | <answer> |
---|
184 | <para> |
---|
185 | Yes, if you use at least IDL 6.2. It is produced by <application><link xl:href="http://www.ittvis.com/codebank/search.asp?FID=100">IDLdoc</link></application>. SAXO and IDL online_help have been merged, you can simply get the help by typing: |
---|
186 | <screen> |
---|
187 | <prompt>&promptidl;</prompt> <userinput><command>?</command></userinput> |
---|
188 | </screen> |
---|
189 | </para> |
---|
190 | </answer> |
---|
191 | </qandaentry> |
---|
192 | </qandadiv> |
---|
193 | <qandadiv xml:id="Contributors"> |
---|
194 | <title>Contributors</title> |
---|
195 | <qandaentry> |
---|
196 | <question> |
---|
197 | <para> |
---|
198 | Is there an SAXO Style Guide available ? |
---|
199 | </para> |
---|
200 | </question> |
---|
201 | <answer> |
---|
202 | <para> |
---|
203 | There is a template for header <link xl:href="../new_header.txt">new_header.txt</link> |
---|
204 | which can be parsed by <application>IDLdoc</application>. |
---|
205 | </para> |
---|
206 | <para> |
---|
207 | This file can be added in <application>Emacs</application> configuration |
---|
208 | <menuchoice> |
---|
209 | <shortcut> |
---|
210 | <keycombo><keysym>C-c</keysym><keysym>C-h</keysym></keycombo> |
---|
211 | </shortcut> |
---|
212 | <guimenu>IDLWAVE</guimenu> |
---|
213 | <guimenuitem>Templates</guimenuitem> |
---|
214 | <guimenuitem>Doc Header</guimenuitem> |
---|
215 | </menuchoice>. |
---|
216 | in your <filename>${HOME}/.emacs</filename> like this : |
---|
217 | <programlisting> |
---|
218 | (add-hook 'idlwave-mode-hook |
---|
219 | (function |
---|
220 | (lambda () |
---|
221 | (setq idlwave-file-header '("<replaceable>SAXO_basedirectory</replaceable>/SAXO_DIR/SRC/Documentation/new_header.txt") |
---|
222 | )))) |
---|
223 | </programlisting> |
---|
224 | </para> |
---|
225 | </answer> |
---|
226 | </qandaentry> |
---|
227 | <qandaentry> |
---|
228 | <question> |
---|
229 | <para> |
---|
230 | Is there any trouble with <application>IDLdoc</application> ? |
---|
231 | </para> |
---|
232 | </question> |
---|
233 | <answer> |
---|
234 | <para> |
---|
235 | Yes, there are some : |
---|
236 | <itemizedlist> |
---|
237 | <listitem> |
---|
238 | <para> |
---|
239 | <literal>\</literal> in <filename>*.pro</filename> are not written |
---|
240 | in <filename>*.html</filename>. |
---|
241 | They must be escaped by an other <literal>\</literal> or you can choose an other character. |
---|
242 | </para> |
---|
243 | </listitem> |
---|
244 | <listitem> |
---|
245 | <para> |
---|
246 | The search facility (<guimenu>Search</guimenu>) doesn't handle characters |
---|
247 | like <literal>-</literal> and <literal>|</literal>. |
---|
248 | </para> |
---|
249 | </listitem> |
---|
250 | <listitem> |
---|
251 | <para> |
---|
252 | Paragraphs of <filename>*.pro</filename> headers are shown with a proportional |
---|
253 | font in the <literal>HTML</literal> release. |
---|
254 | </para> |
---|
255 | <para> |
---|
256 | If you need to draw some small figure like grid cell, you can encapsulate |
---|
257 | the block to be shown in constant font <!-- see savesaxo.sh --> |
---|
258 | between |
---|
259 | <literal>; <fixe></literal> and |
---|
260 | <literal>; </fixe></literal> |
---|
261 | </para> |
---|
262 | </listitem> |
---|
263 | </itemizedlist> |
---|
264 | </para> |
---|
265 | <para> |
---|
266 | Unfortunately, these troubles may not be fixed because the author does not |
---|
267 | have anymore the opportunity to work on his own work. |
---|
268 | </para> |
---|
269 | <para> |
---|
270 | Bugs can be submitted to IDL but we do not expect answers ! |
---|
271 | <!-- ++ rappel du bug soumis --> |
---|
272 | </para> |
---|
273 | </answer> |
---|
274 | </qandaentry> |
---|
275 | <qandaentry> |
---|
276 | <question> |
---|
277 | <para> |
---|
278 | How can I check spelling of XML files ? |
---|
279 | </para> |
---|
280 | </question> |
---|
281 | <answer> |
---|
282 | <para> |
---|
283 | There is one way with command line : |
---|
284 | <screen> |
---|
285 | <prompt>$</prompt> <userinput><command>aspell</command> <option>--mode=sgml</option> <option>-c</option> <filename><replaceable>xmlfile</replaceable></filename></userinput> |
---|
286 | </screen> |
---|
287 | </para> |
---|
288 | </answer> |
---|
289 | </qandaentry> |
---|
290 | <qandaentry> |
---|
291 | <question> |
---|
292 | <para> |
---|
293 | How can I check spelling of IDL files ? |
---|
294 | </para> |
---|
295 | </question> |
---|
296 | <answer> |
---|
297 | <para> |
---|
298 | Not so easy but you can start with something like this : |
---|
299 | <screen> |
---|
300 | <prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">${HOME}/SAXO_DIR/SRC/</filename></userinput> |
---|
301 | <prompt>$</prompt> <userinput>list=$(find . -name "*.pro")</userinput> |
---|
302 | <prompt>$</prompt> <userinput>for file in ${list}; do aspell list < ${file}; done > /tmp/list_word </userinput> |
---|
303 | <prompt>$</prompt> <userinput>sort -u /tmp/list_word > /tmp/list_sort</userinput> |
---|
304 | </screen> |
---|
305 | </para> |
---|
306 | <para> |
---|
307 | This will give <filename>/tmp/list_sort</filename> a list of sorted word |
---|
308 | used in IDL files that are not in the default dictionnary. |
---|
309 | Some of these words are correct in IDL and SAXO vocabulary, so they do not have to be replaced but some typo can be found. |
---|
310 | </para> |
---|
311 | <para> |
---|
312 | To find occurences of one of these misspelled words, you have to do this : |
---|
313 | <screen> |
---|
314 | <prompt>$</prompt> <userinput>find . -name "*.pro" -exec grep -h "<replaceable>misspelled_word</replaceable>" {} \;</userinput> |
---|
315 | </screen> |
---|
316 | </para> |
---|
317 | <para> |
---|
318 | We should improve this by providing some IDL and SAXO dictionnary. <!-- ++ --> |
---|
319 | </para> |
---|
320 | </answer> |
---|
321 | </qandaentry> |
---|
322 | <qandaentry> |
---|
323 | <question> |
---|
324 | <para> |
---|
325 | How can I see online help update ? |
---|
326 | </para> |
---|
327 | </question> |
---|
328 | <answer> |
---|
329 | <para> |
---|
330 | You won't see online help update if you are working with the official distribution because of <varname>!HELP_PATH</varname>. To override this problem, when you are in <filename class="directory"><replaceable>SAXO_basedirectory</replaceable>/SAXO_DIR/SRC/Documentation/xmldoc/</filename>, you can call online help like this : |
---|
331 | <screen> |
---|
332 | <prompt>&promptidl;</prompt> <userinput><command>ONLINE_HELP</command>,<option>book="../idldoc_assistant_output/idldoc-lib.adp"</option></userinput> |
---|
333 | </screen> |
---|
334 | </para> |
---|
335 | </answer> |
---|
336 | </qandaentry> |
---|
337 | </qandadiv> |
---|
338 | </qandaset> |
---|
339 | </article> |
---|