Changeset 420 for trunk/SRC

Timestamp:

01/25/10 12:47:34 (14 years ago)

Author:

pinsard

Message:

documentations tools improvements

Location:

trunk/SRC/Documentation/xmldoc

Files:

• docompileall.sh (modified) (1 diff)
• doidldoc.sh (modified) (13 diffs)
• pro2href.sh (modified) (1 diff)
• savesaxo.sh (modified) (2 diffs)

trunk/SRC/Documentation/xmldoc/docompileall.sh

@@ -55 +55 @@
 #
 #
-# For POST_IT in working space /usr/home/fplod/incas/post_it/post_it_ws/
+# For POST_IT in working space /usr/lodyc/incas/fplod/post_it_ws/
 # with IDL 6.4
 #
 # ::
 #
-# $ ${SAXO_DIR}/SRC/Documentation/xmldoc/docompileall.sh -i /usr/home/fplod/incas/post_it/post_it_ws/ -idl_dir /usr/local_linux/idl/idl_6.4/idl/
-#
-# For POST_IT in working space /usr/home/fplod/incas/post_it/post_it_ws/
+# $ ${SAXO_DIR}/SRC/Documentation/xmldoc/docompileall.sh -i /usr/lodyc/incas/fplod/post_it_ws/ -idl_dir /usr/local_linux/idl/idl_6.4/idl/
+#
+# For POST_IT in working space /usr/lodyc/incas/fplod/post_it_ws/
 # with IDL 7.0
 #
 # ::
 #
-# $ ${SAXO_DIR}/SRC/Documentation/xmldoc/docompileall.sh -i /usr/home/fplod/incas/post_it/post_it_ws/ -idl_dir /usr/local_linux/idl/idl70/
+# $ ${SAXO_DIR}/SRC/Documentation/xmldoc/docompileall.sh -i /usr/lodyc/incas/fplod/post_it_ws/ -idl_dir /usr/local_linux/idl/idl70/
 #
 # TODO

trunk/SRC/Documentation/xmldoc/doidldoc.sh

@@ -10 +10 @@
 # ========
 #
-# ``doidldoc.sh -i indir -t title -o outdir -idl_dir idl_dir -idldoc_version idldoc_version -idldoc_dir idldoc_dir``
+# ``doidldoc.sh -i indir -t title -o outdir -idl_dir idl_dir -idldoc_version idldoc_version -idldoc_dir idldoc_dir -e element -r refhtlm``
 #
 # DESCRIPTION
@@ -23 +23 @@
 # -idldoc_version idldoc_version
 # -idldoc_dir idldoc_dir
-#
-# Two pass : first *classic* idldoc then some home made transformation to avoid
-# for example version of idldoc on each HTML files.
+# -e element
+# -r refhtml
+#
+# Two passes : first *classic* idldoc then some home made transformation 
+# to avoid for example version of idldoc on each HTML files.
 #
 # The first pass produce files in /tmp/idldoc_output_${$}/ directory.
 #
 # At the end the result is in ``outdir``.
-#
 #
 # By default, embedded ``idldoc`` 2.0 in SAXO is used.
@@ -39 +40 @@
 # Be warned that assitant help is only available with ``idldoc 2.0``.
 #
+# Must be run two times to resolve internal links.
+#
 # CAUTIONS
 # ========
@@ -51 +54 @@
 # directory and set SAXO_DIR to the working space.
 #
-# example for me : SAXO_DIR=${HOME}/SAXO_DIR_ws/
+# example for me : SAXO_DIR=/usr/lodyc/incas/fplod/SAXO_DIR_ws/
 #
 # EXAMPLES
@@ -61 +64 @@
 # ::
 #
