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