Changeset 111 for trunk/SRC/Documentation/xmldoc

Timestamp:

06/19/06 11:48:58 (18 years ago)

Author:

pinsard

Message:

modification of savesaxo.sh to add ?format=raw as often needed in one line, and suppress .html in idldoc-index*.html (known bug of idldoc)

Location:

trunk/SRC/Documentation/xmldoc

Files:

• savesaxo.sh (modified) (6 diffs)
• whatsnew.html (modified) (2 diffs)
• whatsnew.xml (modified) (1 diff)

trunk/SRC/Documentation/xmldoc/savesaxo.sh

@@ -1 +1 @@
 #!/bin/bash
+# 
+# fplod 2006-06-19T08:46:39Z aedon.locean-ipsl.upmc.fr (Darwin)
+# for idldoc html output 
+#. replace
+#     -e 's/\(href=".*\)\(\.html\)\("\)/\1\2?format=raw\3/g' \
+#     -e 's/\(href=".*\)\(\.html\)\(#.*"\)/\1\2?format=raw\3/g' \
+#     -e 's/\(src=".*\)\(\.htmal\)\("\)/\1\2?format=raw\3/g' \
+# by 
+# -e 's@\(href="[^.]*[^h]*[^t]*[^m]*[^l]*[^"]*\)\(\.html\)\("\)@\1\2?format=raw\3@g' \
+# -e 's@\(href="[^.]*[^h]*[^t]*[^m]*[^l]*[^"]*\)\(\.html\)\(#.*"\)@\1\2?format=raw\3@g' \
+#-e 's@\(src="[^.]*[^h]*[^t]*[^m]*[^l]*[^"]*\)\(\.html\)\("\)@\1\2?format=raw\3@g'
+# in order to be able to add ?format=raw several time on one line
+# . suppress .html in line like 
+# a parameter from the routine ./ReadWrite/idl-NetCDF/ncdf_read.html
+# in files idldoc-index*.html
 # fplod 2006-06-14T12:41:37Z aedon.locean-ipsl.upmc.fr (Darwin)
-# add embed parmater idldoc instructions to try to fix ticket#17
+# add embed paramater idldoc instructions to try to fix ticket#17
 # fplod 2006-06-07T12:11:50Z aedon.locean-ipsl.upmc.fr (Darwin)
 # add g option in ?format=raw sed transformation in order to fix 
@@ -17 +32 @@
 set -u
 #
-docompileall=0
+docompileall=1
 dohtml=0
 dooldtest=0
@@ -23 +38 @@
 doidldoc_html=0
 doidldoc_assistant=0
-doTARsrc=1
+doTARsrc=0
 doTARdata=0
-doforge=1
+doforge=0
 doSRClodyc=0
 doDTAlodyc=0
@@ -140 +155 @@
 #
     # build a idl file to launch idldoc
-    cat <<EOF > /tmp/idldoc_html_${$}.pro
+    output=../idldoc_html_output/
+    log="/tmp/idldochtlm_${$}.log"
+    pro="/tmp/idldochtlm_${$}.pro"
+    cat <<EOF > ${pro}
 !path = expand_path('+' + '../idldoc/')
 print,!path
-idldoc,root="../../",title="SAXO Documentation",LOG_FILE="/tmp/idldochtlm_${$}.log", $
-output="../idldoc_html_output",/preformat,/embed
+idldoc,root="../../",title="SAXO Documentation", $
+LOG_FILE="${log}", $
+output="${output}", /preformat, /embed
 exit
 EOF
     # launch idl with the file built above
-    IDL_STARTUP=/tmp/idldoc_html_${$}.pro;idl
-    /bin/rm /tmp/idldoc_html_${$}.pro
+    IDL_STARTUP=${pro};idl
+    /bin/rm ${pro}
     # In order to do not have to many revision in svn, we modify some
     # lines produced by idldoc :
@@ -170 +189 @@
     # should also be removed ++ je ne sais pas dire en sed la ligne
     # suivant l'occurence de Last modification
-    # add ?format=rawx to links on html files
-    list_html=$(find ../idldoc_html_output/ -name "*.html")
+    # add ?format=raw to links on html files
+    list_html=$(find ${output} -name "*.html")
     for file_html in ${list_html}
     do
@@ -180 +199 @@
      -e "/Last modification:/d" \
      -e "/<dd>... ... .* ..:..:.. ....<\/dd>/d" \
-     -e 's/\(href=".*\)\(\.html\)\("\)/\1\2?format=raw\3/g' \
-     -e 's/\(href=".*\)\(\.html\)\(#.*"\)/\1\2?format=raw\3/g' \
-     -e 's/\(src=".*\)\(\.html\)\("\)/\1\2?format=raw\3/g' \
+     -e 's@\(href="[^.]*[^h]*[^t]*[^m]*[^l]*[^"]*\)\(\.html\)\("\)@\1\2?format=raw\3@g' \
+     -e 's@\(href="[^.]*[^h]*[^t]*[^m]*[^l]*[^"]*\)\(\.html\)\(#.*"\)@\1\2?format=raw\3@g' \
+     -e 's@\(src="[^.]*[^h]*[^t]*[^m]*[^l]*[^"]*\)\(\.html\)\("\)@\1\2?format=raw\3@g' \
      ${file_html} > ${file_html}_modify
      mv ${file_html}_modify ${file_html}
     done
