Gentoo Archives: gentoo-commits

From: "Marion Age (titefleur)" <titefleur@g.o>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] gentoo commit in xml/htdocs/doc/fr: xml-guide.xml
Date: Tue, 06 Nov 2007 12:39:01
Message-Id: E1IpNhh-0004o0-Et@stork.gentoo.org
1 titefleur 07/11/06 12:38:49
2
3 Modified: xml-guide.xml
4 Log:
5 Sync to 1.67
6
7 Revision Changes Path
8 1.48 xml/htdocs/doc/fr/xml-guide.xml
9
10 file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/fr/xml-guide.xml?rev=1.48&view=markup
11 plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/fr/xml-guide.xml?rev=1.48&content-type=text/plain
12 diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/fr/xml-guide.xml?r1=1.47&r2=1.48
13
14 Index: xml-guide.xml
15 ===================================================================
16 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/fr/xml-guide.xml,v
17 retrieving revision 1.47
18 retrieving revision 1.48
19 diff -u -r1.47 -r1.48
20 --- xml-guide.xml 27 May 2006 14:05:40 -0000 1.47
21 +++ xml-guide.xml 6 Nov 2007 12:38:48 -0000 1.48
22 @@ -1,12 +1,12 @@
23 -<?xml version="1.0" encoding="UTF-8"?>
24 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/fr/xml-guide.xml,v 1.47 2006/05/27 14:05:40 neysx Exp $ -->
25 +<?xml version="1.0" encoding="UTF-8"?>
26 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/fr/xml-guide.xml,v 1.48 2007/11/06 12:38:48 titefleur Exp $ -->
27 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
28
29 -<guide link="/doc/fr/xml-guide.xml" lang="fr">
30 +<guide>
31 <title>Manuel du Guide XML de Gentoo</title>
32
33 <author title="Auteur, Traducteur">
34 - <mail link="neysx@g.o">Xavier Neys</mail>
35 + <mail link="neysx"/>
36 </author>
37 <author title="Auteur">
38 <mail link="drobbins@g.o">Daniel Robbins</mail>
39 @@ -24,6 +24,9 @@
40 <author title="Traducteur">
41 <mail link="koppatroopa@×××××.fr">Bertrand Coppa</mail>
42 </author>
43 +<author title="Traducteur">
44 + <mail link="titefleur"/>
45 +</author>
46
47 <abstract>
48 Ce guide vous montre comment écrire de la documentation Web en utilisant la
49 @@ -37,8 +40,8 @@
50 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
51 <license/>
52
53 -<version>7</version>
54 -<date>2006-05-11</date>
55 +<version>8</version>
56 +<date>2007-10-04</date>
57
58 <chapter>
59 <title>Introduction à Guide XML</title>
60 @@ -74,7 +77,7 @@
61 documentaliste</uri> qui explique notamment comment transformer les documents
62 Guide XML en html.
63 </p>
64 -
65 +
66 <p>
67 Cela peut aussi vous intéresser de lire <uri link="?passthru=1">la source
68 XML</uri> de ce document.
69 @@ -129,16 +132,18 @@
70 sera mise à jour automatiquement par le serveur CVS et permet de suivre les
71 différentes révisions de chaque document. Juste après, il y a une balise
72 <c>&lt;guide&gt;</c>, l'intégralité du document étant comprise entre les
73 -balises <c>&lt;guide&gt;</c> et <c>&lt;/guide&gt;</c>. L'attribut <c>link</c>
74 -est obligatoire et doit normalement contenir le chemin absolu du document
75 -relativement à la racine du serveur web, bien que le nom du fichier seul
76 -fonctionne. Cet attribut est principalement utilisé pour générer un lien vers
77 -une version imprimable de votre document. Si vous mettez une valeur incorrecte,
78 -le lien vers la version imprimable ne marchera pas, ou alors il pointera vers
79 -un autre document. Les documents traduits <e>doivent</e> spécifier le chemin
80 -entier, car cela sert aussi à vérifier si une version plus récente du document
81 -existe. L'attribut <c>lang</c> spécifie le code de la langue utilisée dans
82 -votre document. Il est utilisé pour formater la date et insérer des chaînes de
83 +balises <c>&lt;guide&gt;</c> et <c>&lt;/guide&gt;</c>.
84 +<br />
85 +L'attribut <c>link</c> est optionnel et doit normalement contenir le chemin
86 +absolu du document relativement à la racine du serveur web, bien que le nom du
87 +fichier seul fonctionne. Cet attribut est uniquement utilisé pour générer un
88 +lien vers une version imprimable de votre document et vérifier que la
89 +traduction est à jour. Notre moteur XSL passe le chemin actuel à notre feuille
90 +de style XSL. L'attribut <c>link</c> n'est utilisé qu'en solution de repli dans
91 +le cas où le XML est traité par d'autres moyens.
92 +<br />
93 +L'attribut <c>lang</c> spécifie le code de la langue utilisée dans votre
94 +document. Il est utilisé pour formater la date et insérer des chaînes de
95 caractères telles que «&nbsp;Note&nbsp;», «&nbsp;Contenu&nbsp;», etc. dans la
96 langue spécifiée. La langue par défaut est l'anglais.
97 </p>
98 @@ -156,8 +161,7 @@
99 etc.) Dans cet exemple particulier, le nom de l'auteur est compris dans une
100 autre balise, une balise <c>&lt;mail&gt;</c> qui spécifie une adresse de
101 courrier pour cette personne. La balise <c>&lt;mail&gt;</c> est optionnelle. De
102 -plus, il n'est pas nécessaire d'avoir plus d'un élément <c>&lt;author&gt;</c>
103 -par document.
104 +plus, au moins un élément <c>&lt;author&gt;</c> est requis par document.
105 </p>
106
107 <p>
108 @@ -169,7 +173,7 @@
109 </p>
110
111 <p>
112 -Nous avons maintenant fait le tour des balises qui doivent apparaître au début
113 +Nous avons maintenant récapitulé les balises qui doivent apparaître au début
114 d'un document guide. Hormis <c>&lt;title&gt;</c> et <c>&lt;mail&gt;</c>, ces
115 balises ne devraient pas apparaître ailleurs, excepté immédiatement après la
116 balise <c>&lt;guide&gt;</c> et, pour être cohérent, il est recommandé (mais ce
117 @@ -225,10 +229,10 @@
118 </p>
119
120 <note>
121 -Un élément <c>&lt;guide&gt;</c> peut contenir plusieurs éléments
122 -<c>&lt;chapter&gt;</c>, et un élément <c>&lt;chapter&gt;</c> peut contenir
123 -plusieurs éléments <c>&lt;section&gt;</c>, mais un élément
124 -<c>&lt;section&gt;</c> ne peut contenir qu'un élément <c>&lt;body&gt;</c>.
125 +Un élément <c>&lt;guide&gt;</c> doit contenir au moins un élément
126 +<c>&lt;chapter&gt;</c>, un élément <c>&lt;chapter&gt;</c> doit contenir au
127 +moins un élément <c>&lt;section&gt;</c> et un élément <c>&lt;section&gt;</c>
128 +doit contenir au moins un élément <c>&lt;body&gt;</c>.
129 </note>
130
131 </body>
132 @@ -356,18 +360,17 @@
133 contient la signature de l'auteur.
134 </p>
135
136 -
137 <pre caption="Petit épigraphe">
138 &lt;p by="Étudiant anonyme"&gt;
139 Les délégués des 13 états originaux ont formé...
140 &lt;/p&gt;
141 </pre>
142 -
143 +
144 </body>
145 </section>
146 <section>
147 <title>
148 - &lt;path&gt;, &lt;c&gt;, &lt;b&gt;, &lt;e&gt;, &lt;sub&gt; and &lt;sup&gt;
149 + &lt;path&gt;, &lt;c&gt;, &lt;b&gt;, &lt;e&gt;, &lt;sub&gt; et &lt;sup&gt;
150 </title>
151 <body>
152
153 @@ -496,22 +499,36 @@
154 <p>
155 Nous avons déja parlé de la balise <c>&lt;mail&gt;</c> plus tôt. Elle est
156 utilisée pour lier un texte avec une adresse de courrier et a la forme
157 -<c>&lt;mail link="foo@×××.com"&gt;Mr. Foo Bar&lt;/mail&gt;</c>. Si vous voulez
158 -afficher l'adresse, vous pouvez utiliser
159 -<c>&lt;mail&gt;foo@×××.com&lt;/mail&gt;</c>, cela sera affiché comme
160 -ceci&nbsp;: <mail>foo@×××.com</mail>.
161 +<c>&lt;mail link="foo.bar@×××××××.com"&gt;Mr. Foo Bar&lt;/mail&gt;</c>. Si vous
162 +voulez afficher l'adresse, vous pouvez utiliser
163 +<c>&lt;mail&gt;foo.bar@×××××××.com&lt;/mail&gt;</c>, cela sera affiché comme
164 +ceci&nbsp;: <mail>foo.bar@×××××××.com</mail>.
165 +</p>
166 +
167 +<p>
168 +Les formes courtes rendent plus facile l'utilisation des noms et adresses pour
169 +les développeurs Gentoo. Les formes <c>&lt;mail&gt;neysx&lt;/mail&gt;</c> et
170 +<c>&lt;mail link="neysx"/&gt;</c> afficheront <mail>neysx</mail>. Si vous
171 +voulez utiliser une adresse d'un développeur Gentoo avec un autre contenu que
172 +son nom complet, utilisez la seconde forme avec le contenu désiré. Par exemple,
173 +pour obtenir le prénom d'un développeur&nbsp;: <c>&lt;mail
174 +link="neysx"&gt;Xavier&lt;/mail&gt;</c> s'affichera comme <mail
175 +link="neysx">Xavier</mail>.
176 +<br/>
177 +Ceci est particulièrement utile si vous voulez nommer un développeur dont le
178 +nom contient quelques caractères exotiques que vous ne pouvez pas écrire.
179 </p>
180
181 <p>
182 La balise <c>&lt;uri&gt;</c> est utilisée pour pointer vers des
183 fichiers/emplacements sur Internet. Elle a deux formes. La première peut être
184 utilisée quand vous voulez que l'URI s'affiche, comme ce lien vers
185 -<uri>http://forums.gentoo.org</uri>. Pour créer ce lien, j'ai tapé
186 -<c>&lt;uri&gt;http://forums.gentoo.org&lt;/uri&gt;</c>. L'autre forme est utile
187 +<uri>http://forums.gentoo.org/</uri>. Pour créer ce lien, j'ai tapé
188 +<c>&lt;uri&gt;http://forums.gentoo.org/&lt;/uri&gt;</c>. L'autre forme est utile
189 quand vous voulez associer un URI avec un autre texte quelconque&nbsp;; par
190 -exemple <uri link="http://forums.gentoo.org">le forum de Gentoo</uri>. Pour
191 +exemple <uri link="http://forums.gentoo.org/">le forum de Gentoo</uri>. Pour
192 créer <e>ce</e> lien, j'ai tapé <c>&lt;uri
193 -link="http://forums.gentoo.org"&gt;le forum de Gentoo&lt;/uri&gt;</c>. Ce n'est
194 +link="http://forums.gentoo.org/"&gt;le forum de Gentoo&lt;/uri&gt;</c>. Ce n'est
195 pas la peine d'écrire <c>http://www.gentoo.org/</c> lorsque vous faites un lien
196 vers une page du site de Gentoo. Par exemple, pour faire un lien vers l'<uri
197 link="/doc/fr/index.xml">index de la documentation</uri>, vous n'avez qu'à
198 @@ -519,7 +536,20 @@
199 documentation&lt;/uri&gt;</c>. Vous pouvez même ne pas indiquer
200 <c>index.xml</c> si vous faites un lien vers l'index d'un répertoire.
201 Exemple&nbsp;: <c>&lt;uri link="/doc/fr/"&gt;index de la
202 -documentation&lt;/uri&gt;</c>.
203 +documentation&lt;/uri&gt;</c>. Le fait de laisser la barre oblique finale permet
204 +de gagner une requête HTTP.
205 +</p>
206 +
207 +<p>
208 +Vous ne devriez pas utiliser l'élément <c>&lt;uri&gt;</c> avec un attribut
209 +<c>link</c> qui commence par <c>mailto:</c>. Dans ce cas, utilisez l'élément
210 +<c>&lt;mail&gt;</c>.
211 +</p>
212 +
213 +<p>
214 +Veuillez éviter <uri link="http://en.wikipedia.org/wiki/Click_here">le syndrôme
215 +du cliquez ici</uri> comme le recommande le <uri
216 +link="http://www.w3.org/QA/Tips/noClickHere">W3C</uri>.
217 </p>
218
219 </body>
220 @@ -545,10 +575,10 @@
221 <body>
222
223 <p>
224 -Guide contient une syntaxe de tableau simplifiée et similaire à celle du HTML.
225 -Pour commencer un tableau, utilisez une balise <c>&lt;table&gt;</c>. Commencez
226 -une ligne avec une balise <c>&lt;tr&gt;</c>. Toutefois, pour insérer des
227 -données dans le tableau, Guide ne supporte <e>pas</e> la balise HTML
228 +Guide XML contient une syntaxe de tableau simplifiée et similaire à celle du
229 +HTML. Pour commencer un tableau, utilisez une balise <c>&lt;table&gt;</c>.
230 +Commencez une ligne avec une balise <c>&lt;tr&gt;</c>. Toutefois, pour insérer
231 +des données dans le tableau, Guide XML ne supporte <e>pas</e> la balise HTML
232 &lt;td&gt;. À la place, utilisez <c>&lt;th&gt;</c> si vous voulez insérer un
233 en-tête ou <c>&lt;ti&gt;</c> si vous insérez de l'information normale. Vous
234 pouvez utiliser <c>&lt;th&gt;</c> partout où <c>&lt;ti&gt;</c> est
235 @@ -602,7 +632,7 @@
236 <section>
237 <title>Listes</title>
238 <body>
239 -
240 +
241 <p>
242 Pour créer des listes, ordonnées ou pas, utilisez simplement des balises
243 similaires à celles de XHTML&nbsp;: <c>&lt;ol&gt;</c>, <c>&lt;ul&gt;</c> et
244 @@ -739,8 +769,8 @@
245 &lt;?xml version="1.0" encoding="UTF-8"?&gt;
246 &lt;!DOCTYPE guide SYSTEM "/dtd/guide.dtd"&gt;
247 &lt;!-- &#36;Header&#36; --&gt;
248 -
249 -&lt;guide link="/doc/fr/gentoo-x86-install.xml" disclaimer="obsolete" redirect="/doc/fr/handbook/handbook-x86.xml"&gt;
250 +
251 +&lt;guide disclaimer="obsolete" redirect="/doc/fr/handbook/handbook-x86.xml"&gt;
252 &lt;title>Guide d'installation Gentoo pour x86&lt;/title&gt;
253
254 &lt;author title="Auteur"&gt;
255 @@ -748,9 +778,324 @@
256 </pre>
257 </body>
258 </section>
259 +<section>
260 +<title>Les FAQs</title>
261 +<body>
262 +
263 +<p>
264 +Les documents FAQ doivent commencer avec une liste de questions avec un lien
265 +vers leur réponse respective. La création d'une telle liste est à la fois longue
266 +et source d'erreurs. La lisye peut être créée automatiquement si vous utilisez
267 +un élément <c>faqindex</c> comme premier chapitre du document. Cet élément a la
268 +même structure qu'un élément <c>chapter</c> afin de permettre les textes
269 +d'introduction. La structure du document est faite pour être découpée en
270 +chapitres (au moins un chapitre) contenant des sections, chaque section
271 +contenant une question spécifiée dans son élément <c>title</c> avec la réponse
272 +dans son élément <c>body</c>. L'index de la FAQ apparaitra comme une section par
273 +chapitre avec un lien par question.
274 +</p>
275 +
276 +<p>
277 +Un coup d'oeil rapide à une <uri link="/doc/fr/faq.xml">FAQ</uri> et à <uri
278 +link="/doc/fr/faq.xml?passthru=1">sa source</uri> devrait rendre cette
279 +explication comme une évidence.
280 +</p>
281 +
282 +</body>
283 +</section>
284 </chapter>
285
286 <chapter>
287 +<title>Le format du Manuel</title>
288 +<section>
289 +<title>Différences entre Guide et Book</title>
290 +<body>
291 +
292 +<p>
293 +Le format actuel ne permettait pas de produire des documents plus volumineux
294 +tels que le <uri link="/doc/fr/handbook/handbook-x86.xml?part=1">manuel
295 +d'installation</uri>. Le format GuideXML a donc été étendu pour permettre la
296 +rédaction de documents sur plusieurs pages.
297 +</p>
298 +
299 +</body>
300 +</section>
301 +<section>
302 +<title>Fichier principal</title>
303 +<body>
304 +
305 +<p>
306 +La première étape est de créer un document «&nbsp;maître&nbsp;» qui ne contient
307 +que très peu de texte, mais qui relie les différents documents. Sa syntaxe est
308 +très proche de GuideXML&nbsp;:
309 +</p>
310 +
311 +<pre caption="Exemple d'utilisation du type « book »">
312 +&lt;?xml version='1.0' encoding='UTF-8'?&gt;
313 +&lt;!DOCTYPE book SYSTEM "/dtd/book.dtd"&gt;
314 +&lt;!-- &#36;Header&#36; --&gt;
315 +
316 +&lt;<i>book</i>&gt;
317 +&lt;title&gt;Exemple d'utilisation du type « book »&lt;/title&gt;
318 +
319 +&lt;author...&gt;
320 + ...
321 +&lt;/author&gt;
322 +
323 +&lt;abstract&gt;
324 + ...
325 +&lt;/abstract&gt;
326 +
327 +&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
328 +&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt;
329 +&lt;license/&gt;
330 +
331 +&lt;version&gt;...&lt;/version&gt;
332 +&lt;date&gt;...&lt;/date&gt;
333 +</pre>
334 +
335 +<p>
336 +Jusqu'ici, la seule différence avec un document normal est que l'élément
337 +<c>&lt;book&gt;</c> remplace <c>&lt;guide&gt;</c>. Ensuite, au lieu de définir
338 +un chapitre avec un élément <c>&lt;chapter&gt;</c>, il faut définir une partie
339 +avec un élément <c>&lt;part&gt;</c>&nbsp;:
340 +</p>
341 +
342 +<pre caption="Définir une partie">
343 +&lt;part&gt;
344 +&lt;title&gt;Première partie&lt;/title&gt;
345 +&lt;abstract&gt;
346 + ...
347 +&lt;/abstract&gt;
348 +
349 +<comment>(Les chapitres suivent)</comment>
350 +&lt;/part&gt;
351 +</pre>
352 +
353 +<p>
354 +Chaque partie doit contenir un titre (élément <c>&lt;title&gt;</c>) et un
355 +résumé (élément <c>&lt;abstract&gt;</c> qui permet d'introduire brièvement la
356 +partie en question.
357 +</p>
358 +
359 +<p>
360 +Chaque partie contient des chapitres (éléments <c>&lt;chapter&gt;</c>). Chaque
361 +chapitre <e>doit</e> être dans un fichier séparé. Vous ne serez donc pas
362 +surpris d'apprendre qu'un élément <c>&lt;include&gt;</c> permet d'indiquer le
363 +nom du fichier qui contient le chapitre.
364 +</p>
365 +
366 +<pre caption="Définir un chapitre">
367 +&lt;chapter&gt;
368 +&lt;title&gt;Chapitre 1&lt;/title&gt;
369 +&lt;abstract&gt;
370 + Ceci est un court résumé du chapitre.
371 +&lt;/abstract&gt;
372 +
373 + &lt;include href="chemin/vers/chapter-one.xml"/&gt;
374 +
375 +&lt;/chapter&gt;
376 +</pre>
377 +
378 +</body>
379 +</section>
380 +<section>
381 +<title>Designing the Individual Chapters</title>
382 +<body>
383 +
384 +<p>
385 +The content of an individual chapter is structured as follows:
386 +</p>
387 +
388 +<pre caption="Syntaxe d'un chapitre">
389 +&lt;?xml version='1.0' encoding='UTF-8'?&gt;
390 +&lt;!DOCTYPE sections SYSTEM "/dtd/book.dtd"&gt;
391 +&lt;!-- &#36;Header&#36; --&gt;
392 +
393 +&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
394 +&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt;
395 +
396 +&lt;sections&gt;
397 +
398 +&lt;abstract&gt;
399 +Ceci est une petite explication du premier chapitre.
400 +&lt;/abstract&gt;
401 +
402 +&lt;version&gt;...&lt;/version&gt;
403 +&lt;date&gt;...&lt;/date&gt;
404 +
405 +<comment>(Définir des éléments &lt;section&gt; et &lt;subsection&gt;)</comment>
406 +
407 +&lt;/sections&gt;
408 +</pre>
409 +
410 +<p>
411 +Chaque chapitre contient des éléments <c>&lt;section&gt;</c> (l'équivalent d'un
412 +élément <c>&lt;chapter&gt;</c> de GuideXML) et des éléments
413 +<c>&lt;subsection&gt;</c> (l'équivalent d'un élément <c>&lt;section&gt;</c> de
414 +GuideXML).
415 +</p>
416 +
417 +<p>
418 +Chaque chapitre doit avoir ses propres éléments date et version. La date la plus
419 +récente parmi tous les documents principaux et les documents de chapitres sera
420 +affichée lorsqu'un utilisateur visite une quelconque partie du manuel.
421 +</p>
422 +
423 +</body>
424 +</section>
425 +</chapter>
426 +
427 +<chapter>
428 +<title>Fonctionnalités avancées du Manuel</title>
429 +<section>
430 +<title>Valeurs globales</title>
431 +<body>
432 +
433 +<p>
434 +Quelques fois, les mêmes valeurs sont répétées plusieurs fois dans plusieurs
435 +parties d'un manuel. Les opérations de recherche global et de remplacement ont
436 +tendance à oublier quelques itérations ou mènent et des changements
437 +involontaires. De plus, il peut être utile de définir des valeurs différentes
438 +qui pourront être partagées dans des chapitres différents, selon le manuel qui
439 +inclut le chapitre.
440 +</p>
441 +
442 +<p>
443 +Les valeurs globales peuvent être définies dans le fichier maître d'un manuel et
444 +utilisées dans tous les chapitres inclus.
445 +</p>
446 +
447 +<p>
448 +Pour définir des valeurs globales, ajoutez un élément <c>&lt;values&gt;</c> dans
449 +le fichier principal du manuel. Chaque valeur est alors définie dans un élément
450 +<c>&lt;key&gt;</c> dans lequel l'attribut <c>id</c> identifie la valeur, c-à-d.
451 +le nom de la variable. Le contenu de l'élément <c>&lt;key&gt;</c> est sa valeur.
452 +</p>
453 +
454 +<p>
455 +L'exemple suivant définit trois valeurs dans le fichier principal d'un
456 +manuel&nbsp;:
457 +</p>
458 +
459 +<pre caption="Définir des valeurs dans un manuel">
460 +&lt;?xml version='1.0' encoding='UTF-8'?&gt;
461 +&lt;!DOCTYPE book SYSTEM "/dtd/book.dtd"&gt;
462 +&lt;!-- &#36;Header&#36; --&gt;
463 +
464 +&lt;book&gt;
465 +&lt;title&gt;Exemple d'utilisation du book&lt;/title&gt;
466 +
467 +<i>&lt;values>
468 +&lt;key id="arch"&gt;x86&lt;/key&gt;
469 +&lt;key id="min-cd-name"&gt;install-x86-minimal-2007.0-r1.iso&lt;/key&gt;
470 +&lt;key id="min-cd-size"&gt;57&lt;/key&gt;
471 +&lt;/values&gt;</i>
472 +
473 +&lt;author...&gt;
474 +...
475 +&lt;/author&gt;
476 +
477 +...
478 +</pre>
479 +
480 +<p>
481 +Les valeurs définies peuvent alors être utilisées tout au long du manuel avec
482 +l'élément en ligne <c>&lt;keyval id="key_id"/&gt;</c>. Le fait de spécifier le
483 +nom de la clef dans son attribut <c>id</c>, par exemple &lt;keyval
484 +id="min-cd-name"/&gt; la remplacera par "install-x86-minimal-2007.0-r1.iso" dans
485 +notre exemple.
486 +</p>
487 +
488 +<pre caption="Utilisation des valeurs définies">
489 +&lt;p&gt;
490 +L'image du CD d'installation Minimal s'appelle &lt;c&gt;<i>&lt;keyval
491 +id="min-cd-name"/&gt;</i>&lt;/c&gt; et ne pèse que <i>&lt;keyval
492 +id="min-cd-size"/&gt;</i> Mo. Une connexion à Internet est nécessaire. Vous
493 +pouvez utiliser ce CD d'installation pour installer Gentoo mais
494 +&lt;e&gt;seulement&lt;/e&gt; si vous disposez d'une connexion à Internet.
495 +&lt;/p&gt;
496 +</pre>
497 +
498 +<p>
499 +Pour rendre la vie plus facile à nos traducteurs, n'utilisez seulement que de
500 +vraies valeurs, c-à-d. dont le contenu n'a pas besoin d'être traduit. Par
501 +exemple, nous avons défini la valeur <c>min-cd-size</c> à <c>57</c> et non à
502 +<c>57 MB</c>.
503 +</p>
504 +
505 +</body>
506 +</section>
507 +<section>
508 +<title>Éléments conditionnels</title>
509 +<body>
510 +
511 +<p>
512 +Les chapitres qui sont utilisés par plusieurs manuels comme nos <uri
513 +link="/doc/fr/handbook/">Manuels d'installation</uri> ont souvent des petites
514 +différences en fonction du manuel qui les inclut. Au lieu d'ajouter du contenu
515 +sans rapport avec plusieurs manuels, les auteurs peuvent ajouter une condition
516 +aux élements suivants&nbsp;: <c>&lt;section&gt;</c>, <c>&lt;subsection&gt;</c>,
517 +<c>&lt;body&gt;</c>, <c>&lt;note&gt;</c>, <c>&lt;impo&gt;</c>,
518 +<c>&lt;warn&gt;</c>, <c>&lt;pre&gt;</c>, <c>&lt;p&gt;</c>,
519 +<c>&lt;table&gt;</c>, <c>&lt;tr&gt;</c>, <c>&lt;ul&gt;</c>, <c>&lt;ol&gt;</c>
520 +et <c>&lt;li&gt;</c>.
521 +</p>
522 +
523 +<p>
524 +La condition doit être une expression <uri
525 +link="http://fr.wikipedia.org/wiki/XPath">XPATH</uri> qui sera évaluée lors de
526 +la transformation du XML. Si celle-ci est évaluée à <c>vrai</c>, l'élément est
527 +traité, sinon, il est ignoré. La condition est spécifiée dans un attribut
528 +<c>test</c>.
529 +</p>
530 +
531 +<p>
532 +L'exemple suivant utilise la valeur <c>arch</c> qui est définie dans chaque
533 +fichier principal de manuel pour conditionner du contenu&nbsp;:
534 +</p>
535 +
536 +<pre caption="Utilisation des éléments conditionnels">
537 +&lt;body test="contains('AMD64 x86',func:keyval('arch'))"&gt;
538 +
539 +&lt;p&gt;
540 +Ce paragraphe s'applique aux architectures x86 et AMD64.
541 +&lt;/p&gt;
542 +
543 +&lt;p test="func:keyval('arch')='x86'"&gt;
544 +Ce paragraphe ne s'applique qu'aux architectures x86.
545 +&lt;/p&gt;
546 +
547 +&lt;p test="func:keyval('arch')='AMD64'"&gt;
548 +Ce paragraphe ne s'applique qu'aux architectures AMD64.
549 +&lt;/p&gt;
550 +
551 +&lt;p test="func:keyval('arch')='PPC'"&gt;
552 +Ce paragraphe ne s'affichera jamais&nbsp;!
553 +Le corps complet est zappé à cause de la première condition.
554 +&lt;/p&gt;
555 +
556 +&lt;/body&gt;
557 +
558 +&lt;body test="contains('AMD64 PPC64',func:keyval('arch'))"&gt;
559 +
560 +&lt;p&gt;
561 +Celui-ci s'applique aux architectures AMD64, PPC64 <comment>et PPC</comment> à
562 +cause de la chaîne 'AMD64 PPC64' qui contient 'PPC'.
563 +&lt;/p&gt;
564 +
565 +&lt;note test="func:keyval('arch')='AMD64' or func:keyval('arch')='PPC64'"&gt;
566 +Cette note ne s'applique qu'aux architectures AMD64 et PPC64.
567 +&lt;/note&gt;
568 +
569 +&lt;/body&gt;
570 +</pre>
571 +
572 +</body>
573 +</section>
574 +</chapter>
575 +
576 +<chapter id="codingstyle">
577 <title>Style d'écriture</title>
578 <section>
579 <title>Introduction</title>
580 @@ -843,8 +1188,9 @@
581 </pre>
582
583 <p>
584 -Les <b>attributs</b> doivent être définis sans espace entre le nom de l'attribut,
585 -le signe «&nbsp;=&nbsp;» et la valeur de l'attribut. Voici un exemple&nbsp;:
586 +Les <b>attributs</b> doivent être définis sans espace entre le nom de
587 +l'attribut, le signe «&nbsp;=&nbsp;» et la valeur de l'attribut. Voici un
588 +exemple&nbsp;:
589 </p>
590
591 <pre caption="Attributs">
592 @@ -859,10 +1205,11 @@
593 <body>
594
595 <p>
596 -À l'intérieur des tables (<c>&lt;table&gt;</c>) et des listes (<c>&lt;ul&gt;</c>,
597 -<c>&lt;ol&gt;</c> et <c>&lt;dl&gt;</c>), des points («&nbsp;.&nbsp;») ne
598 -devraient être utilisés que si plusieurs phrases apparaissent. Dans ce cas, le
599 -point ou tout autre signe de ponctuation sont autorisés.
600 +À l'intérieur des tables (<c>&lt;table&gt;</c>) et des listes
601 +(<c>&lt;ul&gt;</c>, <c>&lt;ol&gt;</c> et <c>&lt;dl&gt;</c>), des points
602 +(«&nbsp;.&nbsp;») ne devraient être utilisés que si plusieurs phrases
603 +apparaissent. Dans ce cas, le point ou tout autre signe de ponctuation sont
604 +autorisés.
605 </p>
606
607 <note>
608 @@ -910,149 +1257,13 @@
609 </section>
610 </chapter>
611 <chapter>
612 -<title>Format du manuel</title>
613 -<section>
614 -<title>Différences entre Guide et Book</title>
615 -<body>
616 -
617 -<p>
618 -Le format actuel ne permettait pas de produire des documents plus volumineux
619 -tels que le <uri link="/doc/fr/handbook/handbook-x86.xml?part=1">manuel
620 -d'installation</uri>. Le format GuideXML a donc été étendu pour permettre la
621 -rédaction de documents sur plusieurs pages.
622 -</p>
623 -
624 -</body>
625 -</section>
626 -<section>
627 -<title>Fichier principal</title>
628 -<body>
629 -
630 -<p>
631 -La première étape est de créer un document «&nbsp;maître&nbsp;» qui ne contient
632 -que très peu de texte, mais qui relie les différents documents. Sa syntaxe est
633 -très proche de GuideXML&nbsp;:
634 -</p>
635 -
636 -<pre caption="Exemple d'utilisation du type « book »">
637 -&lt;?xml version='1.0' encoding='UTF-8'?&gt;
638 -&lt;!DOCTYPE book SYSTEM "/dtd/book.dtd"&gt;
639 -&lt;!-- &#36;Header&#36; --&gt;
640 -
641 -&lt;<i>book</i> link="example.xml"&gt;
642 -&lt;title&gt;Exemple d'utilisation du type « book »&lt;/title&gt;
643 -
644 -&lt;author...&gt;
645 - ...
646 -&lt;/author&gt;
647 -
648 -&lt;abstract&gt;
649 - ...
650 -&lt;/abstract&gt;
651 -
652 -&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
653 -&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt;
654 -&lt;license/&gt;
655 -
656 -&lt;version&gt;...&lt;/version&gt;
657 -&lt;date&gt;...&lt;/date&gt;
658 -</pre>
659 -
660 -<p>
661 -Jusqu'ici, la seule différence avec un document normal est que l'élément
662 -<c>&lt;book&gt;</c> remplace <c>&lt;guide&gt;</c>. Ensuite, au lieu de définir
663 -un chapitre avec un élément <c>&lt;chapter&gt;</c>, il faut définir une partie
664 -avec un élément <c>&lt;part&gt;</c>&nbsp;:
665 -</p>
666 -
667 -<pre caption="Définir une partie">
668 -&lt;part&gt;
669 -&lt;title&gt;Première partie&lt;/title&gt;
670 -&lt;abstract&gt;
671 - ...
672 -&lt;/abstract&gt;
673 -
674 -<comment>(Les chapitres suivent)</comment>
675 -&lt;/part&gt;
676 -</pre>
677 -
678 -<p>
679 -Chaque partie doit contenir un titre (élément <c>&lt;title&gt;</c>) et un
680 -résumé (élément <c>&lt;abstract&gt;</c> qui permet d'introduire brièvement la
681 -partie en question.
682 -</p>
683 -
684 -<p>
685 -Chaque partie contient des chapitres (éléments <c>&lt;chapter&gt;</c>). Chaque
686 -chapitre <e>doit</e> être dans un fichier séparé. Vous ne serez donc pas
687 -surpris d'apprendre qu'un élément <c>&lt;include&gt;</c> permet d'indiquer le
688 -nom du fichier qui contient le chapitre.
689 -</p>
690 -
691 -<pre caption="Définir un chapitre">
692 -&lt;chapter&gt;
693 -&lt;title&gt;Chapitre 1&lt;/title&gt;
694 -&lt;abstract&gt;
695 - Ceci est un court résumé du chapitre.
696 -&lt;/abstract&gt;
697 -
698 - &lt;include href="chemin/vers/chapter-one.xml"/&gt;
699 -
700 -&lt;/chapter&gt;
701 -</pre>
702 -
703 -</body>
704 -</section>
705 -<section>
706 -<title>Rédiger les chapitres</title>
707 -<body>
708 -
709 -<p>
710 -Le contenu de chaque chapitre est structuré comme suit&nbsp;:
711 -</p>
712 -
713 -<pre caption="Syntaxe d'un chapitre">
714 -&lt;?xml version='1.0' encoding='UTF-8'?&gt;
715 -&lt;!DOCTYPE sections SYSTEM "/dtd/book.dtd"&gt;
716 -&lt;!-- &#36;Header&#36; --&gt;
717 -
718 -&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
719 -&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt;
720 -
721 -&lt;sections&gt;
722 -
723 -&lt;version&gt;...&lt;/version&gt;
724 -&lt;date&gt;...&lt;/date&gt;
725 -
726 -<comment>(Définir des éléments &lt;section&gt; et &lt;subsection&gt;)</comment>
727 -
728 -&lt;/sections&gt;
729 -</pre>
730 -
731 -<p>
732 -Chaque chapitre contient des éléments <c>&lt;section&gt;</c> (l'équivalent d'un
733 -élément <c>&lt;chapter&gt;</c> de GuideXML) et des éléments
734 -<c>&lt;subsection&gt;</c> (l'équivalent d'un élément <c>&lt;section&gt;</c> de
735 -GuideXML).
736 -</p>
737 -
738 -<p>
739 -Chaque chapitre doit avoir ses propres éléments date et version. La date la plus
740 -récente parmi tous les documents principaux et les documents de chapitres sera
741 -affichée lorsqu'un utilisateur visite une quelconque partie du manuel.
742 -</p>
743 -
744 -</body>
745 -</section>
746 -</chapter>
747 -<chapter>
748 <title>Ressources</title>
749 <section>
750 <title>Commencez à écrire</title>
751 <body>
752
753 <p>
754 -Guide a été spécialement conçu pour être «&nbsp;simple et léger&nbsp;»
755 +Guide XML a été spécialement conçu pour être «&nbsp;simple et léger&nbsp;»
756 afin que les développeurs puissent passer plus de temps à
757 écrire de la documentation et moins à apprendre la syntaxe XML.
758 Espérons que cela permette aux développeurs qui ne sont
759 @@ -1060,7 +1271,7 @@
760 Gentoo de qualité. N'hésitez pas à consulter nos <uri
761 link="/proj/fr/gdp/doc/doc-tipsntricks.xml">trucs et astuces du
762 documentaliste</uri>. Si vous voulez aider (ou si vous avez
763 -des questions sur Guide), envoyez un message en anglais sur la <uri
764 +des questions sur Guide XML), envoyez un message en anglais sur la <uri
765 link="/main/en/lists.xml">liste de diffusion gentoo-doc</uri> en
766 indiquant ce que vous souhaitez améliorer. Amusez-vous bien&nbsp;!
767 </p>
768
769
770
771 --
772 gentoo-commits@g.o mailing list