1 | = Frequently Asked questions about SAXO = |
---|
2 | [[PageOutline]] |
---|
3 | |
---|
4 | |
---|
5 | |
---|
6 | |
---|
7 | |
---|
8 | |
---|
9 | |
---|
10 | This is a list of Frequently Asked Questions about SAXO. |
---|
11 | |
---|
12 | |
---|
13 | This list is roughly divided into categories: general questions, |
---|
14 | technical questions, contributors questions. |
---|
15 | |
---|
16 | |
---|
17 | Suggestions for corrections or additional sections are welcome -- please email them to [mailto:saxo-dev@forge.ipsl.jussieu.fr saxo-dev@forge.ipsl.jussieu.fr]. |
---|
18 | |
---|
19 | |
---|
20 | |
---|
21 | == General == |
---|
22 | |
---|
23 | |
---|
24 | |
---|
25 | |
---|
26 | === What is SAXO ? === |
---|
27 | |
---|
28 | |
---|
29 | |
---|
30 | |
---|
31 | see document [wiki:WhatisSaxo What is SAXO]. |
---|
32 | |
---|
33 | |
---|
34 | |
---|
35 | |
---|
36 | |
---|
37 | |
---|
38 | === How can I get help ? === |
---|
39 | |
---|
40 | |
---|
41 | |
---|
42 | |
---|
43 | see Support in document [wiki:WikiStart Main page of SAXO]. |
---|
44 | |
---|
45 | |
---|
46 | |
---|
47 | |
---|
48 | |
---|
49 | |
---|
50 | === How do I get SAXO ? === |
---|
51 | |
---|
52 | |
---|
53 | |
---|
54 | |
---|
55 | see document [wiki:GetSaxo Get SAXO]. |
---|
56 | |
---|
57 | |
---|
58 | |
---|
59 | |
---|
60 | |
---|
61 | |
---|
62 | === What is the current version of SAXO ? === |
---|
63 | |
---|
64 | |
---|
65 | |
---|
66 | |
---|
67 | |
---|
68 | |
---|
69 | |
---|
70 | |
---|
71 | |
---|
72 | === On what systems does SAXO run ? === |
---|
73 | |
---|
74 | |
---|
75 | |
---|
76 | |
---|
77 | |
---|
78 | |
---|
79 | |
---|
80 | |
---|
81 | |
---|
82 | === Does SAXO works with GDL instead of IDL ? === |
---|
83 | |
---|
84 | |
---|
85 | |
---|
86 | |
---|
87 | Not yet. |
---|
88 | |
---|
89 | |
---|
90 | |
---|
91 | |
---|
92 | |
---|
93 | === When is the next version of SAXO due out ? === |
---|
94 | |
---|
95 | |
---|
96 | |
---|
97 | |
---|
98 | |
---|
99 | |
---|
100 | |
---|
101 | |
---|
102 | |
---|
103 | === How can I find if a routine to do what I want already exists ? === |
---|
104 | |
---|
105 | |
---|
106 | |
---|
107 | |
---|
108 | |
---|
109 | |
---|
110 | |
---|
111 | |
---|
112 | |
---|
113 | === How should SAXO be cited or acknowledged in publication ? === |
---|
114 | |
---|
115 | |
---|
116 | |
---|
117 | |
---|
118 | |
---|
119 | |
---|
120 | |
---|
121 | |
---|
122 | |
---|
123 | == Technical questions == |
---|
124 | |
---|
125 | |
---|
126 | |
---|
127 | |
---|
128 | === Is there on-line help for SAXO ? === |
---|
129 | |
---|
130 | |
---|
131 | |
---|
132 | |
---|
133 | Yes, if you use at least IDL 6.2. It is produced by [http://www.ittvis.com/codebank/search.asp?FID=100 IDLdoc]. SAXO and IDL online_help have been merged, you can simply get the help by typing: |
---|
134 | |
---|
135 | {{{ |
---|
136 | #!html |
---|
137 | <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen"> |
---|
138 | <code class="prompt">idl></code> <strong class="userinput"><code><span><strong class="command">?</strong></span></code></strong> |
---|
139 | </pre> |
---|
140 | }}} |
---|
141 | |
---|
142 | |
---|
143 | |
---|
144 | |
---|
145 | |
---|
146 | |
---|
147 | == Contributors == |
---|
148 | |
---|
149 | |
---|
150 | |
---|
151 | |
---|
152 | === Is there an SAXO Style Guide available ? === |
---|
153 | |
---|
154 | |
---|
155 | |
---|
156 | |
---|
157 | There is a template for header [../new_header.txt new_header.txt] |
---|
158 | which can be parsed by IDLdoc. |
---|
159 | |
---|
160 | |
---|
161 | This file can be added in Emacs configuration |
---|
162 | |
---|
163 | |
---|
164 | C-cC-h |
---|
165 | |
---|
166 | IDLWAVE |
---|
167 | Templates |
---|
168 | Doc Header |
---|
169 | . |
---|
170 | in your {{{${HOME}/.emacs}}} like this : |
---|
171 | |
---|
172 | {{{ |
---|
173 | #!html |
---|
174 | <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen"> |
---|
175 | (add-hook 'idlwave-mode-hook |
---|
176 | (function |
---|
177 | (lambda () |
---|
178 | (setq idlwave-file-header '("'''''SAXO_basedirectory'''''/SAXO_DIR/SRC/Documentation/new_header.txt") |
---|
179 | )))) |
---|
180 | </pre> |
---|
181 | }}} |
---|
182 | |
---|
183 | |
---|
184 | |
---|
185 | |
---|
186 | |
---|
187 | |
---|
188 | === Is there any trouble with IDLdoc ? === |
---|
189 | |
---|
190 | |
---|
191 | |
---|
192 | |
---|
193 | Yes, there are some : |
---|
194 | |
---|
195 | * {{{\}}} in {{{*.pro}}} are not written |
---|
196 | in {{{*.html}}}. |
---|
197 | They must be escaped by an other {{{\}}} or you can choose an other character. |
---|
198 | |
---|
199 | * The search facility (Search) doesn't handle characters |
---|
200 | like {{{-}}} and {{{|}}}. |
---|
201 | |
---|
202 | * Paragraphs of {{{*.pro}}} headers are shown with a proportional |
---|
203 | font in the {{{HTML}}} release. |
---|
204 | |
---|
205 | If you need to draw some small figure like grid cell, you can encapsulate |
---|
206 | the block to be shown in constant font |
---|
207 | between |
---|
208 | {{{; <fixe>}}} and |
---|
209 | {{{; </fixe>}}} |
---|
210 | |
---|
211 | Unfortunately, these troubles may not be fixed because the author does not |
---|
212 | have anymore the opportunity to work on his own work. |
---|
213 | |
---|
214 | |
---|
215 | Bugs can be submitted to IDL but we do not expect answers ! |
---|
216 | |
---|
217 | |
---|
218 | |
---|
219 | |
---|
220 | |
---|
221 | |
---|
222 | === How can I check spelling of XML files ? === |
---|
223 | |
---|
224 | |
---|
225 | |
---|
226 | |
---|
227 | There is one way with command line : |
---|
228 | |
---|
229 | {{{ |
---|
230 | #!html |
---|
231 | <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen"> |
---|
232 | <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> xmlfile</code></strong> |
---|
233 | </pre> |
---|
234 | }}} |
---|
235 | |
---|
236 | |
---|
237 | |
---|
238 | |
---|
239 | |
---|
240 | |
---|
241 | === How can I check spelling of IDL files ? === |
---|
242 | |
---|
243 | |
---|
244 | |
---|
245 | |
---|
246 | Not so easy but you can start with something like this : |
---|
247 | |
---|
248 | {{{ |
---|
249 | #!html |
---|
250 | <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen"> |
---|
251 | <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> ${HOME}/SAXO_DIR/SRC/</code></strong> |
---|
252 | <code class="prompt">$</code> <strong class="userinput"><code>list=$(find . -name "*.pro")</code></strong> |
---|
253 | <code class="prompt">$</code> <strong class="userinput"><code>for file in ${list}; do aspell list < ${file}; done > /tmp/list_word </code></strong> |
---|
254 | <code class="prompt">$</code> <strong class="userinput"><code>sort -u /tmp/list_word > /tmp/list_sort</code></strong> |
---|
255 | </pre> |
---|
256 | }}} |
---|
257 | |
---|
258 | |
---|
259 | This will give {{{/tmp/list_sort}}} a list of sorted word |
---|
260 | used in IDL files that are not in the default dictionnary. |
---|
261 | 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. |
---|
262 | |
---|
263 | |
---|
264 | To find occurences of one of these misspelled words, you have to do this : |
---|
265 | |
---|
266 | {{{ |
---|
267 | #!html |
---|
268 | <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen"> |
---|
269 | <code class="prompt">$</code> <strong class="userinput"><code>find . -name "*.pro" -exec grep -h "<code class="replaceable">misspelled_word</code>" {} \;</code></strong> |
---|
270 | </pre> |
---|
271 | }}} |
---|
272 | |
---|
273 | |
---|
274 | We should improve this by providing some IDL and SAXO dictionnary. |
---|
275 | |
---|
276 | |
---|
277 | |
---|
278 | |
---|
279 | |
---|
280 | === How can I see online help update ? === |
---|
281 | |
---|
282 | |
---|
283 | |
---|
284 | |
---|
285 | You won't see online help update if you are working with the official distribution because of {{{!HELP_PATH}}}. To override this problem, when you are in {{{SAXO_basedirectory/SAXO_DIR/SRC/Documentation/xmldoc/}}}, you can call online help like this : |
---|
286 | |
---|
287 | {{{ |
---|
288 | #!html |
---|
289 | <pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen"> |
---|
290 | <code class="prompt">idl></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> |
---|
291 | </pre> |
---|
292 | }}} |
---|
293 | |
---|
294 | |
---|
295 | |
---|
296 | |
---|
297 | |
---|