1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
<?xml version="1.0" encoding="ISO8859-1" standalone="no"?>
<!-- Copyright (c) 1998 Nik Clayton, All rights reserved.
Redistribution and use in source (SGML DocBook) and 'compiled' forms
(SGML HTML, PDF, PostScript, RTF and so forth) with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code (SGML DocBook) must retain the above
copyright notice, this list of conditions and the following
disclaimer as the first lines of this file unmodified.
2. Redistributions in compiled form (transformed to other DTDs,
converted to PDF, PostScript, RTF and other formats) must reproduce
the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials
provided with the distribution.
THIS DOCUMENTATION IS PROVIDED BY NIK CLAYTON "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL NIK CLAYTON BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
$Id: chapter.sgml,v 1.1 2000-06-12 15:47:08 gioria Exp $
-->
<chapter id="writing-style">
<title> Style</title>
<para>Pour conserver une certaine cohérence entre le travail des nombreux
rédacteurs de la documentation de FreeBSD, on a défini quelques règles à
suivre.</para>
<variablelist>
<varlistentry>
<term>N'utilisez pas de formes contractées</term>
<listitem>
<para>N'utilisez pas de formes contractées. Utilisez toujours les mots
entiers. “<foreignphrase>Don't use
contractions</foreignphrase>” n'est pas
correct<footnote><para>N.d.T.: Ceci s'applique bien sûr aux textes
rédigés en anglais.</para></footnote>.</para>
<para>Ne pas contracter donne au texte un ton plus formel, est plus
précis, et facilite la tâche des traducteurs.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Utilisez la virgule dans les énumérations</term>
<listitem>
<para>Dans une énumération au sein d'un paragraphe, séparez avec des
virgules les éléments les uns des autres. Mettez aussi un virgule et
la conjonction “et” avant le dernier élément.</para>
<para>Examinez par exemple la phrase suivante :</para>
<blockquote>
<para>C'est une liste d'un, deux et trois éléments.</para>
</blockquote>
<para>Est-ce une liste de trois éléments, “un”,
“deux”, et “trois”, ou une liste de deux
éléments, “un” et “deux et
trois” ?</para>
<para>Il vaut mieux être explicite et ajouter la dernière
virgule :</para>
<blockquote>
<para>C'est une liste d'un, deux, et trois éléments.</para>
</blockquote>
</listitem>
</varlistentry>
<varlistentry>
<term>Evitez les redondances</term>
<listitem>
<para>Evitez les redondances. En particulier, “la
commande”, “le fichier”, et “man
commande” sont probablement redondants.</para>
<para>Voici deux exemples pour ce qui concerne les commandes. Il est
préférable d'utiliser le second.</para>
<informalexample>
<para>Utilisez la commande <command>cvsup</command> pour mettre à
jour vos sources.</para>
</informalexample>
<informalexample>
<para>Utilisez <command>cvsup</command> pour mettre à jour vos
sources.</para>
</informalexample>
<para>Voici deux exemples pour ce qui concerne les noms de fichiers.
Il est préférable d'utiliser le second.</para>
<informalexample>
<para>… dans le fichier
<filename>/etc/rc.local</filename>…</para>
</informalexample>
<informalexample>
<para>… dans
<filename>/etc/rc.local</filename>…</para>
</informalexample>
<para>Voici enfin deux exemples pour les références aux pages de
manuel. Il est préférable d'utiliser le second (il emploie
<sgmltag>citerefentry</sgmltag>).</para>
<informalexample>
<para>Voyez <command>man csh</command> pour plus
d'information.</para>
</informalexample>
<informalexample>
<para>Voyez &man.csh.1;</para>
</informalexample>
</listitem>
</varlistentry>
</variablelist>
<para>Pour des détails sur le style, consultez les <ulink
url="http://www.columbia.edu/acis/bartleby/strunk/"><foreignphrase>Eléments
de Style</foreignphrase></ulink>, de William Strunk.</para>
</chapter>
|