Changeset 163 for trunk/SRC/Documentation/xmldoc/savesaxo.sh

Timestamp:

08/29/06 14:59:46 (18 years ago)

Author:

navarro

Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:

• trunk/SRC/Documentation/xmldoc/savesaxo.sh (modified) (6 diffs)

trunk/SRC/Documentation/xmldoc/savesaxo.sh

@@ -3 +3 @@
 # update :
 # $Id$
+# snlod/fplod 2006-08-25T08:30:36Z electre.locean-ipsl.upmc.fr (Darwin)
+# add for idldoc assistant
 # fplod 2006-08-17T09:19:06Z aedon.locean-ipsl.upmc.fr (Darwin)
 # add transformation after idldoc to force non-proportionnal font
 # on bloc delimited by
-# ; <fixe>
-# ; </fixe>
+#  <fixe>
+#  </fixe>
 # in .pro files (with modification of css)
 # !! do not replace \ by \\ inside this block
@@ -56 +58 @@
 set -u
 #
-docompileall=1
+docompileall=0
 dohtml=0
 dooldtest=0
 doidlwavedoc=0
-doidldoc_html=0
-doidldoc_assistant=0
+doidldoc_html=1
+doidldoc_assistant=1
 doTARsrc=0
 doTARdata=0
@@ -198 +200 @@
 idldoc,root="../../",title="SAXO Documentation", $
 LOG_FILE="${log}", $
-output="${output}", /preformat, /embed
+output="${output}", $
+overview="../../overview", /statistics, /preformat, /embed
 exit
 EOF
@@ -244 +247 @@
      -e 's@<div class="value">@<div class="preformat">@' \
      -e 's/div\#file_comments {/div\#file_comments { white-space: pre;/' \
-     -e 's@^; <fixe>@<p class="preformat">@' \
-     -e 's@^; </fixe>@</p>@' \
+     -e 's@^ <fixe>@<p class="preformat">@' \
+     -e 's@^ </fixe>@</p>@' \
      -e '/Main styles/r /tmp/css_modification' \
      ${file_html} > ${file_html}_modify
@@ -263 +266 @@
     echo "iii : you can see log file in ${log}"
     echo "iii : and look ${output}/idldoc-warnings.html#undoc"
-    exit 1
 fi
 #------------------------------------------------------------------
@@ -269 +271 @@
 then
 #
-    echo "eee : pas encore ecrit"
-    exit 1
+    # build a idl file to launch idldoc
+    output=../idldoc_assistant_output/
+    log="/tmp/idldocassistant_${$}.log"
+    pro="/tmp/idldocassistant_${$}.pro"
+    cat <<EOF > ${pro}
+!path = expand_path('+' + '../idldoc/')
+print,!path
+idldoc,root="../../",title="SAXO Documentation Assistant", $
+LOG_FILE="${log}", $
+output="${output}", overview='../../overview', /statistics, /preformat, /embed, /assistant
+exit
+EOF
+    # launch idl with the file built above
+    IDL_STARTUP=${pro};${IDL_DIR}/bin/idl
+    /bin/rm ${pro}
+    # In order to do not have to many revision in svn, we modify some
+    # lines produced by idldoc :
+    # examples :
+    # <!-- Generated by IDLdoc 2.0 on Wed Jun  7 10:25:28 2006 -->
+    # will be replaced by
+    # <!-- Generated by IDLdoc 2.0 -->
+    # <div id="tagline">Produced by IDLdoc 2.0 on Wed Jun  7 10:54:37 2006.</div
+    # will be replaced by
+    # <div id="tagline">Produced by IDLdoc 2.0</div>
+    # <h2>Produced on Wed Jun  7 10:23:13 2006</h2>
+    # will be delete 
+    # other lines will be deleted because the time is the time of checkout not 
+    # the time of revision.
+    # the sequence of lines
+    #<dl>
+    #      <dt>Last modification:</dt>
+    #       <dd>Fri Jun  2 11:46:24 2006</dd>
+    #    </dl>
+    # should also be removed ++ je ne sais pas dire en sed la ligne
+    # suivant l'occurence de Last modification
+    # replace *_param_* in href attributes because anchors are badly written
+    # with _keyword_
+    #++ -e 's@\(href="#_.*\)\(_param_\)\(.*"\)@\1_keyword_\3@g' \ # ++ pb global
+    # DON'T add here (in assistant idldoc output) ?format=raw to link because
+    #  ONLINE_HELP, book="../idldoc_assistant_output/idldoc-lib.adp", /full_path    # won't work
+    list_html=$(find ${output} -name "*.html")
+    for file_html in ${list_html}
+    do
+     sed \
+     -e "s/\(Generated by IDLdoc 2.0\)\( on .*\)\( -->\)/\1\3/" \
+     -e "s/\(Produced by IDLdoc 2.0\)\( on .*\)\(\.<\/div>\)/\1\3/" \
+     -e "/<h2>Produced on/d" \
+     -e "/Last modification:/d" \
+     -e "/<dd>... ... .* ..:..:.. ....<\/dd>/d" \
+     -e '/href/s@_param_@_keyword_@g' \
+     -e 's@<div class="value">@<div class="preformat">@' \
+     -e 's/div\#file_comments {/div\#file_comments { white-space: pre;/' \
+     -e 's@^ <fixe>@<pre style="font-family: Courier;">@' \
+     -e 's@^ </fixe>@</pre>@' \
+     ${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"
 fi
 #------------------------------------------------------------------