| 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|---|
| 2 | <html> |
|---|
| 3 | <head> |
|---|
| 4 | <meta name="generator" content= |
|---|
| 5 | "HTML Tidy for Mac OS X (vers 1 September 2005), see www.w3.org"> |
|---|
| 6 | <meta http-equiv="Content-Type" content= |
|---|
| 7 | "text/html; charset=us-ascii"> |
|---|
| 8 | <title>Frequently Asked questions about SAXO</title> |
|---|
| 9 | <link rel="stylesheet" href="style.css" type="text/css"> |
|---|
| 10 | <link rel="stylesheet" href="saxo.css" type="text/css"> |
|---|
| 11 | <meta name="generator" content="DocBook XSL Stylesheets V1.70.1"> |
|---|
| 12 | <meta name="keywords" content="idl, SAXO, FAQ"> |
|---|
| 13 | </head> |
|---|
| 14 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" |
|---|
| 15 | alink="#0000FF"> |
|---|
| 16 | <div class="article" lang="en"> |
|---|
| 17 | <div class="titlepage"> |
|---|
| 18 | <div> |
|---|
| 19 | <div> |
|---|
| 20 | <h2 class="title"><a name="d0e2" id="d0e2"></a>Frequently Asked |
|---|
| 21 | questions about SAXO</h2> |
|---|
| 22 | </div> |
|---|
| 23 | <div> |
|---|
| 24 | <div class="authorgroup"> |
|---|
| 25 | <div class="author"> |
|---|
| 26 | <h3 class="author"><span class="firstname">Sébastien</span> |
|---|
| 27 | <span class="surname">Masson</span> <code class= |
|---|
| 28 | "email"><<a href="mailto:Sebastien.Masson_at_locean-ipsl.upmc.fr">Sebastien.Masson_at_locean-ipsl.upmc.fr</a>></code></h3> |
|---|
| 29 | </div> |
|---|
| 30 | <div class="author"> |
|---|
| 31 | <h3 class="author"><span class="firstname">Françoise</span> |
|---|
| 32 | <span class="surname">Pinsard</span> <code class= |
|---|
| 33 | "email"><<a href= |
|---|
| 34 | "mailto:Francoise.Pinsard_at_locean-ipsl.upmc.fr">Francoise.Pinsard_at_locean-ipsl.upmc.fr</a>></code></h3> |
|---|
| 35 | </div> |
|---|
| 36 | </div> |
|---|
| 37 | </div> |
|---|
| 38 | <div><span class="pubdate">svn Id of xml source file : $Id: |
|---|
| 39 | faqsaxo.xml 161 2006-08-29 09:07:50Z pinsard $<br> |
|---|
| 40 | <br></span></div> |
|---|
| 41 | <div> |
|---|
| 42 | <div class="revhistory"> |
|---|
| 43 | <table border="1" width="100%" summary="Revision history"> |
|---|
| 44 | <tr> |
|---|
| 45 | <th align="left" valign="top" colspan="2"><b>Revision |
|---|
| 46 | History</b></th> |
|---|
| 47 | </tr> |
|---|
| 48 | <tr> |
|---|
| 49 | <td align="left">Revision 0.0</td> |
|---|
| 50 | <td align="left">August 2006</td> |
|---|
| 51 | </tr> |
|---|
| 52 | <tr> |
|---|
| 53 | <td align="left" colspan="2">First draft</td> |
|---|
| 54 | </tr> |
|---|
| 55 | <tr> |
|---|
| 56 | <td align="left">Revision 0.1</td> |
|---|
| 57 | <td align="left">September 2006</td> |
|---|
| 58 | </tr> |
|---|
| 59 | <tr> |
|---|
| 60 | <td align="left" colspan="2">+ onlinehelp</td> |
|---|
| 61 | </tr> |
|---|
| 62 | </table> |
|---|
| 63 | </div> |
|---|
| 64 | </div> |
|---|
| 65 | </div> |
|---|
| 66 | <hr></div> |
|---|
| 67 | <div class="qandaset"> |
|---|
| 68 | <dl> |
|---|
| 69 | <dt>1. <a href="#intro">Introduction</a></dt> |
|---|
| 70 | <dt>2. <a href="#general">General</a></dt> |
|---|
| 71 | <dd> |
|---|
| 72 | <dl> |
|---|
| 73 | <dt>2.1. <a href="#d0e66">What is SAXO ?</a></dt> |
|---|
| 74 | <dt>2.2. <a href="#d0e76">How can I get help ?</a></dt> |
|---|
| 75 | <dt>2.3. <a href="#d0e86">How do I get SAXO ?</a></dt> |
|---|
| 76 | <dt>2.4. <a href="#d0e96">What is the current version of SAXO |
|---|
| 77 | ?</a></dt> |
|---|
| 78 | <dt>2.5. <a href="#d0e103">On what systems does SAXO run ?</a></dt> |
|---|
| 79 | <dt>2.6. <a href="#d0e110">Does SAXO works wih GDL instead of IDL |
|---|
| 80 | ?</a></dt> |
|---|
| 81 | <dt>2.7. <a href="#d0e119">When is the next version of SAXO due out |
|---|
| 82 | ?</a></dt> |
|---|
| 83 | <dt>2.8. <a href="#d0e126">How can I find if a routine to do what I |
|---|
| 84 | want already exists ?</a></dt> |
|---|
| 85 | <dt>2.9. <a href="#d0e133">How should SAXO be cited or acknowledged |
|---|
| 86 | in publication ?</a></dt> |
|---|
| 87 | </dl> |
|---|
| 88 | </dd> |
|---|
| 89 | <dt>3. <a href="#technical">Technical questions</a></dt> |
|---|
| 90 | <dd> |
|---|
| 91 | <dl> |
|---|
| 92 | <dt>3.1. <a href="#d0e143">Is there on-line help for SAXO |
|---|
| 93 | ?</a></dt> |
|---|
| 94 | </dl> |
|---|
| 95 | </dd> |
|---|
| 96 | <dt>4. <a href="#Contributors">Contributors</a></dt> |
|---|
| 97 | <dd> |
|---|
| 98 | <dl> |
|---|
| 99 | <dt>4.1. <a href="#d0e174">Is there an SAXO Style Guide available |
|---|
| 100 | ?</a></dt> |
|---|
| 101 | <dt>4.2. <a href="#d0e215">Is there any trouble with IDLdoc |
|---|
| 102 | ?</a></dt> |
|---|
| 103 | </dl> |
|---|
| 104 | </dd> |
|---|
| 105 | </dl> |
|---|
| 106 | <table border="0" summary="Q and A Set"> |
|---|
| 107 | <col align="left" width="1%"> |
|---|
| 108 | <tbody> |
|---|
| 109 | <tr class="qandadiv"> |
|---|
| 110 | <td align="left" valign="top" colspan="2"> |
|---|
| 111 | <h3 class="title"><a name="intro" id="intro"></a>1. |
|---|
| 112 | Introduction</h3> |
|---|
| 113 | </td> |
|---|
| 114 | </tr> |
|---|
| 115 | <tr class="toc"> |
|---|
| 116 | <td align="left" valign="top" colspan="2"></td> |
|---|
| 117 | </tr> |
|---|
| 118 | <tr class="toc"> |
|---|
| 119 | <td align="left" valign="top" colspan="2"> |
|---|
| 120 | <p>This is a list of Frequently Asked Questions about SAXO.</p> |
|---|
| 121 | <p>This list is roughly divided into categories: general questions, |
|---|
| 122 | technical questions, contributors questions.</p> |
|---|
| 123 | <p>Suggestions for corrections or additional sections are welcome |
|---|
| 124 | -- please email them to <code class="email"><<a href= |
|---|
| 125 | "mailto:saxo-dev@forge.ipsl.jussieu.fr">saxo-dev@forge.ipsl.jussieu.fr</a>></code>.</p> |
|---|
| 126 | </td> |
|---|
| 127 | </tr> |
|---|
| 128 | <tr class="qandadiv"> |
|---|
| 129 | <td align="left" valign="top" colspan="2"> |
|---|
| 130 | <h3 class="title"><a name="general" id="general"></a>2. |
|---|
| 131 | General</h3> |
|---|
| 132 | </td> |
|---|
| 133 | </tr> |
|---|
| 134 | <tr class="toc"> |
|---|
| 135 | <td align="left" valign="top" colspan="2"> |
|---|
| 136 | <dl> |
|---|
| 137 | <dt>2.1. <a href="#d0e66">What is SAXO ?</a></dt> |
|---|
| 138 | <dt>2.2. <a href="#d0e76">How can I get help ?</a></dt> |
|---|
| 139 | <dt>2.3. <a href="#d0e86">How do I get SAXO ?</a></dt> |
|---|
| 140 | <dt>2.4. <a href="#d0e96">What is the current version of SAXO |
|---|
| 141 | ?</a></dt> |
|---|
| 142 | <dt>2.5. <a href="#d0e103">On what systems does SAXO run ?</a></dt> |
|---|
| 143 | <dt>2.6. <a href="#d0e110">Does SAXO works wih GDL instead of IDL |
|---|
| 144 | ?</a></dt> |
|---|
| 145 | <dt>2.7. <a href="#d0e119">When is the next version of SAXO due out |
|---|
| 146 | ?</a></dt> |
|---|
| 147 | <dt>2.8. <a href="#d0e126">How can I find if a routine to do what I |
|---|
| 148 | want already exists ?</a></dt> |
|---|
| 149 | <dt>2.9. <a href="#d0e133">How should SAXO be cited or acknowledged |
|---|
| 150 | in publication ?</a></dt> |
|---|
| 151 | </dl> |
|---|
| 152 | </td> |
|---|
| 153 | </tr> |
|---|
| 154 | <tr class="question"> |
|---|
| 155 | <td align="left" valign="top"><a name="d0e66" id= |
|---|
| 156 | "d0e66"></a><a name="d0e67" id="d0e67"></a><b>2.1.</b></td> |
|---|
| 157 | <td align="left" valign="top"> |
|---|
| 158 | <p>What is SAXO ?</p> |
|---|
| 159 | </td> |
|---|
| 160 | </tr> |
|---|
| 161 | <tr class="answer"> |
|---|
| 162 | <td align="left" valign="top"></td> |
|---|
| 163 | <td align="left" valign="top"> |
|---|
| 164 | <p>see document <a href= |
|---|
| 165 | "../../saxo/browser/trunk/SRC/Documentation/xmldoc/whatissaxo.html?format=raw" |
|---|
| 166 | target="_top">What is SAXO</a>.</p> |
|---|
| 167 | </td> |
|---|
| 168 | </tr> |
|---|
| 169 | <tr class="question"> |
|---|
| 170 | <td align="left" valign="top"><a name="d0e76" id= |
|---|
| 171 | "d0e76"></a><a name="d0e77" id="d0e77"></a><b>2.2.</b></td> |
|---|
| 172 | <td align="left" valign="top"> |
|---|
| 173 | <p>How can I get help ?</p> |
|---|
| 174 | </td> |
|---|
| 175 | </tr> |
|---|
| 176 | <tr class="answer"> |
|---|
| 177 | <td align="left" valign="top"></td> |
|---|
| 178 | <td align="left" valign="top"> |
|---|
| 179 | <p>see Support in document <a href= |
|---|
| 180 | "../../saxo/browser/trunk/SRC/Documentation/xmldoc/main.html?format=raw" |
|---|
| 181 | target="_top">Main page of SAXO</a>.</p> |
|---|
| 182 | </td> |
|---|
| 183 | </tr> |
|---|
| 184 | <tr class="question"> |
|---|
| 185 | <td align="left" valign="top"><a name="d0e86" id= |
|---|
| 186 | "d0e86"></a><a name="d0e87" id="d0e87"></a><b>2.3.</b></td> |
|---|
| 187 | <td align="left" valign="top"> |
|---|
| 188 | <p>How do I get SAXO ?</p> |
|---|
| 189 | </td> |
|---|
| 190 | </tr> |
|---|
| 191 | <tr class="answer"> |
|---|
| 192 | <td align="left" valign="top"></td> |
|---|
| 193 | <td align="left" valign="top"> |
|---|
| 194 | <p>see document <a href= |
|---|
| 195 | "../../saxo/browser/trunk/SRC/Documentation/xmldoc/getsaxo.html?format=raw" |
|---|
| 196 | target="_top">Get SAXO</a>.</p> |
|---|
| 197 | </td> |
|---|
| 198 | </tr> |
|---|
| 199 | <tr class="question"> |
|---|
| 200 | <td align="left" valign="top"><a name="d0e96" id= |
|---|
| 201 | "d0e96"></a><a name="d0e97" id="d0e97"></a><b>2.4.</b></td> |
|---|
| 202 | <td align="left" valign="top"> |
|---|
| 203 | <p>What is the current version of SAXO ?</p> |
|---|
| 204 | </td> |
|---|
| 205 | </tr> |
|---|
| 206 | <tr class="answer"> |
|---|
| 207 | <td align="left" valign="top"></td> |
|---|
| 208 | <td align="left" valign="top"></td> |
|---|
| 209 | </tr> |
|---|
| 210 | <tr class="question"> |
|---|
| 211 | <td align="left" valign="top"><a name="d0e103" id= |
|---|
| 212 | "d0e103"></a><a name="d0e104" id="d0e104"></a><b>2.5.</b></td> |
|---|
| 213 | <td align="left" valign="top"> |
|---|
| 214 | <p>On what systems does SAXO run ?</p> |
|---|
| 215 | </td> |
|---|
| 216 | </tr> |
|---|
| 217 | <tr class="answer"> |
|---|
| 218 | <td align="left" valign="top"></td> |
|---|
| 219 | <td align="left" valign="top"></td> |
|---|
| 220 | </tr> |
|---|
| 221 | <tr class="question"> |
|---|
| 222 | <td align="left" valign="top"><a name="d0e110" id= |
|---|
| 223 | "d0e110"></a><a name="d0e111" id="d0e111"></a><b>2.6.</b></td> |
|---|
| 224 | <td align="left" valign="top"> |
|---|
| 225 | <p>Does SAXO works wih GDL instead of IDL ?</p> |
|---|
| 226 | </td> |
|---|
| 227 | </tr> |
|---|
| 228 | <tr class="answer"> |
|---|
| 229 | <td align="left" valign="top"></td> |
|---|
| 230 | <td align="left" valign="top"> |
|---|
| 231 | <p>Not yet.</p> |
|---|
| 232 | </td> |
|---|
| 233 | </tr> |
|---|
| 234 | <tr class="question"> |
|---|
| 235 | <td align="left" valign="top"><a name="d0e119" id= |
|---|
| 236 | "d0e119"></a><a name="d0e120" id="d0e120"></a><b>2.7.</b></td> |
|---|
| 237 | <td align="left" valign="top"> |
|---|
| 238 | <p>When is the next version of SAXO due out ?</p> |
|---|
| 239 | </td> |
|---|
| 240 | </tr> |
|---|
| 241 | <tr class="answer"> |
|---|
| 242 | <td align="left" valign="top"></td> |
|---|
| 243 | <td align="left" valign="top"></td> |
|---|
| 244 | </tr> |
|---|
| 245 | <tr class="question"> |
|---|
| 246 | <td align="left" valign="top"><a name="d0e126" id= |
|---|
| 247 | "d0e126"></a><a name="d0e127" id="d0e127"></a><b>2.8.</b></td> |
|---|
| 248 | <td align="left" valign="top"> |
|---|
| 249 | <p>How can I find if a routine to do what I want already exists |
|---|
| 250 | ?</p> |
|---|
| 251 | </td> |
|---|
| 252 | </tr> |
|---|
| 253 | <tr class="answer"> |
|---|
| 254 | <td align="left" valign="top"></td> |
|---|
| 255 | <td align="left" valign="top"></td> |
|---|
| 256 | </tr> |
|---|
| 257 | <tr class="question"> |
|---|
| 258 | <td align="left" valign="top"><a name="d0e133" id= |
|---|
| 259 | "d0e133"></a><a name="d0e134" id="d0e134"></a><b>2.9.</b></td> |
|---|
| 260 | <td align="left" valign="top"> |
|---|
| 261 | <p>How should SAXO be cited or acknowledged in publication ?</p> |
|---|
| 262 | </td> |
|---|
| 263 | </tr> |
|---|
| 264 | <tr class="answer"> |
|---|
| 265 | <td align="left" valign="top"></td> |
|---|
| 266 | <td align="left" valign="top"></td> |
|---|
| 267 | </tr> |
|---|
| 268 | <tr class="qandadiv"> |
|---|
| 269 | <td align="left" valign="top" colspan="2"> |
|---|
| 270 | <h3 class="title"><a name="technical" id="technical"></a>3. |
|---|
| 271 | Technical questions</h3> |
|---|
| 272 | </td> |
|---|
| 273 | </tr> |
|---|
| 274 | <tr class="toc"> |
|---|
| 275 | <td align="left" valign="top" colspan="2"> |
|---|
| 276 | <dl> |
|---|
| 277 | <dt>3.1. <a href="#d0e143">Is there on-line help for SAXO |
|---|
| 278 | ?</a></dt> |
|---|
| 279 | </dl> |
|---|
| 280 | </td> |
|---|
| 281 | </tr> |
|---|
| 282 | <tr class="question"> |
|---|
| 283 | <td align="left" valign="top"><a name="d0e143" id= |
|---|
| 284 | "d0e143"></a><a name="d0e144" id="d0e144"></a><b>3.1.</b></td> |
|---|
| 285 | <td align="left" valign="top"> |
|---|
| 286 | <p>Is there on-line help for SAXO ?</p> |
|---|
| 287 | </td> |
|---|
| 288 | </tr> |
|---|
| 289 | <tr class="answer"> |
|---|
| 290 | <td align="left" valign="top"></td> |
|---|
| 291 | <td align="left" valign="top"> |
|---|
| 292 | <p>Yes. produced by <span class="application">IDLdoc</span>.</p> |
|---|
| 293 | <p>You can access to this documentation set during your IDL session |
|---|
| 294 | with this command :</p> |
|---|
| 295 | <pre class="screen"> |
|---|
| 296 | <code class="prompt">IDL</code> <strong class= |
|---|
| 297 | "userinput"><code><span><strong class= |
|---|
| 298 | "command">ONLINE_HELP</strong></span>,<code class= |
|---|
| 299 | "option">book="<em class= |
|---|
| 300 | "replaceable"><code>SAXO_basedirectory</code></em>/SAXO_DIR/SRC/Documentation/idldoc_assistant_output/idldoc-lib.adp"</code></code></strong> |
|---|
| 301 | </pre></td> |
|---|
| 302 | </tr> |
|---|
| 303 | <tr class="qandadiv"> |
|---|
| 304 | <td align="left" valign="top" colspan="2"> |
|---|
| 305 | <h3 class="title"><a name="Contributors" id="Contributors"></a>4. |
|---|
| 306 | Contributors</h3> |
|---|
| 307 | </td> |
|---|
| 308 | </tr> |
|---|
| 309 | <tr class="toc"> |
|---|
| 310 | <td align="left" valign="top" colspan="2"> |
|---|
| 311 | <dl> |
|---|
| 312 | <dt>4.1. <a href="#d0e174">Is there an SAXO Style Guide available |
|---|
| 313 | ?</a></dt> |
|---|
| 314 | <dt>4.2. <a href="#d0e215">Is there any trouble with IDLdoc |
|---|
| 315 | ?</a></dt> |
|---|
| 316 | </dl> |
|---|
| 317 | </td> |
|---|
| 318 | </tr> |
|---|
| 319 | <tr class="question"> |
|---|
| 320 | <td align="left" valign="top"><a name="d0e174" id= |
|---|
| 321 | "d0e174"></a><a name="d0e175" id="d0e175"></a><b>4.1.</b></td> |
|---|
| 322 | <td align="left" valign="top"> |
|---|
| 323 | <p>Is there an SAXO Style Guide available ?</p> |
|---|
| 324 | </td> |
|---|
| 325 | </tr> |
|---|
| 326 | <tr class="answer"> |
|---|
| 327 | <td align="left" valign="top"></td> |
|---|
| 328 | <td align="left" valign="top"> |
|---|
| 329 | <p>There is a template for header <a href= |
|---|
| 330 | "../new_header.txt?format=raw" target="_top">new_header.txt</a> |
|---|
| 331 | which can be parsed by <span class="application">IDLdoc</span>.</p> |
|---|
| 332 | <p>This file can be added in <span class="application">Emacs</span> |
|---|
| 333 | configuration <span class="guimenu">IDLWAVE</span> → |
|---|
| 334 | <span class="guimenuitem">Templates</span> → <span class= |
|---|
| 335 | "guimenuitem">Doc Header</span> (<span><strong class= |
|---|
| 336 | "shortcut"><span class="keysym">C-c</span>-<span class= |
|---|
| 337 | "keysym">C-h</span></strong></span>). in your <code class= |
|---|
| 338 | "filename">${HOME}/.emacs</code> like this :</p> |
|---|
| 339 | <pre class="programlisting"> |
|---|
| 340 | (add-hook 'idlwave-mode-hook |
|---|
| 341 | (function |
|---|
| 342 | (lambda () |
|---|
| 343 | (setq idlwave-file-header '("<em class= |
|---|
| 344 | "replaceable"><code>SAXO_basedirectory</code></em>/SAXO_DIR/SRC/Documentation/new_header.txt") |
|---|
| 345 | )))) |
|---|
| 346 | </pre></td> |
|---|
| 347 | </tr> |
|---|
| 348 | <tr class="question"> |
|---|
| 349 | <td align="left" valign="top"><a name="d0e215" id= |
|---|
| 350 | "d0e215"></a><a name="d0e216" id="d0e216"></a><b>4.2.</b></td> |
|---|
| 351 | <td align="left" valign="top"> |
|---|
| 352 | <p>Is there any trouble with <span class= |
|---|
| 353 | "application">IDLdoc</span> ?</p> |
|---|
| 354 | </td> |
|---|
| 355 | </tr> |
|---|
| 356 | <tr class="answer"> |
|---|
| 357 | <td align="left" valign="top"></td> |
|---|
| 358 | <td align="left" valign="top"> |
|---|
| 359 | <p>Yes, there are some :</p> |
|---|
| 360 | <div class="itemizedlist"> |
|---|
| 361 | <ul type="disc"> |
|---|
| 362 | <li> |
|---|
| 363 | <p><code class="literal">\</code> in <code class= |
|---|
| 364 | "filename">*.pro</code> are not written in <code class= |
|---|
| 365 | "filename">*.html</code>. They must be escaped by an other |
|---|
| 366 | <code class="literal">\</code> or you can choose an other |
|---|
| 367 | character.</p> |
|---|
| 368 | </li> |
|---|
| 369 | <li> |
|---|
| 370 | <p><span class="guimenu">Search</span> does'nt handle characters |
|---|
| 371 | like <code class="literal">-</code> and <code class= |
|---|
| 372 | "literal">|</code>.</p> |
|---|
| 373 | </li> |
|---|
| 374 | <li> |
|---|
| 375 | <p>Paragraphs of <code class="filename">*.pro</code> headers are |
|---|
| 376 | shown with a proportinal font in the <code class= |
|---|
| 377 | "literal">html</code> release.</p> |
|---|
| 378 | <p>If you need to draw some small figure like grid cell, you can |
|---|
| 379 | encapsulate between the block to be shown in constant font between |
|---|
| 380 | <code class="literal">; <fixe></code> and <code class= |
|---|
| 381 | "literal">; </fixe></code></p> |
|---|
| 382 | </li> |
|---|
| 383 | </ul> |
|---|
| 384 | </div> |
|---|
| 385 | <p>Unfortunatly, these troubles may not be fixed because the author |
|---|
| 386 | does not have anymore the opportunity to work on his own work.</p> |
|---|
| 387 | <p>Bugs can be submitted to IDL but we do not expect answers !</p> |
|---|
| 388 | </td> |
|---|
| 389 | </tr> |
|---|
| 390 | </tbody> |
|---|
| 391 | </table> |
|---|
| 392 | </div> |
|---|
| 393 | </div> |
|---|
| 394 | </body> |
|---|
| 395 | </html> |
|---|
