Ignore:
Timestamp:
09/06/06 12:46:29 (18 years ago)
Author:
pinsard
Message:

Main document available on top directory, Source links available in idldoc html output

Location:
trunk/SRC/Documentation/xmldoc
Files:
3 edited

Legend:

Unmodified
Added
Removed

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

    r162 r168  
    5353<td align="left" colspan="2">First draft</td> 
    5454</tr> 
     55<tr> 
     56<td align="left">Revision 0.1</td> 
     57<td align="left">September 2006</td> 
     58</tr> 
     59<tr> 
     60<td align="left" colspan="2">+ onlinehelp</td> 
     61</tr> 
    5562</table> 
    5663</div> 
    … …  
    6471<dd> 
    6572<dl> 
    66 <dt>2.1. <a href="#d0e59">What is SAXO ?</a></dt> 
    67 <dt>2.2. <a href="#d0e69">How can I get help ?</a></dt> 
    68 <dt>2.3. <a href="#d0e79">How do I get SAXO ?</a></dt> 
    69 <dt>2.4. <a href="#d0e89">What is the current version of SAXO 
    70 ?</a></dt> 
    71 <dt>2.5. <a href="#d0e96">On what systems does SAXO run ?</a></dt> 
    72 <dt>2.6. <a href="#d0e103">Does SAXO works wih GDL instead of IDL 
    73 ?</a></dt> 
    74 <dt>2.7. <a href="#d0e112">When is the next version of SAXO due out 
    75 ?</a></dt> 
    76 <dt>2.8. <a href="#d0e119">How can I find if a routine to do what I 
     73<dt>2.1. <a href="#d0e66">What is SAXO ?</a></dt> 
     74<dt>2.2. <a href="#d0e76">How can I get help ?</a></dt> 
     75<dt>2.3. <a href="#d0e86">How do I get SAXO ?</a></dt> 
     76<dt>2.4. <a href="#d0e96">What is the current version of SAXO 
     77?</a></dt> 
     78<dt>2.5. <a href="#d0e103">On what systems does SAXO run ?</a></dt> 
     79<dt>2.6. <a href="#d0e110">Does SAXO works wih GDL instead of IDL 
     80?</a></dt> 
     81<dt>2.7. <a href="#d0e119">When is the next version of SAXO due out 
     82?</a></dt> 
     83<dt>2.8. <a href="#d0e126">How can I find if a routine to do what I 
    7784want already exists ?</a></dt> 
    78 <dt>2.9. <a href="#d0e126">How should SAXO be cited or acknowledged 
     85<dt>2.9. <a href="#d0e133">How should SAXO be cited or acknowledged 
    7986in publication ?</a></dt> 
    8087</dl> 
    … …  
    8390<dd> 
    8491<dl> 
    85 <dt>3.1. <a href="#d0e136">Is there on-line help for SAXO 
     92<dt>3.1. <a href="#d0e143">Is there on-line help for SAXO 
    8693?</a></dt> 
    8794</dl> 
    … …  
    9097<dd> 
    9198<dl> 
    92 <dt>4.1. <a href="#d0e146">Is there an SAXO Style Guide available 
    93 ?</a></dt> 
    94 <dt>4.2. <a href="#d0e187">Is there any trouble with IDLdoc 
     99<dt>4.1. <a href="#d0e174">Is there an SAXO Style Guide available 
     100?</a></dt> 
     101<dt>4.2. <a href="#d0e215">Is there any trouble with IDLdoc 
    95102?</a></dt> 
    96103</dl> 
    … …  
    128135<td align="left" valign="top" colspan="2"> 
    129136<dl> 
    130 <dt>2.1. <a href="#d0e59">What is SAXO ?</a></dt> 
    131 <dt>2.2. <a href="#d0e69">How can I get help ?</a></dt> 
    132 <dt>2.3. <a href="#d0e79">How do I get SAXO ?</a></dt> 
    133 <dt>2.4. <a href="#d0e89">What is the current version of SAXO 
    134 ?</a></dt> 
    135 <dt>2.5. <a href="#d0e96">On what systems does SAXO run ?</a></dt> 
    136 <dt>2.6. <a href="#d0e103">Does SAXO works wih GDL instead of IDL 
    137 ?</a></dt> 
    138 <dt>2.7. <a href="#d0e112">When is the next version of SAXO due out 
    139 ?</a></dt> 
    140 <dt>2.8. <a href="#d0e119">How can I find if a routine to do what I 
     137<dt>2.1. <a href="#d0e66">What is SAXO ?</a></dt> 
     138<dt>2.2. <a href="#d0e76">How can I get help ?</a></dt> 
     139<dt>2.3. <a href="#d0e86">How do I get SAXO ?</a></dt> 
     140<dt>2.4. <a href="#d0e96">What is the current version of SAXO 
     141?</a></dt> 
     142<dt>2.5. <a href="#d0e103">On what systems does SAXO run ?</a></dt> 
     143<dt>2.6. <a href="#d0e110">Does SAXO works wih GDL instead of IDL 
     144?</a></dt> 
     145<dt>2.7. <a href="#d0e119">When is the next version of SAXO due out 
     146?</a></dt> 
     147<dt>2.8. <a href="#d0e126">How can I find if a routine to do what I 
    141148want already exists ?</a></dt> 
    142 <dt>2.9. <a href="#d0e126">How should SAXO be cited or acknowledged 
     149<dt>2.9. <a href="#d0e133">How should SAXO be cited or acknowledged 
    143150in publication ?</a></dt> 
    144151</dl> 
    … …  
    146153</tr> 
    147154<tr class="question"> 
    148 <td align="left" valign="top"><a name="d0e59" id= 
    149 "d0e59"></a><a name="d0e60" id="d0e60"></a><b>2.1.</b></td> 
     155<td align="left" valign="top"><a name="d0e66" id= 
     156"d0e66"></a><a name="d0e67" id="d0e67"></a><b>2.1.</b></td> 
    150157<td align="left" valign="top"> 
    151158<p>What is SAXO ?</p> 
    … …  
    161168</tr> 
    162169<tr class="question"> 
    163 <td align="left" valign="top"><a name="d0e69" id= 
    164 "d0e69"></a><a name="d0e70" id="d0e70"></a><b>2.2.</b></td> 
     170<td align="left" valign="top"><a name="d0e76" id= 
     171"d0e76"></a><a name="d0e77" id="d0e77"></a><b>2.2.</b></td> 
    165172<td align="left" valign="top"> 
    166173<p>How can I get help ?</p> 
    … …  
    176183</tr> 
    177184<tr class="question"> 
    178 <td align="left" valign="top"><a name="d0e79" id= 
    179 "d0e79"></a><a name="d0e80" id="d0e80"></a><b>2.3.</b></td> 
     185<td align="left" valign="top"><a name="d0e86" id= 
     186"d0e86"></a><a name="d0e87" id="d0e87"></a><b>2.3.</b></td> 
    180187<td align="left" valign="top"> 
    181188<p>How do I get SAXO ?</p> 
    … …  
    191198</tr> 
    192199<tr class="question"> 
    193 <td align="left" valign="top"><a name="d0e89" id= 
    194 "d0e89"></a><a name="d0e90" id="d0e90"></a><b>2.4.</b></td> 
     200<td align="left" valign="top"><a name="d0e96" id= 
     201"d0e96"></a><a name="d0e97" id="d0e97"></a><b>2.4.</b></td> 
    195202<td align="left" valign="top"> 
    196203<p>What is the current version of SAXO ?</p> 
    … …  
    202209</tr> 
    203210<tr class="question"> 
    204 <td align="left" valign="top"><a name="d0e96" id= 
    205 "d0e96"></a><a name="d0e97" id="d0e97"></a><b>2.5.</b></td> 
     211<td align="left" valign="top"><a name="d0e103" id= 
     212"d0e103"></a><a name="d0e104" id="d0e104"></a><b>2.5.</b></td> 
    206213<td align="left" valign="top"> 
    207214<p>On what systems does SAXO run ?</p> 
    … …  
    213220</tr> 
    214221<tr class="question"> 
    215 <td align="left" valign="top"><a name="d0e103" id= 
    216 "d0e103"></a><a name="d0e104" id="d0e104"></a><b>2.6.</b></td> 
     222<td align="left" valign="top"><a name="d0e110" id= 
     223"d0e110"></a><a name="d0e111" id="d0e111"></a><b>2.6.</b></td> 
    217224<td align="left" valign="top"> 
    218225<p>Does SAXO works wih GDL instead of IDL ?</p> 
    … …  
    226233</tr> 
    227234<tr class="question"> 
    228 <td align="left" valign="top"><a name="d0e112" id= 
    229 "d0e112"></a><a name="d0e113" id="d0e113"></a><b>2.7.</b></td> 
     235<td align="left" valign="top"><a name="d0e119" id= 
     236"d0e119"></a><a name="d0e120" id="d0e120"></a><b>2.7.</b></td> 
    230237<td align="left" valign="top"> 
    231238<p>When is the next version of SAXO due out ?</p> 
    … …  
    237244</tr> 
    238245<tr class="question"> 
    239 <td align="left" valign="top"><a name="d0e119" id= 
    240 "d0e119"></a><a name="d0e120" id="d0e120"></a><b>2.8.</b></td> 
     246<td align="left" valign="top"><a name="d0e126" id= 
     247"d0e126"></a><a name="d0e127" id="d0e127"></a><b>2.8.</b></td> 
    241248<td align="left" valign="top"> 
    242249<p>How can I find if a routine to do what I want already exists 
    … …  
    249256</tr> 
    250257<tr class="question"> 
    251 <td align="left" valign="top"><a name="d0e126" id= 
    252 "d0e126"></a><a name="d0e127" id="d0e127"></a><b>2.9.</b></td> 
     258<td align="left" valign="top"><a name="d0e133" id= 
     259"d0e133"></a><a name="d0e134" id="d0e134"></a><b>2.9.</b></td> 
    253260<td align="left" valign="top"> 
    254261<p>How should SAXO be cited or acknowledged in publication ?</p> 
    … …  
    268275<td align="left" valign="top" colspan="2"> 
    269276<dl> 
    270 <dt>3.1. <a href="#d0e136">Is there on-line help for SAXO 
    271 ?</a></dt> 
    272 </dl> 
    273 </td> 
    274 </tr> 
    275 <tr class="question"> 
    276 <td align="left" valign="top"><a name="d0e136" id= 
    277 "d0e136"></a><a name="d0e137" id="d0e137"></a><b>3.1.</b></td> 
     277<dt>3.1. <a href="#d0e143">Is there on-line help for SAXO 
     278?</a></dt> 
     279</dl> 
     280</td> 
     281</tr> 
     282<tr class="question"> 
     283<td align="left" valign="top"><a name="d0e143" id= 
     284"d0e143"></a><a name="d0e144" id="d0e144"></a><b>3.1.</b></td> 
    278285<td align="left" valign="top"> 
    279286<p>Is there on-line help for SAXO ?</p> 
    … …  
    282289<tr class="answer"> 
    283290<td align="left" valign="top"></td> 
    284 <td align="left" valign="top"></td> 
     291<td align="left" valign="top"> 
     292<p>Yes. produced by <span class="application">IDLdoc</span>.</p> 
     293<p>You can access to this documentation set during your IDL session 
     294with this command :</p> 
     295<pre class="screen"> 
     296  <code class="prompt">IDL</code> <strong class= 
     297"userinput"><code><span><strong class= 
     298"command">ONLINE_HELP</strong></span>,<code class= 
     299"option">book="<em class= 
     300"replaceable"><code>SAXO_basedirectory</code></em>/SAXO_DIR/SRC/Documentation/idldoc_assistant_output/idldoc-lib.adp"</code></code></strong> 
     301</pre></td> 
    285302</tr> 
    286303<tr class="qandadiv"> 
    … …  
    293310<td align="left" valign="top" colspan="2"> 
    294311<dl> 
    295 <dt>4.1. <a href="#d0e146">Is there an SAXO Style Guide available 
    296 ?</a></dt> 
    297 <dt>4.2. <a href="#d0e187">Is there any trouble with IDLdoc 
    298 ?</a></dt> 
    299 </dl> 
    300 </td> 
    301 </tr> 
    302 <tr class="question"> 
    303 <td align="left" valign="top"><a name="d0e146" id= 
    304 "d0e146"></a><a name="d0e147" id="d0e147"></a><b>4.1.</b></td> 
     312<dt>4.1. <a href="#d0e174">Is there an SAXO Style Guide available 
     313?</a></dt> 
     314<dt>4.2. <a href="#d0e215">Is there any trouble with IDLdoc 
     315?</a></dt> 
     316</dl> 
     317</td> 
     318</tr> 
     319<tr class="question"> 
     320<td align="left" valign="top"><a name="d0e174" id= 
     321"d0e174"></a><a name="d0e175" id="d0e175"></a><b>4.1.</b></td> 
    305322<td align="left" valign="top"> 
    306323<p>Is there an SAXO Style Guide available ?</p> 
    … …  
    330347</tr> 
    331348<tr class="question"> 
    332 <td align="left" valign="top"><a name="d0e187" id= 
    333 "d0e187"></a><a name="d0e188" id="d0e188"></a><b>4.2.</b></td> 
     349<td align="left" valign="top"><a name="d0e215" id= 
     350"d0e215"></a><a name="d0e216" id="d0e216"></a><b>4.2.</b></td> 
    334351<td align="left" valign="top"> 
    335352<p>Is there any trouble with <span class= 

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

    r161 r168  
    3535        <revremark>First draft</revremark> 
    3636      </revision> 
     37      <revision> 
     38        <revnumber>0.1</revnumber> 
     39        <date>September 2006</date> 
     40        <revremark>+ onlinehelp</revremark> 
     41      </revision> 
    3742    </revhistory> 
    3843    <pubdate>$Id$</pubdate> 
    … …  
    170175<answer> 
    171176<para> 
     177Yes. produced by <application>IDLdoc</application>.  
     178</para> 
     179<para> 
     180You can access to this documentation set during your IDL session with this  
     181command : 
     182 <screen format="linespecific"> 
     183  <prompt>IDL</prompt> <userinput><command>ONLINE_HELP</command>,<option>book="<replaceable>SAXO_basedirectory</replaceable>/SAXO_DIR/SRC/Documentation/idldoc_assistant_output/idldoc-lib.adp"</option></userinput> 
     184</screen> 
    172185</para> 
    173186</answer> 

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

    r163 r168  
    33# update : 
    44# $Id$ 
     5# fplod 2006-09-05T15:39:47Z aedon.locean-ipsl.upmc.fr (Darwin) 
     6# add Source link in idldoc html outpout 
    57# snlod/fplod 2006-08-25T08:30:36Z electre.locean-ipsl.upmc.fr (Darwin) 
    68# add for idldoc assistant 
    … …  
    5860set -u 
    5961# 
    60 docompileall=0 
     62docompileall=1 
    6163dohtml=0 
    6264dooldtest=0 
    6365doidlwavedoc=0 
    64 doidldoc_html=1 
    65 doidldoc_assistant=1 
     66doidldoc_html=0 
     67doidldoc_assistant=0 
    6668doTARsrc=0 
    6769doTARdata=0 
    … …  
    209211    # In order to do not have to many revision in svn, we modify some 
    210212    # lines produced by idldoc : 
     213    # - add Source link in each html file 
     214    # example : 
     215    # <td>Source</td> 
     216    # will be replaced by 
     217    # <td><a href="../../Calendar/caldat.pro?format=raw" title="Source code of a file">Source</a></td> 
     218    # 
     219    # - remove date and time of idldoc production 
    211220    # examples : 
    212221    # <!-- Generated by IDLdoc 2.0 on Wed Jun  7 10:25:28 2006 --> 
    … …  
    233242} 
    234243EOF 
     244    # count of directory levels in output 
     245    # this ount will be use to format relative path later 
     246    nblev1=$(echo ${output} | sed -e "s@/\$@@" |awk -F "/" '{print NF}') 
     247    # 
    235248    list_html=$(find ${output} -name "*.html") 
    236249    for file_html in ${list_html} 
    237250    do 
     251     # buil the .pro file name 
     252     bfile=$(basename ${file_html} .html) 
     253     # retrieve the path of html file relative to memopwd (so relative to 
     254     # output). This path will be used in "Source" link. 
     255     nblev2=$(dirname ${file_html} |  sed -e "s@/\$@@" | awk -F "/" '{print NF}') 
     256     difflev=$((${nblev2} - ${nblev1})) 
     257     if [ ${difflev} -ge 2 ] 
     258     then 
     259      ilev=1 
     260      reloutput_html=".." 
     261      while [ ${ilev} -le ${difflev} ] 
     262      do 
     263       reloutput_html="${reloutput_html}/.." 
     264       ilev=$(( ${ilev} + 1 )) 
     265      done 
     266      relpath_html=$(dirname ${file_html} | \ 
     267                   sed -e "s@${output}@${reloutput_html}@" \ 
     268                       -e "s@\$@/@") 
     269      echo "relpath ${relpath_html})" 
     270     else 
     271      relpath_html="./" 
     272     fi 
     273     # echo "relpath ${relpath_html}/${bfile}" 
    238274     sed \ 
     275     -e "s@<td >Source<\/td>@<td><a href=\"${relpath_html}/${bfile}.pro?format=raw\" title=\"Source code of a file\">Source<\/a><\/td>@" \ 
    239276     -e "s/\(Generated by IDLdoc 2.0\)\( on .*\)\( -->\)/\1\3/" \ 
    240277     -e "s/\(Produced by IDLdoc 2.0\)\( on .*\)\(\.<\/div>\)/\1\3/" \ 
Note: See TracChangeset for help on using the changeset viewer.