-# $ cd SAXO_DIR_ws/SRC/Documentation/xmldoc/
-# $ ${SAXO_DIR}/SRC/Documentation/xmldoc/doidldoc.sh -i ../.. -t "SAXO Documentation" -o ./idldoc_html_output/ -idl_dir /usr/local_linux/idl/idl_6.4/idl/
+# $ cd ${SAXO_DIR}/SRC/Documentation/xmldoc/
+# $ ${SAXO_DIR}/SRC/Documentation/xmldoc/doidldoc.sh -i ../.. -t "SAXO Documentation" -o ../idldoc_html_output/ -idl_dir /usr/local_linux/idl/idl_6.4/idl/ -e pro -r ../idldoc_html_output/ -e proidl -r /usr/local_linux/idl/idl_6.4/idl/help/online_help
+#
 #
 # To produce GEOMAG HTML outputs :
@@ -68 +72 @@
 #
 # $ cd /usr/home/fplod/incas/geomag/geomag_ws/
-# $ ${SAXO_DIR}/SRC/Documentation/xmldoc/doidldoc.sh -i . -t "GEOMAG Documentation" -o /usr/work/incas/${LOGNAME}/geomag/idldoc_html_output/ -idl_dir /usr/local_linux/idl/idl_6.4/idl/
+# $ ${SAXO_DIR}/SRC/Documentation/xmldoc/doidldoc.sh -i . -t "GEOMAG Documentation" -o /usr/work/incas/${LOGNAME}/geomag/idldoc_html_output/ -idl_dir /usr/local_linux/idl/idl_6.4/idl/ -e pro -r ../idldoc_html_output/ -e proidl -r /usr/local_linux/idl/idl_6.4/idl/help/online_help -e progeomag -r /usr/work/incas/${LOGNAME}/idldoc_html_output/
+
 #
 # To produce VARAMMA HTML outputs :
@@ -74 +79 @@
 #
 # $ cd /usr/home/fplod/incas/varamma/varamma_ws/
-# $ ${SAXO_DIR}/SRC/Documentation/xmldoc/doidldoc.sh -i . -t "VARAMMA Documentation" -o /tmp/idldoc_html_output/ -idl_dir /usr/local_linux/idl/idl_6.4/idl/
+# $ ${SAXO_DIR}/SRC/Documentation/xmldoc/doidldoc.sh -i . -t "VARAMMA Documentation" -o /tmp/idldoc_html_output/ -idl_dir /usr/local_linux/idl/idl_6.4/idl/ -e pro -r ../idldoc_html_output/ -e proidl -r /usr/local_linux/idl/idl_6.4/idl/help/online_help
 #
 # To produce POST_IT HTML outputs :
 # ::
 #
-# $ cd /usr/home/fplod/incas/post_it/post_it_ws/
-# $ ${SAXO_DIR}/SRC/Documentation/xmldoc/doidldoc.sh -i . -t "POST_IT/Documentation" -o /usr/work/incas/${LOGNAME}/idldoc_html_output/ -idl_dir /usr/local_linux/idl/idl_6.4/idl/
-#
-
+# $ cd /usr/lodyc/incas/fplod/post_it_ws/
+# $ ${SAXO_DIR}/SRC/Documentation/xmldoc/doidldoc.sh -i . -t "POST_IT/Documentation" -o /usr/work/incas/${LOGNAME}/idldoc_html_output/ -idl_dir /usr/local_linux/idl/idl_6.4/idl/ -e pro -r ${SAXO_DIR}/SRC/Documentation/idldoc_html_output/ -e proidl -r /usr/local_linux/idl/idl_6.4/idl/help/online_help -e propost_it -r /usr/work/incas/${LOGNAME}/idldoc_html_output/
+#
 # TODO
 # ====
@@ -91 +95 @@
 # doc idl
 #
+# add checking of consistency between numbers of -e and -r parameters
+#
 # SEE ALSO
 # ========
@@ -96 +102 @@
 # idldoc++ lien
 #
+# pro2href.sh
+#
 # EVOLUTIONS
 # ==========
 #
 # $Id$
+#
+# - fplod 20100125T105849Z aedon.locean-ipsl.upmc.fr (Darwin)
+#
+#   * add -e and -r parameters to replace hardcoded element and reference
+#     of links
 #
 # - fplod 20091112T101526Z zeus.locean-ipsl.upmc.fr (Linux)
