Changeset 346 for trunk/SRC/Documentation/xmldoc/faqsaxo.html
- Timestamp:
- 04/16/08 11:33:20 (16 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/xmldoc/faqsaxo.html
r255 r346 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 1st December 2004), 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 href="style.css" rel="stylesheet" type="text/css"> 10 <link href="saxo.css" rel="stylesheet" type="text/css"> 11 <meta content="DocBook XSL Stylesheets V1.71.1" name="generator"> 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="N10002" id="N10002"></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"> 29 Sebastien.Masson_at_locean-ipsl.upmc.fr</a>></code></h3> 30 </div> 31 <div class="author"> 32 <h3 class="author"><span class="firstname">Françoise</span> 33 <span class="surname">Pinsard</span> <code class= 34 "email"><<a href= 35 "mailto:Francoise.Pinsard_at_locean-ipsl.upmc.fr">Francoise.Pinsard_at_locean-ipsl.upmc.fr</a>></code></h3> 36 </div> 37 </div> 38 </div> 39 <div><span class="pubdate">svn Id of xml source file : $Id: 40 faqsaxo.xml 230 2007-03-19 10:17:59Z pinsard $<br> 41 <br></span></div> 42 <div> 43 <div class="revhistory"> 44 <table summary="Revision history" width="100%" border="1"> 45 <tr> 46 <th colspan="2" valign="top" align="left"><b>Revision 47 History</b></th> 48 </tr> 49 <tr> 50 <td align="left">Revision 0.0</td> 51 <td align="left">August 2006</td> 52 </tr> 53 <tr> 54 <td colspan="2" align="left">First draft</td> 55 </tr> 56 <tr> 57 <td align="left">Revision 0.1</td> 58 <td align="left">September 2006</td> 59 </tr> 60 <tr> 61 <td colspan="2" align="left">+ onlinehelp</td> 62 </tr> 63 </table> 64 </div> 65 </div> 66 </div> 67 <hr></div> 68 <div class="qandaset"> 69 <dl> 70 <dt>1. <a href="#intro">Introduction</a></dt> 71 <dt>2. <a href="#general">General</a></dt> 72 <dd> 73 <dl> 74 <dt>2.1. <a href="#N10045">What is SAXO ?</a></dt> 75 <dt>2.2. <a href="#N10050">How can I get help ?</a></dt> 76 <dt>2.3. <a href="#N1005B">How do I get SAXO ?</a></dt> 77 <dt>2.4. <a href="#N10066">What is the current version of SAXO 78 ?</a></dt> 79 <dt>2.5. <a href="#N1006D">On what systems does SAXO run ?</a></dt> 80 <dt>2.6. <a href="#N10074">Does SAXO works with GDL instead of IDL 81 ?</a></dt> 82 <dt>2.7. <a href="#N1007D">When is the next version of SAXO due out 83 ?</a></dt> 84 <dt>2.8. <a href="#N10084">How can I find if a routine to do what I 85 want already exists ?</a></dt> 86 <dt>2.9. <a href="#N1008B">How should SAXO be cited or acknowledged 87 in publication ?</a></dt> 88 </dl> 89 </dd> 90 <dt>3. <a href="#technical">Technical questions</a></dt> 91 <dd> 92 <dl> 93 <dt>3.1. <a href="#N10096">Is there on-line help for SAXO 94 ?</a></dt> 95 </dl> 96 </dd> 97 <dt>4. <a href="#Contributors">Contributors</a></dt> 98 <dd> 99 <dl> 100 <dt>4.1. <a href="#N100B5">Is there an SAXO Style Guide available 101 ?</a></dt> 102 <dt>4.2. <a href="#N100E9">Is there any trouble with IDLdoc 103 ?</a></dt> 104 <dt>4.3. <a href="#N10135">How can I check spelling of xml files 105 ?</a></dt> 106 <dt>4.4. <a href="#N10157">How can I see online help update 107 ?</a></dt> 108 </dl> 109 </dd> 110 </dl> 111 <table summary="Q and A Set" border="0"> 112 <col align="left" width="1%"> 113 <tbody> 114 <tr class="qandadiv"> 115 <td colspan="2" valign="top" align="left"> 116 <h3 class="title"><a name="intro" id="intro"></a>1. 117 Introduction</h3> 118 </td> 119 </tr> 120 <tr class="toc"> 121 <td colspan="2" valign="top" align="left"></td> 122 </tr> 123 <tr class="toc"> 124 <td colspan="2" valign="top" align="left"> 125 <p>This is a list of Frequently Asked Questions about SAXO.</p> 126 <p>This list is roughly divided into categories: general questions, 127 technical questions, contributors questions.</p> 128 <p>Suggestions for corrections or additional sections are welcome 129 -- please email them to <code class="email"><<a href= 130 "mailto:saxo-dev@forge.ipsl.jussieu.fr">saxo-dev@forge.ipsl.jussieu.fr</a>></code>.</p> 131 </td> 132 </tr> 133 <tr class="qandadiv"> 134 <td colspan="2" valign="top" align="left"> 135 <h3 class="title"><a name="general" id="general"></a>2. 136 General</h3> 137 </td> 138 </tr> 139 <tr class="toc"> 140 <td colspan="2" valign="top" align="left"> 141 <dl> 142 <dt>2.1. <a href="#N10045">What is SAXO ?</a></dt> 143 <dt>2.2. <a href="#N10050">How can I get help ?</a></dt> 144 <dt>2.3. <a href="#N1005B">How do I get SAXO ?</a></dt> 145 <dt>2.4. <a href="#N10066">What is the current version of SAXO 146 ?</a></dt> 147 <dt>2.5. <a href="#N1006D">On what systems does SAXO run ?</a></dt> 148 <dt>2.6. <a href="#N10074">Does SAXO works with GDL instead of IDL 149 ?</a></dt> 150 <dt>2.7. <a href="#N1007D">When is the next version of SAXO due out 151 ?</a></dt> 152 <dt>2.8. <a href="#N10084">How can I find if a routine to do what I 153 want already exists ?</a></dt> 154 <dt>2.9. <a href="#N1008B">How should SAXO be cited or acknowledged 155 in publication ?</a></dt> 156 </dl> 157 </td> 158 </tr> 159 <tr class="question"> 160 <td valign="top" align="left"><a name="N10045" id= 161 "N10045"></a><a name="N10046" id="N10046"></a><b>2.1.</b></td> 162 <td valign="top" align="left"> 163 <p>What is SAXO ?</p> 164 </td> 165 </tr> 166 <tr class="answer"> 167 <td valign="top" align="left"></td> 168 <td valign="top" align="left"> 169 <p>see document <a href="./whatissaxo.html" target="_top">What is 170 SAXO</a>.</p> 171 </td> 172 </tr> 173 <tr class="question"> 174 <td valign="top" align="left"><a name="N10050" id= 175 "N10050"></a><a name="N10051" id="N10051"></a><b>2.2.</b></td> 176 <td valign="top" align="left"> 177 <p>How can I get help ?</p> 178 </td> 179 </tr> 180 <tr class="answer"> 181 <td valign="top" align="left"></td> 182 <td valign="top" align="left"> 183 <p>see Support in document <a href="./websaxo.html" target= 184 "_top">Main page of SAXO</a>.</p> 185 </td> 186 </tr> 187 <tr class="question"> 188 <td valign="top" align="left"><a name="N1005B" id= 189 "N1005B"></a><a name="N1005C" id="N1005C"></a><b>2.3.</b></td> 190 <td valign="top" align="left"> 191 <p>How do I get SAXO ?</p> 192 </td> 193 </tr> 194 <tr class="answer"> 195 <td valign="top" align="left"></td> 196 <td valign="top" align="left"> 197 <p>see document <a href="./getsaxo.html" target="_top">Get 198 SAXO</a>.</p> 199 </td> 200 </tr> 201 <tr class="question"> 202 <td valign="top" align="left"><a name="N10066" id= 203 "N10066"></a><a name="N10067" id="N10067"></a><b>2.4.</b></td> 204 <td valign="top" align="left"> 205 <p>What is the current version of SAXO ?</p> 206 </td> 207 </tr> 208 <tr class="answer"> 209 <td valign="top" align="left"></td> 210 <td valign="top" align="left"></td> 211 </tr> 212 <tr class="question"> 213 <td valign="top" align="left"><a name="N1006D" id= 214 "N1006D"></a><a name="N1006E" id="N1006E"></a><b>2.5.</b></td> 215 <td valign="top" align="left"> 216 <p>On what systems does SAXO run ?</p> 217 </td> 218 </tr> 219 <tr class="answer"> 220 <td valign="top" align="left"></td> 221 <td valign="top" align="left"></td> 222 </tr> 223 <tr class="question"> 224 <td valign="top" align="left"><a name="N10074" id= 225 "N10074"></a><a name="N10075" id="N10075"></a><b>2.6.</b></td> 226 <td valign="top" align="left"> 227 <p>Does SAXO works with GDL instead of IDL ?</p> 228 </td> 229 </tr> 230 <tr class="answer"> 231 <td valign="top" align="left"></td> 232 <td valign="top" align="left"> 233 <p>Not yet.</p> 234 </td> 235 </tr> 236 <tr class="question"> 237 <td valign="top" align="left"><a name="N1007D" id= 238 "N1007D"></a><a name="N1007E" id="N1007E"></a><b>2.7.</b></td> 239 <td valign="top" align="left"> 240 <p>When is the next version of SAXO due out ?</p> 241 </td> 242 </tr> 243 <tr class="answer"> 244 <td valign="top" align="left"></td> 245 <td valign="top" align="left"></td> 246 </tr> 247 <tr class="question"> 248 <td valign="top" align="left"><a name="N10084" id= 249 "N10084"></a><a name="N10085" id="N10085"></a><b>2.8.</b></td> 250 <td valign="top" align="left"> 251 <p>How can I find if a routine to do what I want already exists 252 ?</p> 253 </td> 254 </tr> 255 <tr class="answer"> 256 <td valign="top" align="left"></td> 257 <td valign="top" align="left"></td> 258 </tr> 259 <tr class="question"> 260 <td valign="top" align="left"><a name="N1008B" id= 261 "N1008B"></a><a name="N1008C" id="N1008C"></a><b>2.9.</b></td> 262 <td valign="top" align="left"> 263 <p>How should SAXO be cited or acknowledged in publication ?</p> 264 </td> 265 </tr> 266 <tr class="answer"> 267 <td valign="top" align="left"></td> 268 <td valign="top" align="left"></td> 269 </tr> 270 <tr class="qandadiv"> 271 <td colspan="2" valign="top" align="left"> 272 <h3 class="title"><a name="technical" id="technical"></a>3. 273 Technical questions</h3> 274 </td> 275 </tr> 276 <tr class="toc"> 277 <td colspan="2" valign="top" align="left"> 278 <dl> 279 <dt>3.1. <a href="#N10096">Is there on-line help for SAXO 280 ?</a></dt> 281 </dl> 282 </td> 283 </tr> 284 <tr class="question"> 285 <td valign="top" align="left"><a name="N10096" id= 286 "N10096"></a><a name="N10097" id="N10097"></a><b>3.1.</b></td> 287 <td valign="top" align="left"> 288 <p>Is there on-line help for SAXO ?</p> 289 </td> 290 </tr> 291 <tr class="answer"> 292 <td valign="top" align="left"></td> 293 <td valign="top" align="left"> 294 <p>Yes, if you use at least IDL 6.2. It is produced by <span class= 295 "application"><a href= 296 "http://www.ittvis.com/codebank/search.asp?FID=100" target= 297 "_top">IDLdoc</a></span>. SAXO and IDL online_help have been 298 merged, you can simply get the help by typing:</p> 299 <pre class="screen"> 300 <code class="prompt">idl></code> <strong class= 301 "userinput"><code><span><strong class= 302 "command">?</strong></span></code></strong> 303 304 </pre></td> 305 </tr> 306 <tr class="qandadiv"> 307 <td colspan="2" valign="top" align="left"> 308 <h3 class="title"><a name="Contributors" id="Contributors"></a>4. 309 Contributors</h3> 310 </td> 311 </tr> 312 <tr class="toc"> 313 <td colspan="2" valign="top" align="left"> 314 <dl> 315 <dt>4.1. <a href="#N100B5">Is there an SAXO Style Guide available 316 ?</a></dt> 317 <dt>4.2. <a href="#N100E9">Is there any trouble with IDLdoc 318 ?</a></dt> 319 <dt>4.3. <a href="#N10135">How can I check spelling of xml files 320 ?</a></dt> 321 <dt>4.4. <a href="#N10157">How can I see online help update 322 ?</a></dt> 323 </dl> 324 </td> 325 </tr> 326 <tr class="question"> 327 <td valign="top" align="left"><a name="N100B5" id= 328 "N100B5"></a><a name="N100B6" id="N100B6"></a><b>4.1.</b></td> 329 <td valign="top" align="left"> 330 <p>Is there an SAXO Style Guide available ?</p> 331 </td> 332 </tr> 333 <tr class="answer"> 334 <td valign="top" align="left"></td> 335 <td valign="top" align="left"> 336 <p>There is a template for header <a href="../new_header.txt" 337 target="_top">new_header.txt</a> which can be parsed by 338 <span class="application">IDLdoc</span>.</p> 339 <p>This file can be added in <span class="application">Emacs</span> 340 configuration <span class="guimenu">IDLWAVE</span> → 341 <span class="guimenuitem">Templates</span> → <span class= 342 "guimenuitem">Doc Header</span> (<span><strong class= 343 "shortcut"><span class="keysym">C-c</span>-<span class= 344 "keysym">C-h</span></strong></span>). in your <code class= 345 "filename">${HOME}/.emacs</code> like this :</p> 346 <pre class="programlisting"> 1 <?xml version="1.0" encoding="utf-8"?> 2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 3 <html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 6 <title>Frequently Asked questions about SAXO</title> 7 <link rel="stylesheet" href="style.css" type="text/css" /> 8 <link rel="stylesheet" href="saxo.css" type="text/css" /> 9 <link rev="made" href="mailto:saxo-dev_at_forge.ipsl.jussieu.fr" /> 10 <meta name="generator" content="DocBook XSL Stylesheets V1.71.1" /> 11 <meta name="keywords" content="IDL, SAXO, FAQ" /> 12 </head> 13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14 <div class="article" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="faqsaxo" id="faqsaxo"></a>Frequently Asked questions about SAXO</h2></div><div><div class="authorgroup"> 15 <div class="author"><h3 class="author"><span class="firstname">Sébastien</span> <span class="surname">Masson</span> <code class="email"><<a href="mailto:Sebastien.Masson_at_locean-ipsl.upmc.fr">Sebastien.Masson_at_locean-ipsl.upmc.fr</a>></code></h3></div> 16 <div class="author"><h3 class="author"><span class="firstname">Françoise</span> <span class="surname">Pinsard</span> <code class="email"><<a href="mailto:Francoise.Pinsard_at_locean-ipsl.upmc.fr">Francoise.Pinsard_at_locean-ipsl.upmc.fr</a>></code></h3></div> 17 </div></div><div><span class="pubdate">svn Id of xml source file : $Id: faqsaxo.xml 345 2008-04-16 09:15:20Z pinsard $<br /><br /></span></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="2"><b>Revision History</b></th></tr> 18 <tr><td align="left">Revision 0.0</td><td align="left">August 2006</td></tr><tr><td align="left" colspan="2">First draft</td></tr> 19 <tr><td align="left">Revision 0.1</td><td align="left">September 2006</td></tr><tr><td align="left" colspan="2">+ onlinehelp</td></tr> 20 <tr><td align="left">Revision 0.2</td><td align="left">April 2008</td></tr><tr><td align="left" colspan="2">migration from DocBook 4.2 to Docbook 5.0</td></tr> 21 </table></div></div></div><hr /></div> 22 23 24 25 26 27 <div class="qandaset"><dl><dt>1. <a href="#general">General</a></dt><dd><dl><dt>1.1. <a href="#id2550383"> 28 What is SAXO ? 29 </a></dt><dt>1.2. <a href="#id2550402"> 30 How can I get help ? 31 </a></dt><dt>1.3. <a href="#id2550427"> 32 How do I get SAXO ? 33 </a></dt><dt>1.4. <a href="#id2550452"> 34 What is the current version of SAXO ? 35 </a></dt><dt>1.5. <a href="#id2550477"> 36 On what systems does SAXO run ? 37 </a></dt><dt>1.6. <a href="#id2550497"> 38 Does SAXO works with GDL instead of IDL ? 39 </a></dt><dt>1.7. <a href="#id2550520"> 40 When is the next version of SAXO due out ? 41 </a></dt><dt>1.8. <a href="#id2550540"> 42 How can I find if a routine to do what I want already exists ? 43 </a></dt><dt>1.9. <a href="#id2550560"> 44 How should SAXO be cited or acknowledged in publication ? 45 </a></dt></dl></dd><dt>2. <a href="#technical">Technical questions</a></dt><dd><dl><dt>2.1. <a href="#id2550587"> 46 Is there on-line help for SAXO ? 47 </a></dt></dl></dd><dt>3. <a href="#Contributors">Contributors</a></dt><dd><dl><dt>3.1. <a href="#id2550642"> 48 Is there an SAXO Style Guide available ? 49 </a></dt><dt>3.2. <a href="#id2550657"> 50 Is there any trouble with IDLdoc ? 51 </a></dt><dt>3.3. <a href="#id2550833"> 52 How can I check spelling of XML files ? 53 </a></dt><dt>3.4. <a href="#id2550879"> 54 How can I check spelling of IDL files ? 55 </a></dt><dt>3.5. <a href="#id2550977"> 56 How can I see online help update ? 57 </a></dt></dl></dd></dl><p> 58 This is a list of Frequently Asked Questions about SAXO. 59 </p><p> 60 This list is roughly divided into categories: general questions, 61 technical questions, contributors questions. 62 </p><p> 63 Suggestions for corrections or additional sections are welcome -- please email them to <code class="email"><<a href="mailto:saxo-dev@forge.ipsl.jussieu.fr">saxo-dev@forge.ipsl.jussieu.fr</a>></code>. 64 </p><table border="0" summary="Q and A Set"><col align="left" width="1%" /><tbody><tr class="qandadiv"><td align="left" valign="top" colspan="2"><h3 class="title"><a name="general" id="general"></a>1. General</h3></td></tr><tr class="toc"><td align="left" valign="top" colspan="2"><dl><dt>1.1. <a href="#id2550383"> 65 What is SAXO ? 66 </a></dt><dt>1.2. <a href="#id2550402"> 67 How can I get help ? 68 </a></dt><dt>1.3. <a href="#id2550427"> 69 How do I get SAXO ? 70 </a></dt><dt>1.4. <a href="#id2550452"> 71 What is the current version of SAXO ? 72 </a></dt><dt>1.5. <a href="#id2550477"> 73 On what systems does SAXO run ? 74 </a></dt><dt>1.6. <a href="#id2550497"> 75 Does SAXO works with GDL instead of IDL ? 76 </a></dt><dt>1.7. <a href="#id2550520"> 77 When is the next version of SAXO due out ? 78 </a></dt><dt>1.8. <a href="#id2550540"> 79 How can I find if a routine to do what I want already exists ? 80 </a></dt><dt>1.9. <a href="#id2550560"> 81 How should SAXO be cited or acknowledged in publication ? 82 </a></dt></dl></td></tr> 83 <tr class="question"><td align="left" valign="top"><a name="id2550383" id="id2550383"></a><a name="id2550385" id="id2550385"></a><b>1.1.</b></td><td align="left" valign="top"><p> 84 What is SAXO ? 85 </p></td></tr> 86 <tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> 87 see document <a href="./whatissaxo.html" target="_top">What is SAXO</a>. 88 </p></td></tr> 89 90 <tr class="question"><td align="left" valign="top"><a name="id2550402" id="id2550402"></a><a name="id2550412" id="id2550412"></a><b>1.2.</b></td><td align="left" valign="top"><p> 91 How can I get help ? 92 </p></td></tr> 93 <tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> 94 see Support in document <a href="./websaxo.html" target="_top">Main page of SAXO</a>. 95 </p></td></tr> 96 97 <tr class="question"><td align="left" valign="top"><a name="id2550427" id="id2550427"></a><a name="id2550437" id="id2550437"></a><b>1.3.</b></td><td align="left" valign="top"><p> 98 How do I get SAXO ? 99 </p></td></tr> 100 <tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> 101 see document <a href="./getsaxo.html" target="_top">Get SAXO</a>. 102 </p></td></tr> 103 104 <tr class="question"><td align="left" valign="top"><a name="id2550452" id="id2550452"></a><a name="id2550462" id="id2550462"></a><b>1.4.</b></td><td align="left" valign="top"><p> 105 What is the current version of SAXO ? 106 </p></td></tr> 107 <tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> 108 </p></td></tr> 109 110 <tr class="question"><td align="left" valign="top"><a name="id2550477" id="id2550477"></a><a name="id2550480" id="id2550480"></a><b>1.5.</b></td><td align="left" valign="top"><p> 111 On what systems does SAXO run ? 112 </p></td></tr> 113 <tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> 114 </p></td></tr> 115 116 <tr class="question"><td align="left" valign="top"><a name="id2550497" id="id2550497"></a><a name="id2550499" id="id2550499"></a><b>1.6.</b></td><td align="left" valign="top"><p> 117 Does SAXO works with GDL instead of IDL ? 118 </p></td></tr> 119 <tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> 120 Not yet. 121 </p></td></tr> 122 123 <tr class="question"><td align="left" valign="top"><a name="id2550520" id="id2550520"></a><a name="id2550522" id="id2550522"></a><b>1.7.</b></td><td align="left" valign="top"><p> 124 When is the next version of SAXO due out ? 125 </p></td></tr> 126 <tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> 127 </p></td></tr> 128 129 <tr class="question"><td align="left" valign="top"><a name="id2550540" id="id2550540"></a><a name="id2550542" id="id2550542"></a><b>1.8.</b></td><td align="left" valign="top"><p> 130 How can I find if a routine to do what I want already exists ? 131 </p></td></tr> 132 <tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> 133 </p></td></tr> 134 135 <tr class="question"><td align="left" valign="top"><a name="id2550560" id="id2550560"></a><a name="id2550562" id="id2550562"></a><b>1.9.</b></td><td align="left" valign="top"><p> 136 How should SAXO be cited or acknowledged in publication ? 137 </p></td></tr> 138 <tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> 139 </p></td></tr> 140 <tr class="qandadiv"><td align="left" valign="top" colspan="2"><h3 class="title"><a name="technical" id="technical"></a>2. Technical questions</h3></td></tr><tr class="toc"><td align="left" valign="top" colspan="2"><dl><dt>2.1. <a href="#id2550587"> 141 Is there on-line help for SAXO ? 142 </a></dt></dl></td></tr> 143 <tr class="question"><td align="left" valign="top"><a name="id2550587" id="id2550587"></a><a name="id2550589" id="id2550589"></a><b>2.1.</b></td><td align="left" valign="top"><p> 144 Is there on-line help for SAXO ? 145 </p></td></tr> 146 <tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> 147 Yes, if you use at least IDL 6.2. It is produced by <span class="application"><a href="http://www.ittvis.com/codebank/search.asp?FID=100" target="_top">IDLdoc</a></span>. SAXO and IDL online_help have been merged, you can simply get the help by typing: 148 </p><pre class="screen"> 149 <code class="prompt">idl></code> <strong class="userinput"><code><span><strong class="command">?</strong></span></code></strong> 150 </pre><p> 151 </p></td></tr> 152 <tr class="qandadiv"><td align="left" valign="top" colspan="2"><h3 class="title"><a name="Contributors" id="Contributors"></a>3. Contributors</h3></td></tr><tr class="toc"><td align="left" valign="top" colspan="2"><dl><dt>3.1. <a href="#id2550642"> 153 Is there an SAXO Style Guide available ? 154 </a></dt><dt>3.2. <a href="#id2550657"> 155 Is there any trouble with IDLdoc ? 156 </a></dt><dt>3.3. <a href="#id2550833"> 157 How can I check spelling of XML files ? 158 </a></dt><dt>3.4. <a href="#id2550879"> 159 How can I check spelling of IDL files ? 160 </a></dt><dt>3.5. <a href="#id2550977"> 161 How can I see online help update ? 162 </a></dt></dl></td></tr> 163 <tr class="question"><td align="left" valign="top"><a name="id2550642" id="id2550642"></a><a name="id2550644" id="id2550644"></a><b>3.1.</b></td><td align="left" valign="top"><p> 164 Is there an SAXO Style Guide available ? 165 </p></td></tr> 166 <tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> 167 There is a template for header <a href="../new_header.txt" target="_top">new_header.txt</a> 168 which can be parsed by <span class="application">IDLdoc</span>. 169 </p><p> 170 This file can be added in <span class="application">Emacs</span> configuration 171 <span class="guimenu">IDLWAVE</span> â <span class="guimenuitem">Templates</span> â <span class="guimenuitem">Doc Header</span> (<span><strong class="shortcut"> 172 <span class="keysym">C-c</span>-<span class="keysym">C-h</span> 173 </strong></span>). 174 in your <code class="filename">${HOME}/.emacs</code> like this : 175 </p><pre class="programlisting"> 347 176 (add-hook 'idlwave-mode-hook 348 177 (function 349 178 (lambda () 350 (setq idlwave-file-header '("<em class= 351 "replaceable"><code>SAXO_basedirectory</code></em>/SAXO_DIR/SRC/Documentation/new_header.txt") 179 (setq idlwave-file-header '("<em class="replaceable"><code>SAXO_basedirectory</code></em>/SAXO_DIR/SRC/Documentation/new_header.txt") 352 180 )))) 353 </pre></td> 354 </tr> 355 <tr class="question"> 356 <td valign="top" align="left"><a name="N100E9" id= 357 "N100E9"></a><a name="N100EA" id="N100EA"></a><b>4.2.</b></td> 358 <td valign="top" align="left"> 359 <p>Is there any trouble with <span class= 360 "application">IDLdoc</span> ?</p> 361 </td> 362 </tr> 363 <tr class="answer"> 364 <td valign="top" align="left"></td> 365 <td valign="top" align="left"> 366 <p>Yes, there are some :</p> 367 <div class="itemizedlist"> 368 <ul type="disc"> 369 <li> 370 <p><code class="literal">\</code> in <code class= 371 "filename">*.pro</code> are not written in <code class= 372 "filename">*.html</code>. They must be escaped by an other 373 <code class="literal">\</code> or you can choose an other 374 character.</p> 375 </li> 376 <li> 377 <p><span class="guimenu">Search</span> doesn't handle characters 378 like <code class="literal">-</code> and <code class= 379 "literal">|</code>.</p> 380 </li> 381 <li> 382 <p>Paragraphs of <code class="filename">*.pro</code> headers are 383 shown with a proportional font in the <code class= 384 "literal">HTML</code> release.</p> 385 <p>If you need to draw some small figure like grid cell, you can 386 encapsulate between the block to be shown in constant font between 387 <code class="literal">; <fixe></code> and <code class= 388 "literal">; </fixe></code></p> 389 </li> 390 </ul> 181 </pre><p> 182 </p></td></tr> 183 184 <tr class="question"><td align="left" valign="top"><a name="id2550657" id="id2550657"></a><a name="id2550719" id="id2550719"></a><b>3.2.</b></td><td align="left" valign="top"><p> 185 Is there any trouble with <span class="application">IDLdoc</span> ? 186 </p></td></tr> 187 <tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> 188 Yes, there are some : 189 </p><div class="itemizedlist"><ul type="disc"><li> 190 <p> 191 <code class="literal">\</code> in <code class="filename">*.pro</code> are not written 192 in <code class="filename">*.html</code>. 193 They must be escaped by an other <code class="literal">\</code> or you can choose an other character. 194 </p> 195 </li><li> 196 <p> 197 <span class="guimenu">Search</span> doesn't handle characters like <code class="literal">-</code> 198 and <code class="literal">|</code>. 199 </p> 200 </li><li> 201 <p> 202 Paragraphs of <code class="filename">*.pro</code> headers are shown with a proportional 203 font in the <code class="literal">HTML</code> release. 204 </p> 205 <p> 206 If you need to draw some small figure like grid cell, you can encapsulate 207 the block to be shown in constant font 208 between 209 <code class="literal">; <fixe></code> and 210 <code class="literal">; </fixe></code> 211 </p> 212 </li></ul></div><p> 213 </p><p> 214 Unfortunately, these troubles may not be fixed because the author does not 215 have anymore the opportunity to work on his own work. 216 </p><p> 217 Bugs can be submitted to IDL but we do not expect answers ! 218 219 </p></td></tr> 220 221 <tr class="question"><td align="left" valign="top"><a name="id2550833" id="id2550833"></a><a name="id2550835" id="id2550835"></a><b>3.3.</b></td><td align="left" valign="top"><p> 222 How can I check spelling of XML files ? 223 </p></td></tr> 224 <tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> 225 There is one way with command line : 226 </p><pre class="screen"> 227 <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> <code class="filename"><em class="replaceable"><code>xmlfile</code></em></code></code></strong> 228 </pre><p> 229 </p></td></tr> 230 231 <tr class="question"><td align="left" valign="top"><a name="id2550879" id="id2550879"></a><a name="id2550881" id="id2550881"></a><b>3.4.</b></td><td align="left" valign="top"><p> 232 How can I check spelling of IDL files ? 233 </p></td></tr> 234 <tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> 235 Not so easy but you can start with something like this : 236 </p><pre class="screen"> 237 <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> <code class="filename">${HOME}/SAXO_DIR/SRC/</code></code></strong> 238 <code class="prompt">$</code> <strong class="userinput"><code>list=$(find . -name "*.pro")</code></strong> 239 <code class="prompt">$</code> <strong class="userinput"><code>for file in ${list}; do aspell list < ${file}; done > /tmp/list_word </code></strong> 240 <code class="prompt">$</code> <strong class="userinput"><code>sort -u /tmp/list_word > /tmp/list_sort</code></strong> 241 </pre><p> 242 </p><p> 243 This will give <code class="filename">/tmp/list_sort</code> a list of sorted word 244 used in IDL files that are not in the default dictionnary. 245 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. 246 </p><p> 247 To find occurences of one of these misspelled words, you have to do this : 248 </p><pre class="screen"> 249 <code class="prompt">$</code> <strong class="userinput"><code>find . -name "*.pro" -exec grep -h "<em class="replaceable"><code>misspelled_word</code></em>" {} \;</code></strong> 250 </pre><p> 251 </p><p> 252 We should improve this by providing some IDL and SAXO dictionnary. 253 </p></td></tr> 254 255 <tr class="question"><td align="left" valign="top"><a name="id2550977" id="id2550977"></a><a name="id2550979" id="id2550979"></a><b>3.5.</b></td><td align="left" valign="top"><p> 256 How can I see online help update ? 257 </p></td></tr> 258 <tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p> 259 You won't see online help update if you are working with the official distribution because of <code class="varname">!HELP_PATH</code>. To override this problem, when you are in <code class="filename"><em class="replaceable"><code>SAXO_basedirectory</code></em>/SAXO_DIR/SRC/Documentation/xmldoc/</code>, you can call online help like this : 260 </p><pre class="screen"> 261 <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> 262 </pre><p> 263 </p></td></tr> 264 </tbody></table></div> 391 265 </div> 392 <p>Unfortunately, these troubles may not be fixed because the 393 author does not have anymore the opportunity to work on his own 394 work.</p> 395 <p>Bugs can be submitted to IDL but we do not expect answers !</p> 396 </td> 397 </tr> 398 <tr class="question"> 399 <td valign="top" align="left"><a name="N10135" id= 400 "N10135"></a><a name="N10136" id="N10136"></a><b>4.3.</b></td> 401 <td valign="top" align="left"> 402 <p>How can I check spelling of xml files ?</p> 403 </td> 404 </tr> 405 <tr class="answer"> 406 <td valign="top" align="left"></td> 407 <td valign="top" align="left"> 408 <p>There is one way with command line :</p> 409 <pre class="screen"> 410 <code class="prompt">$</code> <strong class= 411 "userinput"><code><span><strong class= 412 "command">aspell</strong></span> <code class= 413 "option">--mode=sgml</code> <code class= 414 "option">-c</code> <em class="parameter"><code><code class= 415 "filename"><em class= 416 "replaceable"><code>xmlfile</code></em></code></code></em></code></strong> 417 418 </pre></td> 419 </tr> 420 <tr class="question"> 421 <td valign="top" align="left"><a name="N10157" id= 422 "N10157"></a><a name="N10158" id="N10158"></a><b>4.4.</b></td> 423 <td valign="top" align="left"> 424 <p>How can I see online help update ?</p> 425 </td> 426 </tr> 427 <tr class="answer"> 428 <td valign="top" align="left"></td> 429 <td valign="top" align="left"> 430 <p>You won't see online help update if you are working with the 431 official distribution because of <code class= 432 "varname">!HELP_PATH</code>. To override this problem, when you are 433 in <code class="filename"><em class= 434 "replaceable"><code>SAXO_basedirectory</code></em>/SAXO_DIR/SRC/Documentation/xmldoc/</code>, 435 you can call online help like this :</p> 436 <pre class="screen"> 437 <code class="prompt">idl></code> <strong class= 438 "userinput"><code><span><strong class= 439 "command">ONLINE_HELP</strong></span>,<code class= 440 "option">book="../idldoc_assistant_output/idldoc-lib.adp"</code></code></strong> 441 442 </pre></td> 443 </tr> 444 </tbody> 445 </table> 446 </div> 447 </div> 448 </body> 266 </body> 449 267 </html>
Note: See TracChangeset
for help on using the changeset viewer.