Changeset 376


Ignore:
Timestamp:
08/11/08 12:24:07 (16 years ago)
Author:
pinsard
Message:

improve wiki FAQ production

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

Legend:

Unmodified
Added
Removed

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

    r345 r376  
    66# update : 
    77# $Id$ 
     8# ++ pb PATH introduire SAXO_PATH 
     9# fplod 2008-06-20T13:07:59Z aedon.locean-ipsl.upmc.fr (Darwin) 
     10# evaluation version 3.1.1 
     11# we are not yet still ready to migrate to rst format because of lack of 
     12# assistant 
     13# transformation independant of IDLdoc release (at least between 2. and 3.) 
    814# fplod 2008-01-10T08:13:41Z aedon.locean-ipsl.upmc.fr (Darwin) 
    915# version  
    … …  
    3945# pas ok ne reconnait pas les @param, @keyword 
    4046# 
    41 set -x 
    4247set -u 
    4348# ++ test si idl (car gdl inutilisable) 
    4449application=idl 
    4550assistant=0 
    46 transform=0 
     51transform=1 
    4752title="SAXO Documentation" # ++ parametre 
    4853root="../../" 
    … …  
    5358# 
    5459idldoc_dir="../idldoc/" #  
    55 idldoc_dir="/usr/home/fplod/src/idldoc-3.0b3/" # overriding idldoc_dir for ctest ++ 
    56 #idldoc_dir="/usr/home/fplod/src/idldoc-3.0b4-src/" # overriding idldoc_dir for test ++ 
    57 idldoc_dir="/usr/home/fplod/src/idldoc-3.0b4/" # overriding idldoc_dir for test ++ 
    58 idldoc_dir="/usr/home/fplod/src/idldoc-3.0rc2/" # overriding idldoc_dir for test ++ 
     60idldoc_dir="/usr/home/fplod/src/idldoc-3.1.1/" # overriding idldoc_dir for ctest ++ 
    5961template_location=${idldoc_dir}/templates/ 
    6062#++ pas fini  
    61 template_location=${idldoc_dir}/templates_dbk/ # overriding TEMPLATE_LOCATION++ 
    62 template_location=/usr/home/fplod/src/idldoc-3.0b3/templates_dbk/ # overriding TEMPLATE_LOCATION++ 
     63#template_location=${idldoc_dir}/templates_dbk/ # overriding TEMPLATE_LOCATION++ 
     64#template_location=/usr/home/fplod/src/idldoc-3.0b3/templates_dbk/ # overriding TEMPLATE_LOCATION++ 
    6365# 
    6466# memorize current directory 
    … …  
    7274log="/tmp/idldochtml_${$}.log" 
    7375pro="/tmp/idldochtml_${$}.pro" 
    74  
    75 #+++ a remettre pour dbk template_location="${template_location}", $ 
    76 #++MARKUP_STYLE="verbatim", $ 
    77 # !path = expand_path('+' + '${idldoc_dir}') 
     76# 
    7877cd ${idldoc_dir} 
    79 pwd 
    80 read a 
    81 cat <<EOF > ${pro} 
     78cat << EOF > ${pro} 
     79!path = expand_path('+' + '${idldoc_dir}') 
    8280idldoc,root="${root}",title="${title}", $ 
    8381CHARSET="ISO-8859-15", $ 
    8482LOG_FILE="${log}", $ 
    8583output="${outputtmp}", $ 
    86 template_prefix="dbk", $ 
    87 template_location="${template_location}", $ 
    88 overview="../../overview", /statistics, $ 
    89 COMMENT_STYLE="assistant" 
     84overview="../../overview", /statistics 
    9085exit 
    9186EOF 
    92 more ${pro} 
    93 read a 
    9487# launch idl with the file built above 
    95 IDL_STARTUP=${pro};${application} 
    96 /bin/rm ${pro} 
     88export IDL_STARTUP=${pro} 
     89${application} 
     90rm ${pro} 
    9791# 
    9892if [ ${transform} -eq 1 ] 
    … …  
    106100# <td><a href="../../Calendar/caldat.pro" title="Source code of a file">Source</a></td> 
    107101# 
    108 # - remove date and time of idldoc production 
    109 # examples : 
    110 # <!-- Generated by IDLdoc 2.0 on Wed Jun  7 10:25:28 2006 --> 
    111 # will be replaced by 
    112 # <!-- Generated by IDLdoc 2.0 --> 
    113 # <div id="tagline">Produced by IDLdoc 2.0 on Wed Jun  7 10:54:37 2006.</div 
    114 # will be replaced by 
    115 # <div id="tagline">Produced by IDLdoc 2.0</div> 
    116 # <h2>Produced on Wed Jun  7 10:23:13 2006</h2> 
    117 # will be delete 
    118 # other lines will be deleted because the time is the time of checkout not 
    119 # the time of revision. 
    120 # the sequence of lines 
    121 #<dl> 
    122 #      <dt>Last modification:</dt> 
    123 #       <dd>Fri Jun  2 11:46:24 2006</dd> 
    124 #    </dl> 
    125 # should also be removed ++ je ne sais pas dire en sed la ligne 
    126 # suivant l'occurence de Last modification 
     102# - remove version, date and time of idldoc production 
     103# ++ je ne sais pas dire en sed la ligne suivant l'occurence de Modification date 
    127104# 
    128105# count of directory levels in output 
    … …  
    166143do 
    167144 sed \ 
    168  -e "s/\(Generated by IDLdoc 2.0\)\( on .*\)\( -->\)/\1\3/" \ 
    169  -e "s/\(Produced by IDLdoc 2.0\)\( on .*\)\(\.<\/div>\)/\1\3/" \ 
     145 -e "s/\(Generated by IDLdoc\)\( .* on .*\)\( -->\)/\1\3/" \ 
     146 -e "s/\(Produced by IDLdoc\)\( .* on .*\)\(<\/td>\)/\1\3/" \ 
    170147 -e "/<h2>Produced on/d" \ 
    171  -e "/Last modification:/d" \ 
    172  -e "/<dd>... ... .* ..:..:.. ....<\/dd>/d" \ 
     148 -e "/Modifcation:/d" \ 
     149 -e "/<td>... ... .* ..:..:.. ....<\/td>/d" \ 
    173150 -e 's@<div class="value">@<div class="preformat">@' \ 
    174151 -e 's/div\#file_comments {/div\#file_comments { white-space: pre;/' \ 
    … …  
    191168# replace <pro>ginette</pro> by a sequence like 
    192169# <a href="./ginette.html">ginette</a> 
    193 ./pro2href.sh -i ${outputtmp} -r ${outputtmp} -e pro 
     170pro2href.sh -i ${outputtmp} -r ${outputtmp} -e pro 
    194171status=${?} 
    195172if [ ${status} -ne 0 ] 
    196173then 
    197    echo "eee : pb during ./pro2href.sh for <pro>...</pro>" 
     174   echo "eee : pb during pro2href.sh for <pro>...</pro>" 
    198175   exit 1 
    199176fi 
    200177# replace <proidl>ginette</proidl> by a sequence like 
    201178# <a href="./ginette.html">ginette</a> 
    202 ./pro2href.sh -i ${outputtmp} -r ${IDL_DIR}/help/online_help -e proidl 
     179pro2href.sh -i ${outputtmp} -r ${IDL_DIR}/help/online_help -e proidl 
    203180status=${?} 
    204181if [ ${status} -ne 0 ] 
    205182then 
    206    echo "eee : pb during ./pro2href.sh for <proidl>...</proidl>" 
     183   echo "eee : pb during pro2href.sh for <proidl>...</proidl>" 
    207184   exit 1 
    208185fi 
    … …  
    276253# replace <pro>ginette</pro> by a sequence like 
    277254# <a href="./ginette.html">ginette</a> 
    278 ./pro2href.sh -i ${outputtmp} -r ${outputtmp} -e pro 
     255pro2href.sh -i ${outputtmp} -r ${outputtmp} -e pro 
    279256status=${?} 
    280257if [ ${status} -ne 0 ] 
    281258then 
    282    echo "eee : pb during ./pro2href.sh for <pro>...</pro>" 
     259   echo "eee : pb during pro2href.sh for <pro>...</pro>" 
    283260   exit 1 
    284261fi 
    285262# replace <proidl>ginette</proidl> by a sequence like 
    286263# <a href="./ginette.html">ginette</a> 
    287 ./pro2href.sh  -i ${outputtmp} -r ${IDL_DIR}/help/online_help -e proidl 
     264pro2href.sh  -i ${outputtmp} -r ${IDL_DIR}/help/online_help -e proidl 
    288265status=${?} 
    289266if [ ${status} -ne 0 ] 
    290267then 
    291    echo "eee : pb during ./pro2href.sh for <proidl>...</proidl>" 
     268   echo "eee : pb during pro2href.sh for <proidl>...</proidl>" 
    292269   exit 1 
    293270fi 

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

    r345 r376  
    244244<listitem> 
    245245<para> 
    246 <guimenu>Search</guimenu> doesn't handle characters like <literal>-</literal> 
    247 and <literal>|</literal>. 
     246The search facility (<guimenu>Search</guimenu>) doesn't handle characters  
     247like <literal>-</literal> and <literal>|</literal>. 
    248248</para> 
    249249</listitem> 

  • trunk/SRC/Documentation/xmldoc/saxo_tracwiki.xsl

    r356 r376  
    1515must be followed by awk -f saxo_trackwiki.awk 
    1616because I did not yet correctly handle "* text" (with no linefeed) 
     17 
    1718update : 
    1819$Id$ 
    19 ++ 
    2020++ voir http://trac-hacks.org/wiki/XsltMacro 
     21++ add menu tags menuchoice, gui*, shortcut, keycombo, etc. 
     22fplod 2008-08-06T09:38:26Z aedon.locean-ipsl.upmc.fr (Darwin) 
     23add qanda tags (see ugly http://forge.ipsl.jussieu.fr/saxo/wiki/FaqSaxo 
     24vs http://forge.ipsl.jussieu.fr/saxo/download/xmldoc/faqsaxo.html) 
     25add programlisting management 
     26fplod 2008-08-11T10:15:40Z aedon.locean-ipsl.upmc.fr (Darwin) 
     27 menu tags in comments because to ugly ... problem with these tags vs item in lists 
    2128fplod 2008-04-18T13:01:50Z aedon.locean-ipsl.upmc.fr (Darwin) 
    2229pompage de href="http://docbook.sourceforge.net/release/xsl/current/html/xref.xsl 
    … …  
    6269</xsl:template> 
    6370 
     71<xsl:template match="d:qandadiv/d:title"> 
     72 <xsl:text>&#xA;</xsl:text> 
     73 <xsl:text>== </xsl:text><xsl:value-of select="normalize-space(.)"/><xsl:text> ==</xsl:text> 
     74 <xsl:text>&#xA;</xsl:text> 
     75</xsl:template> 
     76 
    6477<xsl:template match="d:sect2/d:title"> 
    6578 <xsl:text>&#xA;</xsl:text> 
    … …  
    7689</xsl:template> 
    7790 
     91<xsl:template match="d:qandaentry/d:question/d:para"> 
     92 <xsl:text>&#xA;</xsl:text> 
     93 <xsl:variable name="newtitle"> 
     94  <xsl:call-template name="replace-string"> 
     95   <xsl:with-param name="text" select="normalize-space(.)"/> 
     96   <xsl:with-param name="replace" select="'&gt;'"/> 
     97<!-- do not how to write > instead of &gt; ++. need sed features -->  
     98   <xsl:with-param name="with" select="'&gt;'"/> 
     99  </xsl:call-template> 
     100 </xsl:variable> 
     101 <xsl:text>=== </xsl:text><xsl:value-of select="$newtitle"/><xsl:text> ===</xsl:text> 
     102 <xsl:text>&#xA;</xsl:text> 
     103</xsl:template> 
     104 
    78105<xsl:template match="d:sect3/d:title"> 
    79106 <xsl:text>&#xA;</xsl:text> 
    … …  
    131158 
    132159<xsl:template match="d:screen"> 
     160 <!--  
     161we open an HTML block because it is not possible to have font effect (bold, italic) using TracWiki 
     162 --> 
     163 <xsl:text>&#xA;</xsl:text> 
     164 <xsl:text>{{{</xsl:text> 
     165 <xsl:text>&#xA;</xsl:text> 
     166 <xsl:text>#!html</xsl:text> 
     167 <xsl:text>&#xA;</xsl:text> 
     168 <pre class="screen"> 
     169 <xsl:apply-templates/> 
     170 </pre> 
     171 <xsl:text>&#xA;</xsl:text> 
     172 <xsl:text>}}}</xsl:text> 
     173 <xsl:text>&#xA;</xsl:text> 
     174</xsl:template> 
     175 
     176<xsl:template match="d:programlisting"> 
    133177 <!--  
    134178we open an HTML block because it is not possible to have font effect (bold, italic) using TracWiki 
    … …  
    340384 <xsl:text>&#xA;</xsl:text> 
    341385</xsl:template> 
     386 
     387<xsl:template match="d:informaltable"> 
     388<!-- but beware of links inside --> 
     389 <xsl:text>&#xA;</xsl:text> 
     390 <xsl:text>{{{</xsl:text> 
     391 <xsl:text>&#xA;</xsl:text> 
     392 <xsl:text>#!docbook</xsl:text> 
     393 <xsl:text>&#xA;</xsl:text> 
     394 <xsl:copy-of select="."/> 
     395 <xsl:text>&#xA;</xsl:text> 
     396 <xsl:text>}}}</xsl:text> 
     397 <xsl:text>&#xA;</xsl:text> 
     398</xsl:template> 
     399 
     400<!-- ++ pb when in listitem/para 
     401<xsl:template match="d:menuchoice|d:guimenu|d:guisubmenu"> 
     402 <xsl:text>&#xA;</xsl:text> 
     403 <xsl:text>{{{</xsl:text> 
     404 <xsl:text>&#xA;</xsl:text> 
     405 <xsl:text>#!docbook</xsl:text> 
     406 <xsl:text>&#xA;</xsl:text> 
     407 <xsl:copy-of select="."/> 
     408 <xsl:text>&#xA;</xsl:text> 
     409 <xsl:text>}}}</xsl:text> 
     410 <xsl:text>&#xA;</xsl:text> 
     411</xsl:template> 
     412--> 
    342413 
    343414<xsl:template match="d:informaltable"> 

  • trunk/SRC/Documentation/xmldoc/wiki/FaqSaxo

    r356 r376  
    1818 
    1919 
    20 General 
    21  
    22  
    23  
    24 What is SAXO ? 
     20 
     21== General == 
     22 
     23 
     24 
     25 
     26=== What is SAXO ? === 
    2527 
    2628 
    … …  
    3436 
    3537 
    36 How can I get help ? 
     38=== How can I get help ? === 
    3739 
    3840 
    … …  
    4648 
    4749 
    48 How do I get SAXO ? 
     50=== How do I get SAXO ? === 
    4951 
    5052 
    … …  
    5860 
    5961 
    60 What is the current version of SAXO ? 
    61  
    62  
    63  
    64  
    65  
    66  
    67  
    68  
    69  
    70 On what systems does SAXO run ? 
    71  
    72  
    73  
    74  
    75  
    76  
    77  
    78  
    79  
    80 Does SAXO works with GDL instead of IDL ? 
     62=== What is the current version of SAXO ? === 
     63 
     64 
     65 
     66 
     67 
     68 
     69 
     70 
     71 
     72=== On what systems does SAXO run ? === 
     73 
     74 
     75 
     76 
     77 
     78 
     79 
     80 
     81 
     82=== Does SAXO works with GDL instead of IDL ? === 
    8183 
    8284 
    … …  
    8991 
    9092 
    91 When is the next version of SAXO due out ? 
    92  
    93  
    94  
    95  
    96  
    97  
    98  
    99  
    100  
    101 How can I find if a routine to do what I want already exists ? 
    102  
    103  
    104  
    105  
    106  
    107  
    108  
    109  
    110  
    111 How should SAXO be cited or acknowledged in publication ? 
    112  
    113  
    114  
    115  
    116  
    117  
    118  
    119  
    120 Technical questions 
    121  
    122  
    123  
    124 Is there on-line help for SAXO ? 
     93=== When is the next version of SAXO due out ? === 
     94 
     95 
     96 
     97 
     98 
     99 
     100 
     101 
     102 
     103=== How can I find if a routine to do what I want already exists ? === 
     104 
     105 
     106 
     107 
     108 
     109 
     110 
     111 
     112 
     113=== How should SAXO be cited or acknowledged in publication ? === 
     114 
     115 
     116 
     117 
     118 
     119 
     120 
     121 
     122 
     123== Technical questions == 
     124 
     125 
     126 
     127 
     128=== Is there on-line help for SAXO ? === 
    125129 
    126130 
    … …  
    140144 
    141145 
    142 Contributors 
    143  
    144  
    145  
    146 Is there an SAXO Style Guide available ? 
     146 
     147== Contributors == 
     148 
     149 
     150 
     151 
     152=== Is there an SAXO Style Guide available ? === 
    147153 
    148154 
    … …  
    164170in your {{{${HOME}/.emacs}}} like this : 
    165171 
     172{{{ 
     173#!html 
     174<pre xmlns:xl="http://www.w3.org/1999/xlink" class="screen"> 
    166175(add-hook 'idlwave-mode-hook 
    167176  (function 
    … …  
    169178     (setq idlwave-file-header '("'''''SAXO_basedirectory'''''/SAXO_DIR/SRC/Documentation/new_header.txt") 
    170179    )))) 
    171  
    172  
    173  
    174  
    175  
    176  
    177 Is there any trouble with IDLdoc ? 
     180</pre> 
     181}}} 
     182 
     183 
     184 
     185 
     186 
     187 
     188=== Is there any trouble with IDLdoc ? === 
    178189 
    179190 
    … …  
    186197They must be escaped by an other {{{\}}} or you can choose an other character. 
    187198 
    188  * Search doesn't handle characters like {{{-}}} 
    189 and {{{|}}}. 
     199 * The search facility (Search) doesn't handle characters  
     200like {{{-}}} and {{{|}}}. 
    190201 
    191202 * Paragraphs of {{{*.pro}}} headers are shown with a proportional 
    … …  
    209220 
    210221 
    211 How can I check spelling of XML files ? 
     222=== How can I check spelling of XML files ? === 
    212223 
    213224 
    … …  
    228239 
    229240 
    230 How can I check spelling of IDL files ? 
     241=== How can I check spelling of IDL files ? === 
    231242 
    232243 
    … …  
    267278 
    268279 
    269 How can I see online help update ? 
     280=== How can I see online help update ? === 
    270281 
    271282 

  • trunk/SRC/Documentation/xmldoc/wiki/GetSaxo

    r357 r376  
    6666==== Regular users ==== 
    6767 
    68 The '''complete''' latest revision (source + tests data files: 773 Mb) can be checked out with the following command executed in your ${HOME}: 
     68The '''complete''' latest revision (source + tests data files: 771 Mb) can be checked out with the following command executed in your ${HOME}: 
    6969 
    7070{{{ 
    … …  
    7575}}} 
    7676 
    77 The latest revision of the '''source files''' (46 Mb) can be checked out with the following command: 
     77The latest revision of the '''source files''' (44 Mb) can be checked out with the following command: 
    7878 
    7979{{{ 
Note: See TracChangeset for help on using the changeset viewer.