Ignore:
Timestamp:
04/22/08 10:52:34 (16 years ago)
Author:
pinsard
Message:

some improvements in wiki production

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/xmldoc/firststeps.xml

    r345 r354  
    9191      <title> Start IDL session: <userinput><command>@init</command></userinput> </title> 
    9292      <para> 
    93 Each IDL session using <application>SAXO</application> must always start with: <prompt>&promptidl;</prompt> <userinput><command>@init</command></userinput>. 
     93Each IDL session using <application>SAXO</application> must always start with: 
     94<screen> 
     95 <prompt>&promptidl;</prompt> <userinput><command>@init</command></userinput> 
     96</screen> 
    9497      </para> 
    9598      <para> 
    9699<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 @&hellip; file will still be accessible after the execution of the @&hellip; is finished (which is not the case for procedures and functions that ends with the return instruction).</emphasis> 
     100</para> 
     101<para> 
    97102<screen> 
    98103  <prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">${HOME}/My_IDL/</filename></userinput> 
    … …  
    118123  <prompt>&promptidl;</prompt> 
    119124</screen> 
    120 As an IDL session using <application>SAXO</application> must always start with <prompt>&promptidl;</prompt> <userinput><command>@init</command></userinput>, it could be convenient to define the environment variable <envar>IDL_STARTUP</envar> to <filename>${HOME}/My_IDL/init.pro</filename>. In that way, <filename>init.pro</filename> will automatically been executed when starting IDL. This can be done with the following command: 
     125</para> 
     126<para> 
     127As an IDL session using <application>SAXO</application> must always start with : 
     128<screen> 
     129 <prompt>&promptidl;</prompt> <userinput><command>@init</command></userinput> 
     130</screen> 
     131, it could be convenient to define the environment variable <envar>IDL_STARTUP</envar> to <filename>${HOME}/My_IDL/init.pro</filename>. In that way, <filename>init.pro</filename> will automatically been executed when starting IDL. This can be done with the following command: 
    121132      <variablelist> 
    122 <varlistentry><term><command>csh</command></term> 
     133<varlistentry> 
     134<term><command>csh</command></term> 
    123135<listitem><screen><prompt>$</prompt> <userinput><command>setenv</command> <envar>IDL_STARTUP</envar> <filename>${HOME}/My_IDL/init.pro</filename></userinput></screen></listitem> 
    124136</varlistentry> 
    125 <varlistentry><term><command>ksh</command></term> 
     137<varlistentry> 
     138<term><command>ksh</command></term> 
    126139<listitem><screen><prompt>$</prompt> <userinput><command>export</command> <envar>IDL_STARTUP</envar>=<filename>${HOME}/My_IDL/init.pro</filename></userinput></screen></listitem> 
    127140</varlistentry> 
    … …  
    144157   <prompt>&promptidl;</prompt> <userinput><command>plot, y</command></userinput> <link xl:href="./figpng/basic_plot.png">&showfig;</link> 
    145158</screen> 
    146           <calloutlist> 
     159   <calloutlist> 
    147160    <callout arearefs="findgen"> 
    148161      <para> 
    149 <command>findgen</command> stands for 
    150 <emphasis role="bold">f</emphasis>loat <emphasis role="bold">ind</emphasis>ex <emphasis role="bold">gen</emphasis>erator. 
     162<command>findgen</command> stands for <emphasis role="bold">f</emphasis>loat <emphasis role="bold">ind</emphasis>ex <emphasis role="bold">gen</emphasis>erator. 
    151163<screen> 
    152164  <prompt>&promptidl;</prompt> <userinput><command>print, findgen(6)</command></userinput> 
    … …  
    229241</screen> 
    230242      </para> 
    231       <para xml:id="splot_description"> 
     243<para xml:id="splot_description"> 
    232244<command>splot</command> accepts the same keywords as <command>plot</command> (<computeroutput xml:id="plot_kwd">/ISOTROPIC, MAX_VALUE=value, MIN_VALUE=value, NSUM=value, /POLAR, THICK=value, /XLOG, /YLOG, /YNOZERO</computeroutput>), including the graphics keywords (<computeroutput xml:id="gr_kwd">BACKGROUND, CHARSIZE, CHARTHICK, CLIP, COLOR, DATA, DEVICE, FONT, LINESTYLE, NOCLIP, NODATA, NOERASE, NORMAL, POSITION, PSYM, SUBTITLE, SYMSIZE, T3D, THICK, TICKLEN, TITLE, [XYZ]CHARSIZE, [XYZ]GRIDSTYLE, [XYZ]MARGIN, [XYZ]MINOR, [XYZ]RANGE, [XYZ]STYLE, [XYZ]THICK, [XYZ]TICKFORMAT, [XYZ]TICKINTERVAL, [XYZ]TICKLAYOUT, [XYZ]TICKLEN, [XYZ]TICKNAME, [XYZ]TICKS, [XYZ]TICKUNITS, [XYZ]TICKV, [XYZ]TICK_GET, [XYZ]TITLE, ZVALUE</computeroutput>). 
    233       </para> 
    234       <simpara> 
     245</para> 
     246<simpara> 
    235247It can therefore be customized <emphasis>as much as you want</emphasis>. See this short example: 
    236       </simpara> 
    237       <para> 
     248</simpara> 
     249<para> 
    238250<screen> 
    239251  <prompt>&promptidl;</prompt> <userinput><command>splot, y, y^2, linestyle = 2, thick = 2, title = 'y = x^2', /portrait</command></userinput> <link xl:href="./figpng/basic_splot2.png">&showfig;</link> 
    … …  
    277289      <title> scontour </title> 
    278290      <para> 
    279 Following <command><link linkend="basic_splot">splot</link></command> example, we provide <command>scontour</command> as a "super <command>contour</command>". 
     291Following <command><link linkend="basic_splot">splot</link></command> example, we provide <command>scontour</command> as a <quote>super <command>contour</command></quote>. 
    280292<screen> 
    281293  <prompt>&promptidl;</prompt> <userinput><command>z = dist(n)</command></userinput> 
    … …  
    326338 
    327339      <sect3 xml:id="tvplus"> 
    328 <title> Quick look and explore 2D arrays: tvplus </title> 
     340<title> Quick look and explore 2D arrays: <command>tvplus</command> </title> 
    329341<para> 
    330342  <command>tvplus</command> is a enhanced version of <command>tvscl</command> and allow you to have a quick look and perform basic exploration of 2D arrays. 
    331   <screen> 
    332   <prompt>&promptidl;</prompt> <userinput><command>tvplus, dist(20)</command></userinput> <link xl:href="./figpng/tvplus.png">&showfig;</link> 
    333   <computeroutput>left button  : mouse position and associated array value</computeroutput> 
    334   <computeroutput>middle button: use it twice to define a zoom box</computeroutput> 
    335   <computeroutput>right button : quit</computeroutput> 
    336   <computeroutput>(x, y) = (  5,   5), value = 7.07107</computeroutput> 
    337   <computeroutput>(x, y) = ( 12,   8), value = 11.3137</computeroutput> 
    338   </screen> 
    339   For more informations on <command>tvplus</command>, try: 
    340   <screen> 
    341   <prompt>&promptidl;</prompt> <userinput><command>xhelp, 'tvplus'</command></userinput> 
    342   </screen> 
    343   To see the source code of <command>tvplus</command>, try: 
    344   <screen> 
    345   <prompt>&promptidl;</prompt> <userinput><command>xfile, 'tvplus'</command></userinput> 
    346   </screen> 
    347   <note><title>New Feature</title><para> 
    348   If you use an IDL 6.2 or later revision, you can simply get the help of any command by typing ?<replaceable>command_name</replaceable>, for example: 
    349   <screen> 
    350   <prompt>&promptidl;</prompt> <userinput><command>?tvplus</command></userinput> 
    351   </screen> 
    352   </para></note> 
    353 </para> 
    354       </sect3> 
     343<screen> 
     344 <prompt>&promptidl;</prompt> <userinput><command>tvplus, dist(20)</command></userinput> <link xl:href="./figpng/tvplus.png">&showfig;</link> 
     345 <computeroutput>left button  : mouse position and associated array value</computeroutput> 
     346 <computeroutput>middle button: use it twice to define a zoom box</computeroutput> 
     347 <computeroutput>right button : quit</computeroutput> 
     348 <computeroutput>(x, y) = (  5,   5), value = 7.07107</computeroutput> 
     349 <computeroutput>(x, y) = ( 12,   8), value = 11.3137</computeroutput> 
     350 </screen> 
     351</para> 
     352<para> 
     353For more informations on <command>tvplus</command>, try: 
     354<screen> 
     355 <prompt>&promptidl;</prompt> <userinput><command>xhelp, 'tvplus'</command></userinput> 
     356</screen> 
     357</para> 
     358<para> 
     359To see the source code of <command>tvplus</command>, try: 
     360<screen> 
     361 <prompt>&promptidl;</prompt> <userinput><command>xfile, 'tvplus'</command></userinput> 
     362</screen> 
     363<note><title>New Feature</title> 
     364<para> 
     365If you use an IDL 6.2 or later revision, you can simply get the help of any command by typing ?<replaceable>command_name</replaceable>, for example: 
     366<screen> 
     367 <prompt>&promptidl;</prompt> <userinput><command>?tvplus</command></userinput> 
     368</screen> 
     369</para> 
     370</note> 
     371</para> 
     372</sect3> 
    355373 
    356374      <sect3 xml:id="pltv"> 
    … …  
    493511    </sect2> 
    494512 
    495     <sect2 xml:id="pltz"> 
    496       <title> Vertical sections </title> 
     513<sect2 xml:id="pltz"> 
     514<title> Vertical sections </title> 
    497515<para> 
    498516  A quick presentation of vertical sections is shown in <link xl:href="../../Tests/tst_pltz.pro">tst_pltz</link>. After loading any of the grid (for example with one of the <link linkend="load_grid">above examples</link>). Just try: 
    … …  
    537555    </sect2> 
    538556 
    539     <sect2 xml:id="plt1d"> 
    540       <title> 1D plots </title> 
    541         <para> 
    542   To be continued &hellip; 
    543 </para> 
    544    </sect2> 
    545  
    546  
    547   </sect1> 
     557<sect2 xml:id="plt1d"> 
     558<title> 1D plots </title> 
     559<para> 
     560To be continued &hellip; 
     561</para> 
     562</sect2> 
     563 
     564 
     565</sect1> 
    548566 
    549567</article> 
Note: See TracChangeset for help on using the changeset viewer.