Ignore:
Timestamp:
08/21/06 11:01:50 (18 years ago)
Author:
navarro
Message:

header improvements + xxx doc

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r149 r157  
    334334<sect3 id="initmethodtxt"><title>Grid initalization method</title> 
    335335  <para> 
    336     +++ 
     336    By default, "automatic grid construction with initncdf.pro" is checked. 
     337  </para> 
     338  <para> 
     339    But you can choose an other grid by checking "grid construction with other IDL batch or procedure"   
    337340  </para> 
    338341</sect3> 
    … …  
    358361    Once these two lines have been completed, click on <guibutton>let's go</guibutton>. 
    359362  </para> 
     363  <para>For example, we choose the mask "tst_initlev". Compare the result with "automatic grid construction with initncdf.pro" checked. Cf <xref linkend="fig_xxx_0404"/> </para> 
     364<para> 
     365  <figure id="fig_xxx_0103"> 
     366      <title>Oceania at 125 metters of depth with a mask</title> 
     367        <imageobject> 
     368          <imagedata fileref="figpng/xxx_0103.png"/> 
     369        </imageobject> 
     370  </figure> 
     371</para> 
    360372</sect3> 
    361373</sect2> 
    … …  
    440452<para> 
    441453    <figure id="fig_xxx_0202"> 
    442       <title></title> 
    443       <mediaobjectco> 
    444         <imageobjectco> 
     454      <title>Differents plot types avaibles</title> 
    445455          <imageobject> 
    446456            <imagedata fileref="figpng/xxx_0202.png"/> 
    447457          </imageobject> 
    448         </imageobjectco> 
    449       </mediaobjectco> 
    450458    </figure> 
    451459</para> 
    … …  
    461469<para> 
    462470    <figure id="fig_xxx_0203"> 
    463       <title></title> 
    464       <mediaobjectco> 
    465         <imageobjectco> 
     471      <title>The File menu</title> 
    466472          <imageobject> 
    467473            <imagedata fileref="figpng/xxx_0203.png"/> 
    468474          </imageobject> 
    469         </imageobjectco> 
    470       </mediaobjectco> 
    471475    </figure> 
    472476</para> 
    … …  
    489493<para> 
    490494    <figure id="fig_xxx_0204"> 
    491       <title></title> 
    492       <mediaobjectco> 
    493         <imageobjectco> 
     495      <title>The Save As menu</title> 
    494496          <imageobject> 
    495497            <imagedata fileref="figpng/xxx_0204.png"/> 
    496498          </imageobject> 
    497         </imageobjectco> 
    498       </mediaobjectco> 
    499499    </figure> 
    500500</para> 
    … …  
    503503<itemizedlist> 
    504504<listitem><para><guimenuitem>Postscript:</guimenuitem> to save in Postscript format</para></listitem> 
    505 <listitem><para><guimenuitem>Animations:</guimenuitem> to create an animation from the XXX window. 
     505<listitem><para><guimenuitem>Animated gif:</guimenuitem> to create an animation from the XXX window. 
    506506Careful, the creation of an animation is only possible if none of the 
    507507plots have a time axis, and if the plots are all on the same time base 
    508508(calendar).  On the other hand, animations of horizontal and vertical 
    509509plots, with different color palettes (for those not on an X-terminal), 
    510 are possible.</para></listitem> 
    511 <listitem><para><guimenuitem>Image:</guimenuitem> to save a gif of the XXX graphics window.</para></listitem> 
    512 <listitem><para><guimenuitem>Script:</guimenuitem> to save the command history that has created the 
     510are possible. 
     511<note> 
     512<para> 
     513the creation of animations has a tendency to saturate the video 
     514memory of X-terminals, crashing the entire program...</para> 
     515</note> 
     516</para></listitem> 
     517<listitem><para><guimenuitem>Gif:</guimenuitem> to save a gif of the XXX graphics window.</para></listitem> 
     518<listitem><para><guimenuitem>IDL procedure:</guimenuitem> to save the command history that has created the 
    513519plot.  For example if I save the commands in <filename>xxx_figure.pro</filename>, I can 
    514520then launch a new IDL session and type: 
    … …  
    528534</screen> 
    529535will then create a Postscript file of the figure.</para><para></para></listitem> 
    530 <listitem><para><guimenuitem>Prompt:</guimenuitem> lists in the IDL window the command history that 
     536<listitem><para><guimenuitem>RESTORE kwd of xxx:</guimenuitem></para></listitem> 
     537<listitem><para><guimenuitem>Print to prompt:</guimenuitem> lists in the IDL window the command history that 
    531538created the last plot.  Useful primarily for debugging...</para></listitem> 
    532539</itemizedlist> 
    533540</para> 
    534541</sect4> 
     542<para>Test the various possibilities in the <guimenu>Save As</guimenu> menu.</para> 
    535543<sect4 id="flagsubmenu"><title><guisubmenu>Flag options</guisubmenu> submenu</title> 
    536544<para> 
    537545    <figure id="fig_xxx_0205"> 
    538       <title></title> 
    539       <mediaobjectco> 
    540         <imageobjectco> 
     546      <title>The Flag Option menu</title> 
    541547          <imageobject> 
    542548            <imagedata fileref="figpng/xxx_0205.png"/> 
    543549          </imageobject> 
    544         </imageobjectco> 
    545       </mediaobjectco> 
    546550    </figure> 
    547551</para> 
    … …  
    563567</para> 
    564568</sect4> 
     569<para> 
     570Test the various possibilities in the <guimenu>Flag options</guimenu> menu. 
     571</para> 
     572<caution> 
     573<para> 
     574Careful, a selected option remains selected until it is reclicked. 
     575</para> 
     576</caution> 
    565577</sect3> 
    566578 
    … …  
    573585<para> 
    574586    <figure id="fig_xxx_0206"> 
    575       <title></title> 
    576       <mediaobjectco> 
    577         <imageobjectco> 
     587      <title>Number of Column</title> 
    578588          <imageobject> 
    579589            <imagedata fileref="figpng/xxx_0206.png"/> 
    580590          </imageobject> 
    581         </imageobjectco> 
    582       </mediaobjectco> 
     591    </figure> 
     592</para> 
     593<para>For example: For 2 cln and 2 row. For explanations, see further.</para> 
     594<para> 
     595    <figure id="fig_xxx_0206a"> 
     596      <title>A frame with several graphics</title> 
     597          <imageobject> 
     598            <imagedata fileref="figpng/xxx_0206a.png"/> 
     599          </imageobject> 
    583600    </figure> 
    584601</para> 
    … …  
    589606<para> 
    590607    <figure id="fig_xxx_0207"> 
    591       <title></title> 
    592       <mediaobjectco> 
    593         <imageobjectco> 
     608      <title>differents Variables avaible</title> 
    594609          <imageobject> 
    595610            <imagedata fileref="figpng/xxx_0207.png"/> 
    596611          </imageobject> 
    597         </imageobjectco> 
    598       </mediaobjectco> 
    599612    </figure> 
    600613</para> 
    … …  
    605618<para> 
    606619    <figure id="fig_xxx_0208"> 
    607       <title></title> 
    608       <mediaobjectco> 
    609         <imageobjectco> 
     620      <title>List of open files</title> 
    610621          <imageobject> 
    611622            <imagedata fileref="figpng/xxx_0208.png"/> 
    612623          </imageobject> 
    613         </imageobjectco> 
    614       </mediaobjectco> 
    615624    </figure> 
    616625</para> 
    … …  
    618627 
    619628<sect3 id="commandtexttxt"><title><guimenuitem>Command text</guimenuitem></title> 
    620 <para>To specify the computation you want to do  
    621 +++ donner plus d'infos et des examples 
     629<para>To specify the computation you want to do.  
     630Examples: </para> 
     631<sect4 id="withoutcommandtexttxt"><title><guimenuitem> Without any Command Text</guimenuitem></title> 
     632<para> 
     633    <figure id="fig_xxx_0209"> 
     634      <title>Graphic by default</title> 
     635          <imageobject> 
     636            <imagedata fileref="figpng/xxx_0209.png"/> 
     637          </imageobject> 
     638    </figure> 
     639</para> 
     640</sect4> 
     641 
     642<sect4 id="withrealcont"><title><guimenuitem> With the command text /realcont</guimenuitem></title> 
     643<para> 
     644    <figure id="fig_xxx_0210a"> 
     645      <title>Command text area</title> 
     646          <imageobject> 
     647            <imagedata fileref="figpng/xxx_0210a.png"/> 
     648          </imageobject> 
     649    </figure> 
     650</para> 
     651<para> 
     652    <figure id="fig_xxx_0210"> 
     653      <title>Graphic with the command text "/realcont"</title> 
     654          <imageobject> 
     655            <imagedata fileref="figpng/xxx_0210.png"/> 
     656          </imageobject> 
     657    </figure> 
     658</para> 
     659</sect4> 
     660 
     661<sect4 id="withmaportho"><title><guimenuitem>With the command text /realcont+ map=[90,0,0]+ /ortho+ cell_fill=2.</guimenuitem></title> 
     662<para> 
     663    <figure id="fig_xxx_0211a"> 
     664      <title>Command text area with the right syntax</title> 
     665          <imageobject> 
     666            <imagedata fileref="figpng/xxx_0211a.png"/> 
     667          </imageobject> 
     668    </figure> 
     669</para> 
     670<para> 
     671    <figure id="fig_xxx_0211"> 
     672      <title>Polar Projection</title> 
     673          <imageobject> 
     674            <imagedata fileref="figpng/xxx_0211.png"/> 
     675          </imageobject> 
     676    </figure> 
     677</para> 
     678</sect4> 
     679 
    622680<note><para>In the default case, the name given to a field is of no importance.</para></note> 
    623 </para> 
    624681</sect3> 
    625682 
    … …  
    628685The calendar is made up of two droplists, which allow specification of 
    629686two dates, the beginning and end of a time series, or the period over 
    630 which to average before plotting. 
     687which to average before plotting.</para> 
     688<para>Example: The first plot is during January.</para> 
     689<para>         The second plot is from January to December.</para> 
     690<para> 
     691    <figure id="fig_xxx_0301"> 
     692      <title>Graphic with 2 different period of study</title> 
     693          <imageobject> 
     694            <imagedata fileref="figpng/xxx_0301.png"/> 
     695          </imageobject> 
     696    </figure> 
    631697</para> 
    632698</sect3> 
    … …  
    639705plot, and in meters for a vertical plot. 
    640706</para> 
    641 </sect3> 
     707 
     708<sect4 id="withoutdomainspecification"><title><guimenuitem>Without any domain specification</guimenuitem></title> 
     709<para> 
     710    <figure id="fig_xxx_0210"> 
     711      <title>Domain by default</title> 
     712          <imageobject> 
     713            <imagedata fileref="figpng/xxx_0210.png"/> 
     714          </imageobject> 
     715    </figure> 
     716</para> 
     717</sect4> 
     718 
     719<sect4 id="withzoom"><title><guimenuitem>With a zoom on Oceania</guimenuitem></title> 
     720<para>We can zoom, between 0 and 1 meter of depth, on the Oceania, by playing with the part Domdef, with this configuration</para> 
     721<para> 
     722    <figure id="fig_xxx_0401"> 
     723      <title>Change Domain area</title> 
     724          <imageobject> 
     725            <imagedata fileref="figpng/xxx_0401.png"/> 
     726          </imageobject> 
     727    </figure> 
     728</para> 
     729<para>This configuration give us:</para> 
     730<para> 
     731    <figure id="fig_xxx_0402"> 
     732      <title>Graphic with a specified domain</title> 
     733          <imageobject> 
     734            <imagedata fileref="figpng/xxx_0402.png"/> 
     735          </imageobject> 
     736    </figure> 
     737</para> 
     738</sect4> 
     739</sect3> 
     740 
     741<sect4 id="depthspecificationtxt"><title><guimenuitem>With the specification of the depth</guimenuitem></title> 
     742<para>If we want to see the temperature of the ocean between 125 and 126 meters of depth</para> 
     743<para> 
     744    <figure id="fig_xxx_0403"> 
     745      <title>Change depth area</title> 
     746          <imageobject> 
     747            <imagedata fileref="figpng/xxx_0403.png"/> 
     748          </imageobject> 
     749    </figure> 
     750</para> 
     751<para> 
     752    <figure id="fig_xxx_0404"> 
     753      <title>Oceania at 125 metters of depth without a mask</title> 
     754          <imageobject> 
     755            <imagedata fileref="figpng/xxx_0404.png"/> 
     756          </imageobject> 
     757    </figure> 
     758</para> 
     759<para>As you can see, at this depth, we can see the difference between the continent at the surface and the real goegraphy of the terrain. If we want to see only the terrain at the specified depth, we have to put a mask. Cf <xref linkend="fig_xxx_0103"/></para>   
     760<para>You can define precisely the depth you want to see:</para> 
     761<para> 
     762    <figure id="fig_xxx_0405"> 
     763      <title>The Precise Depth menu</title> 
     764          <imageobject> 
     765            <imagedata fileref="figpng/xxx_0405.png"/> 
     766          </imageobject> 
     767    </figure> 
     768</para> 
     769</sect4> 
     770 
    642771 
    643772<sect3 id="specificationstxt"><title>specify your plot</title> 
     773<sect4 id="minmaxintervaltxt"><title><guimenuitem>Specify the min, the max and the interval</guimenuitem></title> 
    644774<para> 
    645775You can specify the min, max, and contour interval by filling out the 
    646 provided boxes! For the color palette, you can either specify the name 
     776provided boxes! 
     777</para> 
     778<para> 
     779You can restore configuration by default by pressing the "default" button. 
     780</para> 
     781<para> 
     782    <figure id="fig_xxx_0501"> 
     783      <title>Specification area</title> 
     784          <imageobject> 
     785            <imagedata fileref="figpng/xxx_0501.png"/> 
     786          </imageobject> 
     787    </figure> 
     788</para> 
     789</sect4> 
     790 
     791<sect4 id="colortxt"><title><guimenuitem>Specify the palette to be used</guimenuitem></title> 
     792<para>For the color palette, you can either specify the name 
    647793or go search for one among the palettes available. 
     794</para> 
     795<para> 
     796    <figure id="fig_xxx_0502"> 
     797      <title>The Color menu</title> 
     798          <imageobject> 
     799            <imagedata fileref="figpng/xxx_0502.png"/> 
     800          </imageobject> 
     801    </figure> 
     802</para> 
     803</sect4> 
     804 
    648805<para> 
    649806The "keywords" window allows specification of all desired 
    … …  
    651808<filename>plt.pro</filename>, <filename>pltt.pro</filename>, <filename>pltz.pro</filename>, 
    652809<filename>plt1d.pro</filename>, or those of contour, plot, or all other programs that are 
    653 used. Cf <xref linkend="example1"/> 
    654 </para></para> 
     810used. Cf <xref linkend="commandtexttxt"/>  
     811</para> 
    655812</sect3> 
    656813 
    … …  
    658815</sect2> 
    659816</sect1> 
    660 <sect1 id="examples"><title>Concrete examples of XXX in practice</title> 
    661  
    662 <sect2 id="example1"><title>First plots</title> 
    663  
    664 <para> 
    665 One single file, one single plot per page 
    666 </para> 
    667 <para> 
    668 Click on OK. 
    669 </para> 
    670 <para> 
    671 Test the various basic functions: change the dates, the zoom, the 
    672 field...</para> 
    673 <para> 
    674 Specify the min, max, and contour interval in the provided boxes.</para> 
    675 <para> 
    676 Add some keywords in the "keywords:" box, for example: </para> 
    677 <blockquote> 
    678 <para> 
    679 /nocontour, /carte 
    680 </para> 
    681 </blockquote> 
    682 <para> 
    683 or the keywords for a northern hortographic polar projection:</para> 
    684 <blockquote> 
    685 <para> 
    686 /nocontour, map=[90,0,0], /horto 
    687 </para> 
    688 </blockquote> 
    689 <para> 
    690 Test the various possibilities in the <guimenu>Save As</guimenu> menu.</para> 
    691 <note> 
    692 <para> 
    693 the creation of animations has a tendency to saturate the video 
    694 memory of X-terminals, crashing the entire program...</para> 
    695 </note> 
    696 <para> 
    697 Test the various possibilities in the <guimenu>Flag options</guimenu> menu. 
    698 </para> 
    699 <caution> 
    700 <para> 
    701 Careful, a selected option remains selected until it is reclicked. 
    702 </para> 
    703 </caution> 
    704 </sect2> 
    705  
    706 <sect2 id="example2"><title>Work with more than one file</title> 
    707 <para> 
    708 Open some other files and go between them by selecting them from the 
    709 file list...  Note that the different widgets (calendar, domain, ...) 
    710 follow the different file characteristics. 
    711 </para> 
    712 </sect2> 
    713  
    714 <sect2 id="mouse"><title>Mouse actions in the graphics window on a horizontal plot</title> 
    715  
     817<sect1 id="mouseactions"><title>Mouse Actions</title> 
     818 
     819<sect2 id="mouse"><title>In the graphics window on a horizontal plot</title> 
    716820<para> 
    717821Select a domain and select the horizontal plot (<constant>plt</constant>), vertical plot 
    … …  
    748852      </mediaobjectco> 
    749853    </figure> 
     854<para> 
     855    <figure id="fig_xxx_0701"> 
     856      <title>Horizontal Plot</title> 
     857          <imageobject> 
     858            <imagedata fileref="figpng/xxx_0701.png"/> 
     859          </imageobject> 
     860    </figure> 
     861</para> 
    750862 
    751863</para></listitem> 
    … …  
    761873      </mediaobjectco> 
    762874    </figure> 
     875<para> 
     876    <figure id="fig_xxx_0702"> 
     877      <title>Vertical Plot</title> 
     878          <imageobject> 
     879            <imagedata fileref="figpng/xxx_0702.png"/> 
     880          </imageobject> 
     881    </figure> 
     882</para> 
    763883 
    764884</para></listitem> 
    … …  
    774894      </mediaobjectco> 
    775895    </figure> 
     896<para> 
     897    <figure id="fig_xxx_0703"> 
     898      <title>Common hovmoeller for xt and yt cuts</title> 
     899          <imageobject> 
     900            <imagedata fileref="figpng/xxx_0703.png"/> 
     901          </imageobject> 
     902    </figure> 
     903</para> 
    776904 
    777905</para></listitem> 
    … …  
    811939      </mediaobjectco> 
    812940    </figure> 
     941<para> 
     942    <figure id="fig_xxx_0801"> 
     943      <title>The reference frame is selected</title> 
     944          <imageobject> 
     945            <imagedata fileref="figpng/xxx_0801.png"/> 
     946          </imageobject> 
     947    </figure> 
     948</para> 
    813949     
    814950</para></listitem> 
    … …  
    824960      </mediaobjectco> 
    825961    </figure> 
    826      
     962<para> 
     963    <figure id="fig_xxx_0802"> 
     964      <title>The target frame is selected</title> 
     965          <imageobject> 
     966            <imagedata fileref="figpng/xxx_0802.png"/> 
     967          </imageobject> 
     968    </figure> 
     969</para> 
    827970</para></listitem> 
    828971<listitem><para> 
    … …  
    8631006<abbrev>DCM</abbrev> in frame 4, <abbrev>LCR</abbrev> on the plot in frame 1, to create a hovmoeller in frame 4. 
    8641007</para> 
     1008<para> 
     1009    <figure id="fig_xxx_0901"> 
     1010      <title>Frame with four plot</title> 
     1011          <imageobject> 
     1012            <imagedata fileref="figpng/xxx_0901.png"/> 
     1013          </imageobject> 
     1014    </figure> 
     1015</para> 
    8651016</step> 
    8661017</procedure> 
    … …  
    8781029Add the keyword 
    8791030<literallayout>/nocontour</literallayout> 
     1031<para> 
     1032    <figure id="fig_xxx_0902a"> 
     1033      <title>Command text area</title> 
     1034          <imageobject> 
     1035            <imagedata fileref="figpng/xxx_0902a.png"/> 
     1036          </imageobject> 
     1037    </figure> 
     1038</para> 
    8801039</para> 
    8811040</step> 
    … …  
    8831042<para> 
    8841043click <guibutton>OK</guibutton>, and the plot is redone. 
     1044</para> 
     1045<para> 
     1046    <figure id="fig_xxx_0902"> 
     1047      <title>The fourth plot with the keyword "nocontour"</title> 
     1048          <imageobject> 
     1049            <imagedata fileref="figpng/xxx_0902.png"/> 
     1050          </imageobject> 
     1051    </figure> 
    8851052</para> 
    8861053</step> 
    … …  
    9081075<para> 
    9091076click on <guibutton>OK</guibutton> 
    910 , and voilà, the new plot. 
     1077</para> 
     1078<para> 
     1079    <figure id="fig_xxx_0903"> 
     1080      <title>Frame with five plot</title> 
     1081          <imageobject> 
     1082            <imagedata fileref="figpng/xxx_0903.png"/> 
     1083          </imageobject> 
     1084    </figure> 
    9111085</para> 
    9121086</step> 
    … …  
    9141088</sect2> 
    9151089</sect1> 
    916 <sect1 id="crash"><title>How to quit when it crashes</title> 
     1090<sect1 id="crash"><title>What should I do when it breakdown</title> 
    9171091 
    9181092<para> 
    … …  
    9261100</para></listitem> 
    9271101<listitem> 
    928 <para><abbrev>DCR</abbrev> to erase the problem frame 
     1102<para><abbrev>DCR</abbrev> to erase the problem frame.  
    9291103</para> 
    9301104</listitem> 
    931 <listitem><para>press the <guibutton>clear</guibutton> button 
    932 </para></listitem> 
    933 <listitem><para>change the orientation of the plot 
    934 </para></listitem> 
    935 <listitem><para>quit XXX cleanly using <guibutton>quit</guibutton> from the <guimenu>File</guimenu> menu 
     1105<listitem><para>change the orientation of the plot by pressing Flag options -> Portrait/Landscape. Cf <xref linkend="flagsubmenu"/> 
     1106</para></listitem> 
     1107<listitem><para>quit XXX cleanly using <guibutton>quit</guibutton> from the <guimenu>File</guimenu> menu. Cf <xref linkend="filesubmenu"/> 
    9361108</para></listitem> 
    9371109</orderedlist> 
Note: See TracChangeset for help on using the changeset viewer.