Changeset 345 for trunk/SRC/Documentation/xmldoc/mini_notice.xml
- Timestamp:
- 04/16/08 11:15:20 (16 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/xmldoc/mini_notice.xml
r327 r345 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" 4 [ 5 <!ENTITY hellip "…"> 1 <?xml version="1.0" encoding="iso-8859-1"?> 2 <!DOCTYPE article [ 3 <!ENTITY % isolat1 SYSTEM "http://www.w3.org/2003/entities/iso8879/isolat1.ent"> 4 %isolat1; 5 <!ENTITY % isolat2 SYSTEM "http://www.w3.org/2003/entities/iso8879/isolat2.ent"> 6 %isolat2; 7 <!ENTITY % isogrk3 SYSTEM "http://www.w3.org/2003/entities/iso8879/isogrk3.ent"> 8 %isogrk3; 9 <!ENTITY % isopub SYSTEM "http://www.w3.org/2003/entities/iso8879/isopub.ent"> 10 %isopub; 11 <!ENTITY % isotech SYSTEM "http://www.w3.org/2003/entities/iso8879/isotech.ent"> 12 %isotech; 13 <!ENTITY % isonum SYSTEM "http://www.w3.org/2003/entities/iso8879/isonum.ent"> 14 %isonum; 6 15 <!ENTITY promptidl "idl>"> 7 16 ] 8 17 > 18 <article version="5.0" 19 xmlns="http://docbook.org/ns/docbook" 20 xmlns:xl="http://www.w3.org/1999/xlink" 21 xmlns:xi="http://www.w3.org/2001/XInclude" 22 xml:lang="en" 23 xml:id="mini_notice"> 9 24 <!-- 10 25 … … 19 34 20 35 --> 21 <article lang="en"> 22 <title> 23 Mini Guide for Basic Commands in the XXX Program 24 </title> 25 <articleinfo> 36 <title> Mini Guide for Basic Commands in the XXX Program </title> 37 <info> 26 38 <authorgroup> 27 <author>< firstname>Sébastien</firstname><surname>Masson</surname><email>Sebastien.Masson_at_locean-ipsl.upmc.fr</email></author>28 <author>< firstname>Albert</firstname><surname>Fisher</surname></author>29 <author>< firstname>Françoise</firstname><surname>Pinsard</surname><email>Francoise.Pinsard_at_locean-ipsl.upmc.fr</email></author>30 <author>< firstname>Steve</firstname><surname>Navarro</surname></author>39 <author><personname><firstname>Sébastien</firstname> <surname>Masson</surname></personname> <email>Sebastien.Masson_at_locean-ipsl.upmc.fr</email></author> 40 <author><personname><firstname>Albert</firstname> <surname>Fisher</surname></personname></author> 41 <author><personname><firstname>Françoise</firstname> <surname>Pinsard</surname></personname> <email>Francoise.Pinsard_at_locean-ipsl.upmc.fr</email></author> 42 <author><personname><firstname>Steve</firstname> <surname>Navarro</surname></personname></author> 31 43 </authorgroup> 32 44 <keywordset> … … 61 73 <revremark>Review by Sébastien Masson</revremark> 62 74 </revision> 75 <revision> 76 <revnumber>1.2</revnumber> 77 <date>April 2008</date> 78 <revremark>migration from DocBook 4.2 to Docbook 5.0</revremark> 79 </revision> 80 63 81 </revhistory> 64 82 <pubdate>$Id$</pubdate> 65 </ articleinfo>66 67 68 <sect1 id="launchxxx"><title>Launching XXX</title>83 </info> 84 85 86 <sect1 xml:id="launchxxx"><title>Launching XXX</title> 69 87 70 88 <para> 71 89 There is several ways to launch XXX which we will detail in the next sections: 72 <screen format="linespecific">90 <screen> 73 91 <prompt>&promptidl;</prompt> <userinput><command>xxx</command></userinput> 74 92 <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>/separate</parameter></userinput> … … 82 100 </para> 83 101 84 <sect2 id="launch_xxx_1"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command></userinput></title>102 <sect2 xml:id="launch_xxx_1"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command></userinput></title> 85 103 <para> 86 104 A window will open with 3 parts to consider. 87 <figure id="fig_xxx_0101">105 <figure xml:id="fig_xxx_0101"> 88 106 <title>Window xxx 1</title> 89 <mediaobject co>107 <mediaobject> 90 108 <imageobjectco> 91 109 <areaspec units="calspair"> 92 <area id="datafile" coords="500,1715 9326,3074"/>93 <area id="initmethod" coords="1500,3268 8326,4919"/>94 <area id="initprogram" coords="57,5145 9961,8996"/>110 <area xml:id="datafile" coords="500,1715 9326,3074"/> 111 <area xml:id="initmethod" coords="1500,3268 8326,4919"/> 112 <area xml:id="initprogram" coords="57,5145 9961,8996"/> 95 113 </areaspec> 96 114 <imageobject> … … 112 130 <textobject>[plot figpng/xxx_0101.png]</textobject> 113 131 --> 114 </mediaobject co>132 </mediaobject> 115 133 </figure> 116 134 </para> 117 135 118 <sect3 id="datafiletxt"><title>Data file name</title>136 <sect3 xml:id="datafiletxt"><title>Data file name</title> 119 137 <para> 120 138 The name of the data file. It can be typed directly in the window provided, or selected with the help of the <guibutton>browse</guibutton> button. 121 139 </para> 122 140 </sect3> 123 <sect3 id="initmethodtxt"><title>Grid initialization method</title>141 <sect3 xml:id="initmethodtxt"><title>Grid initialization method</title> 124 142 <para> 125 For visualising grilled data, you need to < ulink url="./firststeps.html#load_grid">define the grid</ulink> on which are located the data. By default, "automatic grid construction with initncdf.pro" is checked. This means that the grid will be defined by using the informations contained in the data file (through the IDL prodecure <command>initncdf</command>) without needing any other auxiliary file. If you checked "grid construction with other IDL batch or procedure", this means that you don't want to use the default <command>initncdf</command> procedure to define the grid and you will provide your own IDL procedure or the so-called IDL batch file (a file which is called by using @, see IDL documentation).143 For visualising grilled data, you need to <link xl:href="./firststeps.html#load_grid">define the grid</link> on which are located the data. By default, "automatic grid construction with initncdf.pro" is checked. This means that the grid will be defined by using the informations contained in the data file (through the IDL prodecure <command>initncdf</command>) without needing any other auxiliary file. If you checked "grid construction with other IDL batch or procedure", this means that you don't want to use the default <command>initncdf</command> procedure to define the grid and you will provide your own IDL procedure or the so-called IDL batch file (a file which is called by using @, see IDL documentation). 126 144 </para> 127 145 </sect3> 128 <sect3 id="initprogramtxt"><title>Grid initialization parameters</title>146 <sect3 xml:id="initprogramtxt"><title>Grid initialization parameters</title> 129 147 <para> 130 148 This third part allows you to specify the name, the argument and the keywords of the routine you want to use to initialize the grid. 131 149 By default the name of the procedure is <command>initncdf</command>, its argument will be automatically defined so you cannot change them. If you If you checked "grid construction with other IDL batch or procedure", you have to select the name of the IDL procedure or batch file and its suitable arguments and keywords. Note that if you select an IDL batch file you cannot give any parameter or keyword. 132 <figure id="fig_xxx_0102">150 <figure xml:id="fig_xxx_0102"> 133 151 <title>Window xxx 1</title> 134 <mediaobjectco> 135 <imageobjectco> 136 <imageobject> 137 <imagedata fileref="figpng/xxx_0102.png"/> 138 </imageobject> 139 </imageobjectco> 140 </mediaobjectco> 152 <mediaobject> 153 <imageobject> 154 <imagedata fileref="figpng/xxx_0102.png"/> 155 </imageobject> 156 </mediaobject> 141 157 </figure> 142 158 </para> … … 147 163 </para> 148 164 <para> 149 <figure id="fig_xxx_0103">165 <figure xml:id="fig_xxx_0103"> 150 166 <title>Oceania at 125 meters of depth with proper grid initialization</title> 151 <imageobject> 152 <imagedata fileref="figpng/xxx_0103.png"/> 153 </imageobject> 154 </figure> 155 </para> 156 </sect3> 157 </sect2> 158 159 <sect2 id="launch_xxx_2"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>/separate</parameter></userinput></title> 167 <mediaobject> 168 <imageobject> 169 <imagedata fileref="figpng/xxx_0103.png"/> 170 </imageobject> 171 </mediaobject> 172 </figure> 173 </para> 174 </sect3> 175 </sect2> 176 177 <sect2 xml:id="launch_xxx_2"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>/separate</parameter></userinput></title> 160 178 <para> 161 179 This is the same as the simple <link linkend="launch_xxx_1"><prompt>&promptidl;</prompt> <userinput><command>xxx</command></userinput></link> except that once the xxx window open, you will have 2 separate windows (command and plotting window) instead of one. … … 163 181 </sect2> 164 182 165 <sect2 id="launch_xxx_3"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>restore = 'file.dat'</parameter></userinput></title>183 <sect2 xml:id="launch_xxx_3"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>restore = 'file.dat'</parameter></userinput></title> 166 184 <para> 167 185 In that case xxx window will open directly in the same state as it was when the file "file.dat" was created. see <link linkend="restore">+++++++</link> … … 169 187 </sect2> 170 188 171 <sect2 id="launch_xxx_4"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter></userinput></title>189 <sect2 xml:id="launch_xxx_4"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter></userinput></title> 172 190 <para> 173 191 In this case, the xxx window directly open the data file 'file.nc' and build the grid automatically with the IDL procedure <command>initncdf</command>. For example: 174 <screen format="linespecific">192 <screen> 175 193 <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'Levitus98_1m_01_12_Temperature_Pot_1x1.nc'</parameter></userinput> 176 194 </screen> … … 178 196 </sect2> 179 197 180 <sect2 id="launch_xxx_5"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>keywd1 = …</parameter>, <parameter>keywd2 = …</parameter></userinput></title>198 <sect2 xml:id="launch_xxx_5"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>keywd1 = …</parameter>, <parameter>keywd2 = …</parameter></userinput></title> 181 199 <para> 182 200 In this case, the xxx window directly open the data file 'file.nc', build the grid automatically with the IDL procedure <command>initncdf</command> and use the keywords <userinput><parameter>keywd1 = …</parameter>, <parameter>keywd2 = …</parameter></userinput> in the call of <command>initncdf</command>. For example: 183 <screen format="linespecific">201 <screen> 184 202 <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'Levitus98_1m_01_12_Temperature_Pot_1x1.nc'</parameter>, <parameter>useasmask = 'votemper'</parameter>, <parameter>missing_value = 31.0720</parameter></userinput> 185 203 </screen> … … 187 205 </sect2> 188 206 189 <sect2 id="launch_xxx_6"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter></userinput></title>207 <sect2 xml:id="launch_xxx_6"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter></userinput></title> 190 208 <para> 191 209 In this case, the xxx window directly open the data file 'file.nc' and build the grid directly with the IDL procedure or batch file <command>initgrid</command> 192 <screen format="linespecific">210 <screen> 193 211 <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'Levitus98_1m_01_12_Temperature_Pot_ORCA2.nc'</parameter>, <parameter>'tst_initorca2'</parameter></userinput> 194 212 </screen> … … 196 214 </sect2> 197 215 198 <sect2 id="launch_xxx_7"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter>, <parameter>keywd1 = …</parameter>, <parameter>keywd2 = …</parameter></userinput></title>216 <sect2 xml:id="launch_xxx_7"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter>, <parameter>keywd1 = …</parameter>, <parameter>keywd2 = …</parameter></userinput></title> 199 217 <para> 200 218 In this case, the xxx window directly open the data file 'file.nc', build the grid directly with the IDL procedure <command>initgrid</command> and use the keywords <userinput><parameter>keywd1 = …</parameter>, <parameter>keywd2 = …</parameter></userinput> in the call of <command>initgrid</command>. … … 202 220 </sect2> 203 221 204 <sect2 id="launch_xxx_8"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter>, <parameter>'arg1, arg2, …'</parameter></userinput></title>222 <sect2 xml:id="launch_xxx_8"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter>, <parameter>'arg1, arg2, …'</parameter></userinput></title> 205 223 <para> 206 224 In this case, the xxx window directly open the data file 'file.nc', build the grid directly with the IDL procedure <command>initgrid</command> and use the string <userinput><parameter>'arg1, arg2, …'</parameter></userinput> to specify the input arguments in the call of <command>initgrid</command>. … … 210 228 </sect1> 211 229 212 <sect1 id="wigdets"><title>Description of XXX window</title>230 <sect1 xml:id="wigdets"><title>Description of XXX window</title> 213 231 214 232 <para> … … 220 238 ce produit klickety est installable via fink sous mac 221 239 --> 222 <figure id="fig_xxx_0201">240 <figure xml:id="fig_xxx_0201"> 223 241 <title>Window xxx 2</title> 224 <mediaobject co>242 <mediaobject> 225 243 <imageobjectco> 226 244 <areaspec units="calspair"> 227 <area id="plottype" coords="69,380 2261,809"/>228 <area id="menu" coords="2517,380 7575,841"/>229 <area id="ok" coords="116,936 1025,1365"/>230 <area id="pagelayout" coords="1631,936 4498,1365"/>231 <area id="variableslist" coords="4871,952 7529,1349"/>232 <area id="fileslist" coords="46,1507 8018,1857"/>233 <area id="commandtext" coords="46,2000 8065,2539"/>234 <area id="calendar" coords="46,2682 4941,3428"/>235 <area id="domdef" coords="372,3603 7179,7095"/>236 <area id="specifications" coords="23,7269 8041,9206"/>245 <area xml:id="plottype" coords="69,380 2261,809"/> 246 <area xml:id="menu" coords="2517,380 7575,841"/> 247 <area xml:id="ok" coords="116,936 1025,1365"/> 248 <area xml:id="pagelayout" coords="1631,936 4498,1365"/> 249 <area xml:id="variableslist" coords="4871,952 7529,1349"/> 250 <area xml:id="fileslist" coords="46,1507 8018,1857"/> 251 <area xml:id="commandtext" coords="46,2000 8065,2539"/> 252 <area xml:id="calendar" coords="46,2682 4941,3428"/> 253 <area xml:id="domdef" coords="372,3603 7179,7095"/> 254 <area xml:id="specifications" coords="23,7269 8041,9206"/> 237 255 </areaspec> 238 256 <imageobject> … … 275 293 <textobject>[plot figpng/xxx_0201.png]</textobject> 276 294 --> 277 </mediaobject co>295 </mediaobject> 278 296 </figure> 279 297 </para> 280 298 281 <sect2 id="plottypetxt"><title>Plot type list</title>299 <sect2 xml:id="plottypetxt"><title>Plot type list</title> 282 300 <para>Allows specification of the type of plot desired.</para> 283 301 <para> 284 <figure id="fig_xxx_0202">302 <figure xml:id="fig_xxx_0202"> 285 303 <title>Different plot types available</title> 286 <imageobject> 287 <imagedata fileref="figpng/xxx_0202.png"/> 288 </imageobject> 304 <mediaobject> 305 <imageobject> 306 <imagedata fileref="figpng/xxx_0202.png"/> 307 </imageobject> 308 </mediaobject> 289 309 </figure> 290 310 </para> … … 296 316 </sect2> 297 317 298 <sect2 id="menutxt"><title>The menu bar made up of 3 sub-menus</title>299 <sect3 id="filesubmenu"><title><guibutton>File</guibutton> sub-menu</title>300 <para> 301 <figure id="fig_xxx_0203">318 <sect2 xml:id="menutxt"><title>The menu bar made up of 3 sub-menus</title> 319 <sect3 xml:id="filesubmenu"><title><guibutton>File</guibutton> sub-menu</title> 320 <para> 321 <figure xml:id="fig_xxx_0203"> 302 322 <title>The File menu</title> 303 <imageobject> 304 <imagedata fileref="figpng/xxx_0203.png"/> 305 </imageobject> 323 <mediaobject> 324 <imageobject> 325 <imagedata fileref="figpng/xxx_0203.png"/> 326 </imageobject> 327 </mediaobject> 306 328 </figure> 307 329 </para> … … 311 333 The new file can be on a different grid, with different variables, with a different time base … 312 334 </para></listitem> 313 <listitem><para><menuchoice><guisubmenu>New XXX:</guisubmenu></menuchoice> to open a second XXX window identical to the first one.</para></listitem>335 <listitem><para><menuchoice><guisubmenu>New XXX:</guisubmenu></menuchoice> to open a second XXX window xml:identical to the first one.</para></listitem> 314 336 <listitem><para><menuchoice><guisubmenu>Quit:</guisubmenu></menuchoice> to close the XXX window.</para></listitem> 315 337 </itemizedlist> 316 338 </para> 317 339 </sect3> 318 <sect3 id="saveassubmenu"><title><guibutton>Save As</guibutton> sub-menu</title>319 <para> 320 <figure id="fig_xxx_0204">340 <sect3 xml:id="saveassubmenu"><title><guibutton>Save As</guibutton> sub-menu</title> 341 <para> 342 <figure xml:id="fig_xxx_0204"> 321 343 <title>The Save As menu</title> 322 <imageobject> 323 <imagedata fileref="figpng/xxx_0204.png"/> 324 </imageobject> 344 <mediaobject> 345 <imageobject> 346 <imagedata fileref="figpng/xxx_0204.png"/> 347 </imageobject> 348 </mediaobject> 325 349 </figure> 326 350 </para> … … 334 358 <listitem><para><menuchoice><guisubmenu>Gif:</guisubmenu></menuchoice> to save a gif of the plotting window.</para></listitem> 335 359 <listitem><para><menuchoice><guisubmenu>IDL procedure:</guisubmenu></menuchoice> to save the command history that has created the plot in an IDL procedure that can be re-executed later. For example if I save the commands in <filename>xxx_figure.pro</filename> file, when ever I want, I can then launch a new IDL session and type: 336 <screen format="linespecific">360 <screen> 337 361 <prompt>&promptidl;</prompt> <userinput>@init</userinput> 338 362 <prompt>&promptidl;</prompt> <userinput>xxx_figure</userinput> 339 363 </screen> 340 364 and I'll obtain the saved figure. 341 <screen format="linespecific">365 <screen> 342 366 <prompt>&promptidl;</prompt> <userinput>xxx_figure,/post</userinput> 343 367 </screen> 344 368 or 345 <screen format="linespecific">369 <screen> 346 370 <prompt>&promptidl;</prompt> <userinput>@ps</userinput> 347 371 </screen> 348 372 will then create a Postscript file of the figure. 349 373 </para></listitem> 350 <listitem><para id='restore'><menuchoice><guisubmenu>RESTORE kwd of xxx:</guisubmenu></menuchoice> to save the xxx widget (all buttons and parameters stored in memory …) in a binary file in order to quit xxx and relaunch it later with <link linkend="launch_xxx_3"><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>restore = 'file.dat'</parameter></userinput></link> and get exactly the same configuration.</para></listitem>374 <listitem><para xml:id='restore'><menuchoice><guisubmenu>RESTORE kwd of xxx:</guisubmenu></menuchoice> to save the xxx widget (all buttons and parameters stored in memory …) in a binary file in order to quit xxx and relaunch it later with <link linkend="launch_xxx_3"><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>restore = 'file.dat'</parameter></userinput></link> and get exactly the same configuration.</para></listitem> 351 375 <listitem><para><menuchoice><guisubmenu>Print to prompt:</guisubmenu></menuchoice> lists in the IDL window the command history that created the last plot. Useful primarily for debugging…</para></listitem> 352 376 </itemizedlist> 353 377 </para> 354 378 </sect3> 355 <sect3 id="flagsubmenu"><title><guisubmenu>Flag options</guisubmenu> sub-menu</title>356 <para> 357 <figure id="fig_xxx_0205">379 <sect3 xml:id="flagsubmenu"><title><guisubmenu>Flag options</guisubmenu> sub-menu</title> 380 <para> 381 <figure xml:id="fig_xxx_0205"> 358 382 <title>The Flag Option menu</title> 359 <imageobject> 360 <imagedata fileref="figpng/xxx_0205.png"/> 361 </imageobject> 383 <mediaobject> 384 <imageobject> 385 <imagedata fileref="figpng/xxx_0205.png"/> 386 </imageobject> 387 </mediaobject> 362 388 </figure> 363 389 </para> … … 378 404 </sect2> 379 405 380 <sect2 id="oktxt"><title>OK button</title>406 <sect2 xml:id="oktxt"><title>OK button</title> 381 407 <para>Click on this <guibutton>OK</guibutton> button is required to make a new plot appear</para> 382 408 </sect2> 383 409 384 <sect2 id="pagelayouttxt"><title>Page Layout</title>410 <sect2 xml:id="pagelayouttxt"><title>Page Layout</title> 385 411 <para>Specify the number of columns and rows for plots on the sheet of paper.</para> 386 412 <para> 387 <figure id="fig_xxx_0206">413 <figure xml:id="fig_xxx_0206"> 388 414 <title>Number of Column</title> 389 <imageobject> 390 <imagedata fileref="figpng/xxx_0206.png"/> 391 </imageobject> 392 </figure> 393 </para> 394 <para> 395 <figure id="fig_xxx_0206a"> 415 <mediaobject> 416 <imageobject> 417 <imagedata fileref="figpng/xxx_0206.png"/> 418 </imageobject> 419 </mediaobject> 420 </figure> 421 </para> 422 <para> 423 <figure xml:id="fig_xxx_0206a"> 396 424 <title>Example: For 2 columns and 2 rows</title> 397 <imageobject> 398 <imagedata fileref="figpng/xxx_0206a.png"/> 399 </imageobject> 400 </figure> 401 </para> 402 </sect2> 403 404 <sect2 id="variableslisttxt"><title>List of variables</title> 425 <mediaobject> 426 <imageobject> 427 <imagedata fileref="figpng/xxx_0206a.png"/> 428 </imageobject> 429 </mediaobject> 430 </figure> 431 </para> 432 </sect2> 433 434 <sect2 xml:id="variableslisttxt"><title>List of variables</title> 405 435 <para>You can choose the variable to work on.</para> 406 436 <para> 407 <figure id="fig_xxx_0207">437 <figure xml:id="fig_xxx_0207"> 408 438 <title>Example of different Variables available</title> 409 <imageobject> 410 <imagedata fileref="figpng/xxx_0207.png"/> 411 </imageobject> 412 </figure> 413 </para> 414 </sect2> 415 416 <sect2 id="fileslisttxt"><title>List of open files</title> 439 <mediaobject> 440 <imageobject> 441 <imagedata fileref="figpng/xxx_0207.png"/> 442 </imageobject> 443 </mediaobject> 444 </figure> 445 </para> 446 </sect2> 447 448 <sect2 xml:id="fileslisttxt"><title>List of open files</title> 417 449 <para>You can choose the file to work on.</para> 418 450 <para> 419 <figure id="fig_xxx_0208">451 <figure xml:id="fig_xxx_0208"> 420 452 <title>Example of list of open files</title> 421 <imageobject> 422 <imagedata fileref="figpng/xxx_0208.png"/> 423 </imageobject> 424 </figure> 425 </para> 426 </sect2> 427 428 <sect2 id="commandtexttxt"><title><guimenuitem>Command text</guimenuitem><!--++ textarea--></title> 453 <mediaobject> 454 <imageobject> 455 <imagedata fileref="figpng/xxx_0208.png"/> 456 </imageobject> 457 </mediaobject> 458 </figure> 459 </para> 460 </sect2> 461 462 <sect2 xml:id="commandtexttxt"><title><guimenuitem>Command text</guimenuitem><!--++ textarea--></title> 429 463 <para> 430 464 To specify in the widget part number 7 the computation you want to do on the data 431 465 <note><para>In all cases bellow, the name given to a field (a, b, c, …) is of no importance.</para></note> 432 466 </para> 433 <sect3 id="commandtext1"><title>Linear calculation</title>434 <para> 435 If you want to make basic linear computation (like difference between fields, add/multiply by a constant …). you can simply put the following commands: <screen format="linespecific">a - b</screen><screen format="linespecific">numb1*a</screen><screen format="linespecific">a + numb</screen> or any command with the following format <screen format="linespecific">numb1*a + numb2*b + numb3*c … + numb</screen> where numb1, numb2, … correspond to numbers and a, b, c … will be the data to read.436 </para> 437 </sect3> 438 <sect3 id="commandtext1"><title>Any kind of computation</title>439 <para> 440 If you want to make a computation more complicated than a basic linear you must put designate the data you want to read between <keycap>"</keycap><keycap>"</keycap> (with anything in between the "). For example: <screen format="linespecific">"a"^2</screen><screen format="linespecific">"a" - abs("b")</screen><screen format="linespecific">grad("a", 'x')</screen> …441 </para> 442 </sect3> 443 </sect2> 444 445 <sect2 id="calendartxt"><title>Calendar</title>467 <sect3 xml:id="commandtext_linear"><title>Linear calculation</title> 468 <para> 469 If you want to make basic linear computation (like difference between fields, add/multiply by a constant …). you can simply put the following commands: <screen>a - b</screen><screen>numb1*a</screen><screen>a + numb</screen> or any command with the following format <screen>numb1*a + numb2*b + numb3*c … + numb</screen> where numb1, numb2, … correspond to numbers and a, b, c … will be the data to read. 470 </para> 471 </sect3> 472 <sect3 xml:id="commandtext_anykind"><title>Any kind of computation</title> 473 <para> 474 If you want to make a computation more complicated than a basic linear you must put designate the data you want to read between <keycap>"</keycap><keycap>"</keycap> (with anything in between the "). For example: <screen>"a"^2</screen><screen>"a" - abs("b")</screen><screen>grad("a", 'x')</screen> … 475 </para> 476 </sect3> 477 </sect2> 478 479 <sect2 xml:id="calendartxt"><title>Calendar</title> 446 480 <para> 447 481 The calendar is made up of two drop-lists, which allow specification of two dates, the beginning and end of a time series, or the period over which to average before plotting.</para> 448 482 <para> 449 <figure id="fig_xxx_0301">483 <figure xml:id="fig_xxx_0301"> 450 484 <title>Example: first plot in January, second plot is from January to December</title> 451 <imageobject> 452 <imagedata fileref="figpng/xxx_0301.png"/> 453 </imageobject> 454 </figure> 455 </para> 456 </sect2> 457 458 <sect2 id="domdeftxt"><title>Define the domain</title> 485 <mediaobject> 486 <imageobject> 487 <imagedata fileref="figpng/xxx_0301.png"/> 488 </imageobject> 489 </mediaobject> 490 </figure> 491 </para> 492 </sect2> 493 494 <sect2 xml:id="domdeftxt"><title>Define the domain</title> 459 495 <para> 460 496 A series of widgets that allow specification of the min/max limits of the domain in longitude/x-index, latitude/y-index, and depth in levels or meters. 461 <figure id="fig_xxx_0210">497 <figure xml:id="fig_xxx_0210_domain"> 462 498 <title>Domain by default</title> 499 <mediaobject> 463 500 <imageobject> 464 501 <imagedata fileref="figpng/xxx_0210.png"/> 465 502 </imageobject> 466 </figure> 467 <figure id="fig_xxx_0401"> 503 </mediaobject> 504 </figure> 505 <figure xml:id="fig_xxx_0401"> 468 506 <title>Change Domain area: zoom on Oceania</title> 469 <imageobject> 470 <imagedata fileref="figpng/xxx_0401.png"/> 471 </imageobject> 472 </figure> 473 <figure id="fig_xxx_0402"> 507 <mediaobject> 508 <imageobject> 509 <imagedata fileref="figpng/xxx_0401.png"/> 510 </imageobject> 511 </mediaobject> 512 </figure> 513 <figure xml:id="fig_xxx_0402"> 474 514 <title>This configuration give us:</title> 515 <mediaobject> 475 516 <imageobject> 476 517 <imagedata fileref="figpng/xxx_0402.png"/> 477 518 </imageobject> 478 </figure> 479 <figure id="fig_xxx_0403"> 519 </mediaobject> 520 </figure> 521 <figure xml:id="fig_xxx_0403"> 480 522 <title>Change depth area: between depth 125 and 126</title> 523 <mediaobject> 481 524 <imageobject> 482 525 <imagedata fileref="figpng/xxx_0403.png"/> 483 526 </imageobject> 484 </figure> 485 <figure id="fig_xxx_0404"> 527 </mediaobject> 528 </figure> 529 <figure xml:id="fig_xxx_0404"> 486 530 <title>temperature of the ocean at depth 125 meters without proper land/sea mask</title> 531 <mediaobject> 487 532 <imageobject> 488 533 <imagedata fileref="figpng/xxx_0404.png"/> 489 534 </imageobject> 535 </mediaobject> 490 536 </figure> 491 537 As you can see, at this depth, we better define a land/sea mask when loading the grid. Cf <xref linkend="fig_xxx_0103"/> … … 493 539 </sect2> 494 540 495 <sect2 id="specificationstxt"><title>Specify your plot</title>496 497 <sect3 id="minmaxintervaltxt"><title>Specify min, max and contour interval</title>498 <para> 499 <figure id="fig_xxx_0501">541 <sect2 xml:id="specificationstxt"><title>Specify your plot</title> 542 543 <sect3 xml:id="minmaxintervaltxt"><title>Specify min, max and contour interval</title> 544 <para> 545 <figure xml:id="fig_xxx_0501"> 500 546 <title>min, max, and contour interval specifications</title> 547 <mediaobject> 501 548 <imageobject> 502 549 <imagedata fileref="figpng/xxx_0501.png"/> 503 550 </imageobject> 551 </mediaobject> 504 552 </figure> 505 553 You can restore configuration by default by pressing the <menuchoice><guibutton>Default</guibutton></menuchoice> button. 506 <note><para>The path of the file < ulink type="text" url="../../ToBeReviewed/WIDGET/AUTOUR_de_XXX/definedefaultextra.pro"><filename>definedefaultextra.pro</filename></ulink> that defines the default values for each variable names is displayed when the cursor hovers over the button <menuchoice><guibutton>Default</guibutton></menuchoice>. This file contains a case statement based on the name of the variable and defining the min, max, contour interval and other keywords that should be used as default for the specified variable. You can copy this file in your own <filename class="directory"><envar>${HOME}</envar>/My_IDL/</filename> directory and easily modify it to suit your favorite default values.</para></note>507 </para> 508 </sect3> 509 510 <sect3 id="colortxt"><title>Specify the palette to be used</title>554 <note><para>The path of the file <link xl:href="../../ToBeReviewed/WIDGET/AUTOUR_de_XXX/definedefaultextra.pro"><filename>definedefaultextra.pro</filename></link> that defines the default values for each variable names is displayed when the cursor hovers over the button <menuchoice><guibutton>Default</guibutton></menuchoice>. This file contains a case statement based on the name of the variable and defining the min, max, contour interval and other keywords that should be used as default for the specified variable. You can copy this file in your own <filename class="directory">${HOME}/My_IDL/</filename> directory and easily modify it to suit your favorite default values.</para></note> 555 </para> 556 </sect3> 557 558 <sect3 xml:id="colortxt"><title>Specify the palette to be used</title> 511 559 <para>For the color palette, you can either specify the name or go search for one among the palettes available.</para> 512 560 <para> 513 <figure id="fig_xxx_0502">561 <figure xml:id="fig_xxx_0502"> 514 562 <title>The Color menu</title> 515 <imageobject> 516 <imagedata fileref="figpng/xxx_0502.png"/> 517 </imageobject> 518 </figure> 519 </para> 520 </sect3> 521 522 <sect3 id="kwdtxt"><title>Add any keyword</title> 563 <mediaobject> 564 <imageobject> 565 <imagedata fileref="figpng/xxx_0502.png"/> 566 </imageobject> 567 </mediaobject> 568 </figure> 569 </para> 570 </sect3> 571 572 <sect3 xml:id="kwdtxt"><title>Add any keyword</title> 523 573 <para> 524 574 The <quote>keywords</quote> window allows specification of all desired keywords. There is a few examples of the use of this <quote>keywords</quote> window. 525 <figure id="fig_xxx_0209">575 <figure xml:id="fig_xxx_0209"> 526 576 <title>Without any additional keyword</title> 577 <mediaobject> 527 578 <imageobject> 528 579 <imagedata fileref="figpng/xxx_0209.png"/> 529 580 </imageobject> 530 </figure> 531 <figure id="fig_xxx_0210a"> 581 </mediaobject> 582 </figure> 583 <figure xml:id="fig_xxx_0210a"> 532 584 <title>Add <varname>/realcont</varname> keyword</title> 585 <mediaobject> 533 586 <imageobject> 534 587 <imagedata fileref="figpng/xxx_0210a.png"/> 535 588 </imageobject> 536 </figure> 537 <figure id="fig_xxx_0210"> 589 </mediaobject> 590 </figure> 591 <figure xml:id="fig_xxx_0210_realcont"> 538 592 <title>Graphic with <varname>/realcont</varname> keyword</title> 593 <mediaobject> 539 594 <imageobject> 540 595 <imagedata fileref="figpng/xxx_0210.png"/> 541 596 </imageobject> 542 </figure> 543 <figure id="fig_xxx_0211a"> 597 </mediaobject> 598 </figure> 599 <figure xml:id="fig_xxx_0211a"> 544 600 <title>Add <userinput>/realcont, map=[90,0,0], /ortho, cell_fill=2</userinput> keywords</title> 601 <mediaobject> 545 602 <imageobject> 546 603 <imagedata fileref="figpng/xxx_0211a.png"/> 547 604 </imageobject> 548 </figure> 549 <figure id="fig_xxx_0211"> 605 </mediaobject> 606 </figure> 607 <figure xml:id="fig_xxx_0211"> 550 608 <title>Graphic with <literal>/realcont, map=[90,0,0], /ortho, cell_fill=2</literal> keywords</title> 609 <mediaobject> 551 610 <imageobject> 552 611 <imagedata fileref="figpng/xxx_0211.png"/> 553 612 </imageobject> 613 </mediaobject> 554 614 </figure> 555 615 </para> … … 558 618 </sect1> 559 619 560 <sect1 id="mouseactions"><title>Mouse Actions</title>561 562 <sect2 id="mouse"><title>In the graphics window on a horizontal plot</title>620 <sect1 xml:id="mouseactions"><title>Mouse Actions</title> 621 622 <sect2 xml:id="mouse"><title>In the graphics window on a horizontal plot</title> 563 623 <para> 564 624 Select a domain and select the horizontal plot (<constant>plt</constant>), vertical plot … … 586 646 <para> 587 647 <itemizedlist> 588 <listitem><para> 589 <figure id="fig_mousell"> 648 <listitem> 649 <para> 650 <figure xml:id="fig_mousell"> 590 651 <title><abbrev>LCL</abbrev>---><constant>plt</constant></title> 591 <mediaobjectco> 592 <imageobjectco> 593 <imageobject> 594 <imagedata fileref="figpng/xxx_mousell.png"/> 595 </imageobject> 596 </imageobjectco> 597 </mediaobjectco> 598 </figure> 599 <para> 600 <figure id="fig_xxx_0701"> 652 <mediaobject> 653 <imageobject> 654 <imagedata fileref="figpng/xxx_mousell.png"/> 655 </imageobject> 656 </mediaobject> 657 </figure> 658 </para> 659 <para> 660 <figure xml:id="fig_xxx_0701"> 601 661 <title>Horizontal Plot</title> 602 <imageobject> 603 <imagedata fileref="figpng/xxx_0701.png"/> 604 </imageobject> 605 </figure> 606 </para> 607 608 </para></listitem> 609 <listitem><para> 610 <figure id="fig_mouselm"> 662 <mediaobject> 663 <imageobject> 664 <imagedata fileref="figpng/xxx_0701.png"/> 665 </imageobject> 666 </mediaobject> 667 </figure> 668 </para> 669 670 </listitem> 671 <listitem> 672 <para> 673 <figure xml:id="fig_mouselm"> 611 674 <title><abbrev>LCM</abbrev>---><constant>pltz</constant></title> 612 <mediaobjectco> 613 <imageobjectco> 614 <imageobject> 615 <imagedata fileref="figpng/xxx_mouselm.png"/> 616 </imageobject> 617 </imageobjectco> 618 </mediaobjectco> 619 </figure> 620 <para> 621 <figure id="fig_xxx_0702"> 675 <mediaobject> 676 <imageobject> 677 <imagedata fileref="figpng/xxx_mouselm.png"/> 678 </imageobject> 679 </mediaobject> 680 </figure> 681 </para> 682 <para> 683 <figure xml:id="fig_xxx_0702"> 622 684 <title>Vertical Plot</title> 623 <imageobject> 624 <imagedata fileref="figpng/xxx_0702.png"/> 625 </imageobject> 626 </figure> 627 </para> 628 629 </para></listitem> 630 <listitem><para> 631 <figure id="fig_mouselr"> 685 <mediaobject> 686 <imageobject> 687 <imagedata fileref="figpng/xxx_0702.png"/> 688 </imageobject> 689 </mediaobject> 690 </figure> 691 </para> 692 693 </listitem> 694 <listitem> 695 <para> 696 <figure xml:id="fig_mouselr"> 632 697 <title><abbrev>LCR</abbrev>---><constant>pltt</constant></title> 633 <mediaobjectco> 634 <imageobjectco> 635 <imageobject> 636 <imagedata fileref="figpng/xxx_mouselr.png"/> 637 </imageobject> 638 </imageobjectco> 639 </mediaobjectco> 640 </figure> 641 <para> 642 <figure id="fig_xxx_0703"> 698 <mediaobject> 699 <imageobject> 700 <imagedata fileref="figpng/xxx_mouselr.png"/> 701 </imageobject> 702 </mediaobject> 703 </figure> 704 </para> 705 <para> 706 <figure xml:id="fig_xxx_0703"> 643 707 <title>Common hovmoeller for xt and yt cuts</title> 644 <imageobject> 645 <imagedata fileref="figpng/xxx_0703.png"/> 646 </imageobject> 647 </figure> 648 </para> 649 650 </para></listitem> 708 <mediaobject> 709 <imageobject> 710 <imagedata fileref="figpng/xxx_0703.png"/> 711 </imageobject> 712 </mediaobject> 713 </figure> 714 </para> 715 716 </listitem> 651 717 </itemizedlist> 652 718 </para> … … 655 721 656 722 </sect2> 657 <sect2 id="multipleplots"><title>Create multiple plots on the same sheet and make them interact</title>723 <sect2 xml:id="multipleplots"><title>Create multiple plots on the same sheet and make them interact</title> 658 724 659 725 <para> … … 664 730 <para> 665 731 To create a plot in another frame double-click in the frame with the 666 <mousebutton>middle</mousebutton> button (< abbrev><keycombo action="double-click"><mousebutton>DCM</mousebutton></keycombo></abbrev>).732 <mousebutton>middle</mousebutton> button (<keycombo action="double-click"><mousebutton>DCM</mousebutton></keycombo>). 667 733 A black dotted frame will surround the designated frame, the <quote>target</quote> frame. 668 734 A black frame will surround the first plot. … … 676 742 <para>In summary: </para> 677 743 <itemizedlist> 678 <listitem><para> 679 <figure id="fig_mousedl"> 744 <listitem> 745 <para> 746 <figure xml:id="fig_mousedl"> 680 747 <title><abbrev>DCL</abbrev>---><quote>reference</quote> frame</title> 681 <mediaobjectco> 682 <imageobjectco> 683 <imageobject> 684 <imagedata fileref="figpng/xxx_mousedl.png"/> 685 </imageobject> 686 </imageobjectco> 687 </mediaobjectco> 688 </figure> 689 <para> 690 <figure id="fig_xxx_0801"> 748 <mediaobject> 749 <imageobject> 750 <imagedata fileref="figpng/xxx_mousedl.png"/> 751 </imageobject> 752 </mediaobject> 753 </figure> 754 </para> 755 <para> 756 <figure xml:id="fig_xxx_0801"> 691 757 <title>The reference frame is selected</title> 692 <imageobject> 693 <imagedata fileref="figpng/xxx_0801.png"/> 694 </imageobject> 695 </figure> 696 </para> 697 698 </para></listitem> 699 <listitem><para> 700 <figure id="fig_mousedm"> 758 <mediaobject> 759 <imageobject> 760 <imagedata fileref="figpng/xxx_0801.png"/> 761 </imageobject> 762 </mediaobject> 763 </figure> 764 </para> 765 766 </listitem> 767 <listitem> 768 <para> 769 <figure xml:id="fig_mousedm"> 701 770 <title><abbrev>DCM</abbrev>---><quote>target</quote> frame</title> 702 <mediaobjectco> 703 <imageobjectco> 704 <imageobject> 705 <imagedata fileref="figpng/xxx_mousedm.png"/> 706 </imageobject> 707 </imageobjectco> 708 </mediaobjectco> 709 </figure> 710 <para> 711 <figure id="fig_xxx_0802"> 771 <mediaobject> 772 <imageobject> 773 <imagedata fileref="figpng/xxx_mousedm.png"/> 774 </imageobject> 775 </mediaobject> 776 </figure> 777 </para> 778 <para> 779 <figure xml:id="fig_xxx_0802"> 712 780 <title>The target frame is selected</title> 713 <imageobject> 714 <imagedata fileref="figpng/xxx_0802.png"/> 715 </imageobject> 716 </figure> 717 </para> 718 </para></listitem> 719 <listitem><para> 720 <figure id="fig_mousedr"> 781 <mediaobject> 782 <imageobject> 783 <imagedata fileref="figpng/xxx_0802.png"/> 784 </imageobject> 785 </mediaobject> 786 </figure> 787 </para> 788 </listitem> 789 <listitem> 790 <para> 791 <figure xml:id="fig_mousedr"> 721 792 <title><abbrev>DCR</abbrev>--->erase the frame</title> 722 <mediaobjectco> 723 <imageobjectco> 724 <imageobject> 725 <imagedata fileref="figpng/xxx_mousedr.png"/> 726 </imageobject> 727 </imageobjectco> 728 </mediaobjectco> 729 </figure> 730 731 </para></listitem> 793 <mediaobject> 794 <imageobject> 795 <imagedata fileref="figpng/xxx_mousedr.png"/> 796 </imageobject> 797 </mediaobject> 798 </figure> 799 800 </para> 801 </listitem> 732 802 </itemizedlist> 733 803 <para>Here's a series of commands to show how this works.</para> … … 736 806 <para> 737 807 load xxx with the command: 738 <screen format="linespecific">808 <screen> 739 809 <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'Levitus98_1m_01_12_Temperature_Pot_ORCA05.nc'</parameter>, <parameter>'tst_initorca05'</parameter></userinput> 740 810 </screen> … … 763 833 </para> 764 834 <para> 765 <figure id="fig_xxx_0901">835 <figure xml:id="fig_xxx_0901"> 766 836 <title>Frame with four plot</title> 767 <imageobject> 768 <imagedata fileref="figpng/xxx_0901.png"/> 769 </imageobject> 837 <mediaobject> 838 <imageobject> 839 <imagedata fileref="figpng/xxx_0901.png"/> 840 </imageobject> 841 </mediaobject> 770 842 </figure> 771 843 </para> … … 785 857 Add the keyword 786 858 <literallayout>/nocontour</literallayout> 787 <para> 788 <figure id="fig_xxx_0902a"> 859 </para> 860 <para> 861 <figure xml:id="fig_xxx_0902a"> 789 862 <title>Command text area</title> 790 <imageobject> 791 <imagedata fileref="figpng/xxx_0902a.png"/> 792 </imageobject> 793 </figure> 794 </para> 863 <mediaobject> 864 <imageobject> 865 <imagedata fileref="figpng/xxx_0902a.png"/> 866 </imageobject> 867 </mediaobject> 868 </figure> 795 869 </para> 796 870 </step> … … 800 874 </para> 801 875 <para> 802 <figure id="fig_xxx_0902">876 <figure xml:id="fig_xxx_0902"> 803 877 <title>The fourth plot with the keyword "nocontour"</title> 804 <imageobject> 805 <imagedata fileref="figpng/xxx_0902.png"/> 806 </imageobject> 878 <mediaobject> 879 <imageobject> 880 <imagedata fileref="figpng/xxx_0902.png"/> 881 </imageobject> 882 </mediaobject> 807 883 </figure> 808 884 </para> … … 833 909 </para> 834 910 <para> 835 <figure id="fig_xxx_0903">911 <figure xml:id="fig_xxx_0903"> 836 912 <title>Frame with five plot</title> 837 <imageobject> 838 <imagedata fileref="figpng/xxx_0903.png"/> 839 </imageobject> 913 <mediaobject> 914 <imageobject> 915 <imagedata fileref="figpng/xxx_0903.png"/> 916 </imageobject> 917 </mediaobject> 840 918 </figure> 841 919 </para> … … 844 922 </sect2> 845 923 </sect1> 846 <sect1 id="crash"><title>What should I do when it breakdown</title>924 <sect1 xml:id="crash"><title>What should I do when it breakdown</title> 847 925 848 926 <para> … … 851 929 <para> 852 930 In the IDL window type (as many time you click on a button since a problem occurs in xxx !!!), 853 <screen format="linespecific">931 <screen> 854 932 <prompt>&promptidl;</prompt> <userinput>retall</userinput> 855 933 </screen> … … 858 936 <para> 859 937 in the IDL window, type 860 <screen format="linespecific">938 <screen> 861 939 <prompt>&promptidl;</prompt> <userinput>domdef</userinput> 862 940 </screen> … … 880 958 overflow. 881 959 To clean up this memory: 882 <screen format="linespecific">960 <screen> 883 961 <prompt>&promptidl;</prompt> <userinput>ptr_free, ptr_valid()</userinput> 884 962 </screen>
Note: See TracChangeset
for help on using the changeset viewer.