Changeset 186

Timestamp:

09/20/06 12:50:37 (18 years ago)

Author:

pinsard

Message:

introducing hyperlinks in idldoc outputs (1/2)

Location:

trunk/SRC

Files:

• Documentation/xmldoc/faqsaxo.xml (modified) (2 diffs)
• Documentation/xmldoc/savesaxo.sh (modified) (11 diffs)
• Interpolation/spl_fstdrv.pro (modified) (2 diffs)
• Picture/showimage.pro (modified) (2 diffs)
• Postscript/openps.pro (modified) (1 diff)
• ToBeReviewed/STRING/strtok.pro (modified) (2 diffs)
• ToBeReviewed/TRIANGULATION/definetri.pro (modified) (3 diffs)
• ToBeReviewed/TRIANGULATION/definetri_e.pro (modified) (2 diffs)
• ToBeReviewed/TRIANGULATION/section.pro (modified) (1 diff)
• ToBeReviewed/WIDGET/xxx.pro (modified) (1 diff)

trunk/SRC/Documentation/xmldoc/faqsaxo.xml

@@ -238 +238 @@
 <listitem>
 <para>
-<guimenu>Search</guimenu> does'nt handle characters like <literal>-</literal>
+<guimenu>Search</guimenu> doesn't handle characters like <literal>-</literal>
 and <literal>|</literal>.
 </para>
@@ -267 +267 @@
 </answer>
 </qandaentry>
+<qandaentry>
+<question>
+<para>
+How can I check spelling of xml files ?
+</para>
+</question>
+<answer>
+<para>
+There is one way with command line :
+     <screen format="linespecific">
+       <prompt>$</prompt> <userinput><command>aspell</command> <option>--mode=sgml</option> <option>-c</option> <parameter><filename><replaceable>xmlfile</replaceable></filename></parameter></userinput>
+     </screen>
+</para>
+</answer>
+</qandaentry>
+<qandaentry>
+<question>
+<para>
+How can I see online help update ?
+</para>
+</question>
+<answer>
+<para>
+You won't see  online help update if you are working with the official distribution because of <varname>!HELP_PATH</varname>. To override this problem, when you are in <filename class="directory"><replaceable>SAXO_basedirectory</replaceable>/SAXO_DIR/SRC/Documentation/xmldoc/</filename>,  you can call online help like this :
+     <screen format="linespecific">
+       <prompt>IDL</prompt> <userinput><command>ONLINE_HELP</command>,<option>book="../idldoc_assistant_output/idldoc-lib.adp"</option></userinput>
+     </screen>
+</para>
+</answer>
+</qandaentry>
 </qandadiv>
 </qandaset>

trunk/SRC/Documentation/xmldoc/savesaxo.sh

@@ -1 +1 @@
 #!/bin/bash
-# 
+#
 # update :
 # $Id$
@@ -33 +33 @@
 # ajout de  white-space: pre; dans la css pour file_comments
 # fplod 2006-07-04T13:09:19Z aedon.locean-ipsl.upmc.fr (Darwin)
-# for idldoc html output 
+# for idldoc html output
 # because preformat option doesn't seem to work well
-# replace 
+# replace
 # div class="value"
 # by
 # div class="preformat"
 # fplod 2006-06-19T08:46:39Z aedon.locean-ipsl.upmc.fr (Darwin)
-# for idldoc html output 
+# 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=".*\)\(\.html\)\("\)/\1\2?format=raw\3/g' \
-# by 
+# 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 
+# . suppress .html in line like
 # a parameter from the routine ./ReadWrite/idl-NetCDF/ncdf_read.html
 # in files idldoc-index*.html
@@ -56 +56 @@
 # add embed parameter 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 
+# add g option in ?format=raw sed transformation in order to fix
 # link on top of idldoc like directory-overview.html
 # fplod 2006-06-07T10:57:35Z aedon.locean-ipsl.upmc.fr (Darwin)
@@ -105 +105 @@
     doSRCidris=0
     doDTAidris=0
-fi    
+fi
 #
 # get the date in a nice format
@@ -118 +118 @@
     then
     cat <<EOF > /tmp/compileall${$}.pro
-.reset_session  
+.reset_session
 ;
 !path = expand_path('+' + '../..') + ':' + expand_path('+' + !dir)
