Changeset 79


Ignore:
Timestamp:
05/31/06 14:45:44 (18 years ago)
Author:
pinsard
Message:

add documentation (support, whatsnew, all_plots), change css file

Location:
trunk/SRC/Documentation/xmldoc
Files:
6 added
3 edited
1 moved

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/xmldoc/firststeps.html

    r78 r79  
    33   <title> 
    44    First steps with SAXO 
    5   </title><link rel="stylesheet" href="firststeps.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.69.1"><meta name="keywords" content="idl, SAXO"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e3"></a> 
     5  </title><link rel="stylesheet" href="saxo.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.69.1"><meta name="keywords" content="idl, SAXO"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e3"></a> 
    66    First steps with <span class="application">SAXO</span> 
    7   </h2></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">S&eacute;bastien</span> <span class="surname">Masson</span></h3><code class="email">&lt;<a href="mailto:smasson@lodyc.jussieu.fr">smasson@lodyc.jussieu.fr</a>&gt;</code></div><div class="author"><h3 class="author"><span class="firstname">Fran&ccedil;oise</span> <span class="surname">Pinsard</span></h3></div></div></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="2"><b>Revision History</b></th></tr><tr><td align="left">Revision 0.0</td><td align="left">29 July 2005</td></tr><tr><td align="left" colspan="2">First draft</td></tr><tr><td align="left">Revision 0.1</td><td align="left">29 August 2005</td></tr><tr><td align="left" colspan="2">last japanese version!</td></tr><tr><td align="left">Revision 0.2</td><td align="left">May 2006</td></tr><tr><td align="left" colspan="2">split with getsaxo</td></tr></table></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#first_plots">1.  
     7  </h2></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">S&eacute;bastien</span> <span class="surname">Masson</span></h3><code class="email">&lt;<a href="mailto:smasson_at_lodyc.jussieu.fr">smasson_at_lodyc.jussieu.fr</a>&gt;</code></div><div class="author"><h3 class="author"><span class="firstname">Fran&ccedil;oise</span> <span class="surname">Pinsard</span></h3><code class="email">&lt;<a href="mailto:Francoise.Pinsard_at_lodyc.jussieu.fr">Francoise.Pinsard_at_lodyc.jussieu.fr</a>&gt;</code></div></div></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="2"><b>Revision History</b></th></tr><tr><td align="left">Revision 0.0</td><td align="left">29 July 2005</td></tr><tr><td align="left" colspan="2">First draft</td></tr><tr><td align="left">Revision 0.1</td><td align="left">29 August 2005</td></tr><tr><td align="left" colspan="2">last japanese version!</td></tr><tr><td align="left">Revision 0.2</td><td align="left">May 2006</td></tr><tr><td align="left" colspan="2">split with getsaxo</td></tr></table></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#first_plots">1.  
    88      First plots... 
    99    </a></span></dt><dd><dl><dt><span class="sect2"><a href="#start_with_init">1.1.  
     
    3232        <span class="emphasis"><em>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).</em></span> 
    3333        </p><pre class="screen"> 
    34   <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd <code class="envar">$HOME</code>/My_IDL</strong></span></code></strong> 
     34  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd <code class="envar">${HOME}</code>/My_IDL</strong></span></code></strong> 
    3535  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">idl</strong></span></code></strong> 
    3636  <code class="computeroutput">IDL Version 6.0, Mac OS X (darwin ppc m32). (c) 2003, Research Systems, Inc.</code> 
     
    5454  <code class="prompt">idl&gt;</code> 
    5555        </pre><p> 
    56         As an IDL session using <span class="application">SAXO</span> must always start with <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">@init</strong></span></code></strong>, it could be convenient to define the environment variable <code class="envar">IDL_STARTUP</code> to <code class="filename"><code class="envar">$HOME</code>/My_IDL/init.pro</code>. In that way, init.pro will automatically been execuded when starting IDL. This can be done with the following command: 
    57       </p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command">csh</strong></span></span></dt><dd><pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>setenv <code class="envar">IDL_STARTUP</code> <code class="filename"><code class="envar">$HOME</code>/My_IDL/init.pro</code></code></strong></pre></dd><dt><span class="term"><span><strong class="command">ksh</strong></span></span></dt><dd><pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>export <code class="envar">IDL_STARTUP</code>=<code class="filename"><code class="envar">$HOME</code>/My_IDL/init.pro</code></code></strong></pre></dd></dl></div><p> 
     56        As an IDL session using <span class="application">SAXO</span> must always start with <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">@init</strong></span></code></strong>, it could be convenient to define the environment variable <code class="envar">IDL_STARTUP</code> to <code class="filename"><code class="envar">${HOME}</code>/My_IDL/init.pro</code>. In that way, init.pro will automatically been execuded when starting IDL. This can be done with the following command: 
     57      </p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command">csh</strong></span></span></dt><dd><pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>setenv <code class="envar">IDL_STARTUP</code> <code class="filename"><code class="envar">${HOME}</code>/My_IDL/init.pro</code></code></strong></pre></dd><dt><span class="term"><span><strong class="command">ksh</strong></span></span></dt><dd><pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>export <code class="envar">IDL_STARTUP</code>=<code class="filename"><code class="envar">${HOME}</code>/My_IDL/init.pro</code></code></strong></pre></dd></dl></div><p> 
    5858      </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="basic_plots"></a>1.2.&nbsp; 
    5959        basic plots... 
     
    214214        Load the data grid 
    215215      </h3></div></div></div><p> 
    216         As we focus in this section on the gridded data, we must first load the grid informations before reading and plotting the data. Loading the grid independently of the data allow you to reload the grid only when it is strictly necessary and not every time you access the data. In <code class="envar">$HOME</code>/SAXO_DIR/Tests, we provide several examples to load a grid. 
     216        As we focus in this section on the gridded data, we must first load the grid informations before reading and plotting the data. Loading the grid independently of the data allow you to reload the grid only when it is strictly necessary and not every time you access the data. In <code class="envar">${HOME}</code>/SAXO_DIR/Tests, we provide several examples to load a grid. 
    217217      </p><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="load_fromdata"></a>2.1.1.&nbsp; 
    218218          Easiest solution: load data grid (regular or not) directly from the data file. 
  • trunk/SRC/Documentation/xmldoc/firststeps.xml

    r78 r79  
    3737  <articleinfo> 
    3838    <authorgroup> 
    39       <author><firstname>Sébastien</firstname><surname>Masson</surname><email>smasson@lodyc.jussieu.fr</email></author> 
    40       <author><firstname>Françoise</firstname><surname>Pinsard</surname></author> 
     39      <author><firstname>Sébastien</firstname> <surname>Masson</surname> <email>smasson_at_lodyc.jussieu.fr</email></author> 
     40      <author><firstname>Françoise</firstname> <surname>Pinsard</surname> <email>Francoise.Pinsard_at_lodyc.jussieu.fr</email></author> 
    4141    </authorgroup> 
    4242    <keywordset> 
     
    7979        <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> 
    8080        <screen format="linespecific"> 
    81   <prompt>$</prompt> <userinput><command>cd <envar>$HOME</envar>/My_IDL</command></userinput> 
     81  <prompt>$</prompt> <userinput><command>cd <envar>${HOME}</envar>/My_IDL</command></userinput> 
    8282  <prompt>$</prompt> <userinput><command>idl</command></userinput> 
    8383  <computeroutput>IDL Version 6.0, Mac OS X (darwin ppc m32). (c) 2003, Research Systems, Inc.</computeroutput> 
     
    101101  <prompt>&promptidl;</prompt> 
    102102        </screen> 
    103         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><envar>$HOME</envar>/My_IDL/init.pro</filename>. In that way, init.pro will automatically been execuded when starting IDL. This can be done with the following command: 
     103        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><envar>${HOME}</envar>/My_IDL/init.pro</filename>. In that way, init.pro will automatically been execuded when starting IDL. This can be done with the following command: 
    104104      <variablelist> 
    105105        <varlistentry><term><command>csh</command></term> 
    106         <listitem><screen><prompt>$</prompt> <userinput>setenv <envar>IDL_STARTUP</envar> <filename><envar>$HOME</envar>/My_IDL/init.pro</filename></userinput></screen></listitem> 
     106        <listitem><screen><prompt>$</prompt> <userinput>setenv <envar>IDL_STARTUP</envar> <filename><envar>${HOME}</envar>/My_IDL/init.pro</filename></userinput></screen></listitem> 
    107107        </varlistentry> 
    108108        <varlistentry><term><command>ksh</command></term> 
    109         <listitem><screen><prompt>$</prompt> <userinput>export <envar>IDL_STARTUP</envar>=<filename><envar>$HOME</envar>/My_IDL/init.pro</filename></userinput></screen></listitem> 
     109        <listitem><screen><prompt>$</prompt> <userinput>export <envar>IDL_STARTUP</envar>=<filename><envar>${HOME}</envar>/My_IDL/init.pro</filename></userinput></screen></listitem> 
    110110        </varlistentry> 
    111111      </variablelist> 
     
    353353      </title> 
    354354      <para> 
    355         As we focus in this section on the gridded data, we must first load the grid informations before reading and plotting the data. Loading the grid independently of the data allow you to reload the grid only when it is strictly necessary and not every time you access the data. In <envar>$HOME</envar>/SAXO_DIR/Tests, we provide several examples to load a grid. 
     355        As we focus in this section on the gridded data, we must first load the grid informations before reading and plotting the data. Loading the grid independently of the data allow you to reload the grid only when it is strictly necessary and not every time you access the data. In <envar>${HOME}</envar>/SAXO_DIR/Tests, we provide several examples to load a grid. 
    356356      </para> 
    357357      <sect3 id="load_fromdata"> 
  • trunk/SRC/Documentation/xmldoc/makehtml.sh

    r78 r79  
    11#!/bin/bash 
     2# fplod 2006-05-31T10:34:18Z aedon.locean-ipsl.upmc.fr (Darwin) 
     3# . add creation of all_plots.html using firststeps.html 
     4# . remplace ~/SAXO_RD/SRC/Documentation/xmldoc/figpng by ./figpng/ 
     5# we suppose that this shell script is launched when we are in  
     6# <working space of saxo>/SRC/Documentation/xmldoc/ 
     7# 
    28set -u 
    3 # ndate is the date in the file SAXO_RD_*.tar.gz 
    4 ndate=$( echo ~/SAXO_RD/SAXO_RD_*.tar.gz ) 
    5 ndate=${ndate##*_} 
    6 ndate=${ndate%.tar.gz} 
    7 # ndate2 is the date in the file TestsData_*.tar.gz 
    8 ndate2=$( echo ~/IDL/TestsData_*.tar.gz ) 
    9 ndate2=${ndate2##*_} 
    10 ndate2=${ndate2%.tar.gz} 
     9# 
     10case "${1}" in 
     11   firststeps) 
     12      # ndate is the date in the file SAXO_RD_*.tar.gz 
     13      ndate=$( echo ~/SAXO_RD/SAXO_RD_*.tar.gz ) 
     14      ndate=${ndate##*_} 
     15      ndate=${ndate%.tar.gz} 
     16      # ndate2 is the date in the file TestsData_*.tar.gz 
     17      ndate2=$( echo ~/IDL/TestsData_*.tar.gz ) 
     18      ndate2=${ndate2##*_} 
     19      ndate2=${ndate2%.tar.gz} 
     20   ;; 
     21   *) 
     22      echo "iii : no ndate determination needed" 
     23   ;; 
     24esac 
     25 
    1126# figures lists 
    12 cd ~/SAXO_RD/SRC/Documentation/xmldoc/figpng 
     27cd ./figpng 
    1328 
    1429# 
     
    110125done 
    111126## 
    112 cd ~/SAXO_RD/SRC/Documentation/xmldoc 
    113 szsrc=$( ls -lh ~/SAXO_RD/SRC/SAXO_RD_${ndate}.tar.gz | awk '{print $5}' ) 
    114 szdata=$( ls -lh ~/IDL/TestsData_${ndate2}.tar.gz | awk '{print $5}' ) 
    115 sed -e s/"\&date\;"/${ndate}/g \ 
    116     -e s/"\&date2\;"/${ndate2}/g \ 
    117     -e s/"\&szsrc\;"/${szsrc}/g \ 
    118     -e s/"\&szdata\;"/${szdata}/g \ 
    119     -e s/"\&figsplt_lev\;"/"${figsplt_lev}"/g \ 
    120     -e s/"\&figsplt_orca2\;"/"${figsplt_orca2}"/g \ 
    121     -e s/"\&figsplt_orca05\;"/"${figsplt_orca05}"/g \ 
    122     -e s/"\&figspltz_lev\;"/"${figspltz_lev}"/g \ 
    123     -e s/"\&figspltz_orca2\;"/"${figspltz_orca2}"/g \ 
    124     -e s/"\&figspltz_orca05\;"/"${figspltz_orca05}"/g \ 
    125     -e s/"\&figspltt_lev\;"/"${figspltt_lev}"/g \ 
    126     -e s/"\&figspltt_orca2\;"/"${figspltt_orca2}"/g \ 
    127     -e s/"\&figspltt_orca05\;"/"${figspltt_orca05}"/g \ 
    128     -e s/"\&figsplt_lev_stride\;"/"${figsplt_lev_stride}"/g \ 
    129     -e s/"\&figsplt_orca2_stride\;"/"${figsplt_orca2_stride}"/g \ 
    130     -e s/"\&figsplt_orca05_stride\;"/"${figsplt_orca05_stride}"/g \ 
    131     -e s/"\&figspltz_lev_stride\;"/"${figspltz_lev_stride}"/g \ 
    132     -e s/"\&figspltz_orca2_stride\;"/"${figspltz_orca2_stride}"/g \ 
    133     -e s/"\&figspltz_orca05_stride\;"/"${figspltz_orca05_stride}"/g \ 
    134     -e s/"\&figspltt_lev_stride\;"/"${figspltt_lev_stride}"/g \ 
    135     -e s/"\&figspltt_orca2_stride\;"/"${figspltt_orca2_stride}"/g \ 
    136     -e s/"\&figspltt_orca05_stride\;"/"${figspltt_orca05_stride}"/g \ 
    137     ${1}.xml > ${1}_$$.xml  
     127cd .. # ie <working space of saxo>/SRC/Documentation/xmldoc 
     128 
     129case "${1}" in 
     130   firststeps) 
     131      szsrc=$( ls -lh ~/SAXO_RD/SRC/SAXO_RD_${ndate}.tar.gz | awk '{print $5}' ) 
     132      szdata=$( ls -lh ~/IDL/TestsData_${ndate2}.tar.gz | awk '{print $5}' ) 
     133      sed -e s/"\&date\;"/${ndate}/g \ 
     134          -e s/"\&date2\;"/${ndate2}/g \ 
     135          -e s/"\&szsrc\;"/${szsrc}/g \ 
     136          -e s/"\&szdata\;"/${szdata}/g \ 
     137          -e s/"\&figsplt_lev\;"/"${figsplt_lev}"/g \ 
     138          -e s/"\&figsplt_orca2\;"/"${figsplt_orca2}"/g \ 
     139          -e s/"\&figsplt_orca05\;"/"${figsplt_orca05}"/g \ 
     140          -e s/"\&figspltz_lev\;"/"${figspltz_lev}"/g \ 
     141          -e s/"\&figspltz_orca2\;"/"${figspltz_orca2}"/g \ 
     142          -e s/"\&figspltz_orca05\;"/"${figspltz_orca05}"/g \ 
     143          -e s/"\&figspltt_lev\;"/"${figspltt_lev}"/g \ 
     144          -e s/"\&figspltt_orca2\;"/"${figspltt_orca2}"/g \ 
     145          -e s/"\&figspltt_orca05\;"/"${figspltt_orca05}"/g \ 
     146          -e s/"\&figsplt_lev_stride\;"/"${figsplt_lev_stride}"/g \ 
     147          -e s/"\&figsplt_orca2_stride\;"/"${figsplt_orca2_stride}"/g \ 
     148          -e s/"\&figsplt_orca05_stride\;"/"${figsplt_orca05_stride}"/g \ 
     149          -e s/"\&figspltz_lev_stride\;"/"${figspltz_lev_stride}"/g \ 
     150          -e s/"\&figspltz_orca2_stride\;"/"${figspltz_orca2_stride}"/g \ 
     151          -e s/"\&figspltz_orca05_stride\;"/"${figspltz_orca05_stride}"/g \ 
     152          -e s/"\&figspltt_lev_stride\;"/"${figspltt_lev_stride}"/g \ 
     153          -e s/"\&figspltt_orca2_stride\;"/"${figspltt_orca2_stride}"/g \ 
     154          -e s/"\&figspltt_orca05_stride\;"/"${figspltt_orca05_stride}"/g \ 
     155          ${1}.xml > ${1}_${$}.xml  
     156   ;; 
     157   *) 
     158      cp ${1}.xml ${1}_${$}.xml  
     159      echo "iii : no xml transformation needed" 
     160   ;; 
     161esac 
    138162# 
    139163CLASSPATH="$CLASSPATH:\ 
     
    144168#    -o ${1}.html ${1}.xml  \ 
    145169#    /sw/share/xml/xsl/docbook-xsl/html/docbook.xsl  \ 
    146 #    use.extensions=1 section.autolabel=1 html.stylesheet="${1}.css" css.decoration=1 
     170#    use.extensions=1 section.autolabel=1 html.stylesheet="saxo.css" css.decoration=1 
    147171# 
    148172#    callout.graphics.path="/sw/share/xml/xsl/docbook-xsl/images/callouts/" 
    149173 
    150 java  com.icl.saxon.StyleSheet -o ${1}.html ${1}_$$.xml  \ 
     174java  com.icl.saxon.StyleSheet -o ${1}.html ${1}_${$}.xml  \ 
    151175    /sw/share/xml/xsl/docbook-xsl/html/docbook.xsl  \ 
    152    section.autolabel=1 html.stylesheet="${1}.css" css.decoration=1 
    153 rm -f ${1}_$$.xml 
     176   section.autolabel=1 html.stylesheet="saxo.css" css.decoration=1 
     177 
     178case "${1}" in 
     179   firststeps) 
     180      java  com.icl.saxon.StyleSheet -o all_plots_${$}.xml ${1}_${$}.xml  \ 
     181      all_plots_docbook.xsl 
     182      java com.icl.saxon.StyleSheet -o all_plots.html all_plots_${$}.xml  \ 
     183      /sw/share/xml/xsl/docbook-xsl/html/docbook.xsl  \ 
     184      section.autolabel=1 html.stylesheet="saxo.css" css.decoration=1 
     185      rm -f all_plots_${$}.xml 
     186   ;; 
     187esac 
     188rm -f ${1}_${$}.xml 
Note: See TracChangeset for help on using the changeset viewer.