Changeset 89


Ignore:
Timestamp:
06/07/06 12:51:35 (18 years ago)
Author:
pinsard
Message:

add idldoc html output. see Documentation/idldoc_html_output/index.html

Location:
trunk/SRC/Documentation
Files:
585 added
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/xmldoc/main.html

    r88 r89  
    11<html><head> 
    22      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 
    3    <title>Main page of SAXO</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="d0e1"></a>Main page of SAXO</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">June 2006</td></tr><tr><td align="left" colspan="2">First draft</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="#d0e37">1. What is SAXO</a></span></dt><dt><span class="sect1"><a href="#d0e55">2. What's new</a></span></dt><dt><span class="sect1"><a href="#d0e81">3.  
     3   <title>Main page of SAXO</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="d0e1"></a>Main page of SAXO</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">June 2006</td></tr><tr><td align="left" colspan="2">First draft</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="#d0e38">1. What is SAXO</a></span></dt><dt><span class="sect1"><a href="#d0e56">2. What's new</a></span></dt><dt><span class="sect1"><a href="#d0e82">3.  
    44Get SAXO 
    5 </a></span></dt><dt><span class="sect1"><a href="#d0e103">4. Support</a></span></dt><dt><span class="sect1"><a href="#d0e125">5.  
     5</a></span></dt><dt><span class="sect1"><a href="#d0e104">4. Support</a></span></dt><dt><span class="sect1"><a href="#d0e126">5.  
    66Documentation 
    7 </a></span></dt><dt><span class="sect1"><a href="#d0e142">6. SAXO team</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e37"></a>1.&nbsp;What is SAXO</h2></div></div></div><p> 
     7</a></span></dt><dt><span class="sect1"><a href="#d0e151">6. SAXO team</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e38"></a>1.&nbsp;What is SAXO</h2></div></div></div><p> 
    88SAXO is a package (~400 routines, ~60 000 code lines) used to easily and quickly visualize and analyze models outputs or data observations. It is based on <a href="http://www.ittvis.com/idl/" target="_top"><span class="trademark">IDL</span>&#8482;</a> and contains a Graphic User Interface. Developed in collaboration with <a href="http://www.lodyc.jussieu.fr/" target="_top">LOCEAN</a> researchers, it allows to explore four dimension data which may be gridded or irregularly spaced. It is particularly adapted to the "Arakawa C grid" discretization used in <a href="http://www.lodyc.jussieu.fr/NEMO/" target="_top">NEMO</a>. In addition to graphical procedures, interpolation modules and other things..., it contains a set of programs dedicated to oceanographic diagnostics. <a href="../../saxo/browser/trunk/SRC/Documentation/xmldoc/whatissaxo.html?format=raw" target="_top">More...</a>  
    9 </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e55"></a>2.&nbsp;What's new</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li><p> 
     9</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e56"></a>2.&nbsp;What's new</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li><p> 
    1010March 2006-May 2006 : migration for <span class="bold"><strong>obsolete</strong></span> CVS repository + S&eacute;bastion Masson improvments 
    1111in a beautiful &#8220;<span class="quote"><span class="application">trac</span>+<span class="application">svn</span></span>&#8221; project on <code class="systemitem">http:://forge.ipsl.jussieu.fr/saxo/</code>. 
    1212</p></li><li><p> 
    1313More details in <a href="../../saxo/browser/trunk/SRC/Documentation/xmldoc/whatsnew.html?format=raw" target="_top">What's new in SAXO</a> 
    14 </p></li></ul></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e81"></a>3.&nbsp; 
     14</p></li></ul></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e82"></a>3.&nbsp; 
    1515Get SAXO 
    1616</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li><p> 
    … …  
    2020</p></li><li><p> 
    2121<a href="../../saxo/browser/trunk" target="_top">Browse</a> SAXO 
    22 </p></li></ul></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e103"></a>4.&nbsp;Support</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li><p> 
     22</p></li></ul></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e104"></a>4.&nbsp;Support</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li><p> 
    2323<a href="../../saxo/browser/trunk/SRC/Documentation/xmldoc/mailing.html?format=raw" target="_top">mailing lists</a> (subscribtion and archives). 
    2424</p></li><li><p> 
    … …  
    2626</p></li><li><p> 
    2727FAQ (to be created...) 
    28 </p></li></ul></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e125"></a>5.&nbsp; 
     28</p></li></ul></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e126"></a>5.&nbsp; 
    2929Documentation 
    3030</h2></div></div></div><p> 
    3131<a href="../../saxo/browser/trunk/SRC/Documentation/xmldoc/firststeps.html?format=raw" target="_top">First Steps</a> with saxo. See also plots of First Steps in <a href="../../saxo/browser/trunk/SRC/Documentation/xmldoc/all_plots.html?format=raw" target="_top">All plots</a> 
    3232</p><p> 
    33 Some useful <a href="../../saxo/browser/trunk/SRC/Documentation/xmldoc/tiplink.html?format=raw" target="_top">Tips and links</a> 
    34 </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e142"></a>6.&nbsp;SAXO team</h2></div></div></div><div class="variablelist"><dl><dt><span class="term"> 
     33<span class="application">IDLdoc</span> documentations set is available using  
     34<a href="../../saxo/browser/trunk/SRC/Documentation/idldoc_html_output/index.html?format=raw" target="_top">SRC/Documentation/idldoc_html_output/index.html</a>. 
     35</p><p> 
     36Some useful <a href="../../saxo/browser/trunk/SRC/Documentation/xmldoc/tiplink.html?format=raw" target="_top">Tips and links</a>. 
     37</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e151"></a>6.&nbsp;SAXO team</h2></div></div></div><div class="variablelist"><dl><dt><span class="term"> 
    3538S&eacute;bastien Masson  
    3639</span></dt><dd> 

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

    r88 r89  
    44[]> 
    55<article> 
     6<!-- 
     7 do not forget to modify WikiStart page if you modify this file 
     8--> 
    69<title>Main page of SAXO</title>  
    710  <articleinfo> 
    … …  
    105108</para> 
    106109<para> 
    107 Some useful <ulink url="../../saxo/browser/trunk/SRC/Documentation/xmldoc/tiplink.html?format=raw">Tips and links</ulink> 
     110<application>IDLdoc</application> documentations set is available using  
     111<ulink url="../../saxo/browser/trunk/SRC/Documentation/idldoc_html_output/index.html?format=raw">SRC/Documentation/idldoc_html_output/index.html</ulink>. 
     112</para> 
     113<para> 
     114Some useful <ulink url="../../saxo/browser/trunk/SRC/Documentation/xmldoc/tiplink.html?format=raw">Tips and links</ulink>. 
    108115</para> 
    109116</sect1> 

  • trunk/SRC/Documentation/xmldoc/savesaxo.sh

    r88 r89  
    11#!/bin/bash 
     2# fplod 2006-06-07T08:14:15Z aedon.locean-ipsl.upmc.fr (Darwin) 
     3# add action for idldochtml 
    24# fplod 2006-06-02T14:28:30Z aedon.locean-ipsl.upmc.fr (Darwin) 
    35# modification to produce tar files in /tmp/saxo_${$} when dotar=1 
    … …  
    1012dohtml=0 
    1113dooldtest=0 
    12 doidldoc_html=0 
     14doidldoc_html=1 
    1315doidldoc_assistant=0 
    1416doidlwavedoc=0 
    15 doTARsrc=1 
     17doTARsrc=0 
    1618doTARdata=0 
    1719doforge=1 
    … …  
    6466then 
    6567# 
    66     echo "eee : pas encore ecrit" 
     68    # build a idl file to launch idldoc 
     69    cat <<EOF > idldoc_html_${$}.pro 
     70!path = expand_path('+' + '../idldoc/') 
     71print,!path 
     72idldoc,root="../../",LOG_FILE="/tmp/idldochtlm_${$}.log", $ 
     73output="../idldoc_html_output" 
     74exit 
     75EOF 
     76    # launch idl with the file built above 
     77    IDL_STARTUP=idldoc_html_${$}.pro;idl 
     78    /bin/rm idldoc_html_${$}.pro 
     79    # In order to do not have to many revision in svn, we modify some 
     80    # lines produced by idldoc : 
     81    # examples : 
     82    # <!-- Generated by IDLdoc 2.0 on Wed Jun  7 10:25:28 2006 --> 
     83    # will be replaced by 
     84    # <!-- Generated by IDLdoc 2.0 --> 
     85    # <div id="tagline">Produced by IDLdoc 2.0 on Wed Jun  7 10:54:37 2006.</div 
     86    # will be replaced by 
     87    # <div id="tagline">Produced by IDLdoc 2.0</div> 
     88    # <h2>Produced on Wed Jun  7 10:23:13 2006</h2> 
     89    # will be delete  
     90    # other lines will be deleted because the time is the time of checkout not  
     91    # the time of revision. 
     92    # the sequence of lines 
     93    #<dl> 
     94    #      <dt>Last modification:</dt> 
     95    #       <dd>Fri Jun  2 11:46:24 2006</dd> 
     96    #    </dl> 
     97    # should also be removed ++ je ne sais pas dire en sed la ligne 
     98    # suivant l'occurence de Last modification 
     99    # add ?format=rawx to links on html files 
     100    list_html=$(find ../idldoc_html_output/ -name "*.html") 
     101    for file_html in ${list_html} 
     102    do 
     103     sed \ 
     104     -e "s/\(Generated by IDLdoc 2.0\)\( on .*\)\( -->\)/\1\3/" \ 
     105     -e "s/\(Produced by IDLdoc 2.0\)\( on .*\)\(\.<\/div>\)/\1\3/" \ 
     106     -e "/<h2>Produced on/d" \ 
     107     -e "/Last modification:/d" \ 
     108     -e "/<dd>... ... .* ..:..:.. ....<\/dd>/d" \ 
     109     -e 's/\(href=".*\)\(\.html\)\("\)/\1\2?format=raw\3/' \ 
     110     -e 's/\(href=".*\)\(\.html\)\(#.*"\)/\1\2?format=raw\3/' \ 
     111     ${file_html} > ${file_html}_modify 
     112     mv ${file_html}_modify ${file_html} 
     113    done 
     114    echo "iii : you can see log file in /tmp/idldochtlm_${$}.log" 
     115    echo "iii : and look ../idldoc_html_output/idldoc-warnings.html#undoc" 
    67116    exit 1 
    68117fi 
    … …  
    87136# 
    88137#   informations 
    89     echo "iii : following file may be copied on http://forge.ipsl.jussieu.fr/saxo/download/"  
     138    echo "iii : following file may be copied on http://forge.ipsl.jussieu.fr/saxo/download/" 
    90139    ls -l ${localtarbase} 
    91140fi 
    … …  
    102151# 
    103152#   informations 
    104     echo "iii : following file may be copied on http://forge.ipsl.jussieu.fr/saxo/download/"  
     153    echo "iii : following file may be copied on http://forge.ipsl.jussieu.fr/saxo/download/" 
    105154    ls -l ${localtarbase} 
    106155fi 
    … …  
    111160    if [ ${doTARsrc} -ne 1 ] 
    112161    then 
    113        localtarbase=${1}  
     162       localtarbase=${1} 
    114163    fi 
    115164    scp ${localtarbase}/SAXO_*.tar.gz saxo@forge.ipsl.jussieu.fr:/ipsl/forge/projets/saxo/download/ 
    … …  
    197246# 
    198247[ -f job_src_$$ ] && rm -f job_src_$$ 
    199 [ -f job_data_$$ ] && rm -f  
    200 # 
    201 exit 
    202 # 
     248[ -f job_data_$$ ] && rm -f 
     249# 
     250exit 
     251# 
Note: See TracChangeset for help on using the changeset viewer.