Changeset 7 for trunk


Ignore:
Timestamp:
12/12/08 11:39:06 (15 years ago)
Author:
pinsard
Message:

improvment for manuals production; add manuals

Location:
trunk
Files:
21 added
7 edited

Legend:

Unmodified
Added
Removed

  • trunk/adm/guides/makefile

    r3 r7  
    1 #- 
     1#+ 
     2# 
    23# module 
    34# ====== 
     5# 
    46# generation of documentations from XML files in HTML and wiki forms 
    57# 
    … …  
    2123# 
    2224#   * creation 
     25# 
    2326#- 
    2427PRODUCT = \ 
    … …  
    2831/usr/home/fplod/incas/$(PRODUCT)/$(PRODUCT)_ws/ 
    2932 
    30  
    3133DIRSRC = \ 
    3234$(DIRBASE)/adm/guides/ 
    … …  
    3638 
    3739DIRWWW = \ 
    38 /usr/temp/${LOGNAME}/public_html/$(PRODUCT)/$(PRODUCT)_ws/doc/guides/ 
     40$(DIRBASE)/doc/guides/ 
    3941 
    4042DIRWIKI = \ 
    4143$(DIRWWW)/wiki/ 
     44 
     45LIST_XML = \ 
     46LIST_XML_en \ 
     47LIST_XML_fr 
     48 
     49LIST_XML_en = \ 
     50$(DIRSRC)/svnbasiccommands.xml 
     51 
     52LIST_XML_fr = \ 
     53$(DIRSRC)/web.xml 
    4254 
    4355.PHONY : \ 
    … …  
    4658before \ 
    4759dbkcheck \ 
     60spellcheck \ 
    4861help \ 
    4962html \ 
    … …  
    6477        @mkdir -p ${DIRWWW}/wiki 
    6578 
    66 clean : 
     79clean : \ 
     80cleantmp 
     81        -@rm -rf ${DIRWWW}/html/ 
     82        -@rm -rf ${DIRWWW}/wiki/ 
     83 
     84cleantmp : 
    6785        -@rm -f $(DIRTMP)/*_full.xml 
    6886        -@rm -f $(DIRTMP)/err_xmlstarlet_xsd 
    6987        -@rm -f $(DIRTMP)/get_sed.xml 
    7088        -@rm -f $(DIRTMP)/firststeps_sed.xml 
     89 
     90spellcheck : 
     91        @for file in $(LIST_XML_fr); do \ 
     92         aspell --mode=sgml --master=french -c $${file}; done 
     93        @for file in $(LIST_XML_en); do \ 
     94         aspell --mode=sgml --master=english -c $${file}; done 
    7195 
    7296dbkcheck : 
    … …  
    83107 
    84108html : \ 
    85 $(DIRWWW)/html/svnbasiccommands.html \ 
    86 $(DIRWWW)/html/index.html 
     109$(DIRWWW)/html/index.html \ 
     110$(DIRWWW)/html/svnbasiccommands.html 
    87111 
    88112tracwiki : \ 
    89 $(DIRWIKI)/SvnBasicCommands \ 
    90 $(DIRWIKI)/WikiStart 
     113$(DIRWIKI)/WikiStart \ 
     114$(DIRWIKI)/SvnBasicCommands 
    91115        @echo "Do not forget to import wiki pages" 
    92116        @echo "\$$ ssh $(PRODUCT)@forge.ipsl.jussieu.fr mkdir -p /tmp/$(PRODUCT)/" 

  • trunk/adm/guides/svnbasiccommands.xml

    r5 r7  
    142142A         aaa 
    143143</computeroutput> 
    144  <prompt>$</prompt> <userinput>svn status</userinput> <lineannotation>check that <filename>aaa</filename> has beed add to the deposit</lineannotation> 
     144 <prompt>$</prompt> <userinput>svn status</userinput> <lineannotation>check that <filename>aaa</filename> has been add to the deposit</lineannotation> 
    145145<computeroutput> 
    146146A      aaa 

  • trunk/adm/guides/web.xml

    r6 r7  
    5454<title>Travailler sur &project;</title> 
    5555<para> 
    56 Naviguer dans <link xl:href="http://forge.ipsl.jussieu.fr/ircaam/"/> 
     56Naviguer dans <link xl:href="http://forge.ipsl.jussieu.fr/&project_svn;/"/> 
    5757</para> 
    5858</sect1> 
    … …  
    6363</title> 
    6464<para> 
    65 <link xl:href="file://locean-ipsl.upmc.fr/usr/temp/fplod/public_html/ircaam/fr/one/ircaam.html"/> (notes de travail fp au LOCEAN) 
     65<link xl:href="file://locean-ipsl.upmc.fr/usr/temp/fplod/public_html/&project_svn;/notes/fr/one/&project_svn;.html"/> (notes de travail fp au LOCEAN) 
    6666</para> 
    6767</sect1> 

  • trunk/adm/makefile

    • Property svn:keywords set to Id
    r4 r7  
    3636# .. _extract_rst.sh: ../extract_rst.sh.html 
    3737# 
    38 #+ 
     38#- 
    3939# 
    4040PRODUCT = \ 
    … …  
    5757 
    5858DIRWWW = \ 
    59 ../doc/ 
     59$(DIRBASE)/doc/ 
    6060 
    6161URLPUBLISH = \ 
    … …  
    9898 
    9999before : 
    100         @before.sh -p $(PRODUCT) -s $(DIRSRC) -w $(DIRWWW) -mono -l en 
    101         @mkdir -p $(DIRWWW)/manuals/html/ 
    102         @mkdir -p $(DIRWWW)/manuals/pdf/ 
     100        @mkdir -p $(DIRWWW)/manuals/html/one/ 
     101        @mkdir -p $(DIRWWW)/manuals/html/many/ 
     102        @mkdir -p $(DIRWWW)/manuals/pdf/one/ 
     103        @mkdir -p $(DIRWWW)/manuals/pdf/many/ 
    103104 
    104105install : 
    105106        @install.sh -w $(DIRWWW) -u $(URLPUBLISH) 
    106107 
    107 clean : 
     108clean : \ 
     109cleantmp  
    108110        -@rm -fr $(DIRWWW)/manuals/html/ 
    109111        -@rm -fr $(DIRWWW)/manuals/pdf/ 
    110112        -@rm -fr $(DIRWWW)/src_browser/ 
     113 
     114cleantmp : 
    111115        -@rm -f $(DIRTMP)/all.xml 
    112116        -@rm -f $(DIRTMP)/*.rst 
    … …  
    114118        -@rm -f $(DIRTMP)/links.rst* 
    115119        -@rm -f $(DIRTMP)/*.tex 
    116         -@rm -f $(DIRTMP)/*.aux 
    117         -@rm -f $(DIRTMP)/*.log 
    118         -@rm -f $(DIRTMP)/*.out 
     120        -@rm -f $(DIRWWW)/manuals/pdf/one/*.aux 
     121        -@rm -f $(DIRWWW)/manuals/pdf/one/*.log 
     122        -@rm -f $(DIRWWW)/manuals/pdf/one/*.out 
     123        -@rm -f $(DIRWWW)/manuals/pdf/many/*.aux 
     124        -@rm -f $(DIRWWW)/manuals/pdf/many/*.log 
     125        -@rm -f $(DIRWWW)/manuals/pdf/many/*.out 
    119126 
    120127htmllinkcheckb : 
    121         @linkchecker.sh -d $(DIRWWW) 
     128        @linkchecker.sh -d $(DIRWWW)/manuals/html/ 
    122129 
    123130htmllinkchecka : 
    … …  
    133140 
    134141man_html : \ 
    135 $(DIRWWW)/manuals/html/index.html \ 
    136 $(DIRWWW)/manuals/html/$(PRODUCT)_manuals.html \ 
    137 $(DIRWWW)/manuals/html/$(PRODUCT)_profile.sh.html \ 
    138 $(DIRWWW)/manuals/html/dlogd.sh.html \ 
    139 $(DIRWWW)/manuals/html/elogd.sh.html \ 
    140 $(DIRWWW)/manuals/html/plogd.sh.html \ 
    141 $(DIRWWW)/manuals/html/tlogd.sh.html 
     142man_html_one \ 
     143man_html_many 
     144 
     145man_html_one : \ 
     146$(DIRWWW)/manuals/html/one/index.html 
     147 
     148man_html_many : \ 
     149$(DIRWWW)/manuals/html/many/index.html \ 
     150$(DIRWWW)/manuals/html/many/$(PRODUCT)_profile.sh.html \ 
     151$(DIRWWW)/manuals/html/many/dlogd.sh.html \ 
     152$(DIRWWW)/manuals/html/many/elogd.sh.html \ 
     153$(DIRWWW)/manuals/html/many/plogd.sh.html \ 
     154$(DIRWWW)/manuals/html/many/tlogd.sh.html 
    142155 
    143156man_pdf : \ 
    144 $(DIRWWW)/manuals/pdf/$(PRODUCT)_manuals.pdf \ 
    145 $(DIRWWW)/manuals/pdf/$(PRODUCT)_profile.sh.pdf \ 
    146 $(DIRWWW)/manuals/pdf/dlogd.sh.pdf \ 
    147 $(DIRWWW)/manuals/pdf/elogd.sh.pdf \ 
    148 $(DIRWWW)/manuals/pdf/plogd.sh.pdf \ 
    149 $(DIRWWW)/manuals/pdf/tlogd.sh.pdf 
    150  
    151 $(DIRWWW)/manuals/html/index.html : \ 
     157man_pdf_one \ 
     158man_pdf_many 
     159 
     160man_pdf_one : \ 
     161$(DIRWWW)/manuals/pdf/one/$(PRODUCT)_manuals.pdf \ 
     162 
     163man_pdf_many : \ 
     164$(DIRWWW)/manuals/pdf/many/$(PRODUCT)_profile.sh.pdf \ 
     165$(DIRWWW)/manuals/pdf/many/dlogd.sh.pdf \ 
     166$(DIRWWW)/manuals/pdf/many/elogd.sh.pdf \ 
     167$(DIRWWW)/manuals/pdf/many/plogd.sh.pdf \ 
     168$(DIRWWW)/manuals/pdf/many/tlogd.sh.pdf 
     169 
     170$(DIRWWW)/manuals/html/many/index.html : \ 
    152171$(DIRTMP)/index.rst 
    153172        @rst2html.py --input-encoding=ISO-8859-15 --strict --time \ 
    154173        $< $@ 
    155174 
    156 $(DIRWWW)/manuals/html/$(PRODUCT)_manuals.html : \ 
     175$(DIRWWW)/manuals/html/one/index.html : \ 
    157176$(DIRTMP)/$(PRODUCT)_manuals.rst 
    158177        @rst2html.py --input-encoding=ISO-8859-15 --strict --time \ 
    159178        $< $@ 
    160179 
    161 $(DIRWWW)/manuals/pdf/$(PRODUCT)_manuals.pdf : \ 
     180$(DIRWWW)/manuals/pdf/one/$(PRODUCT)_manuals.pdf : \ 
    162181$(DIRTMP)/$(PRODUCT)_manuals.tex 
    163         @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/ $< 
     182        @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/one/ $< 
    164183 
    165184$(DIRTMP)/$(PRODUCT)_manuals.tex : \ 
    166185$(DIRTMP)/$(PRODUCT)_manuals.rst 
    167         @rst2newlatex.py --input-encoding=ISO-8859-15 --strict --time --time \ 
     186        @rst2newlatex.py --input-encoding=ISO-8859-15 --strict --time \ 
    168187        $< $@ 
    169188 
    … …  
    175194$(DIRTMP)/plogd.sh.rst \ 
    176195$(DIRTMP)/tlogd.sh.rst 
    177         cat $(DIRTMP)/index.rst > ${DIRTMP}/$(PRODUCT)_manuals.rst1 
     196        @cat $(DIRTMP)/index.rst > ${DIRTMP}/$(PRODUCT)_manuals.rst1 
    178197        @for file in $(LIST_SRCSH); \ 
    179198        do echo " " >> ${DIRTMP}/$(PRODUCT)_manuals.rst1 ;\ 
     199        echo ".. raw:: latex" >> ${DIRTMP}/$(PRODUCT)_manuals.rst1 ;\ 
     200        echo " " >> ${DIRTMP}/$(PRODUCT)_manuals.rst1 ;\ 
     201        echo "  \newpage" >> ${DIRTMP}/$(PRODUCT)_manuals.rst1 ;\ 
     202        echo " " >> ${DIRTMP}/$(PRODUCT)_manuals.rst1 ;\ 
     203        echo ".. _$$(basename $${file}) :" >> ${DIRTMP}/$(PRODUCT)_manuals.rst1 ;\ 
     204        echo " " >> ${DIRTMP}/$(PRODUCT)_manuals.rst1 ;\ 
    180205        echo "$$(basename $${file})" >> ${DIRTMP}/$(PRODUCT)_manuals.rst1 ;\ 
    181206        echo "$$(basename $${file} | tr [:print:] =)" >> ${DIRTMP}/$(PRODUCT)_manuals.rst1 ; \ 
    … …  
    183208        sed -e "s/^==*$$/-----------------/" ${DIRTMP}/$$(basename $${file}).rst >> ${DIRTMP}/$(PRODUCT)_manuals.rst1; \ 
    184209        done 
    185         grep "\.\. _.*: .*$$" ${DIRTMP}/$(PRODUCT)_manuals.rst1 > \ 
     210        @grep "\.\. _.*: .*$$" ${DIRTMP}/$(PRODUCT)_manuals.rst1 > \ 
    186211        ${DIRTMP}/links.rst 
    187         sed -e "s/^ *//" ${DIRTMP}/links.rst | sort -u > ${DIRTMP}/links.rst2 
    188         sed -e "/\.\. _.*: .*$$/d" ${DIRTMP}/$(PRODUCT)_manuals.rst1 > \ 
     212        @sed -e "s/^ *//" ${DIRTMP}/links.rst | sort -u > ${DIRTMP}/links.rst2 
     213        @sed -e "/\.\. _.*: .*$$/d" ${DIRTMP}/$(PRODUCT)_manuals.rst1 > \ 
    189214        ${DIRTMP}/$(PRODUCT)_manuals.rst2 
    190         cat ${DIRTMP}/$(PRODUCT)_manuals.rst2 ${DIRTMP}/links.rst2 > $@ 
     215        @cp ${DIRTMP}/$(PRODUCT)_manuals.rst2 $@ 
    191216 
    192217$(DIRTMP)/index.rst : 
    … …  
    195220        @echo "=================" >> $@ 
    196221        @echo " " >> $@ 
    197         @echo "blabla see Guide_ " >> $@ 
    198         @echo " " >> $@ 
    199         @echo " .. _Guide : ../../guides/html/index.html" >> $@ 
    200         @echo " " >> $@ 
    201  
    202222        @echo "Shell scripts" >> $@ 
    203223        @echo "=============" >> $@ 
    204         @for file in $(LIST_SRCSH); do echo " ";echo "$$(basename $${file})_"; echo " "; echo ".. _$$(basename $${file}): $$(basename $${file}).html"; done >> $@ 
     224        @for file in $(LIST_SRCSH); do echo " ";echo "$$(basename $${file})_"; echo " "; echo ".. _$$(basename $${file}) : $$(basename $${file}).html"; done >> $@ 
    205225        @echo " " >> $@ 
    206226 
    207 $(DIRWWW)/manuals/html/$(PRODUCT)_profile.sh.html : \ 
     227$(DIRWWW)/manuals/html/many/$(PRODUCT)_profile.sh.html : \ 
    208228$(DIRTMP)/$(PRODUCT)_profile.sh.rst 
    209229        @rst2html.py --input-encoding=ISO-8859-15 --strict --time \ 
    210230        $< $@ 
    211231 
    212 $(DIRWWW)/manuals/pdf/$(PRODUCT)_profile.sh.pdf : \ 
     232$(DIRWWW)/manuals/pdf/many/$(PRODUCT)_profile.sh.pdf : \ 
    213233$(DIRTMP)/$(PRODUCT)_profile.sh.tex 
    214         @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/ $< 
     234        @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/many/ $< 
    215235 
    216236$(DIRTMP)/$(PRODUCT)_profile.sh.tex : \ 
    … …  
    223243        @extract_rst.sh -i $< -l sh -o $@ 
    224244 
    225 $(DIRWWW)/manuals/html/dlogd.sh.html : \ 
     245$(DIRWWW)/manuals/html/many/dlogd.sh.html : \ 
    226246$(DIRTMP)/dlogd.sh.rst 
    227247        @rst2html.py --input-encoding=ISO-8859-15 --strict --time \ 
    228248        $< $@ 
    229249 
    230 $(DIRWWW)/manuals/pdf/dlogd.sh.pdf : \ 
     250$(DIRWWW)/manuals/pdf/many/dlogd.sh.pdf : \ 
    231251$(DIRTMP)/dlogd.sh.tex 
    232         @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/ $< 
    233         @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/ $< 
     252        @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/many/ $< 
     253        @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/many/ $< 
    234254 
    235255$(DIRTMP)/dlogd.sh.tex : \ 
    … …  
    242262        @extract_rst.sh -i $< -l sh -o $@ 
    243263 
    244 $(DIRWWW)/manuals/html/elogd.sh.html : \ 
     264$(DIRWWW)/manuals/html/many/elogd.sh.html : \ 
    245265$(DIRTMP)/elogd.sh.rst 
    246266        @rst2html.py --input-encoding=ISO-8859-15 --strict --time \ 
    247267        $< $@ 
    248268 
    249 $(DIRWWW)/manuals/pdf/elogd.sh.pdf : \ 
     269$(DIRWWW)/manuals/pdf/many/elogd.sh.pdf : \ 
    250270$(DIRTMP)/elogd.sh.tex 
    251         @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/ $< 
    252         @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/ $< 
     271        @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/many/ $< 
     272        @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/many/ $< 
    253273 
    254274$(DIRTMP)/elogd.sh.tex : \ 
    … …  
    261281        @extract_rst.sh -i $< -l sh -o $@ 
    262282 
    263 $(DIRWWW)/manuals/html/plogd.sh.html : \ 
     283$(DIRWWW)/manuals/html/many/plogd.sh.html : \ 
    264284$(DIRTMP)/plogd.sh.rst 
    265285        @rst2html.py --input-encoding=ISO-8859-15 --strict --time \ 
    266286        $< $@ 
    267287 
    268 $(DIRWWW)/manuals/pdf/plogd.sh.pdf : \ 
     288$(DIRWWW)/manuals/pdf/many/plogd.sh.pdf : \ 
    269289$(DIRTMP)/plogd.sh.tex 
    270         @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/ $< 
    271         @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/ $< 
     290        @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/many/ $< 
     291        @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/many/ $< 
    272292 
    273293$(DIRTMP)/plogd.sh.tex : \ 
    … …  
    280300        @extract_rst.sh -i $< -l sh -o $@ 
    281301 
    282 $(DIRWWW)/manuals/html/tlogd.sh.html : \ 
     302$(DIRWWW)/manuals/html/many/tlogd.sh.html : \ 
    283303$(DIRTMP)/tlogd.sh.rst 
    284304        @rst2html.py --input-encoding=ISO-8859-15 --strict --time \ 
    285305        $< $@ 
    286306 
    287 $(DIRWWW)/manuals/pdf/tlogd.sh.pdf : \ 
     307$(DIRWWW)/manuals/pdf/many/tlogd.sh.pdf : \ 
    288308$(DIRTMP)/tlogd.sh.tex 
    289         @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/ $< 
    290         @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/ $< 
     309        @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/many/ $< 
     310        @-pdflatex -output-directory $(DIRWWW)/manuals/pdf/many/ $< 
    291311 
    292312$(DIRTMP)/tlogd.sh.tex : \ 

  • trunk/src/ircaam_profile.sh

    r2 r7  
    2828# ${IRCAAM} 
    2929# 
    30 # ${PROJECT_LOG} ++ 
     30# ${IRCAAM_LOG} ++ 
    3131# 
    3232# ${IRCAAM_ID} 
    … …  
    6969# 
    7070# /usr/home/fplod/incas/ircaam/ircaam_ws/src/ircaam_profile.sh sur aedon.locean-ipsl.upmc.fr 
     71# 
     72# 
     73# TODO 
     74# ==== 
     75# 
     76# matlab/octave path 
    7177# 
    7278# EVOLUTIONS 
    … …  
    190196fi 
    191197# 
    192 PROJECT_LOG=${tempdir} 
    193 export PROJECT_LOG 
    194 if [ ! -d ${PROJECT_LOG} ]  
    195 then 
    196   mkdir -p ${PROJECT_LOG} 
    197   echo "${command} : iii : creation of \${PROJECT_LOG}" 
     198IRCAAM_LOG=${tempdir} 
     199export IRCAAM_LOG 
     200if [ ! -d ${IRCAAM_LOG} ]  
     201then 
     202  mkdir -p ${IRCAAM_LOG} 
     203  echo "${command} : iii : creation of \${IRCAAM_LOG}" 
    198204fi  
    199 # check for permission on PROJECT_LOG 
    200 if [ ! -x ${PROJECT_LOG} ] 
    201 then 
    202  echo " eee : ${PROJECT_LOG} not reachable" 
    203  # nb : no exit because this file should be launched by login process 
    204 fi 
    205 # 
    206 # check for permission on PROJECT_LOG 
    207 if [ ! -w ${PROJECT_LOG} ] 
    208 then 
    209  echo " eee : ${PROJECT_LOG} not writable" 
     205# check for permission on IRCAAM_LOG 
     206if [ ! -x ${IRCAAM_LOG} ] 
     207then 
     208 echo " eee : ${IRCAAM_LOG} not reachable" 
     209 # nb : no exit because this file should be launched by login process 
     210fi 
     211# 
     212# check for permission on IRCAAM_LOG 
     213if [ ! -w ${IRCAAM_LOG} ] 
     214then 
     215 echo " eee : ${IRCAAM_LOG} not writable" 
    210216 # nb : no exit because this file shouldreachable be launched by login process 
    211217fi 

  • trunk/src/plogd.sh

    r2 r7  
    66# ==== 
    77# 
    8 # plogd.sh - prints the most recent release of ${IRCAAM_LOG}/action.log.AAAA-MM-JJTHH:MM:SSZ 
     8# plogd.sh - prints the most recent release of ${IRCAAM_LOG}/action.log.YYYY-MM-DDTHH:MM:SSZ 
    99# 
    1010# SYNOPSIS 

  • trunk/src/tlogd.sh

    r2 r7  
    66# ==== 
    77# 
    8 # tlogd.sh -  shows the most recent release of ${IRCAAM_LOG}/<action>.log.YYYY-MM-DDTHH:MM:SSZ 
     8# tlogd.sh -  shows the most recent release of ${IRCAAM_LOG}/action.log.YYYY-MM-DDTHH:MM:SSZ 
    99# 
    1010# SYNOPSIS 
Note: See TracChangeset for help on using the changeset viewer.