[DDR] webwml://french/devel/website/working.wml
Bonjour,
Comme j'ai un peu peur que ma première annonce soit passée inaperçue, un
peu perdu au beau milieu d'un fil d'une validation CVS, je renvoie une
DDR pour cette page (que j'ai donc validée dans le CVS).
La modification importante est l'ajout du paragraphe sur
smart_change.pl.
Merci pour les relectures.
Fred
#use wml::debian::template title="Travailler sur les pages du site Debian" BARETITLE=true
#use wml::debian::toc
#use wml::debian::translation-check translation="1.31" maintainer="Frédéric Bothamy"
<toc-display/>
<hrline/>
<toc-add-entry name="general">Informations générales</toc-add-entry>
<h3>Ressources nécessaires</h3>
<p>Si vous voulez travailler sur notre site web, vous devez vous
préparer à accueillir au moins 60 Mo de données sur votre disque dur. Ce
chiffre reflète l'état actuel de l'archive. Si vous reconstruisez
(accidentellement) toutes les pages, vous aurez au moins besoin du
double de place. Et si vous ne récupérez qu'une partie des sources, vous
aurez besoin de nettement moins d'espace, par exemple 18 Mo pour le
répertoire english/.</p>
<h3>Récupération partielle</h3>
<p>Beaucoup de personnes n'auront pas besoin de toute l'arborescence CVS
sous <code>webwml</code>, ce qui peut occasionner des fichiers manquants
et entraîner des erreurs à la compilation, au cas où un fichier
important a été ajouté et qu'on n'a pas fait de <kbd>cvs update</kbd>
dans le répertoire. Veuillez vérifier que vous avez bien tous les
fichiers nécessaires (comme les fichiers .wmlrc) avant de vous plaindre
à nous.</p>
<h3>Que sont ces lignes commençant par « # » ?</h3>
<p>Avec wml, les lignes commençant par « # » sont des
commentaires. Ils sont utilisés de préférence aux commentaires HTML, car
ils n'apparaissent pas dans le code produit.</p>
<p>Veuillez lire la page sur l'<a href="using_wml">utilisation de
WML</a> pour plus d'informations sur WML.</p>
<toc-add-entry name="etiquette">Consignes pour les éditeurs</toc-add-entry>
<h3>Puis-je modifier la version anglaise ?</h3>
<p>Cela dépend. Si vous voyez une petite erreur, comme une faute de
frappe, corrigez-la.
<p>Si vous vous rendez compte qu'une information est manquante, vous
pouvez aussi la corriger.
<p>Si vous pensez que quelque chose ne va pas et doit être réécrit,
dites-le sur debian-www afin que cela soit discuté. Nous serons
certainement d'accord avec vous.
<p>Si vous remarquez un problème dans un fichier modèle (c'est-à-dire un
fichier dans le répertoire webwml/english/template/debian), réfléchissez
à deux fois avant de le corriger, parce que les changements dans ces
fichiers entraînent souvent la reconstruction d'une grande partie du
site.
<h3>Quand on ajoute de nouveaux répertoires, ajoutez aussi le Makefile !</h3>
<p>Il faut faire attention quand on ajoute un nouveau répertoire au CVS.
Si le répertoire courant est indiqué dans ../Makefile, alors il
<b>faut</b> créer un Makefile dans ce répertoire ; sinon <tt>make</tt>
affichera un message d'erreur.</p>
<h3>Utilisez un anglais simple et clair</h3>
<p>Comme le site Debian est consulté par des personnes dont l'anglais
n'est pas la langue maternelle et est traduit dans d'autres langues,
il est préférable d'écrire avec un anglais simple et clair et d'éviter
l'argot, les idiomes ou du vieil anglais.</p>
<p>Si vous en utilisez néanmoins, ajoutez un commentaire au fichier
source expliquant le sens de la phrase.</p>
<h3>Cherchez le README dans les répertoires anglais</h3>
<p>Certains répertoires contiennent un fichier README qui peut vous
aider à comprendre comment ce répertoire est organisé. Il peut
fournir des informations utiles lorsqu'on travaille dans un tel
répertoire.</p>
<h3>Séparez les modifications dans le contenu des modifications dans la mise
en forme</h3>
<p>Réalisez toujours des rustines différentes ou des envois différents pour
les changements relatifs au contenu et les changements relevant de la mise en
page. Lorsque ces changements sont combinés, il est plus difficile pour les
traducteurs d'identifier les différences. En lançant un <kbd>cvs diff</kbd> sur
des changements qui contiennent les deux types de modifications, vous pourrez
vous rendre compte de l'ampleur du problème.</p>
<p>De manière générale, évitez les changements aléatoires de mise en
forme. Il ne faut pas modifier des parties existantes des pages pour
les rendre compatibles avec XHTML/XML et en même temps, apporter
d'autres modifications. Bien évidemment, les ajouts devraient dès
le départ être écrits proprement.</p>
<h3>Mettez également à jour les traductions si possible</h3>
<p>Certains changements sont indépendants de la langue utilisée dans le
fichier WML, comme des changements dans des URLs ou dans du code Perl
inclus. Corriger les erreurs typographique entre également dans la même
catégorie car les traducteurs ont pour habitude de les ignorer lors de
la traduction. Pour tous ces changements indépendants de la langue, vous
pouvez faire le même changement dans tous les fichiers traduits sans
connaître réellement les autres langues et incrémenter de manière
sécurisée la version dans les en-têtes translation-check.</p>
<p>Il n'est pas très difficile pour les traducteurs de faire le
même travail eux-mêmes et il peut être peu pratique pour les éditeurs
anglophones d'avoir un export complet sur lequel opérer. Cependant, nous
encourageons toujours les personnes à le faire pour éviter de demander à
deux douzaines de personnes de faire quelque chose qui pourrait être
rapidement fait par une seule personne.</p>
<p>De plus, pour rendre de telles modifications plus faciles à
appliquer, vous pouvez utiliser le script <code>smart_change.pl</code>
du répertoire de plus haut niveau dans le module CVS webwml.</p>
<h4>Utilisation de smart_change.pl</h4>
<pre>smart_change.pl [options] origfile</pre>
<p>Actuellement, seuls les fichiers de <code>/english/</code> sont
autorisés comme <var>origfile</var>. <code>smart_change.pl</code>
utilise les arguments suivants :</p>
<dl>
<dt><code>-s, --substitute=<var>REGEXP</var></code></dt>
<dd>Spécifie une expression rationnelle Perl à appliquer aux
fichiers source (peut être utilisée plusieurs fois).
<pre>
Exemple: ./smart_change.pl -s "s,http://oldurl/,http://newurl/,g"; english/index.wml
</pre>
</dd>
<dt><code>-l, --lang=<var>STRING</var></code></dt>
<dd>Traite la langue (peut être utilisé plusieurs fois). Si aucune
langue n'est spécifiée, toutes les langues disponibles sont
traitées.</dd>
<dt><code>-n, --no-bump</code></dt>
<dd>N'incrémente pas les numéros de version dans les en-têtes
translation-check. Normalement, le numéro de version de chaque en-tête
translation-check est incrémenté d'un dans les fichiers traduits
qui sont à jour et n'est pas modifié dans ceux qui ne sont pas à jour.
Si cette option est spécifiée, aucun en-tête translation-check
n'est modifié. Voir « Maintenir les traductions à jour »
pour une <a href="uptodate">explication sur les en-têtes
translation-check</a>.
</dd>
<dt><code>-p, --previous</code></dt>
<dd>Affiche la précédente révision CVS. Ceci est principalement
utile quand les fichiers anglais ont déjà été validés et que vous
voulez vérifier les en-têtes translation-check par rapport à la
version précédente.</dd>
<dt><code>-h, --help</code></dt>
<dd>Affiche un court message d'information sur l'utilisation.</dd>
<dt><code>-v, --verbose</code></dt>
<dd>Affiche des messages verbeux lors de l'exécution.</dd>
</dl>
<toc-add-entry name="links">Liens</toc-add-entry>
<h3>Ce lien ne semble pas marcher, dois-je le changer ?</h3>
<p>À cause de la façon dont les serveurs web sont configurés (utilisant
<a href="content_negotiation">la négociation de contenu</a>),
vous ne devriez pas avoir besoin de changer les liens du site.
En fait, nous vous suggérons de ne jamais le faire. Écrivez à debian-www
si vous pensez qu'un lien est cassé avant de le changer.</p>
<h3>Correction des liens</h3>
<p>Si vous trouvez un lien vers un site externe qui renvoie une
redirection (301, 302, redirection par <meta> ou une page indiquant
« <em>This page has moved.</em> »), merci de le signaler
sur debian-www.</p>
<p>Si vous trouvez un lien cassé (404, 403, ou une page qui n'est
manifestement pas celle indiquée dans le lien), veuillez le corriger et
en informer debian-www afin d'avertir les traducteurs. Ou alors corrigez
aussi le lien pour toutes les traductions, en faisant attention de
mettre à jour la ligne <code>#use wml::debian::translation-check</code>.</p>
<h3>Que sont ces fichiers truc.def et truc.data ?</h3>
<p>Afin de faciliter la maintenance des traductions, nous
séparons les parties génériques (données) du texte sur certaines pages.
Les traducteurs ne doivent copier et traduire que la partie textuelle,
les données seront ajoutées automatiquement.</p>
<p>Un exemple peut être utile à mieux comprendre ; plusieurs
fichiers sont nécessaires pour générer la liste des vendeurs dans
<code>CD/vendors</code> :</p>
<dl compact>
<dt><code>index.wml</code> :
<dd>Le texte en haut de la page sur les vendeurs est dans ce fichier.
Une traduction devrait être placée dans votre répertoire.
<dt><code>vendors.CD.def</code> :
<dd>Celui-ci contient tous les morceaux de texte qui sont nécessaires
à chaque entrée dans la liste. Les traductions sont mises dans le
fichier
<code><<var>langue</var>>/po/vendors.<var>xy</var>.po</code>.
<dt><code>vendors.CD</code> :
<dd>Ce fichier contient les données relatives aux vendeurs, qui
sont indépendantes de la langue, il ne doit donc pas être traduit.
</dl>
<p>Lorsqu'une des personnes derrière <email "cdvendors@debian.org">
ajoute un nouveau vendeur, elle l'ajoute dans <code>debiancd.db</code>,
fait la conversion au format WML dans le fichier <code>vendors.CD</code>
(avec le programme <code>getvendors.pl</code>), et ensuite laisse WML
et les Makefiles faire leur travail. Toutes les traductions seront
reconstruites à partir du texte actuellement traduit, mais avec les
données pour le nouveau vendeur (une mise à jour gratuite ! :-)</p>
<toc-add-entry name="newpage">Ajouter de nouvelles pages</toc-add-entry>
<p>Ajouter de nouvelles pages à Debian est assez facile. Tout le travail
consistant à mettre le bon en-tête et le bon pied de page est déjà fait
en utilisant WML. Tout ce que vous avez besoin de faire est d'inclure une
ligne telle que la suivante en haut d'un nouveau fichier :</p>
<pre><protect>
#use wml::debian::template title="TITRE DE LA PAGE"
</protect></pre>
<p>suivi du corps de la page. Toutes les pages devraient utiliser le
fichier modèle
<code>wml::debian::template</code> sauf si elles en utilisent un spécial
créé uniquement pour leur section, comme par exemple les pages des
nouvelles ou celle sur la sécurité.</p>
<p>Les modèles que nous utilisons vous permettent de définir certaines
variables qui affecteront les pages créées. Cela devrait éviter d'avoir
à créer des modèles différents pour chaque situation et permettre que
les améliorations soient plus faciles à mettre en ½uvre. Les variables
disponibles actuellement et leurs fonctions sont :</p>
<dl>
<dt>BARETITLE="true"
<dd>Supprime la partie « Debian GNU/Linux -- » qui est
habituellement ajoutée au début des balises <title>.
<dt>NOHEADER="true"
<dd>Enlève l'en-tête initial de la page. Un en-tête spécial
peut, bien entendu, être inclus dans le corps.
<dt>NOMIRRORS="true"
<dd>Enlève la liste des miroirs de la page. Il n'est
généralement pas recommandé de l'utiliser, à part pour quelques
pages.
<dt>NOHOMELINK="true"
<dd>Enlève le lien en bas de la page qui permet de revenir
à la page Debian principale.
<dt>NOLANGUAGES="true"
<dd>Enlève les liens en bas de la page vers les versions dans
d'autres langues.
<dt>GEN_TIME="true"
<dd>Met dans le fichier résultat la date de génération du
fichier au lieu de la date de modification du fichier source.
<dt>NOCOPYRIGHT="true"
<dd>Enlève la note de copyright en bas de la page.
</dl>
<p>Notez que vous pouvez utiliser n'importe quelle chaîne de caractères
dans ces variables: « true », « yes »,
« foo », cela ne change rien.</p>
<p>Un exemple d'utilisation de tout cela se trouve dans les pages sur
les portages qui ont leurs propres en-têtes ;
<code>ports/arm/index.wml</code> utilise :</p>
<pre><protect>
#use wml::debian::template title="Portage ARM" NOHEADER="yes"
</protect></pre>
<p>Si vous voulez faire quelque chose qui ne peut être fait en utilisant
les modèles existants, envisagez d'abord d'étendre l'un d'entre eux.
S'il n'est pas possible d'étendre l'un d'eux d'une manière compatible
avec l'existant, essayez de vous arranger pour que le nouveau modèle
soit un sur-ensemble d'un modèle existant de façon à ce que les pages
puissent être converties à lui lors du passage à la prochaine version
majeure (avec un peu de chance jamais plus de tous les 6 mois).</p>
<p>Si vous créez une page qui est générée par un script ou qui contient
peu de texte, envisagez d'utiliser les balises <gettext> pour
faciliter la maintenance des traductions.</p>
<toc-add-entry name="newdir">Ajouter un nouveau répertoire</toc-add-entry>
<p>Note : <strong>ne pas</strong> créer de répertoire ayant pour nom
<code>install</code>. Cela dérange <code>make</code> et les pages de ce
répertoire ne seront pas mises à jour automatiquement.</p>
<p>Ci-dessous se trouve un exemple d'ajout de nouveau répertoire au site
web.</p>
<pre>
mkdir foo
cvs add foo
cd foo
cp ../intro/Makefile .
cvs add Makefile
</pre>
<p>Éditez le Makefile dans le répertoire parent et ajoutez le répertoire
que vous venez de créer à la variable <code>SUBS</code>. Cela ajoutera
ce répertoire lors de la prochaine compilation quand make est lancé.</p>
<p>Enfin, enregistrez tous les changements effectués avec</p>
<pre>
cvs commit Makefile foo
</pre>
Reply to: