Changeset 183
- Timestamp:
- 09/18/06 15:49:14 (18 years ago)
- Location:
- trunk/SRC/Documentation/xmldoc
- Files:
-
- 14 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/xmldoc/faqsaxo.xml
r176 r183 27 27 </authorgroup> 28 28 <keywordset> 29 <keyword> idl</keyword>29 <keyword>IDL</keyword> 30 30 <keyword>SAXO</keyword> 31 31 <keyword>FAQ</keyword> … … 70 70 <answer> 71 71 <para> 72 see document <ulink url=". ./../saxo/browser/trunk/SRC/Documentation/xmldoc/whatissaxo.html?format=raw">What is SAXO</ulink>.72 see document <ulink url="./whatissaxo.html?format=raw">What is SAXO</ulink>. 73 73 </para> 74 74 </answer> … … 82 82 <answer> 83 83 <para> 84 see Support in document <ulink url=". ./../saxo/browser/trunk/SRC/Documentation/xmldoc/main.html?format=raw">Main page of SAXO</ulink>.84 see Support in document <ulink url="./websaxo.html?format=raw">Main page of SAXO</ulink>. 85 85 </para> 86 86 </answer> … … 94 94 <answer> 95 95 <para> 96 see document <ulink url=". ./../saxo/browser/trunk/SRC/Documentation/xmldoc/getsaxo.html?format=raw">Get SAXO</ulink>.96 see document <ulink url="./getsaxo.html?format=raw">Get SAXO</ulink>. 97 97 </para> 98 98 </answer> … … 123 123 <question> 124 124 <para> 125 Does SAXO works wi h GDL instead of IDL ?125 Does SAXO works with GDL instead of IDL ? 126 126 </para> 127 127 </question> … … 244 244 <listitem> 245 245 <para> 246 Paragraphs of <filename>*.pro</filename> headers are shown with a proporti nal247 font in the <literal> html</literal> release.246 Paragraphs of <filename>*.pro</filename> headers are shown with a proportional 247 font in the <literal>HTML</literal> release. 248 248 </para> 249 249 <para> … … 258 258 </para> 259 259 <para> 260 Unfortunat ly, these troubles may not be fixed because the author does not260 Unfortunately, these troubles may not be fixed because the author does not 261 261 have anymore the opportunity to work on his own work. 262 262 </para> -
trunk/SRC/Documentation/xmldoc/firststeps.xml
r176 r183 22 22 <!-- 23 23 module : 24 first steps with SAXO ...24 first steps with SAXO ... 25 25 26 26 source : … … 67 67 <title>Before this</title> 68 68 <para> 69 In this document, we supposed that you followed <ulink url="getsaxo.html">Get SAXO</ulink> recomm andations.69 In this document, we supposed that you followed <ulink url="getsaxo.html">Get SAXO</ulink> recommendations. 70 70 </para> 71 71 </sect1> … … 73 73 <sect1 id="first_plots"> 74 74 <title> 75 First plots ...75 First plots … 76 76 </title> 77 77 <sect2 id="start_with_init"> … … 83 83 </para> 84 84 <para> 85 <emphasis>The @ is equivalent to an include. It is used to execute a set of IDL commands that will be directly executed without any compilation (as it is the case for a procedure or a function). All variables defined and used in the @ ... file will still be accessible after the execution of the @...is finished (which is not the case for procedures and functions that ends with the return instruction).</emphasis>85 <emphasis>The @ is equivalent to an include. It is used to execute a set of IDL commands that will be directly executed without any compilation (as it is the case for a procedure or a function). All variables defined and used in the @… file will still be accessible after the execution of the @… is finished (which is not the case for procedures and functions that ends with the return instruction).</emphasis> 86 86 <screen format="linespecific"> 87 87 <prompt>$</prompt> <userinput><command>cd</command> <filename class="directory"><envar>${HOME}</envar>/My_IDL/</filename></userinput> … … 122 122 <sect2 id="basic_plots"> 123 123 <title> 124 basic plots ...124 basic plots … 125 125 </title> 126 126 <sect3 id="basic_splot"> … … 177 177 <computeroutput>% Compiled module: OPENPS.</computeroutput> 178 178 <computeroutput>% Compiled module: XQUESTION.</computeroutput> 179 <computeroutput>Name of the postscript file? (default answer is idl.ps) 179 <computeroutput>Name of the postscript file? (default answer is idl.ps)</computeroutput><userinput>first_ps</userinput> &numb1; 180 180 <computeroutput>% Compiled module: ISAFILE.</computeroutput> 181 181 <computeroutput>% Compiled module: XNOTICE.</computeroutput> … … 194 194 </calloutlist> 195 195 </screenco> 196 Check that the <quote><filename>first_ps.ps</filename></quote> file is now existing ...196 Check that the <quote><filename>first_ps.ps</filename></quote> file is now existing … 197 197 <screen format="linespecific"> 198 198 <prompt>&promptidl;</prompt> <userinput><command>print, file_test(psdir + 'first_ps.ps')</command></userinput> … … 292 292 <prompt>&promptidl;</prompt> <userinput><command> , xtitle = 'x index', charsize = 1.5</command></userinput> <ulink url="figpng/basic_scontour2.png?format=raw">&showfig;</ulink> 293 293 </screen> 294 It can be used in combina ison with contour to make more complex plots:294 It can be used in combination with contour to make more complex plots: 295 295 <screenco> 296 296 <areaspec> … … 342 342 <prompt>&promptidl;</prompt> <userinput><command>xhelp, 'tvplus'</command></userinput> 343 343 </screen> 344 To s se the source code of <command>tvplus</command>, try:344 To see the source code of <command>tvplus</command>, try: 345 345 <screen format="linespecific"> 346 346 <prompt>&promptidl;</prompt> <userinput><command>xfile, 'tvplus'</command></userinput> … … 415 415 <listitem><simpara>cells corners ordinates, stored in 2D array <varname></varname>gphif</simpara></listitem> 416 416 <listitem><simpara>cells upper boundary depth, stored in 1D array <varname></varname>gdepw</simpara></listitem> 417 <listitem><simpara>land-sea mask, stored in <varname> </varname>tmask</simpara></listitem>417 <listitem><simpara>land-sea mask, stored in <varname>tmask</varname></simpara></listitem> 418 418 <listitem><simpara>the cells size in the longitudinal direction, stored in 2D array <varname></varname>e1t</simpara></listitem> 419 419 <listitem><simpara>the cells size in the latitudinal direction, stored in 2D array <varname></varname>e2t</simpara></listitem> … … 511 511 </title> 512 512 <para> 513 A quick presentation of vertical sections is shown in <ulink url="../../Tests/tst_pltz.pro?format=raw">tst_pltz</ulink>. After l aoding any of the grid (for example with one of the <link linkend="load_grid">above examples</link>). Just try:513 A quick presentation of vertical sections is shown in <ulink url="../../Tests/tst_pltz.pro?format=raw">tst_pltz</ulink>. After loading any of the grid (for example with one of the <link linkend="load_grid">above examples</link>). Just try: 514 514 <screen format="linespecific"> 515 515 <prompt>&promptidl;</prompt> <userinput><command>tst_pltz</command></userinput> … … 535 535 </title> 536 536 <para> 537 A quick presentation of hovmoellers and time series is shown in <ulink url="../../Tests/tst_pltt.pro?format=raw">tst_pltt</ulink>. After l aoding any of the grid (for example with one of the <link linkend="load_grid">above examples</link>). Just try:537 A quick presentation of hovmoellers and time series is shown in <ulink url="../../Tests/tst_pltt.pro?format=raw">tst_pltt</ulink>. After loading any of the grid (for example with one of the <link linkend="load_grid">above examples</link>). Just try: 538 538 <screen format="linespecific"> 539 539 <prompt>&promptidl;</prompt> <userinput><command>tst_pltt</command></userinput> … … 559 559 </title> 560 560 <para> 561 To be continued ...561 To be continued … 562 562 </para> 563 563 </sect2> -
trunk/SRC/Documentation/xmldoc/forxxxdoc.sh
r149 r183 4 4 # add frame and callouts image to an existing one 5 5 # 6 # !! exists only because graphics callouts are not yet ava laible6 # !! exists only because graphics callouts are not yet available 7 7 # with xsl processing on XML/Docbook files (xsl stylesheet 1.70 and 8 8 # DocBook DTD 4.2) … … 51 51 capture_ysize=309 #++ should be obtain by parsing identify result 52 52 # 53 # description of frames (title, xmin, ymin, xmax,ymax)53 # description of frames (title, xmin, ymin, xmax,ymax) 54 54 # nb : title and label are not yet used but they may be added in a kind of 55 55 # comments … … 77 77 capture_ysize=630 #++ should be obtain by parsing identify result 78 78 # 79 # description of frames (title, xmin, ymin, xmax,ymax)79 # description of frames (title, xmin, ymin, xmax,ymax) 80 80 # nb : title and label are not yet used but they may be added in a kind of 81 81 # comments … … 125 125 capture_ysize=82 #++ should be obtain by parsing identify result 126 126 # 127 # description of frames (title, xmin, ymin, xmax,ymax)127 # description of frames (title, xmin, ymin, xmax,ymax) 128 128 # nb : title and label are not yet used but they may be added in a kind of 129 129 # comments … … 198 198 # 199 199 # +++ verrue mal codee... 200 # dans le cas mouse, je ne veux pas les ca rdes200 # dans le cas mouse, je ne veux pas les cadres 201 201 # a voir si on integre proprement ou si on vire... 202 202 if [ $1 = mouse ] -
trunk/SRC/Documentation/xmldoc/getsaxo.xml
r144 r183 18 18 </authorgroup> 19 19 <keywordset> 20 <keyword> idl</keyword>20 <keyword>IDL</keyword> 21 21 <keyword>SAXO</keyword> 22 22 </keywordset> … … 168 168 </title> 169 169 <para> 170 Create your <filename class='directory'><envar>${HOME}</envar>/SAXO_DIR</filename> directory ...170 Create your <filename class='directory'><envar>${HOME}</envar>/SAXO_DIR</filename> directory … 171 171 <screen format="linespecific"> 172 172 <prompt>$</prompt> <userinput><command>cd</command> <parameter><envar>${HOME}</envar></parameter></userinput> … … 174 174 <prompt>$</prompt> <userinput><command>cd</command> <parameter>SAXO_DIR</parameter></userinput> 175 175 </screen> 176 ...and download it the latest version of the sources tar file: <ulink url="http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_&date;.tar.gz">SAXO_SRC_&date;.tar.gz</ulink> (&szsrc; Mb). This tar.gz file could also be downloaded with176 … and download it the latest version of the sources tar file: <ulink url="http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_&date;.tar.gz">SAXO_SRC_&date;.tar.gz</ulink> (&szsrc; Mb). This tar.gz file could also be downloaded with 177 177 <variablelist> 178 178 <varlistentry><term><command>wget</command></term> … … 221 221 </screen> 222 222 Download <ulink url="http://forge.ipsl.jussieu.fr/saxo/download/SAXO_DATA_&date2;.tar.gz">SAXO_DATA_&date2;.tar.gz</ulink> (&szdata; Mb) 223 ...or with223 … or with 224 224 <variablelist> 225 225 <varlistentry><term><command>wget</command></term> … … 246 246 </title> 247 247 <para> 248 To use <application>SAXO</application>, we need to build an idlscript that we usually call "<filename>init.pro</filename>". This file contains a set of IDL commands and default definitions (paths and variables of the common files) that are necessary to <application>SAXO</application>. Once it has been created, <filename>init.pro</filename> should the first executed command when starting IDL session.248 To use <application>SAXO</application>, we need to build an IDL script that we usually call "<filename>init.pro</filename>". This file contains a set of IDL commands and default definitions (paths and variables of the common files) that are necessary to <application>SAXO</application>. Once it has been created, <filename>init.pro</filename> should the first executed command when starting IDL session. 249 249 </para> 250 250 <para> -
trunk/SRC/Documentation/xmldoc/mailing.xml
r166 r183 13 13 </authorgroup> 14 14 <keywordset> 15 <keyword> idl</keyword>15 <keyword>IDL</keyword> 16 16 <keyword>SAXO</keyword> 17 17 </keywordset> … … 20 20 <revnumber>0.1</revnumber> 21 21 <date>September 2006</date> 22 <revremark>Mailing lists on forge.ipsl.jussieu.fr are ok(thanks to Frédéric Bongat)</revremark>22 <revremark>Mailing lists on forge.ipsl.jussieu.fr are OK (thanks to Frédéric Bongat)</revremark> 23 23 </revision> 24 24 <revision> -
trunk/SRC/Documentation/xmldoc/makehtml.sh
r170 r183 8 8 # released on 1 September 2005) doesn't handle carriage returns 9 9 # 10 # fplod 2006-09-18T12:53:07Z aedon.locean-ipsl.upmc.fr (Darwin) 11 # add status checking 10 12 # fplod 2006-09-07T08:10:23Z aedon.locean-ipsl.upmc.fr (Darwin) 11 13 # main is rename to websaxo.html … … 56 58 case "${1}" in 57 59 getsaxo) 58 # size of SRC and DATA with .svn60 # size of SRC and DATA with .svn 59 61 szallsvn=$( du -sh ../../.. | awk '{print $1}' ) 60 62 szallsvn=${szallsvn%*M} … … 217 219 ${titlepagexsl} \ 218 220 titlepage.saxo.xml 221 status=${?} 222 if [ ${status} -ne 0 ] 223 then 224 echo "eee : pb xsltproc sur titlepage.saxo.xml" 225 exit 1 226 fi 219 227 # 220 228 case "${1}" in … … 264 272 xmllint --xinclude \ 265 273 --output ${1}_${$}.xml ${1}.xml 274 status=${?} 275 if [ ${status} -ne 0 ] 276 then 277 echo "eee : pb xmllint sur ${1}.xml" 278 exit 1 279 fi 266 280 ;; 267 281 *) … … 284 298 use.extensions=1 \ 285 299 callouts.extension=1 300 status=${?} 301 if [ ${status} -ne 0 ] 302 then 303 echo "eee : pb saxon sur ${1}_${$}.xml" 304 exit 1 305 fi 286 306 # 287 307 case "${1}" in -
trunk/SRC/Documentation/xmldoc/mini_notice.xml
r176 r183 30 30 </authorgroup> 31 31 <keywordset> 32 <keyword> idl</keyword>32 <keyword>IDL</keyword> 33 33 <keyword>SAXO</keyword> 34 34 <keyword>xxx</keyword> … … 74 74 <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>restore = 'file.dat'</parameter></userinput> 75 75 <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter></userinput> 76 <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>keywd1 = ...</parameter>, <parameter>keywd2 = ...</parameter></userinput>76 <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>keywd1 = …</parameter>, <parameter>keywd2 = …</parameter></userinput> 77 77 <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter></userinput> 78 <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter>, <parameter>keywd1 = ...</parameter>, <parameter>keywd2 = ...</parameter></userinput>79 <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter>, <parameter>'arg1, arg2, ...'</parameter></userinput>78 <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter>, <parameter>keywd1 = …</parameter>, <parameter>keywd2 = …</parameter></userinput> 79 <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter>, <parameter>'arg1, arg2, …'</parameter></userinput> 80 80 </screen> 81 81 </para> … … 127 127 <sect3 id="initprogramtxt"><title>Grid initialization parameters</title> 128 128 <para> 129 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. 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. 129 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. 130 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. 130 131 <figure id="fig_xxx_0102"> 131 132 <title>Window xxx 1</title> … … 142 143 Once these two lines have been completed, click on <guibutton>let's go</guibutton>. 143 144 </para> 144 <para>For example, we choose the IDL batch file "tst_initlev". Compare the result with "automatic grid construction with initncdf.pro" checked. Cf <xref linkend="fig_xxx_0404"/> </para> 145 <para>For example, we choose the IDL batch file "tst_initlev". Compare the result with "automatic grid construction with initncdf.pro" checked. Cf <xref linkend="fig_xxx_0404"/> 146 </para> 145 147 <para> 146 148 <figure id="fig_xxx_0103"> 147 <title>Oceania at 125 met ters of depth with proper grid initialization</title>149 <title>Oceania at 125 meters of depth with proper grid initialization</title> 148 150 <imageobject> 149 151 <imagedata fileref="figpng/xxx_0103.png"/> … … 175 177 </sect2> 176 178 177 <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>178 <para> 179 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:179 <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> 180 <para> 181 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: 180 182 <screen format="linespecific"> 181 183 <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> … … 193 195 </sect2> 194 196 195 <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>196 <para> 197 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>.198 </para> 199 </sect2> 200 201 <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>202 <para> 203 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>.197 <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> 198 <para> 199 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>. 200 </para> 201 </sect2> 202 203 <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> 204 <para> 205 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>. 204 206 </para> 205 207 </sect2> … … 277 279 278 280 <sect2 id="plottypetxt"><title>Plot type list</title> 279 <para> allows specification of the type of plot desired.</para>281 <para>Allows specification of the type of plot desired.</para> 280 282 <para> 281 283 <figure id="fig_xxx_0202"> 282 <title>Different s plot types avaibles</title>284 <title>Different plot types available</title> 283 285 <imageobject> 284 286 <imagedata fileref="figpng/xxx_0202.png"/> … … 293 295 </sect2> 294 296 295 <sect2 id="menutxt"><title>The menu bar made up of 3 sub menus</title>296 <sect3 id="filesubmenu"><title><guisubmenu>File</guisubmenu> sub menu</title>297 <sect2 id="menutxt"><title>The menu bar made up of 3 sub-menus</title> 298 <sect3 id="filesubmenu"><title><guisubmenu>File</guisubmenu> sub-menu</title> 297 299 <para> 298 300 <figure id="fig_xxx_0203"> … … 305 307 <para> 306 308 <itemizedlist> 307 <listitem><para><menuchoice><guibutton>Open:</guibutton></menuchoice> to open a new file. Same procedure as during the <link linkend="launch_xxx_1">launch of XXX</link>. The new file can be on a different grid, with different variables, with a different time base... 309 <listitem><para><menuchoice><guibutton>Open:</guibutton></menuchoice> to open a new file. Same procedure as during the <link linkend="launch_xxx_1">launch of XXX</link>. 310 The new file can be on a different grid, with different variables, with a different time base … 308 311 </para></listitem> 309 312 <listitem><para><menuchoice><guibutton>New XXX:</guibutton></menuchoice> to open a second XXX window identical to the first one.</para></listitem> … … 312 315 </para> 313 316 </sect3> 314 <sect3 id="saveassubmenu"><title><guisubmenu>Save As</guisubmenu> sub menu</title>317 <sect3 id="saveassubmenu"><title><guisubmenu>Save As</guisubmenu> sub-menu</title> 315 318 <para> 316 319 <figure id="fig_xxx_0204"> … … 326 329 <listitem><para><menuchoice><guibutton>Animated gif:</guibutton></menuchoice> to create an animation of the plotting window. 327 330 <note><para>The creation of an animation is only possible if none of the plots have a time axis, and if the plots are all on the same time base (calendar). On the other hand, animations of horizontal and vertical plots, with different color palettes (for those not on an X-terminal), are possible.</para></note> 328 <note><para> the creation of animations has a tendency to saturate the video memory of X-terminals, crashing the entire program...</para></note>331 <note><para>The creation of animations has a tendency to saturate the video memory of X-terminals, crashing the entire program …</para></note> 329 332 </para></listitem> 330 333 <listitem><para><menuchoice><guibutton>Gif:</guibutton></menuchoice> to save a gif of the plotting window.</para></listitem> 331 <listitem><para><menuchoice><guibutton>IDL procedure:</guibutton></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:334 <listitem><para><menuchoice><guibutton>IDL procedure:</guibutton></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: 332 335 <screen format="linespecific"> 333 336 <prompt>&promptidl;</prompt> <userinput>@init</userinput> … … 336 339 and I'll obtain the saved figure. 337 340 <screen format="linespecific"> 338 <prompt>&promptidl;</prompt> <userinput>xxx_figure,/post 341 <prompt>&promptidl;</prompt> <userinput>xxx_figure,/post</userinput> 339 342 </screen> 340 343 or … … 344 347 will then create a Postscript file of the figure. 345 348 </para></listitem> 346 <listitem><para id='restore'><menuchoice><guibutton>RESTORE kwd of xxx:</guibutton></menuchoice> to save the xxx widget (all buttons and parameters store ed in memory...) in a binary file in order to quit xxx and relauch 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>347 <listitem><para><menuchoice><guibutton>Print to prompt:</guibutton></menuchoice> lists in the IDL window the command history that created the last plot. Useful primarily for debugging ...</para></listitem>349 <listitem><para id='restore'><menuchoice><guibutton>RESTORE kwd of xxx:</guibutton></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> 350 <listitem><para><menuchoice><guibutton>Print to prompt:</guibutton></menuchoice> lists in the IDL window the command history that created the last plot. Useful primarily for debugging…</para></listitem> 348 351 </itemizedlist> 349 352 </para> 350 353 </sect3> 351 <sect3 id="flagsubmenu"><title><guisubmenu>Flag options</guisubmenu> sub menu</title>354 <sect3 id="flagsubmenu"><title><guisubmenu>Flag options</guisubmenu> sub-menu</title> 352 355 <para> 353 356 <figure id="fig_xxx_0205"> … … 364 367 one represented as color-filled contours. It is necessary to relaunch the entire plot to make this work!</para></listitem> 365 368 <listitem><para><guibutton>Vecteur:</guibutton> to plot a vector field on top of contours. Only 366 works on horizontal plots (<filename>plt.pro</filename>). As for Overlay, a relaunch of the entire plot is necessary.</para></listitem> 367 <listitem><para><guibutton>Longitude / x index:</guibutton> switches longitude labelling of the plot subdomain from degrees to indices following i. </para></listitem> 368 <listitem><para><guibutton>Latitude / y index:</guibutton> switches latitude labelling of the plot subdomain from degrees to indices following j. </para></listitem> 369 works on horizontal plots (<filename>plt.pro</filename>). 370 As for Overlay, a relaunch of the entire plot is necessary.</para></listitem> 371 <listitem><para><guibutton>Longitude / x index:</guibutton> switches longitude labeling of the plot sub-domain from degrees to indexes following i.</para></listitem> 372 <listitem><para><guibutton>Latitude / y index:</guibutton> switches latitude labeling of the plot sub-domain from degrees to indexes following j.</para></listitem> 369 373 </itemizedlist> 370 374 </para> 371 <caution><para>Careful, a selected option remains selected until it is re clicked.</para></caution>375 <caution><para>Careful, a selected option remains selected until it is re-clicked.</para></caution> 372 376 </sect3> 373 377 </sect2> 374 378 375 379 <sect2 id="oktxt"><title>OK button</title> 376 <para> click on this <guibutton>OK</guibutton> button is required to make a new plot appear</para>380 <para>Click on this <guibutton>OK</guibutton> button is required to make a new plot appear</para> 377 381 </sect2> 378 382 379 383 <sect2 id="pagelayouttxt"><title>Page Layout</title> 380 <para> specify the number of columns and rows for plots on the sheet of paper.</para>384 <para>Specify the number of columns and rows for plots on the sheet of paper.</para> 381 385 <para> 382 386 <figure id="fig_xxx_0206"> … … 389 393 <para> 390 394 <figure id="fig_xxx_0206a"> 391 <title>Example: For 2 c ln and 2 row</title>395 <title>Example: For 2 columns and 2 rows</title> 392 396 <imageobject> 393 397 <imagedata fileref="figpng/xxx_0206a.png"/> … … 398 402 399 403 <sect2 id="variableslisttxt"><title><guimenuitem>List of variables</guimenuitem></title> 400 <para> you can choose the variable to work on.</para>404 <para>You can choose the variable to work on.</para> 401 405 <para> 402 406 <figure id="fig_xxx_0207"> 403 <title>Example of different s Variables avaible</title>407 <title>Example of different Variables available</title> 404 408 <imageobject> 405 409 <imagedata fileref="figpng/xxx_0207.png"/> … … 410 414 411 415 <sect2 id="fileslisttxt"><title><guimenuitem>List of open files</guimenuitem></title> 412 <para> you can choose the file to work on.</para>416 <para>You can choose the file to work on.</para> 413 417 <para> 414 418 <figure id="fig_xxx_0208"> … … 424 428 <para> 425 429 To specify in the widget part number 7 the computation you want to do on the data 426 <note><para>In all cases bellow, the name given to a field (a, b, c, ...) is of no importance.</para></note>430 <note><para>In all cases bellow, the name given to a field (a, b, c, …) is of no importance.</para></note> 427 431 </para> 428 432 <sect3 id="commandtext1"><title><guimenuitem>Linear calculation</guimenuitem></title> 429 433 <para> 430 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.431 </para> 432 </sect3> 433 <sect3 id="commandtext1"><title><guimenuitem>Any kind of computation calculation</guimenuitem></title>434 <para> 435 If you want to make a computation more complicated than a basic linear you must put designate the data you want to read between "" (with anything inbetween the "). For example: <screen format="linespecific">"a"^2</screen><screen format="linespecific">"a" - abs("b")</screen><screen format="linespecific">grad("a", 'x')</screen>...434 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. 435 </para> 436 </sect3> 437 <sect3 id="commandtext1"><title><guimenuitem>Any kind of computation</guimenuitem></title> 438 <para> 439 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> … 436 440 </para> 437 441 </sect3> … … 440 444 <sect2 id="calendartxt"><title>Calendar</title> 441 445 <para> 442 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>446 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> 443 447 <para> 444 448 <figure id="fig_xxx_0301"> … … 488 492 </sect2> 489 493 490 <sect2 id="specificationstxt"><title> specify your plot</title>494 <sect2 id="specificationstxt"><title>Specify your plot</title> 491 495 492 496 <sect3 id="minmaxintervaltxt"><title><guimenuitem>Specify min, max and contour interval</guimenuitem></title> … … 498 502 </imageobject> 499 503 </figure> 500 You can restore configuration by default by pressing the "default"button.501 <note><para>The path of the file <ulink url="../../ToBeReviewed/WIDGET/AUTOUR_de_XXX/definedefaultextra.pro?format=raw"><filename>definedefaultextra.pro</filename></ulink> that defines the default values for each variable names is displayed when the cursor hovers over the button Default. 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>504 You can restore configuration by default by pressing the <menuchoice><guibutton>Default</guibutton></menuchoice> button. 505 <note><para>The path of the file <ulink url="../../ToBeReviewed/WIDGET/AUTOUR_de_XXX/definedefaultextra.pro?format=raw"><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> 502 506 </para> 503 507 </sect3> … … 517 521 <sect3 id="kwdtxt"><title><guimenuitem>Add any keyword</guimenuitem></title> 518 522 <para> 519 The "keywords" window allows specification of all desired keywords. There is a few examples of the use of this "keywords"window.523 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. 520 524 <figure id="fig_xxx_0209"> 521 525 <title>Without any additional keyword</title> … … 525 529 </figure> 526 530 <figure id="fig_xxx_0210a"> 527 <title> add "/realcont"keyword</title>531 <title>Add <varname>/realcont</varname> keyword</title> 528 532 <imageobject> 529 533 <imagedata fileref="figpng/xxx_0210a.png"/> … … 531 535 </figure> 532 536 <figure id="fig_xxx_0210"> 533 <title>Graphic with "/realcont"keyword</title>537 <title>Graphic with <varname>/realcont</varname> keyword</title> 534 538 <imageobject> 535 539 <imagedata fileref="figpng/xxx_0210.png"/> … … 537 541 </figure> 538 542 <figure id="fig_xxx_0211a"> 539 <title> add "/realcont, map=[90,0,0], /ortho, cell_fill=2"keywords</title>543 <title>Add <userinput>/realcont, map=[90,0,0], /ortho, cell_fill=2</userinput> keywords</title> 540 544 <imageobject> 541 545 <imagedata fileref="figpng/xxx_0211a.png"/> … … 543 547 </figure> 544 548 <figure id="fig_xxx_0211"> 545 <title>Graphic with "/realcont, map=[90,0,0], /ortho, cell_fill=2"keywords</title>549 <title>Graphic with <literal>/realcont, map=[90,0,0], /ortho, cell_fill=2</literal> keywords</title> 546 550 <imageobject> 547 551 <imagedata fileref="figpng/xxx_0211.png"/> … … 561 565 <para> 562 566 The domain we'd like to select for the plot is determined by one of 563 its diagonals, defined therefore by two points. The first point is 567 its diagonals, defined therefore by two points. 568 The first point is 564 569 defined when the mouse button is pushed, then the mouse is moved, and 565 570 the second point is defined as the mouse button is released 566 (click-drag). The domains are thus defined by a long click (<abbrev>LC</abbrev>). To 567 determine which type of plot should be made of selection, use: 571 (click-drag). 572 The domains are thus defined by a long click (<abbrev>LC</abbrev>). 573 To determine which type of plot should be made of selection, use: 568 574 </para> 569 575 <para> 570 576 If the plot selector is on <constant>plt</constant> 571 577 <itemizedlist> 572 <listitem><para>the leftmouse button to create horizontal plots (<constant>plt</constant>)</para></listitem>573 <listitem><para>the middlemouse button to create vertical plots (<constant>pltz</constant>)</para></listitem>574 <listitem><para>the rightmouse button to create common hovmoellers for xt and yt cuts (<constant>pltt</constant>)</para></listitem>578 <listitem><para>the <mousebutton>left</mousebutton> mouse button to create horizontal plots (<constant>plt</constant>)</para></listitem> 579 <listitem><para>the <mousebutton>middle</mousebutton> mouse button to create vertical plots (<constant>pltz</constant>)</para></listitem> 580 <listitem><para>the <mousebutton>right</mousebutton> mouse button to create common hovmoellers for xt and yt cuts (<constant>pltt</constant>)</para></listitem> 575 581 </itemizedlist> 576 582 </para> … … 653 659 Select the number of columns and rows for the page.</para> 654 660 <para> 655 Create a first plot. It will appear in the first frame.</para> 661 Create a first plot. 662 It will appear in the first frame.</para> 656 663 <para> 657 664 To create a plot in another frame double-click in the frame with the 658 middle button (<abbrev>DCM</abbrev>). A black dotted frame will surround the 659 designated frame, the <quote>target</quote> frame. A black frame will surround the 660 first plot. This is the <quote>reference</quote> frame, in other words the one 661 that all the XXX widgets refer to. Change for example the date and 662 create a new plot. With a left button double-click in the first 663 frame, all the widgets change and refer again to the first plot. A 664 double-click with the right button in the second frame will erase the 665 <mousebutton>middle</mousebutton> button (<abbrev><keycombo action="double-click"><mousebutton>DCM</mousebutton></keycombo></abbrev>). 666 A black dotted frame will surround the designated frame, the <quote>target</quote> frame. 667 A black frame will surround the first plot. 668 This is the <quote>reference</quote> frame, in other words the one 669 that all the XXX widgets refer to. 670 Change for example the date and create a new plot. 671 With a <mousebutton>left</mousebutton> button double-click in the first 672 frame, all the widgets change and refer again to the first plot. 673 A double-click with the <mousebutton>right</mousebutton> button in the second frame will erase the 665 674 plot.</para> 666 675 <para>In summary: </para> … … 685 694 </figure> 686 695 </para> 687 696 688 697 </para></listitem> 689 698 <listitem><para> … … 718 727 </mediaobjectco> 719 728 </figure> 720 729 721 730 </para></listitem> 722 731 </itemizedlist> … … 820 829 <step> 821 830 <para> 822 click on <guibutton>OK</guibutton>831 Click on <guibutton>OK</guibutton> 823 832 </para> 824 833 <para> … … 840 849 <listitem> 841 850 <para> 842 in the IDL window type (as many time you click on a button since a problem occurs in xxx !!!), 851 In the IDL window type (as many time you click on a button since a problem occurs in xxx !!!), 843 852 <screen format="linespecific"> 844 853 <prompt>&promptidl;</prompt> <userinput>retall</userinput> … … 853 862 </para></listitem> 854 863 <listitem> 855 <para><abbrev>DCR</abbrev> to erase the problem frame. 864 <para><abbrev>DCR</abbrev> to erase the problem frame. 856 865 </para> 857 866 </listitem> … … 865 874 <para> 866 875 Always avoid if at all possible closing and killing the XXX 867 window, but rather select <guibutton>quit</guibutton> from the <guimenu>File</guimenu> menu. XXX uses a 868 large number of pointers, and wantonly killing the window will leave a 869 large number of unused variables in memory, which could in the end 870 overflow. To clean up this memory: 876 window, but rather select <guibutton>quit</guibutton> from the <guimenu>File</guimenu> menu. 877 XXX uses a large number of pointers, and want only killing the window will 878 leave a large number of unused variables in memory, which could in the end 879 overflow. 880 To clean up this memory: 871 881 <screen format="linespecific"> 872 882 <prompt>&promptidl;</prompt> <userinput>ptr_free, ptr_valid()</userinput> -
trunk/SRC/Documentation/xmldoc/savesaxo.sh
r182 r183 3 3 # update : 4 4 # $Id$ 5 # fplod 2006-09-18T13:25:12Z aedon.locean-ipsl.upmc.fr (Darwin) 6 # add status checking after makehtml.sh 5 7 # smasson Fri Sep 15 10:42:01 CEST 2006 6 8 # merge idldoc html and idldoc assistant … … 16 18 # add for idldoc assistant 17 19 # fplod 2006-08-17T09:19:06Z aedon.locean-ipsl.upmc.fr (Darwin) 18 # add transformation after idldoc to force non-proportion nal font20 # add transformation after idldoc to force non-proportional font 19 21 # on bloc delimited by 20 22 # <fixe> … … 52 54 # in files idldoc-index*.html 53 55 # fplod 2006-06-14T12:41:37Z aedon.locean-ipsl.upmc.fr (Darwin) 54 # add embed param ater idldoc instructions to try to fix ticket#1756 # add embed parameter idldoc instructions to try to fix ticket#17 55 57 # fplod 2006-06-07T12:11:50Z aedon.locean-ipsl.upmc.fr (Darwin) 56 58 # add g option in ?format=raw sed transformation in order to fix … … 175 177 do 176 178 ./makehtml.sh $(basename ${docxml} .xml) 179 status=${?} 180 if [ ${status} -ne 0 ] 181 then 182 echo "eee : pb with makehtml.sh $(basename ${docxml} .xml)" 183 exit 1 184 fi 177 185 done 178 186 exit 0 … … 257 265 for file_html in ${list_html} 258 266 do 259 # buil the .pro file name267 # build the .pro file name 260 268 bfile=$(basename ${file_html} .html) 261 269 # retrieve the path of html file relative to memopwd (so relative to -
trunk/SRC/Documentation/xmldoc/saxo.css
r161 r183 7 7 update : 8 8 $Id$ 9 fplod 2006-09-18T13:19:02Z aedon.locean-ipsl.upmc.fr (Darwin) 10 add color for mousebutton 9 11 fplod 2006-07-20T14:03:51Z aedon.locean-ipsl.upmc.fr (Darwin) 10 12 add style for gui* moche mais c'est juste pour voir … … 32 34 font-style: italic; } 33 35 36 *[class~="mousebutton"] { 37 background-color: #red; 38 font-weight: bold; 39 font-style: italic; } 40 34 41 div.qandaset table { 35 42 border: none; -
trunk/SRC/Documentation/xmldoc/tiplink.xml
r139 r183 14 14 </authorgroup> 15 15 <keywordset> 16 <keyword> idl</keyword>16 <keyword>IDL</keyword> 17 17 <keyword>SAXO</keyword> 18 18 </keywordset> -
trunk/SRC/Documentation/xmldoc/updatesaxo.xml
r139 r183 17 17 </authorgroup> 18 18 <keywordset> 19 <keyword> idl</keyword>19 <keyword>IDL</keyword> 20 20 <keyword>SAXO</keyword> 21 21 </keywordset> … … 71 71 For a quick help on <userinput>svn status</userinput> and <userinput>svn update</userinput> see 72 72 <screen format="linespecific"> 73 <prompt>$</prompt> <userinput><command>svn</command> <option>help</option> <parameter>status</parameter> 74 <prompt>$</prompt> <userinput><command>svn</command> <option>help</option> <parameter>update</parameter> 73 <prompt>$</prompt> <userinput><command>svn</command> <option>help</option> <parameter>status</parameter></userinput> 74 <prompt>$</prompt> <userinput><command>svn</command> <option>help</option> <parameter>update</parameter></userinput> 75 75 </screen> 76 76 </para> -
trunk/SRC/Documentation/xmldoc/websaxo.xml
r181 r183 16 16 </authorgroup> 17 17 <keywordset> 18 <keyword> idl</keyword>18 <keyword>IDL</keyword> 19 19 <keyword>SAXO</keyword> 20 20 </keywordset> … … 35 35 36 36 <note><para> 37 This page is a mir or of <ulink url="http://forge.ipsl.jussieu.fr/saxo">SAXO web page</ulink> and allows you to browse SAXO help pages in local.37 This page is a mirror of <ulink url="http://forge.ipsl.jussieu.fr/saxo">SAXO web page</ulink> and allows you to browse SAXO help pages in local. 38 38 </para></note> 39 39 … … 54 54 55 55 <para> 56 <ulink url="../../saxo/browser/trunk/SRC/Documentation/xmldoc/whatissaxo.html?format=raw">More ...</ulink>56 <ulink url="../../saxo/browser/trunk/SRC/Documentation/xmldoc/whatissaxo.html?format=raw">More …</ulink> 57 57 </para> 58 58 </sect1> … … 106 106 <listitem> 107 107 <para> 108 <ulink url="http://forge.ipsl.jussieu.fr/saxo/report">Read</ulink> tickets. Because of abusive use of our tickets, <ulink url="http://forge.ipsl.jussieu.fr/saxo/newticket">sending tickets</ulink> is now limited to a regist red login accessible if you subscribe to <ulink url="../../saxo/browser/trunk/SRC/Documentation/xmldoc/mailing.html?format=raw">SAXO mailing lists</ulink>.108 <ulink url="http://forge.ipsl.jussieu.fr/saxo/report">Read</ulink> tickets. Because of abusive use of our tickets, <ulink url="http://forge.ipsl.jussieu.fr/saxo/newticket">sending tickets</ulink> is now limited to a registered login accessible if you subscribe to <ulink url="../../saxo/browser/trunk/SRC/Documentation/xmldoc/mailing.html?format=raw">SAXO mailing lists</ulink>. 109 109 </para> 110 110 </listitem> -
trunk/SRC/Documentation/xmldoc/whatissaxo.xml
r164 r183 13 13 </authorgroup> 14 14 <keywordset> 15 <keyword> idl</keyword>15 <keyword>IDL</keyword> 16 16 <keyword>SAXO</keyword> 17 17 </keywordset> … … 38 38 Developed in collaboration with <ulink url="http://www.lodyc.jussieu.fr/">LOCEAN</ulink> researchers, it allows to explore four dimension data which may be gridded or irregularly spaced. 39 39 It is particularly adapted to the "Arakawa C grid" discretization used in <ulink url="http://www.lodyc.jussieu.fr/NEMO/">NEMO</ulink>. 40 In addition to graphical procedures, interpolation modules and other things ..., it contains a set of programs dedicated to oceanographic diagnostics.40 In addition to graphical procedures, interpolation modules and other things …, it contains a set of programs dedicated to oceanographic diagnostics. 41 41 </para> 42 42 </sect1> -
trunk/SRC/Documentation/xmldoc/whatsnew.xml
r176 r183 13 13 </authorgroup> 14 14 <keywordset> 15 <keyword> idl</keyword>15 <keyword>IDL</keyword> 16 16 <keyword>SAXO</keyword> 17 17 </keywordset> … … 66 66 <title>Changeset 163 (2006-08-29)</title> 67 67 <para> 68 Last major commit related to the english translation of headers and their format. Better <ulink url="http://forge.ipsl.jussieu.fr/saxo/browser/trunk/SRC/Documentation/idldoc_html_output/index.html?format=raw">idldoc html documentationb</ulink> and introduce SAXO online_help created by idldoc assistant.68 Last major commit related to the English translation of headers and their format. Better <ulink url="../idldoc_html_output/index.html?format=raw">idldoc HTML documentation</ulink> and introduce SAXO online_help created by idldoc assistant. 69 69 </para> 70 70 <para> … … 76 76 <title>Changeset 152 (2006-08-10)</title> 77 77 <para> 78 This revision includes new <ulink url=" http://forge.ipsl.jussieu.fr/saxo/browser/trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltv.pro">pltv</ulink> (a bix between plt and tvplus) plotting procedure.78 This revision includes new <ulink url="../../ToBeReviewed/PLOTS/DESSINE/pltv.pro">pltv</ulink> (a mix between plt and tvplus) plotting procedure. 79 79 </para> 80 80 <para>
Note: See TracChangeset
for help on using the changeset viewer.