-    echo "iii : you can see log file in /tmp/idldochtlm_${$}.log"
-    echo "iii : and look ../idldoc_html_output/idldoc-warnings.html#undoc"
+    # suppress ".html" in idldoc-index*.html in lines like
+    # a parameter from the routine ./ReadWrite/idl-NetCDF/ncdf_read.html
+    list_html=$(find ${output} -name "idldoc-index*.html")
+    for file_html in ${list_html}
+    do
+     sed \
+     -e "s/\(a parameter from the routine \)\(.*\)\(.html\)/\1\2/" \
+     ${file_html} > ${file_html}_modify
+     mv ${file_html}_modify ${file_html}
+    done
+    echo "iii : you can see log file in ${log}"
+    echo "iii : and look ${output}/idldoc-warnings.html#undoc"
     exit 1
 fi

trunk/SRC/Documentation/xmldoc/whatsnew.html

@@ -1 +1 @@
 <html><head>
       <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-   <title>What's new in 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>What's new in 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">May 2006</td></tr><tr><td align="left" colspan="2">First draft</td></tr><tr><td align="left">Revision 0.1</td><td align="left">June 2006</td></tr><tr><td align="left" colspan="2">add date according to output of <span><strong class="command">svn</strong></span> log</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="#d0e48">1. Introduction</a></span></dt><dt><span class="sect1"><a href="#d0e55">2. Changeset 73 (2006-05-22)</a></span></dt><dt><span class="sect1"><a href="#d0e71">3. Changeset 69 (2006-05-11)</a></span></dt><dt><span class="sect1"><a href="#d0e81">4. Changeset 68 (2006-05-09)</a></span></dt><dt><span class="sect1"><a href="#d0e96">5. Changeset 7 (2006-04-24)</a></span></dt><dt><span class="sect1"><a href="#d0e106">6. Changeset 2 (revision date=2002-09-11 actually done 2006-04-13)</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e48"></a>1.&nbsp;Introduction</h2></div></div></div><p>
+   <title>What's new in 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>What's new in 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">May 2006</td></tr><tr><td align="left" colspan="2">First draft</td></tr><tr><td align="left">Revision 0.1</td><td align="left">June 2006</td></tr><tr><td align="left" colspan="2">add date according to output of svn log</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="#d0e45">1. Introduction</a></span></dt><dt><span class="sect1"><a href="#d0e52">2. Changeset 73 (2006-05-22)</a></span></dt><dt><span class="sect1"><a href="#d0e68">3. Changeset 69 (2006-05-11)</a></span></dt><dt><span class="sect1"><a href="#d0e78">4. Changeset 68 (2006-05-09)</a></span></dt><dt><span class="sect1"><a href="#d0e93">5. Changeset 7 (2006-04-24)</a></span></dt><dt><span class="sect1"><a href="#d0e103">6. Changeset 2 (revision date=2002-09-11 actually done 2006-04-13)</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e45"></a>1.&nbsp;Introduction</h2></div></div></div><p>
 Here are listed major revisions.
 </p><p>
 SAXO team should provide instructions to prevent from side effects of upgrade.
-</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e55"></a>2.&nbsp;Changeset 73 (2006-05-22)</h2></div></div></div><p>
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e52"></a>2.&nbsp;Changeset 73 (2006-05-22)</h2></div></div></div><p>
 This revision is the last one made to split svn repository in two parts : SRC and DATA.
 </p><p>
 Details can be seen in <a href="http://forge.ipsl.jussieu.fr/saxo/changeset/71" target="_top">Changeset 71</a>, <a href="http://forge.ipsl.jussieu.fr/saxo/changeset/72" target="_top">Changeset 72</a> and <a href="http://forge.ipsl.jussieu.fr/saxo/changset/73" target="_top">Changeset 73</a>.
-</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e71"></a>3.&nbsp;Changeset 69 (2006-05-11)</h2></div></div></div><p>
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e68"></a>3.&nbsp;Changeset 69 (2006-05-11)</h2></div></div></div><p>
 This revision includes new XXX features.
 </p><p>
 Details can be seen in <a href="http://forge.ipsl.jussieu.fr/saxo/changeset/69" target="_top">Changeset 69</a>.
-</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e81"></a>4.&nbsp;Changeset 68 (2006-05-09)</h2></div></div></div><p>
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e78"></a>4.&nbsp;Changeset 68 (2006-05-09)</h2></div></div></div><p>
 This revision is equivalent to SAXO_RD 20060124.
 </p><p>
@@ -19 +19 @@
 </p><p>
 Details can be seen in <a href="http://forge.ipsl.jussieu.fr/saxo/changeset/68" target="_top">Changeset 68</a>.
-</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e96"></a>5.&nbsp;Changeset 7 (2006-04-24)</h2></div></div></div><p>
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e93"></a>5.&nbsp;Changeset 7 (2006-04-24)</h2></div></div></div><p>
 This revision is equivalent to IDL_RD.
 </p><p>
 Details can be seen in <a href="http://forge.ipsl.jussieu.fr/saxo/changeset/7" target="_top">Changeset 7</a>.
-</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e106"></a>6.&nbsp;Changeset 2 (revision date=2002-09-11 actually done 2006-04-13)</h2></div></div></div><p>
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e103"></a>6.&nbsp;Changeset 2 (revision date=2002-09-11 actually done 2006-04-13)</h2></div></div></div><p>
 This revision is equivalent to <span class="bold"><strong>obsolete</strong></span> CVS repository.
 </p><p>

trunk/SRC/Documentation/xmldoc/whatsnew.xml

@@ -23 +23 @@
         <revnumber>0.1</revnumber>
         <date>June 2006</date>
-        <revremark>add date according to output of <command>svn</command> log</revremark>
+        <revremark>add date according to output of svn log</revremark>
       </revision>
     </revhistory>