Attachment 26622 Details for Bug 42684 – /doc/fr/tipsntricks.xml

/doc/fr/tipsntricks.xml

tipsntricks.xml (text/plain), 7.29 KB, created by Xavier Neys (RETIRED) on 2004-02-29 14:52:57 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Xavier Neys (RETIRED)

Created: 2004-02-29 14:52:57 UTC

Size: 7.29 KB

patch

obsolete

><?xml version='1.0' encoding="UTF-8"?>
><!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
>
>
><guide link="/doc/fr/tipsntricks.xml" lang="fr">
><title>Trucs et astuces pour le dÃ©veloppement de la documentation</title>
><author title="Auteur">
> <mail link="swift@gentoo.org">Sven Vermeulen</mail>
></author>
><author title="Traducteur">
> <mail link="olivier.fisette@sympatico.ca">Olivier Fisette</mail>
></author>
>
><abstract>
>Quelques trucs et astuces qui faciliteront le travail des dÃ©veloppeurs Gentoo 
>(ou qui le rendront impossible :)
></abstract>
>
><license/>
>
><version>0.6</version>
><date>24 fÃ©vrier 2004</date>
>
><chapter>
><title>ParamÃ©trer votre environnement local</title>
><section>
><title>Environnement local pour les contributeurs</title>
><body>
>
>
>CrÃ©ez un rÃ©pertoire dÃ©diÃ© au dÃ©veloppement de la documentation. Ã titre
>d'exemple, nous utiliserons <path>~/work/gentoo/doc</path>. Dans ce rÃ©pertoire,
>crÃ©ez un sous-rÃ©pertoire dans lequel vous conserverez la documentation (Ã  jour)
>en anglais (par exemple, <path>en/</path>).
>
>
>
>TÃ©lÃ©chargez l'archive tar la plus rÃ©cente de la documentation anglaise&nbsp;:
>
>
><pre caption="TÃ©lÃ©charger la documentation anglaise">
># wget http://www.gentoo.org/dyn/doc-snapshots/docs-latest-en.tar.bz2
></pre>
>
>
>DÃ©sarchivez la documentation dans le rÃ©pertoire <path>en/</path>. Vous 
>disposez maintenant d'un instantanÃ© Ã  jour de la documentation anglaise. 
>Chaque fois que vous souhaiterez mettre Ã  jour votre instantanÃ©, vous pourrez 
>tÃ©lÃ©charger l'archive Ã  nouveau, ou alors naviguer dans la documentation et 
>ajouter <path>?passthru=1</path> Ã  l'URL. Par exemple&nbsp;:
>
>
><pre caption="Mettre Ã  jour un document en anglais">
># wget http://www.gentoo.org/doc/en/alsa-guide.xml?passthru=1 -O alsa-guide.xml
></pre>
>
>
>Si vous voulez participer Ã  la traduction de la documentation, crÃ©ez un 
>rÃ©pertoire pour votre langue dans lequel vous garderez les traductions 
>courantes&nbsp;:
>
>
><pre caption="TÃ©lÃ©charger un instantanÃ© pour votre langue">
># mkdir <comment>${LANG}</comment>
># cd <comment>${LANG}</comment>
># wget http://www.gentoo.org/dyn/doc-snapshots/docs-latest-<comment>${LANG}</comment>.tar.bz2
># tar xvjf docs-latest-*.tar.bz2
></pre>
>
>
>Lorsque vous mettez un document Ã  jour, copiez-le toujours Ã  partir de
><path>${LANG}/</path> vers le rÃ©pertoire racine
>(<path>~/work/gentoo/doc</path>). Ensuite, modifiez cette copie. Vous devez
>conserver l'original afin de crÃ©er un correctif (Â«&nbsp;patch&nbsp;Â»)&nbsp;:
>
>
><pre caption="CrÃ©er un correctif pour une mise Ã  jour">
># diff -uNt <comment>${LANG}</comment>/alsa-guide.xml alsa-guide.xml > alsa-guide.diff
></pre>
>
></body>
></section>
><section>
><title>DÃ©pÃ´t CVS en ligne</title>
><body>
>
>
>Vous pouvez utiliser notre <uri link="/cgi-bin/viewcvs.cgi">dÃ©pÃ´t CVS en
>ligne</uri> pour dÃ©terminer les diffÃ©rences entre des versions d'un mÃªme
>document. Le dÃ©pÃ´t principal pour les documents en anglais est <uri
>link="/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/doc/en/?sortby=date">intÃ©gralement
>disponible</uri>. Notez que le dÃ©pÃ´t CVS en ligne est mis Ã  jour toutes les
>heures.
>
>
></body>
></section>
><section>
><title>DÃ©pÃ´t local pour les dÃ©veloppeurs</title>
><body>
>
>
>CrÃ©ez un rÃ©pertoire dÃ©diÃ© Ã  Gentoo, par exemple 
><path>~/work/gentoo/doc</path>. Ensuite, crÃ©ez un sous-rÃ©pertoire nommÃ© 
><path>cvs/</path> dans lequel vous conserverez un instantanÃ© du CVS&nbsp;:
>
>
><pre caption="Obtenir un instantanÃ© du CVS">
># mkdir cvs; cd cvs/
># export CVSROOT=<comment>&lt;votre nom d'utilisateur&gt;</comment>@cvs.gentoo.org:/home/cvsroot
># cvs co doc
></pre>
>
>
>Pour mettre Ã  jour l'instantanÃ© du CVS, exÃ©cutez <c>cvs update -dP</c> dans 
>le rÃ©pertoire <path>cvs/doc</path>.
>
>
></body>
></section>
></chapter>
><chapter>
><title>Tester GuideXML</title>
><section>
><title>Environnement de test</title>
><body>
>
>
>D'abord, crÃ©ez un rÃ©pertoire <path>test/</path> dans lequel vous conserverez 
><path>guide.dtd</path>, <path>main.css</path> ainsi que quelques images&nbsp;:
>
>
><pre caption="CrÃ©er l'environnement de test">
># mkdir test
># cd test
># mkdir dtd css images
># wget -P dtd/ http://www.gentoo.org/dtd/guide.dtd
># wget -P dtd/ http://www.gentoo.org/dtd/book.dtd
># wget -P css/ http://www.gentoo.org/css/main.css
># wget -P images/ http://www.gentoo.org/images/gbot-s.gif \
> http://www.gentoo.org/images/gridtest.gif \
> http://www.gentoo.org/images/gtop-s.jpg \
> http://www.gentoo.org/images/line.gif \
> http://www.gentoo.org/images/netraverse-gentoo.gif
></pre>
>
>
>TÃ©lÃ©chargez une version spÃ©ciale de <path>guide.xsl</path> disponible sur <uri
>link="http://dev.gentoo.org/~swift/local/guide.xsl">l'espace Web de 
>SwifT</uri>. Cette version est adaptÃ©e pour la transformation locale de 
>GuideXML en HTML.
>
>
><pre caption="TÃ©lÃ©charger guide.xsl">
># wget http://dev.gentoo.org/~swift/local/guide.xsl
></pre>
>
>
>Terminez en Ã©ditant <path>/etc/xml/catalog</path> pour y ajouter la ligne 
>suivante&nbsp;:
>
>
><pre caption="Addenda Ã  /etc/xml/catalog">
>&lt;rewriteURI uriStartString="/dtd" rewritePrefix="/chemin/vers/rÃ©pertoire-dtd"/&gt;
></pre>
>
>
>Bien sÃ»r, changez <c>/chemin/vers/rÃ©pertoire-dtd</c> par le chemin du rÃ©pertoire
>oÃ¹ vous avez tÃ©lÃ©chargÃ© les fichiers <path>guide.dtd</path> et 
><path>book.dtd</path>.
>
>
></body>
></section>
><section>
><title>Tester un guide Gentoo</title>
><body>
>
>
>Pour tester un guide Gentoo, vÃ©rifiez d'abord si sa syntaxe XML est 
>valide&nbsp;:
>
>
><pre caption="Utiliser xmllint pour vÃ©rifier les guides">
># xmllint --valid --noout alsa-guide.xml
></pre>
>
>
>Si <c>xmllint</c> se termine sans afficher quoi que ce soit, cela indique que 
>le fichier est exempt d'erreurs (du moins en ce qui concerne les balises XML). 
>La prochaine Ã©tape est la conversion du fichier en HTML. L'outil idoine est 
><c>xsltproc</c>&nbsp;:
>
>
><pre caption="Conversion en HTML">
># xsltproc --novalid test/guide.xsl alsa-guide.xml &gt; test/alsa-guide.html
></pre>
>
>
>Si aucune erreur n'est affichÃ©e, vous devriez pouvoir pointer votre
>navigateur vers 
><uri>file:///home/user/work/gentoo/doc/test/alsa-guide.html</uri> pour 
>consulter le document rÃ©sultant de la conversion. Dans tous les autres cas, 
>vous devrez corriger votre guide jusqu'Ã  ce qu'il fonctionne convenablement.
>
>
></body>
></section>
><section>
><title>Tester le Manuel Gentoo</title>
><body>
>
>
>Le manuel Gentoo est divisÃ© en chapitres. Pour traiter un chapitre, vous 
>devez utiliser Ã  la fois le fichier <path>handbook.xml</path> et le fichier 
><path>hb-</path> (tel que <path>hb-install-about.xml</path>). Vous devez 
>Ã©galement fournir Ã  <c>xsltproc</c> des paramÃ¨tres identiques Ã  ceux qui sont 
>utilisÃ©s pour la navigation en ligne du Manuel, soit <c>part</c> et 
><c>chap</c>. Par exemple, pour valider 
><path>hb-install-about.xml</path>&nbsp;:
>
>
><pre caption="Valider hb-install-about.xml">
># xmllint --valid --noout handbook.xml
># xmllint --valid --noout hb-install-about.xml
># xsltproc --stringparam part 1 --stringparam chap 1 test/guide.xsl handbook.xml &gt; test/hb-install-about.html
></pre>
>
></body>
></section>
></chapter>
></guide>

Actions: View

Attachments on bug 42684: 26215 | 26217 | 26293 | 26296 | 26622