[161] | 1 | <?xml version='1.0' encoding='iso-8859-1'?> |
---|
| 2 | <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" |
---|
[176] | 4 | [ |
---|
| 5 | <!ENTITY promptidl "idl>"> |
---|
| 6 | ]> |
---|
[161] | 7 | <!-- |
---|
| 8 | en s'inspirant de |
---|
| 9 | http://www.csc.fi/math_topics/Mail/FAQ/msg00069.html |
---|
| 10 | pour les questions |
---|
| 11 | on pourra aussi s'inspirer de http://idlastro.gsfc.nasa.gov/idlfaq.html |
---|
| 12 | |
---|
| 13 | !! on notera l'utilisation hypersioux de xinclude xpointer pour ne pas répéter |
---|
| 14 | (avec des erreurs, forcément)à ce qui est déjà écrit dans un autre document |
---|
| 15 | !! |
---|
| 16 | cf http://www.zvon.org/xxl/XIncludeTutorial/Output/example9.html |
---|
| 17 | cf http://www.zvon.org/xxl/XIncludeTutorial/Output/example12.html |
---|
| 18 | bon finalement c'est pas si hyper rusé parce qu'on hérite du plan (sect1 par |
---|
| 19 | exemple de l'entité incluse) |
---|
| 20 | --> |
---|
| 21 | <article> |
---|
| 22 | <title>Frequently Asked questions about SAXO</title> |
---|
| 23 | <articleinfo> |
---|
| 24 | <authorgroup> |
---|
| 25 | <author><firstname>Sébastien</firstname> <surname>Masson</surname> <email>Sebastien.Masson_at_locean-ipsl.upmc.fr</email></author> |
---|
| 26 | <author><firstname>Françoise</firstname> <surname>Pinsard</surname> <email>Francoise.Pinsard_at_locean-ipsl.upmc.fr</email></author> |
---|
| 27 | </authorgroup> |
---|
| 28 | <keywordset> |
---|
[183] | 29 | <keyword>IDL</keyword> |
---|
[161] | 30 | <keyword>SAXO</keyword> |
---|
| 31 | <keyword>FAQ</keyword> |
---|
| 32 | </keywordset> |
---|
| 33 | <revhistory> |
---|
| 34 | <revision> |
---|
| 35 | <revnumber>0.0</revnumber> |
---|
| 36 | <date>August 2006</date> |
---|
| 37 | <revremark>First draft</revremark> |
---|
| 38 | </revision> |
---|
[168] | 39 | <revision> |
---|
| 40 | <revnumber>0.1</revnumber> |
---|
| 41 | <date>September 2006</date> |
---|
| 42 | <revremark>+ onlinehelp</revremark> |
---|
| 43 | </revision> |
---|
[161] | 44 | </revhistory> |
---|
| 45 | <pubdate>$Id$</pubdate> |
---|
| 46 | </articleinfo> |
---|
| 47 | |
---|
| 48 | <qandaset> |
---|
| 49 | <qandadiv id="intro"> |
---|
| 50 | <title>Introduction</title> |
---|
| 51 | <para> |
---|
| 52 | This is a list of Frequently Asked Questions about SAXO. |
---|
| 53 | </para> |
---|
| 54 | <para> |
---|
| 55 | This list is roughly divided into categories: general questions, |
---|
| 56 | technical questions, contributors questions. |
---|
| 57 | </para> |
---|
| 58 | <para> |
---|
| 59 | Suggestions for corrections or additional sections are welcome -- please email them to <email>saxo-dev@forge.ipsl.jussieu.fr</email>. |
---|
| 60 | </para> |
---|
| 61 | </qandadiv> |
---|
| 62 | <qandadiv id="general"> |
---|
| 63 | <title>General</title> |
---|
| 64 | <qandaentry> |
---|
| 65 | <question> |
---|
| 66 | <para> |
---|
| 67 | What is SAXO ? |
---|
| 68 | </para> |
---|
| 69 | </question> |
---|
| 70 | <answer> |
---|
| 71 | <para> |
---|
[183] | 72 | see document <ulink url="./whatissaxo.html?format=raw">What is SAXO</ulink>. |
---|
[161] | 73 | </para> |
---|
| 74 | </answer> |
---|
| 75 | </qandaentry> |
---|
| 76 | <qandaentry> |
---|
| 77 | <question> |
---|
| 78 | <para> |
---|
| 79 | How can I get help ? |
---|
| 80 | </para> |
---|
| 81 | </question> |
---|
| 82 | <answer> |
---|
| 83 | <para> |
---|
[183] | 84 | see Support in document <ulink url="./websaxo.html?format=raw">Main page of SAXO</ulink>. |
---|
[161] | 85 | </para> |
---|
| 86 | </answer> |
---|
| 87 | </qandaentry> |
---|
| 88 | <qandaentry> |
---|
| 89 | <question> |
---|
| 90 | <para> |
---|
| 91 | How do I get SAXO ? |
---|
| 92 | </para> |
---|
| 93 | </question> |
---|
| 94 | <answer> |
---|
| 95 | <para> |
---|
[183] | 96 | see document <ulink url="./getsaxo.html?format=raw">Get SAXO</ulink>. |
---|
[161] | 97 | </para> |
---|
| 98 | </answer> |
---|
| 99 | </qandaentry> |
---|
| 100 | <qandaentry> |
---|
| 101 | <question> |
---|
| 102 | <para> |
---|
| 103 | What is the current version of SAXO ? |
---|
| 104 | </para> |
---|
| 105 | </question> |
---|
| 106 | <answer> |
---|
| 107 | <para> |
---|
| 108 | </para> |
---|
| 109 | </answer> |
---|
| 110 | </qandaentry> |
---|
| 111 | <qandaentry> |
---|
| 112 | <question> |
---|
| 113 | <para> |
---|
| 114 | On what systems does SAXO run ? |
---|
| 115 | </para> |
---|
| 116 | </question> |
---|
| 117 | <answer> |
---|
| 118 | <para> |
---|
| 119 | </para> |
---|
| 120 | </answer> |
---|
| 121 | </qandaentry> |
---|
| 122 | <qandaentry> |
---|
| 123 | <question> |
---|
| 124 | <para> |
---|
[183] | 125 | Does SAXO works with GDL instead of IDL ? |
---|
[161] | 126 | </para> |
---|
| 127 | </question> |
---|
| 128 | <answer> |
---|
| 129 | <para> |
---|
| 130 | Not yet. <!-- et de toute façon GDL est pour l'instant équivalent à la version |
---|
| 131 | 6.0 de IDL donc peut-etre que tout SAXO ne fonctionnerait pas --> |
---|
| 132 | </para> |
---|
| 133 | </answer> |
---|
| 134 | </qandaentry> |
---|
| 135 | <qandaentry> |
---|
| 136 | <question> |
---|
| 137 | <para> |
---|
| 138 | When is the next version of SAXO due out ? |
---|
| 139 | </para> |
---|
| 140 | </question> |
---|
| 141 | <answer> |
---|
| 142 | <para> |
---|
| 143 | </para> |
---|
| 144 | </answer> |
---|
| 145 | </qandaentry> |
---|
| 146 | <qandaentry> |
---|
| 147 | <question> |
---|
| 148 | <para> |
---|
| 149 | How can I find if a routine to do what I want already exists ? |
---|
| 150 | </para> |
---|
| 151 | </question> |
---|
| 152 | <answer> |
---|
| 153 | <para> |
---|
| 154 | </para> |
---|
| 155 | </answer> |
---|
| 156 | </qandaentry> |
---|
| 157 | <qandaentry> |
---|
| 158 | <question> |
---|
| 159 | <para> |
---|
| 160 | How should SAXO be cited or acknowledged in publication ? |
---|
| 161 | </para> |
---|
| 162 | </question> |
---|
| 163 | <answer> |
---|
| 164 | <para> |
---|
| 165 | </para> |
---|
| 166 | </answer> |
---|
| 167 | </qandaentry> |
---|
| 168 | </qandadiv> |
---|
| 169 | <qandadiv id="technical"> |
---|
| 170 | <title>Technical questions</title> |
---|
| 171 | <qandaentry> |
---|
| 172 | <question> |
---|
| 173 | <para> |
---|
| 174 | Is there on-line help for SAXO ? |
---|
| 175 | </para> |
---|
| 176 | </question> |
---|
| 177 | <answer> |
---|
| 178 | <para> |
---|
[176] | 179 | Yes, if you use at least IDL 6.2. It is produced by <application><ulink url="http://www.ittvis.com/codebank/search.asp?FID=100">IDLdoc</ulink></application>. SAXO and IDL online_help have been merged, you can simply get the help by typing: |
---|
| 180 | <screen format="linespecific"> |
---|
| 181 | <prompt>&promptidl;</prompt> <userinput><command>?</command></userinput> |
---|
| 182 | </screen> |
---|
[161] | 183 | </para> |
---|
| 184 | </answer> |
---|
| 185 | </qandaentry> |
---|
| 186 | </qandadiv> |
---|
| 187 | <qandadiv id="Contributors"> |
---|
| 188 | <title>Contributors</title> |
---|
| 189 | <qandaentry> |
---|
| 190 | <question> |
---|
| 191 | <para> |
---|
| 192 | Is there an SAXO Style Guide available ? |
---|
| 193 | </para> |
---|
| 194 | </question> |
---|
| 195 | <answer> |
---|
| 196 | <para> |
---|
| 197 | There is a template for header <ulink url="../new_header.txt?format=raw">new_header.txt</ulink> |
---|
| 198 | which can be parsed by <application>IDLdoc</application>. |
---|
| 199 | </para> |
---|
| 200 | <para> |
---|
| 201 | This file can be added in <application>Emacs</application> configuration |
---|
| 202 | <menuchoice> |
---|
| 203 | <shortcut> |
---|
| 204 | <keycombo><keysym>C-c</keysym><keysym>C-h</keysym></keycombo> |
---|
| 205 | </shortcut> |
---|
| 206 | <guimenu>IDLWAVE</guimenu> |
---|
| 207 | <guimenuitem>Templates</guimenuitem> |
---|
| 208 | <guimenuitem>Doc Header</guimenuitem> |
---|
| 209 | </menuchoice>. |
---|
| 210 | in your <filename>${HOME}/.emacs</filename> like this : |
---|
| 211 | <programlisting format="linespecific"> |
---|
| 212 | (add-hook 'idlwave-mode-hook |
---|
| 213 | (function |
---|
| 214 | (lambda () |
---|
| 215 | (setq idlwave-file-header '("<replaceable>SAXO_basedirectory</replaceable>/SAXO_DIR/SRC/Documentation/new_header.txt") |
---|
| 216 | )))) |
---|
| 217 | </programlisting> |
---|
| 218 | </para> |
---|
| 219 | </answer> |
---|
| 220 | </qandaentry> |
---|
| 221 | <qandaentry> |
---|
| 222 | <question> |
---|
| 223 | <para> |
---|
| 224 | Is there any trouble with <application>IDLdoc</application> ? |
---|
| 225 | </para> |
---|
| 226 | </question> |
---|
| 227 | <answer> |
---|
| 228 | <para> |
---|
| 229 | Yes, there are some : |
---|
| 230 | <itemizedlist> |
---|
| 231 | <listitem> |
---|
| 232 | <para> |
---|
| 233 | <literal>\</literal> in <filename>*.pro</filename> are not written |
---|
| 234 | in <filename>*.html</filename>. |
---|
| 235 | They must be escaped by an other <literal>\</literal> or you can choose an other character. |
---|
| 236 | </para> |
---|
| 237 | </listitem> |
---|
| 238 | <listitem> |
---|
| 239 | <para> |
---|
| 240 | <guimenu>Search</guimenu> does'nt handle characters like <literal>-</literal> |
---|
| 241 | and <literal>|</literal>. |
---|
| 242 | </para> |
---|
| 243 | </listitem> |
---|
| 244 | <listitem> |
---|
| 245 | <para> |
---|
[183] | 246 | Paragraphs of <filename>*.pro</filename> headers are shown with a proportional |
---|
| 247 | font in the <literal>HTML</literal> release. |
---|
[161] | 248 | </para> |
---|
| 249 | <para> |
---|
| 250 | If you need to draw some small figure like grid cell, you can encapsulate |
---|
| 251 | between the block to be shown in constant font <!-- see savesaxo.sh --> |
---|
| 252 | between |
---|
| 253 | <literal>; <fixe></literal> and |
---|
| 254 | <literal>; </fixe></literal> |
---|
| 255 | </para> |
---|
| 256 | </listitem> |
---|
| 257 | </itemizedlist> |
---|
| 258 | </para> |
---|
| 259 | <para> |
---|
[183] | 260 | Unfortunately, these troubles may not be fixed because the author does not |
---|
[161] | 261 | have anymore the opportunity to work on his own work. |
---|
| 262 | </para> |
---|
| 263 | <para> |
---|
| 264 | Bugs can be submitted to IDL but we do not expect answers ! |
---|
| 265 | <!-- ++ rappel du bug soumis --> |
---|
| 266 | </para> |
---|
| 267 | </answer> |
---|
| 268 | </qandaentry> |
---|
| 269 | </qandadiv> |
---|
| 270 | </qandaset> |
---|
| 271 | </article> |
---|