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