@@ -131 +131 @@
 IF !journal NE 0 THEN journal
 journal, myuniquetmpdir + 'cm_demomode_used.pro'
-journal   
+journal
 ;
 resolve_all, resolve_either='keep_compatibility', skip_routines = ['xxx2ps','trends', 'label_gmt']
@@ -154 +154 @@
     grep -i "error" /tmp/compileallerr_${$}
 #    grep -q "Compilation error(s)" /tmp/compileallerr_${$}
-    if [ ${?} -ne 0 ] 
+    if [ ${?} -ne 0 ]
     then
      echo "ALL SAXO files are OK..."
@@ -174 +174 @@
 #
     cd ${memopwd}
-    for docxml in firststeps.xml getsaxo.xml mailing.xml websaxo.xml tiplink.xml updatesaxo.xml whatissaxo.xml whatsnew.xml infoupdatekwd.xml infoupdatecm.xml mini_notice.xml faqsaxo.xml 
+    for docxml in firststeps.xml getsaxo.xml mailing.xml websaxo.xml tiplink.xml updatesaxo.xml whatissaxo.xml whatsnew.xml infoupdatekwd.xml infoupdatecm.xml mini_notice.xml faqsaxo.xml
     do
       ./makehtml.sh $(basename ${docxml} .xml)
@@ -242 +242 @@
     # <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 
+    # 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
@@ -345 +345 @@
     # <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 