@@ -206 +219 @@
 #idldoc_dir="/usr/home/fplod/src/idldoc-3.1.1/" # overriding idldoc_dir for test ++
 #
+ielement=1
+#
 minargcount=6
 if [ ${#} -lt ${minargcount} ]
@@ -245 +260 @@
  idl_dir=${2}
  shift
+ ;;
+ -e)
+ element[${ielement}]=${2}
+ shift
+ ;;
+ -r)
+ refhtml[${ielement}]=${2}
+ shift
+ ielement=$(( ${ielement} + 1))
  ;;
  -h)
@@ -376 +400 @@
  sed \
  -e "s/\(Generated by IDLdoc\)\( .* on .*\)\( -->\)/\1\3/" \
- -e "s/\(Produced by IDLdoc\)\( .* on .*\)\(<\/td>\)/\1\3/" \
+ -e "s/\(Produced by IDLdoc\)\( .* on .*\)\(<\/div>\)/\1\3/" \
  -e "/<h2>Produced on/d" \
  -e "/Modifcation:/d" \
@@ -398 +422 @@
  mv ${file_html}_modify ${file_html}
 done
-# replace <pro>ginette</pro> by a sequence like
-# <a href="./ginette.html">ginette</a>
-${SAXO_DIR}/SRC/Documentation/xmldoc/pro2href.sh -i ${outputtmp} -r ${outputtmp} -e pro
-status=${?}
-if [ ${status} -ne 0 ]
-then
- echo "eee : pb during pro2href.sh for <pro>...</pro>"
- exit 1
-fi
-# replace <proidl>ginette</proidl> by a sequence like
-# <a href="./ginette.html">ginette</a>
-${SAXO_DIR}/SRC/Documentation/xmldoc/pro2href.sh -i ${outputtmp} -r ${idl_dir}/help/online_help -e proidl
-status=${?}
-if [ ${status} -ne 0 ]
-then
- echo "eee : pb during pro2href.sh for <proidl>...</proidl>"
- exit 1
-fi
+nelement=${#element[@]}
+ielement=1
+while [ ${ielement} -le ${nelement} ]
+do 
+ # replace <element>ginette</element> by a sequence like
+ # <a href="./ginette.html">ginette</a>
+ ${SAXO_DIR}/SRC/Documentation/xmldoc/pro2href.sh -i ${outputtmp} \
+  -r ${refhtml[${ielement}]} \
+  -e ${element[${ielement}]} 
+ status=${?}
+ if [ ${status} -ne 0 ]
+ then
+  echo "eee : pb during pro2href.sh for ${element}...</${element}>"
+  exit 1
+ fi
+ ielement=$(( ${ielement} + 1))
+done
 fi # end of transform = 1
 #

trunk/SRC/Documentation/xmldoc/pro2href.sh

@@ -106 +106 @@
    for file_html in ${list_html_element}
    do
-#      echo "file_html ${file_html}"
-#      read a
+      #echo "file_html ${file_html}"
+      #read a
        fpath=$(dirname ${file_html} | sed -e "s+\(${dirhtml}/\)\(.*\)+\2+")
 #echo "fpath ${fpath}"

trunk/SRC/Documentation/xmldoc/savesaxo.sh

@@ -11 +11 @@
 #
 # $Id$
+#
+# 
+# - fplod 20100125T112917Z aedon.locean-ipsl.upmc.fr (Darwin)
+#   
+#   * complete doidldoc.sh calling sequence
 #
 # - fplod 20091112T101551Z zeus.locean-ipsl.upmc.fr (Linux)
@@ -280 +285 @@
     -o ../idldoc_html_output/ 
     -idl_dir ${idl_dir}
+    -e pro -r ../idldoc_html_output/ \
+    -e proidl -r /usr/local_linux/idl/idl_6.4/idl/help/online_help
     doidldoc_html=${?}
     if [ ${doidldoc_html} -ne 0 ]