+    # 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
@@ -382 +382 @@
     do
       fout=../idldoc_assistant_output/${file_html#../idldoc_html_output/*}
-      fout=${fout%/*}/directory-overview.html 
+      fout=${fout%/*}/directory-overview.html
       sed -e 's/?format=raw//g' ${file_html} > ${fout}
     done

trunk/SRC/Interpolation/spl_fstdrv.pro

@@ -6 +6 @@
 ; @file_comments
 ; SPL_FSTDRV returns the values of the first derivative of
-; the interpolating function at the points X2i. it is a double
+; the interpolating function at the points X2i. It is a double
 ; precision array.
 ;
@@ -32 +32 @@
 ; The input values for which the first derivative values are desired.
 ; X can be scalar or an array of values.
-
+;
 ; @returns
-;
 ;    y2: f'(x2) = y2.
 ;

trunk/SRC/Picture/showimage.pro

@@ -11 +11 @@
 ;    JPEG 24-bit true color,
 ;
-;    Any conversions necessary to translate 8-bit or 24-bit files
-;    to 8-bit or 24-bit images on-screen are done automatically.
+; Any conversions necessary to translate 8-bit or 24-bit files
+; to 8-bit or 24-bit images on-screen are done automatically.
 ;
 ; @categories Input/Output.
@@ -33 +33 @@
 ; Requires IDL 5.2 or higher (image QUERY functions).
 ;
-; @examples $
+; @examples
 ; IDL> showimage, filepath('rose.jpg', subdir='examples/data')
 ;

trunk/SRC/Postscript/openps.pro

@@ -12 +12 @@
 ;
 ; @keyword FILENAME
-; to define the name of the postscript file through
-; a keyword rather than with nameps input argument
-; (in this case the keyword can be pass through
+; to define the name of the postscript file through a keyword rather than with 
+; nameps input argument (in this case the keyword can be pass through
 ; different routines via _EXTRA keyword).
 ;
 ; @keyword INFOWIDGET
-; If INFOWIDGET is present, it specifies a named
-; variable into which the id of the widget giving informations
-; about the postscript creation is stored as a long integer.
-; This id is needed by close ps to kill the information widget.
+; If INFOWIDGET is present, it specifies a named variable into which the id of 
+; the widget giving information about the postscript creation is stored as a 
+; long integer.
+; This id is needed by <a href="./closeps.html">closeps</a> to kill 
+; the information widget.
 ;
 ; @keyword KEEP_PFONT

trunk/SRC/ToBeReviewed/STRING/strtok.pro

@@ -9 +9 @@
 ;
 ; @param STRING {in}{required}
-; String to be split.  Contains text after    in, out
-; token on output.
+; String to be split. Contains text after in, out token on output.
 ; 
 ; @param TOKEN {in}{required}
@@ -16 +15 @@
 ;
 ; @keyword TRIM 
-; set to remove leading blanks from old 
-; before returning.
+; set to remove leading blanks from old before returning.
 ;
 ; @keyword HELP

trunk/SRC/ToBeReviewed/TRIANGULATION/definetri.pro

@@ -6 +6 @@
 ; the points are regulary-gridded on nx*ny array.
 ; Find a Delaunay triangulation for this set of points is easy:
-; Points define (nx-1)*(ny-1) rectangles which we can cut in 2
-; triangles. cf. figure above
+; Points define (nx-1)*(ny-1) rectangles which we can cut in 2 triangles. 
+; cf. figure above
 ;
 ; <fixe>
+; fixe
 ;      ny-1*---*---*. . . . . .*---*---*
 ;          |  +|  +|           |  +|  +|      
@@ -47 +48 @@
 ;
 ; @param DOWNWARD {in}{optional}
-; When downward is undefine all rectangles are cut
-; in using the upward diagonal. Downward is a vector which
-; contains the rectangles numbers which are cut in using the
-; downward diagonal.
-; The rectangle number is define by the index (in a nx*ny
-; vector) of the lower-left corner of the rectangle.
+; When downward is undefine all rectangles are cut in using the upward 
+; diagonal. 
+; Downward is a vector which contains the rectangles numbers which are cut in 
+; using the downward diagonal.
+; The rectangle number is defined by the index (in a nx*ny vector) of the 
+; lower-left corner of the rectangle.
 ;
 ; @returns
-; triangles is a 2d array and is dimensions are 3 and
-; 2*(nx-1)*(ny-1)
-; triangles is define like in the TRIANGULATE procedure.
+; triangles is a 2d array and its dimensions are 3 and 2*(nx-1)*(ny-1).
+; triangles is defined like in the TRIANGULATE procedure.
 ;
 ; @examples
 ;
-; triangles=definetri(3,3,[1,3])
-; triangles will be a this kind of triangulation:
+; IDL> triangles=definetri(3,3,[1,3])
+; triangles will be this kind of triangulation:
 ;
 ;          *---*---*
-;           |+  |  +|
-;           | + | + |
-;           |  +|+  |
+;          |+  |  +|
+;          | + | + |
+;          |  +|+  |
 ;          *---*---*
-;           |  +|+  |
-;           | + | + |
-;           |+  |  +|
+;          |  +|+  |
+;          | + | + |
+;          |+  |  +|
 ;          *---*---*
 ;
@@ -103 +103 @@
 ; we define upward: upward is a vector which contains the rectangles
 ; numbers which are cut in using the upward diagonal.
-; The rectangle number is define by the index (in a nx*ny vector) of
+; The rectangle number is defined by the index (in a nx*ny vector) of
 ; the lower-left corner of the rectangle.
       upward = bytarr(nx, ny)+1

trunk/SRC/ToBeReviewed/TRIANGULATION/definetri_e.pro

@@ -60 +60 @@
 ;
 ; @param SINGULAR {in}{optional}
-; When singular is undefined all rectangles are cut
-; in using the vertical diagonal. Singular is a vector which
-; contains the rectangles numbers which are cut in using the
-; horizontal diagonal.
-; The rectangle number is define by the index (in a nx*ny
-; vector) of the lower-left corner of the rectangle.
+; When singular is undefined all rectangles are cut in using the vertical 
+; diagonal. 
+; Singular is a vector which contains the rectangles numbers which are cut in 
+; using the horizontal diagonal.
+; The rectangle number is defined by the index (in a nx*ny vector) of the 
+; lower-left corner of the rectangle.
 ;
 ; @keyword SHIFTED
@@ -71 +71 @@
 ;
 ; @returns
-; Triangles is a 2d array and is dimensions are 3 and
-; (nx-1)*(ny-1)
+; Triangles is a 2d array and is dimensions are 3 and (nx-1)*(ny-1).
 ; Triangles is defined like in the TRIANGULATE procedure.
 ;        

trunk/SRC/ToBeReviewed/TRIANGULATION/section.pro

@@ -58 +58 @@
 ; 
 ; @version 
+; $Id$
 ; 
 ;-

trunk/SRC/ToBeReviewed/WIDGET/xxx.pro

@@ -1 +1 @@
 ;+
 ; @file_comments
-;
+; see <a href="../../../xmldoc/mini_notice.html">Mini Guide for Basic Commands in the XXX Program</a>
 ;
 ; @categories