diff options
author | tristantheb <tristantheb@users.noreply.github.com> | 2021-05-25 20:47:40 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-05-25 20:47:40 +0200 |
commit | 2a41c9c3d9c4660702c31bb68562958ecb44ee3e (patch) | |
tree | 6cc7a7ac6e0b21d48787798f8d2cbd52e45122c9 /files/fr/mdn/guidelines | |
parent | 88b7b3760b34284f9ba01333052d49710ce77904 (diff) | |
download | translated-content-2a41c9c3d9c4660702c31bb68562958ecb44ee3e.tar.gz translated-content-2a41c9c3d9c4660702c31bb68562958ecb44ee3e.tar.bz2 translated-content-2a41c9c3d9c4660702c31bb68562958ecb44ee3e.zip |
L10N: Update the MDN Guideline (important pages only) with Yari and Git/GitHub (#371)
* UPDATE: Code guideline page is now up-to-date from the US version
* CREATE: Add the general code guildeline page
* CREATE: Add the CSS code guideline page
* CREATE: Add the HTML code guideline page
* FIX: Fix some elements on pages
* CREATE: Add the JavaScript code guideline page
* Pre-Creaate english version of other Guildelines pages
* L10N: Update translation of the Javascript code guildeline page
* L10N: Update translation of the Shell code guildeline page
* FIX: Add missing class on the Code Guideline
* UPDATE: Up-to-date the Feedback page
* UPDATE: Up-to-date the Getting started page
* L10N: Translate the Github for beginners page
* UPDATE: Update indexes of Guideline and Contribute
* L10N: Translation of the two Github additional guide pages
* L10N: Translation of the Help for beginners page
* L10N: Translation of the Localize page
* L10N: Translation of the Open_source_etiquette rules
* UPDATE: Remove wrong html element and update title for Processes page
* L10N: Translation of the Where is everything page
* L10N: Important translation of the Documentation priorities page
* Meta - Review priority
* Meta - Review feedback
* Meta - Review Getting started
* Review - minor edits
* Review - minor typos
* Review - few rewordings
* Review - minor rewordings
* Review - minor lint
* Review - Consistency with MDN vs le MDN
* Review - update / ko / link ks
* Review - minor rewordings
* Review - Complement since no subpage
* Review - minor typo
* Review - rm cssxref
* Review - minor fixes
* Review - minor fixes
* Review - minor fixes
* Review - minor fixes
* Review - minor fixes
* Review - Complete translation of doc
* Review - Complete translation
* Review - complete translation
* Review - complete translation
* Review - minor rewording
* Review - Complete translation
* Review - Localization of style guide in Fr
Co-authored-by: julieng <julien.gattelier@gmail.com>
Diffstat (limited to 'files/fr/mdn/guidelines')
-rw-r--r-- | files/fr/mdn/guidelines/code_guidelines/css/index.html | 255 | ||||
-rw-r--r-- | files/fr/mdn/guidelines/code_guidelines/general/index.html | 167 | ||||
-rw-r--r-- | files/fr/mdn/guidelines/code_guidelines/html/index.html | 162 | ||||
-rw-r--r-- | files/fr/mdn/guidelines/code_guidelines/index.html | 56 | ||||
-rw-r--r-- | files/fr/mdn/guidelines/code_guidelines/javascript/index.html | 504 | ||||
-rw-r--r-- | files/fr/mdn/guidelines/code_guidelines/shell/index.html | 37 | ||||
-rw-r--r-- | files/fr/mdn/guidelines/conventions_definitions/index.html | 175 | ||||
-rw-r--r-- | files/fr/mdn/guidelines/css_style_guide/index.html | 382 | ||||
-rw-r--r-- | files/fr/mdn/guidelines/does_this_belong_on_mdn/index.html | 87 | ||||
-rw-r--r-- | files/fr/mdn/guidelines/editorial/index.html | 37 | ||||
-rw-r--r-- | files/fr/mdn/guidelines/index.html | 9 | ||||
-rw-r--r-- | files/fr/mdn/guidelines/video/index.html | 230 | ||||
-rw-r--r-- | files/fr/mdn/guidelines/writing_style_guide/index.html | 124 |
13 files changed, 2186 insertions, 39 deletions
diff --git a/files/fr/mdn/guidelines/code_guidelines/css/index.html b/files/fr/mdn/guidelines/code_guidelines/css/index.html new file mode 100644 index 0000000000..bffb68aad4 --- /dev/null +++ b/files/fr/mdn/guidelines/code_guidelines/css/index.html @@ -0,0 +1,255 @@ +--- +title: Lignes directrices du CSS +slug: MDN/Guidelines/Code_guidelines/CSS +tags: + - CSS + - Code + - Guide + - Directives + - MDN Meta +translation_of: MDN/Guidelines/Code_guidelines/CSS +--- +<div>{{MDNSidebar}}</div> + +<p class="summary seoSummary">Les directives suivantes couvrent la manière d'écrire les CSS pour les exemples de code MDN.</p> + +<h2 id="In_this_article">Dans cet article</h2> + +<ul> + <li><a href="#high-level_guidelines">Lignes directrices de haut niveau</a> + + <ul> + <li><a href="#dont_use_preprocessors">N'utilisez pas de préprocesseurs</a></li> + <li><a href="#dont_use_specific_css_methodologies">N'utilisez pas de méthodologies CSS spécifiques</a></li> + <li><a href="#use_flexiblerelative_units">Utiliser des unités flexibles/relatives</a></li> + <li><a href="#dont_use_resets">Ne pas utiliser de réinitialisation</a></li> + <li><a href="#plan_your_css_%e2%80%94_avoid_overriding">Planifiez votre CSS — évitez les surcharges</a></li> + </ul> + </li> + <li><a href="#general_css_coding_style">Style général de codage CSS</a> + <ul> + <li><a href="#use_expanded_syntax">Utiliser une syntaxe étendue</a></li> + <li><a href="#favor_longhand_rules_over_terse_shorthand">Privilégiez les règles longues aux règles raccourcies</a></li> + <li><a href="#use_double_quotes_around_values">Utilisez des guillemets doubles autour des valeurs</a></li> + <li><a href="#spacing_around_function_parameters">Espacement autour des paramètres de la fonction</a></li> + <li><a href="#css_comments">Commentaires CSS</a></li> + <li><a href="#dont_use_!important">Ne pas utiliser !important</a></li> + </ul> + </li> + <li><a href="#specific_css_syntax_points">Points de syntaxe CSS spécifiques</a> + <ul> + <li><a href="#turning_off_borders_and_other_properties">Désactiver les bordures et autres propriétés</a></li> + <li><a href="#use_mobile_first_media_queries">Utilisez des requêtes média "mobile first"</a></li> + </ul> + </li> + <li><a href="#selectors">Sélecteurs</a> + <ul> + <li><a href="#dont_use_id_selectors">N'utilisez pas de sélecteurs ID</a></li> + <li><a href="#put_multiple_selectors_on_separate_lines">Mettre les sélecteurs multiples sur des lignes séparées</a></li> + </ul> + </li> +</ul> + +<h2 id="High-level_guidelines">Lignes directrices de haut niveau</h2> + +<h3 id="Dont_use_preprocessors">N'utilisez pas de préprocesseurs</h3> + +<p>N'utilisez pas la syntaxe des préprocesseurs, ex. <a href="https://sass-lang.com/">Sass</a>, <a href="http://lesscss.org/">Less</a>, ou <a href="http://stylus-lang.com/">Stylus,</a> dans votre code d'exemple MDN. MDN documente le langage CSS classique, et l'utilisation de préprocesseurs ne sert qu'à élever la barre pour comprendre les exemples, ce qui peut potentiellement perdre les lecteurs.</p> + +<h3 id="Dont_use_specific_CSS_methodologies">N'utilisez pas de méthodologies CSS spécifiques</h3> + +<p>Dans le même esprit que la directive précédente, n'écrivez pas de code d'exemple MDN en utilisant une méthodologie CSS spécifique telle que <a href="http://getbem.com/naming/">BEM</a> ou <a href="https://smacss.com/">SMACSS</a>. Même s'il s'agit de syntaxe CSS valide, les conventions de dénomination peuvent prêter à confusion pour les personnes qui ne sont pas familières avec ces méthodologies.</p> + +<h3 id="Use_flexiblerelative_units">Utiliser des unités flexibles/relatives</h3> + +<p>Pour une flexibilité maximale sur le plus grand nombre possible d'appareils, il est judicieux de dimensionner les conteneurs, le <code>padding</code>, etc. en utilisant des unités relatives comme les <code>em</code> et les <code>rem</code>, ou des pourcentages et des unités de « viewport » si vous souhaitez qu'ils varient en fonction de la largeur du « viewport ». Vous pouvez en savoir plus à ce sujet dans notre article <a href="/fr/docs/Web/Progressive_web_apps/Responsive/responsive_design_building_blocks#fluid_grids">Éléments de construction d'un design adaptatif (Responsive Design)</a>.</p> + +<h3 id="Dont_use_resets">Ne pas utiliser de réinitialisation</h3> + +<p>Pour un contrôle maximal des CSS sur toutes les plates-formes, beaucoup de gens avaient l'habitude d'utiliser les réinitialisations CSS pour supprimer tous les styles, avant de reconstruire les choses eux-mêmes. Cette méthode a certainement ses mérites, mais surtout dans le monde moderne, les réinitialisations CSS peuvent être excessives et entraîner beaucoup de temps supplémentaire passé à réimplémenter des choses qui n'étaient pas complètement cassées au départ, comme les marges par défaut, les styles de liste, etc.</p> + +<p>Si vous avez vraiment envie d'utiliser une réinitialisation, envisagez d'utiliser <a href="https://necolas.github.io/normalize.css/">normalize.css de Nicolas Gallagher</a>, qui vise simplement à rendre les choses plus cohérentes d'un navigateur à l'autre, à se débarrasser de certains désagréments par défaut que nous supprimons toujours (les marges sur <code><body></code>, par exemple) et à corriger quelques bogues.</p> + +<h3 id="Plan_your_CSS_—_avoid_overriding">Planifiez votre CSS — évitez les surcharges</h3> + +<p>Avant de vous lancer dans l'écriture de gros morceaux de CSS, planifiez soigneusement vos styles. Quels styles généraux seront nécessaires, quelles mises en page différentes devrez-vous créer, quelles redéfinitions spécifiques devront être créées et seront-elles réutilisables ? Par-dessus tout, vous devez essayer d'éviter de créer trop de redéfinitions. Si vous vous retrouvez constamment en train d'écrire des styles pour ensuite les annuler quelques règles plus bas, vous devez probablement repenser votre stratégie.</p> + +<h2 id="General_CSS_coding_style">Style général de codage CSS</h2> + +<h3 id="Use_expanded_syntax">Utiliser une syntaxe étendue</h3> + +<p>Vous pouvez utiliser différents styles d'écriture CSS, mais nous préférons le style étendu, avec le sélecteur/l'accolade ouvrante, l'accolade fermante et chaque déclaration sur une ligne distincte. Cela optimise la lisibilité et favorise la cohérence sur le MDN.</p> + +<p>Utilisez ceci :</p> + +<pre class="brush: css example-good">p { + color: white; + background-color: black; + padding: 1rem; +}</pre> + +<p>Pas cela :</p> + +<pre class="brush: css example-bad">p { color: white; background-color: black; padding: 1rem; }</pre> + +<p>En outre, gardez ces spécificités à l'esprit :</p> + +<ul> + <li>Insérez un espace entre le(s) sélecteur(s) et l'accolade ouvrante.</li> + <li>Incluez toujours un point-virgule à la fin de la dernière déclaration, même si ce n'est pas strictement nécessaire.</li> + <li>Mettez l'accolade de fermeture sur une nouvelle ligne.</li> + <li>Dans chaque déclaration, mettez un espace après les deux points de séparation, mais pas avant.</li> + <li>Utilisez 2 espaces pour l'indentation du code.</li> +</ul> + +<h3 id="Favor_longhand_rules_over_terse_shorthand">Privilégiez les règles longues aux règles raccourcies</h3> + +<p>En général, lorsque vous enseignez les spécificités de la syntaxe CSS, il est plus clair et plus évident d'utiliser des propriétés longues plutôt que des raccourcies (à moins bien sûr que l'enseignement du raccourci ne soit le but de l'exemple). N'oubliez pas que les exemples du MDN ont pour but d'enseigner aux gens, et non d'être efficaces ou astucieuses.</p> + +<p>Tout d'abord, il est souvent plus difficile de comprendre ce que fait le raccourci. Il faut un certain temps pour comprendre exactement ce que fait la syntaxe <a href="/fr/docs/Web/CSS/font"><code>font</code></a>, par exemple :</p> + +<pre class="brush: css">font: small-caps bold 2rem/1.5 sans-serif;</pre> + +<p>Alors que celle-ci est plus immédiate en termes de compréhension :</p> + +<pre class="brush: css">font-variant: small-caps; +font-weight: bold; +font-size: 2rem; +line-height: 1.5; +font-family: sans-serif;</pre> + +<p>Deuxièmement, les raccourcis CSS comportent des pièges potentiels supplémentaires : des valeurs par défaut sont définies pour des parties de la syntaxe que vous n'avez pas explicitement définies, ce qui peut produire des réinitialisations inattendues des valeurs que vous avez définies plus tôt dans la cascade, ou d'autres effets attendus. Par exemple, la propriété <a href="/fr/docs/Web/CSS/grid"><code>grid</code></a> définit toutes les valeurs par défaut suivantes pour les éléments qui ne sont pas spécifiés :</p> + +<ul> + <li><a href="/fr/docs/Web/CSS/grid-template-rows"><code>grid-template-rows</code></a>: <code>none</code></li> + <li><a href="/fr/docs/Web/CSS/grid-template-columns"><code>grid-template-columns</code></a>: <code>none</code></li> + <li><a href="/fr/docs/Web/CSS/grid-template-areas"><code>grid-template-areas</code></a>: <code>none</code></li> + <li><a href="/fr/docs/Web/CSS/grid-auto-rows"><code>grid-auto-rows</code></a>: <code>auto</code></li> + <li><a href="/fr/docs/Web/CSS/grid-auto-columns"><code>grid-auto-columns</code></a>: <code>auto</code></li> + <li><a href="/fr/docs/Web/CSS/grid-auto-flow"><code>grid-auto-flow</code></a>: <code>row</code></li> + <li><a href="/fr/docs/Web/CSS/column-gap"><code>column-gap</code></a>: <code>0</code></li> + <li><a href="/fr/docs/Web/CSS/row-gap"><code>row-gap</code></a>: <code>0</code></li> + <li><a href="/fr/docs/Web/CSS/column-gap"><code>column-gap</code></a>: <code>normal</code></li> + <li><a href="/fr/docs/Web/CSS/row-gap"><code>row-gap</code></a>: <code>normal</code></li> +</ul> + +<p>En outre, certains raccourcis ne fonctionnent comme prévu que si vous incluez les différents composants de la valeur dans un certain ordre. Dans les animations CSS, par exemple :</p> + +<pre class="brush: css">/* duration | timing-function | delay | iteration-count + direction | fill-mode | play-state | name */ +animation: 3s ease-in 1s 2 reverse both paused slidein;</pre> + +<p>À titre d'exemple, la première valeur qui peut être analysée comme un <a href="/fr/docs/Web/CSS/time" title="Le type de données CSS <time> ; représente une valeur de temps exprimée en secondes ou en millisecondes. Il est utilisé dans les propriétés d'animation, de transition et autres propriétés connexes."><code><time></code></a> est affecté à la propriété <a href="/fr/docs/Web/CSS/animation-duration" title="La propriété CSS animation-duration définit la durée nécessaire à une animation pour effectuer un cycle. "><code>animation-duration</code></a>, et la seconde est affectée à <a href="/fr/docs/Web/CSS/animation-delay" title="La propriété CSS animation-delay définit le moment où une animation commence. L'animation peut démarrer plus tard, immédiatement dès son début, ou immédiatement et à mi-chemin de l'animation."><code>animation-delay</code></a>. Pour plus de détails, lisez l'intégralité de <a href="/fr/docs/Web/CSS/animation#syntax">syntaxe de l'animation</a>.</p> + +<h3 id="Use_double_quotes_around_values">Utilisez des guillemets doubles autour des valeurs</h3> + +<p>Lorsque des guillemets peuvent ou doivent être inclus, utilisez-les, et utilisez des guillemets doubles. Par exemple :</p> + +<pre class="brush: css example-good">[data-vegetable="liquid"] { + background-color: goldenrod; + background-image: url("../../media/examples/lizard.png"); +}</pre> + +<h3 id="Spacing_around_function_parameters">Espacement autour des paramètres de la fonction</h3> + +<p>Les paramètres des fonctions doivent comporter des espaces après les virgules de séparation, mais pas avant :</p> + +<pre class="brush: css example-good">color: rgb(255, 0, 0); +background-image: linear-gradient(to bottom, red, black);</pre> + +<h3 id="CSS_comments">Commentaires CSS</h3> + +<p>Utilisez des commentaires de style CSS pour commenter le code qui n'est pas auto-documenté :</p> + +<pre class="brush: css example-good">/* Il s'agit d'un commentaire de style CSS */</pre> + +<p>Mettez vos commentaires sur des lignes séparées précédant le code auquel ils se réfèrent :</p> + +<pre class="brush: css example-good">h3 { + /* Crée une ombre portée rouge, décalée de 1px vers la droite et le bas, avec un rayon de flou de 2px. */ + text-shadow: 1px 1px 2px red; + /* Définit la taille de la police au double de la taille de la police du document par défaut. */ + font-size: 2rem; +}</pre> + +<p>Notez également que vous devez laisser un espace entre les astérisques et le commentaire, dans chaque cas.</p> + +<h3 id="Dont_use_!important">Ne pas utiliser !important</h3> + +<p><code>!important</code> est un dernier recours généralement utilisé uniquement lorsque vous devez remplacer quelque chose et qu'il n'y a pas d'autre moyen. Il s'agit d'une mauvaise pratique que vous devez éviter dans la mesure du possible.</p> + +<p>Mauvais usage :</p> + +<pre class="brush: css example-bad">.bad-code { + font-size: 4rem !important; +}</pre> + +<h2 id="Specific_CSS_syntax_points">Points de syntaxe CSS spécifiques</h2> + +<h3 id="Turning_off_borders_and_other_properties">Désactiver les bordures et autres propriétés</h3> + +<p>Lorsque vous désactivez les bordures (et toute autre propriété qui peut prendre <code>0</code> ou <code>none</code> comme valeurs), utilisez <code>0</code> plutôt que <code>none</code> :</p> + +<pre class="brush: css example-good">border: 0;</pre> + +<h3 id="Use_mobile_first_media_queries">Utilisez des requêtes média "mobile first"</h3> + +<p>Lorsque vous incluez différents ensembles de styles pour différentes tailles de fenêtres d'affichage à l'aide de requêtes de médias dans la même feuille de style, il est judicieux de faire en sorte que le style par défaut avant l'application de toute requête de médias au document soit le style pour écran étroit/mobile, puis de le remplacer pour les fenêtres d'affichage plus larges dans des requêtes de médias successives.</p> + +<pre class="brush: css example-good">/* Mise en page CSS par défaut pour les écrans étroits */ + +@media (min-width: 480px) { + /* CSS pour les écrans de largeur moyenne */ +} + +@media (min-width: 800px) { + /* CSS pour les écrans larges */ +} + +@media (min-width: 1100px) { + /* CSS pour les écrans très larges */ +}</pre> + +<p>Cela présente de nombreux avantages, exposés dans notre article <a href="/fr/docs/Web/Progressive_web_apps/Responsive/Mobile_first">Priorité aux mobiles</a>.</p> + +<h2 id="Selectors">Sélecteurs</h2> + +<h3 id="Dont_use_ID_selectors">N'utilisez pas de sélecteurs ID</h3> + +<p>Il n'est pas vraiment nécessaire d'utiliser des sélecteurs d'ID - ils sont moins flexibles (vous ne pouvez pas en ajouter d'autres si vous découvrez que vous en avez besoin de plus d'un), et il est plus difficile de les remplacer si nécessaire, car ils sont plus spécifiques que les classes.</p> + +<p>Bonne pratique :</p> + +<pre class="brush: css example-good">.editorial-summary { + ... +}</pre> + +<p>Mauvaise pratique :</p> + +<pre class="brush: css example-bad">#editorial-summary { + ... +}</pre> + +<h3 id="Put_multiple_selectors_on_separate_lines">Mettre les sélecteurs multiples sur des lignes séparées</h3> + +<p>Lorsqu'une règle comporte plusieurs sélecteurs, placez chaque sélecteur sur une nouvelle ligne. La liste des sélecteurs est ainsi plus facile à lire et les lignes de code sont plus courtes.</p> + +<p>Faites ceci :</p> + +<pre class="brush: css example-good">h1, +h2, +h3 { + font-family: sans-serif; + text-align: center; +}</pre> + +<p>Pas ça :</p> + +<pre class="brush: css example-bad">h1, h2, h3 { + font-family: sans-serif; + text-align: center; +}</pre> + +<h2 id="Good_CSS_examples_on_MDN">De bons exemples de CSS sur MDN</h2> + +<p>Vous pouvez trouver de bons extraits CSS concis et significatifs en haut de nos pages de référence des propriétés CSS - parcourez notre <a href="/fr/docs/Web/CSS/Reference#keyword_index">index des mots-clés CSS</a> pour en trouver. Nos exemples interactifs sont généralement écrits pour suivre les directives ci-dessus, mais sachez qu'ils peuvent différer à certains endroits, car ils ont pour la plupart été écrits avant la nouvelle rédaction des directives.</p> diff --git a/files/fr/mdn/guidelines/code_guidelines/general/index.html b/files/fr/mdn/guidelines/code_guidelines/general/index.html new file mode 100644 index 0000000000..c2358c8e2f --- /dev/null +++ b/files/fr/mdn/guidelines/code_guidelines/general/index.html @@ -0,0 +1,167 @@ +--- +title: Lignes directrices générales pour tous les exemples de code +slug: MDN/Guidelines/Code_guidelines/General +tags: + - Code + - General + - Guide + - Directives + - MDN Meta +translation_of: MDN/Guidelines/Code_guidelines/General +--- +<div>{{MDNSidebar}}</div> + +<p class="summary">Les directives suivantes concernant les exemples de code s'appliquent à tout le code, qu'il s'agisse de HTML, de CSS, de JavaScript ou d'autre chose.</p> + +<h2 id="In_this_article">Dans cet article</h2> + +<ul> + <li><a href="#indentation_spacing_size">Indentation, espacement, taille</a> + + <ul> + <li><a href="#indentation">Indentation</a></li> + <li><a href="#code_line_length">Longueur des lignes de code</a></li> + <li><a href="#code_block_height">Hauteur des blocs de code</a></li> + </ul> + </li> + <li><a href="#guidelines_for_displaying_examples">Directives pour l'affichage des exemples</a> + <ul> + <li><a href="#size_of_rendered_example">Taille du rendu des exemples</a></li> + <li><a href="#use_of_images_and_other_media">Utilisation d'images et d'autres médias</a></li> + <li><a href="#use_of_color">Utilisation de la couleur</a></li> + <li><a href="#highlight_good_and_bad_practice_examples">Mettre en évidence les exemples de bonnes et de mauvaises pratiques</a></li> + </ul> + </li> + <li><a href="#writing_syntax_sections_on_reference_pages">Rédaction de sections syntaxiques sur les pages de référence</a></li> +</ul> + +<h2 id="Indentation_spacing_size">Indentation, espacement, taille</h2> + +<h3 id="Indentation">Indentation</h3> + +<p>Tout le code doit utiliser 2 espaces pour l'indentation, par exemple :</p> + +<pre class="brush: html example-good"><div> + <p>C'est mon paragraphe.</p> +</div></pre> + +<pre class="brush: js example-good">function myFunc() { + if(thingy) { + console.log('Ouaip, ça a marché.'); + } +}</pre> + +<h3 id="Code_line_length">Longueur des lignes de code</h3> + +<p>Les lignes de code ne doivent pas comporter plus de 80 caractères (64 pour les <a href="https://github.com/mdn/interactive-examples">exemples interactifs</a>). Vous devez rompre les lignes de manière raisonnable pour des raisons de lisibilité, mais pas au détriment des bonnes pratiques.</p> + +<p>Par exemple, ceci n'est pas génial :</p> + +<pre class="brush: js example-bad">let tommyCat = 'Dit Tommy le chat en reculant pour évacuer tout corps étranger qui aurait pu se loger dans sa puissante gorge. Plus d'un gros rat de gouttière avait trouvé la mort en regardant à bout portant le canon caverneux de cette impressionnante machine à rôder.';</pre> + +<p>C'est mieux, mais un peu gênant :</p> + +<pre class="brush: js">let tommyCat = 'Dit Tommy le chat en reculant pour évacuer tout corps étranger ' ++ 'qui aurait pu se loger dans sa puissante gorge. Plus d’un gros rat de gouttière ' ++ 'avait trouvé la mort en regardant à bout portant le canon caverneux de cette ' ++ 'impressionnante machine à rôder.';</pre> + +<p>Une meilleure solution consiste à utiliser un <i>template</i> :</p> + +<pre class="brush: js example-good">let tommyCat = `Dit Tommy le chat en reculant pour évacuer tout corps étranger + qui aurait pu se loger dans sa puissante gorge. Plus d'un gros rat de gouttière + avait trouvé la mort en regardant à bout portant le canon caverneux de cette + impressionnante machine à rôder.`;</pre> + +<h3 id="Code_block_height">Hauteur des blocs de code</h3> + +<p>Les blocs de code doivent être aussi longs que nécessaire, mais pas plus. L'idéal est de viser quelque chose de court, comme 15 à 25 lignes. Si un bloc de code doit être beaucoup plus long, envisagez de ne montrer que l'extrait le plus utile et de créer un lien vers l'exemple complet sur un repo GitHub ou un CodePen, par exemple.</p> + +<h2 id="Guidelines_for_displaying_examples">Directives pour l'affichage des exemples</h2> + +<h3 id="Size_of_rendered_example">Taille du rendu des exemples</h3> + +<p>Le volet de contenu principal de MDN a une largeur d'environ 700px sur un ordinateur de bureau. Les exemples intégrés à MDN doivent donc avoir une apparence correcte à cette largeur (définissez la largeur des exemples intégrés à 100%).</p> + +<p>En ce qui concerne la hauteur, nous vous recommandons de maintenir l'exemple rendu à moins de 700px de hauteur si possible, pour une lisibilité maximale à l'écran.</p> + +<p>Vous devriez également penser à rendre vos exemples plus ou moins adaptables, afin qu'ils soient également utiles sur les appareils mobiles.</p> + +<h3 id="Use_of_images_and_other_media">Utilisation d'images et d'autres médias</h3> + +<p>Parfois, vous voudrez inclure des images ou d'autres médias dans un exemple. Si vous le faites :</p> + +<ul> + <li>Assurez-vous que leur licence vous permet de les utiliser. Essayez d'utiliser des médias dont la licence est très permissive, comme <a href="https://creativecommons.org/share-your-work/public-domain/cc0/">CC0</a>, ou au moins compatible avec notre licence générale de contenu - <a href="https://creativecommons.org/licenses/by-sa/2.5/">Licence Creative Commons Attribution-ShareAlike</a> (CC-BY-SA).</li> + <li>Pour les images, faites-les passer par <a href="https://tinypng.com">https://tinypng.com</a> ou <a href="https://imageoptim.com">https://imageoptim.com</a>, pour réduire le poids de la page des exemples.</li> + <li>Pour le <code>SVG</code>, exécutez le code via <a href="https://jakearchibald.github.io/svgomg/">SVGOMG</a>, et assurez-vous que le fichier <code>SVG</code> comporte une ligne vide à la fin du fichier.</li> + <li> + <p>Lorsque vous affichez des icônes sur une page (ex. via <a href="/fr/docs/Web/CSS/background-image"><code>background-image</code></a>), utilisez les icônes du référentiel <a href="https://github.com/mdn/mdn-dinocons">mdn-dinocons</a>, le cas échéant, et essayez de correspondre à leur style dans les autres cas.</p> + </li> +</ul> + +<h3 id="Use_of_color">Utilisation de la couleur</h3> + +<p>Minuscule pour l'hexadécimal, peut utiliser des mots-clés pour les nuances et les couleurs primaires (ex. : black, white, red), utiliser des schémas plus complexes uniquement si nécessaire (ex. : pour inclure la transparence).</p> + +<p>Préférez utiliser des mots-clés pour les couleurs primaires et autres couleurs "de base", par exemple :</p> + +<pre class="brush: css example-good"> +color: black; +color: white; +color: red; +</pre> + +<p>Utilisez rgb() pour des couleurs plus complexes (y compris les couleurs semi-transparentes) :</p> + +<pre class="brush: css example-good"> +color: rgb(0, 0, 0, 0.5); +color: rgb(248, 242, 230); +</pre> + +<p>Si vous devez utiliser des couleurs hexadécimales, utilisez des minuscules :</p> + +<pre class="brush: css example-good"> +color: #058ed9; +color: #a39a92; +</pre> + +<p>et utilisez la forme abrégée le cas échéant :</p> + +<pre class="brush: css example-good"> +color: #ff0; +color: #fff; +</pre> + +<p>Le fichier <a href="https://github.com/mdn/mdn-minimalist/blob/main/sass/vars/_color-palette.scss">sass/vars/_color-palette.scss</a> du dépôt <a href="https://github.com/mdn/mdn-minimalist">mdn-minimalist</a> comporte un ensemble de couleurs utiles qui complètent le design général de MDN.</p> + +<h3 id="Highlight_good_and_bad_practice_examples">Mettre en évidence les exemples de bonnes et de mauvaises pratiques</h3> + +<p>Comme vous le remarquerez en parcourant ces lignes directrices, les blocs de code censés être des exemples de bonnes pratiques sont marqués d'un fond en vert, et les blocs de code censés être des exemples de mauvaises pratiques sont marqués d'un fond en rouge.</p> + +<p>Pour ce faire, vous devez d'abord utiliser les commandes de l'éditeur MDN pour placer votre bloc de code dans un bloc <code><pre></code> et lui donner la coloration syntaxique appropriée. La source du code ressemblera à quelque chose comme ceci :</p> + +<pre class="brush: js"> +function myFunc() { + console.log('Hello!'); +}; +</pre> +</pre> + +<p>Pour en faire un bon exemple, vous insérez <code>example-good</code> juste avant le guillemet fermant de l'attribut <code>class</code> :</p> + +<pre class="brush: html"><pre class="brush: js example-good"> + ... +</pre> + +<p>Pour en faire un mauvais exemple, vous insérez <code>example-bad</code> juste avant le guillemet fermant de l'attribut <code>class</code> :</p> + +<pre class="brush: html"><pre class="brush: js example-bad"> + ... +</pre> + +<p>Nous aimerions vous encourager à les utiliser. Il n'est pas nécessaire de les utiliser partout, mais seulement lorsque vous signalez spécifiquement les bonnes et mauvaises pratiques dans votre code.</p> + +<h2 id="Writing_syntax_sections_on_reference_pages">Rédaction de sections syntaxiques sur les pages de référence</h2> + +<p>Les pages de référence MDN comprennent des sections Syntaxe qui indiquent sans ambiguïté quelle peut/doit être la syntaxe d'une fonctionnalité, par exemple une méthode JavaScript, une propriété CSS, un élément HTML, etc. Des directives pour les rédiger sont données sur le document <a href="/fr/docs/MDN/Structures/Syntax_sections">Sections syntaxiques</a>.</p> diff --git a/files/fr/mdn/guidelines/code_guidelines/html/index.html b/files/fr/mdn/guidelines/code_guidelines/html/index.html new file mode 100644 index 0000000000..8ac19e47bf --- /dev/null +++ b/files/fr/mdn/guidelines/code_guidelines/html/index.html @@ -0,0 +1,162 @@ +--- +title: Lignes directrices pour le HTML +slug: MDN/Guidelines/Code_guidelines/HTML +tags: + - Code + - Guide + - Directives + - HTML + - MDN Meta +translation_of: MDN/Guidelines/Code_guidelines/HTML +--- +<div>{{MDNSidebar}}</div> + +<p class="summary">Les directives suivantes couvrent la manière d'écrire du HTML pour les exemples de code MDN.</p> + +<h2 id="In_this_article">Dans cet article</h2> + +<ul> + <li><a href="#doctype_and_metadata">Doctype et méta-données</a> + <ul> + <li><a href="#doctype">Doctype</a></li> + <li><a href="#document_language">Langue du document</a></li> + <li><a href="#document_characterset">Jeu de caractères du document</a></li> + <li><a href="#viewport_meta_tag">Méta-balise Viewport</a></li> + </ul> + </li> + <li><a href="#general_markup_coding_style">Style général de codage des balises</a> + <ul> + <li><a href="#use_lowercase">Utiliser les minuscules</a></li> + <li><a href="#trailing_slashes">Barre oblique de fermeture (slash)</a></li> + <li><a href="#quoting_attributes">Guillemets des attributs</a></li> + <li><a href="#use_double_quotes">Utiliser les guillemets doubles</a></li> + <li><a href="#boolean_attributes">Attributs booléens</a></li> + <li><a href="#class_and_id_names">Noms de classes et d'ID</a></li> + <li><a href="#entity_references">Références des entités</a></li> + </ul> + </li> +</ul> + +<h2 id="Doctype_and_metadata">Doctype et méta-données</h2> + +<div class="notecard note"> +<p><strong>Note :</strong> Les directives de cette section ne s'appliquent que lorsque vous devez montrer un document HTML complet. La plupart du temps, vous n'aurez pas besoin de le faire ; un extrait est généralement suffisant pour démontrer une fonctionnalité. Lorsque vous utilisez la macro <a href="/fr/docs/MDN/Structures/Code_examples#traditional_live_samples">EmbedLiveSample</a>, il suffit d'inclure l'extrait HTML ; il sera automatiquement inséré dans un document HTML complet lors de son affichage.</p> +</div> + +<h3 id="Doctype">Doctype</h3> + +<p>Vous devez utiliser le doctype HTML5. Il est court, facile à retenir et rétrocompatible :</p> + +<pre class="brush: html example-good"><!DOCTYPE html></pre> + +<h3 id="Document_language">Langue du document</h3> + +<p>Définissez la langue du document à l'aide de l'attribut <a href="/fr/docs/Web/HTML/Global_attributes#lang"><code>lang</code></a> de votre élément <a href="/fr/docs/Web/HTML/Element/html"><code><html></code></a> :</p> + +<pre class="brush: html example-good"><html lang="fr"></pre> + +<p>C'est bon pour l'accessibilité et les moteurs de recherche, cela aide à localiser le contenu et cela rappelle aux gens d'utiliser les meilleures pratiques.</p> + +<h3 id="Document_characterset">Jeu de caractères du document</h3> + +<p>Vous devez également définir le jeu de caractères de votre document comme suit :</p> + +<pre class="brush: html example-good"><meta charset="utf-8"></pre> + +<p>Utilisez UTF-8 à moins que vous n'ayez une très bonne raison de ne pas le faire ; il couvrira vos besoins en caractères à peu près indépendamment de la langue que vous utilisez dans votre document. En outre, vous devriez toujours spécifier le jeu de caractères le plus tôt possible dans le bloc <a href="/fr/docs/Web/HTML/Element/head"><code><head></code></a> de votre HTML (dans le premier kilooctet), car cela vous protège contre une <a href="http://support.microsoft.com/kb/928847">vulnérabilité de sécurité d'Internet Explorer</a>.</p> + +<h3 id="Viewport_meta_tag">Méta-balise Viewport</h3> + +<p>Enfin, vous devez toujours ajouter la métabalise viewport dans votre HTML <a href="/fr/docs/Web/HTML/Element/head"><code><head></code></a>, pour donner à l'exemple une meilleure chance de fonctionner sur les appareils mobiles. Vous devez inclure au moins les éléments suivants dans votre document, que vous pourrez modifier ultérieurement en fonction des besoins :</p> + +<pre class="brush: html example-good"><meta name="viewport" content="width=device-width"></pre> + +<p>Voir <a href="/fr/docs/Web/CSS/Viewport_concepts#mobile_viewports">Zones d'affichage sur mobiles</a> pour plus de détails.</p> + +<h2 id="General_markup_coding_style">Style général de codage des balises</h2> + +<h3 id="Use_lowercase">Utiliser les minuscules</h3> + +<p>Utilisez les minuscules pour tous les noms d'éléments et les noms/valeurs d'attributs, car elles sont plus nettes et vous permettent d'écrire plus rapidement les balises :</p> + +<p>C'est bien :</p> + +<pre class="brush: html example-good"><p class="nice">Ça a l'air sympa et soigné</p></pre> + +<p>Ce n'est pas très bon :</p> + +<pre class="brush: html example-bad"><P CLASS="WHOA-THERE">Pourquoi mon balisage crie-t-il ?</P></pre> + +<h3 id="Trailing_slashes">Barre oblique de fermeture (slash)</h3> + +<p>N'incluez pas les barres obliques de fin de style XHTML pour les éléments vides, car elles sont inutiles et ralentissent le processus. Elles peuvent également casser les anciens navigateurs si vous ne faites pas attention (bien que, d'après ce dont nous nous souvenons, cela n'a pas été un problème depuis Netscape 4).</p> + +<p>C'est bon :</p> + +<pre class="brush: html example-good"><input type="text"> +<hr></pre> + +<p>Les barres obliques ne sont pas nécessaires :</p> + +<pre class="brush: html example-bad"><input type="text" /> +<hr /></pre> + +<h3 id="Quoting_attributes">Guillemets des attributs</h3> + +<p>Vous devez mettre toutes les valeurs d'attribut entre guillemets. Il est tentant d'omettre les guillemets puisque HTML5 le permet, mais le balisage est plus net et plus facile à lire si vous les incluez. Par exemple, ceci est mieux :</p> + +<pre class="brush: html example-good"><img src="images/logo.jpg" alt="Une icône de globe circulaire" class="no-border"></pre> + +<p>que ça :</p> + +<pre class="brush: html example-bad"><img src=images/logo.jpg alt=Une icône de globe circulaire class=no-border></pre> + +<p>Cela peut également causer des problèmes - dans l'exemple ci-dessus, l'attribut <code>alt</code> sera interprété comme plusieurs attributs, car il n'y a pas de guillemets pour spécifier que "Une icône de globe circulaire" est une valeur d'attribut unique.</p> + +<h3 id="Use_double_quotes">Utiliser les guillemets doubles</h3> + +<p>Utilisez des guillemets doubles pour le HTML, et non des guillemets simples :</p> + +<pre class="brush: html example-good"><p class="important">Yes</p></pre> + +<pre class="brush: html example-bad"><p class='important'>Nope</p></pre> + +<h3 id="Boolean_attributes">Attributs booléens</h3> + +<p>N'écrivez pas les attributs booléens en entier ; vous pouvez simplement écrire le nom de l'attribut pour le définir. Par exemple, vous pouvez écrire :</p> + +<pre class="brush: html example-good">required</pre> + +<p>Ceci est parfaitement compréhensible et fonctionne bien ; la version plus longue avec la valeur est acceptée mais n'est pas nécessaire :</p> + +<pre class="brush: html example-bad">required="required"</pre> + +<h3 id="Class_and_ID_names">Noms de classes et d'ID</h3> + +<p>Utilisez des noms de classe/ID sémantiques et séparez les mots multiples par des traits d'union. N'utilisez pas de camelCase.</p> + +<p>Bon :</p> + +<pre class="brush: html example-good"><p class="editorial-summary">Blah blah blah</p></pre> + +<p>Mauvais :</p> + +<pre class="brush: html example-bad"><p class="bigRedBox">Blah blah blah</p></pre> + +<h3 id="Entity_references">Références des entités</h3> + +<p>N'utilisez pas inutilement les références d'entités - utilisez le caractère littéral chaque fois que cela est possible (vous devrez toujours échapper les caractères comme les crochets et les guillemets).</p> + +<p>Par exemple, vous pourriez simplement écrire</p> + +<pre class="brush: html example-good"><p>© 2018 Me</p></pre> + +<p>Au lieu de</p> + +<pre class="brush: html example-bad"><p>&copy; 2018 Me</p></pre> + +<p>Cela ne pose aucun problème tant que vous déclarez un jeu de caractères UTF-8.</p> + +<h2 id="Good_HTML_examples_on_MDN">De bons exemples HTML sur MDN</h2> + +<p>Vous pouvez trouver de bons extraits HTML, concis et significatifs, en haut des <a href="/fr/docs/Web/HTML/Reference">pages de référence HTML</a> - nos exemples interactifs sont généralement rédigés de manière à suivre ces directives, mais sachez qu'ils peuvent différer à certains endroits car ils ont pour la plupart été rédigés avant la nouvelle rédaction des directives.</p> diff --git a/files/fr/mdn/guidelines/code_guidelines/index.html b/files/fr/mdn/guidelines/code_guidelines/index.html index d912615e54..58ab589009 100644 --- a/files/fr/mdn/guidelines/code_guidelines/index.html +++ b/files/fr/mdn/guidelines/code_guidelines/index.html @@ -1,5 +1,5 @@ --- -title: Guide des lignes directrices +title: Lignes directrices pour les fragments de code slug: MDN/Guidelines/Code_guidelines tags: - CSS @@ -14,39 +14,35 @@ original_slug: MDN/Guidelines/Code_lignesdirectrices --- <div>{{MDNSidebar}}</div> -<div>{{IncludeSubnav("/fr/docs/MDN")}}</div> - -<div> -<p class="summary"><span class="seoSummary">Cette série de documents décrit les directives de codage et les meilleures pratiques que nous utilisons pour écrire des démonstrations, des extraits de code, des exemples interactifs, etc. à utiliser sur MDN.</span></p> +<p class="summary">Cette série de documents décrit les directives de codage et les meilleures pratiques que nous utilisons pour écrire des démonstrations, des extraits de code, des exemples interactifs, etc. à utiliser sur MDN.</p> <p>Si vous cherchez des lignes directrices à suivre pour rédiger vos exemples de codes, vous êtes au bon endroit. Le plus grand avantage de respecter ces directives est qu'elles favoriseront la cohérence entre nos échantillons et nos démos sur MDN, ce qui augmente la lisibilité et la compréhension en général.</p> -</div> -<div class="note"> -<p><strong>Note</strong>: Si vous souhaitez obtenir des conseils sur le style du code tel qu'il apparaît sur un article de MDN, plutôt que sur le contenu du code, consultez notre <a href="/fr-FR/docs/MDN/Contribute/Guidelines/Writing_style_guide#Code_sample_style_and_formatting">Guide de formatage</a>.</p> +<div class="notecard note"> + <p><strong>Note</strong>: Si vous souhaitez obtenir des conseils sur le style du code tel qu'il apparaît sur un article de MDN, plutôt que sur le contenu du code, consultez notre <a href="/fr/docs/MDN/Guidelines/Writing_style_guide#code_sample_style_and_formatting">Guide stylistique</a>.</p> </div> -<h2 id="Structure_de_larticle">Structure de l'article</h2> +<h2 id="Article_structure">Structure d'article</h2> <p>Cet article contient les meilleures pratiques générales de haut niveau pour la rédaction d'exemples de codes MDN. Ses sous-articles sont les suivants :</p> <ul> - <li><a href="/en-US/docs/MDN/Contribute/Guidelines/Code_guidelines/General">Lignes directrices générales pour tous les codes</a> — à la fois syntaxique et pour des exemples de stylisme/affichage</li> - <li><a href="/en-US/docs/MDN/Contribute/Guidelines/Code_guidelines/HTML">Lignes directrices du HTML</a></li> - <li><a href="/en-US/docs/MDN/Contribute/Guidelines/Code_guidelines/CSS">Lignes directrices du CSS</a></li> - <li><a href="/en-US/docs/MDN/Contribute/Guidelines/Code_guidelines/JavaScript">Lignes directrices du JavaScript</a></li> - <li><a href="/en-US/docs/MDN/Contribute/Guidelines/Code_guidelines/Shell">Lignes directrices des commandes Shell</a></li> + <li><a href="/fr/docs/MDN/Guidelines/Code_guidelines/General">Lignes directrices générales pour tous les codes</a> — à la fois syntaxique et pour des exemples de stylisme/affichage</li> + <li><a href="/fr/docs/MDN/Guidelines/Code_guidelines/HTML">Lignes directrices du HTML</a></li> + <li><a href="/fr/docs/MDN/Guidelines/Code_guidelines/CSS">Lignes directrices du CSS</a></li> + <li><a href="/fr/docs/MDN/Guidelines/Code_guidelines/JavaScript">Lignes directrices du JavaScript</a></li> + <li><a href="/fr/docs/MDN/Guidelines/Code_guidelines/Shell">Lignes directrices des commandes Shell</a></li> </ul> -<h2 id="Meilleures_pratiques_générales">Meilleures pratiques générales</h2> +<h2 id="General_best_practices">Bonnes pratiques générales</h2> <p>Cette section fournit rapidement les meilleures pratiques générales pour créer un échantillon de code minimal compréhensible afin de démontrer l'utilisation d'une caractéristique ou d'une fonction spécifique.</p> <p>Les échantillons de code doivent l'être :</p> <ul> - <li>assez simple pour être compréhensible, mais</li> - <li>suffisamment complexe pour faire quelque chose d'intéressant, et de préférence utile.</li> + <li>assez simple pour être compréhensible, mais</li> + <li>suffisamment complexe pour faire quelque chose d'intéressant, et de préférence utile.</li> </ul> <p>Il y a une considération primordiale que vous devez garder à l'esprit : <strong>Les lecteurs copieront et colleront l'échantillon de code dans leur propre code, et pourront le mettre en production.</strong></p> @@ -55,24 +51,14 @@ original_slug: MDN/Guidelines/Code_lignesdirectrices <p>Les échantillons de code doivent être aussi autonomes et faciles à comprendre que possible. L'objectif n'est pas nécessairement de produire un code efficace et intelligent qui impressionne les experts et possède une grande fonctionnalité, mais plutôt de produire des exemples de travail réduits qui peuvent être compris le plus rapidement possible.</p> -<ul> -</ul> - -<div id="magicdomid13"><span class="author-g-frc9o9ihh5c9qyd0">Lignes directrices :</span></div> - -<div id="magicdomid14"></div> - -<div id="magicdomid15"> -<ul> - <li>L'échantillon doit être court et, dans l'idéal, ne montrer que l'élément qui vous intéresse immédiatement.</li> - <li><strong>N'incluez</strong> que le code qui est essentiel pour l'exemple. Une grande quantité de code non pertinent peut facilement distraire ou embrouiller le public. Si vous souhaitez fournir un exemple complet et plus long, placez-le dans l'un de nos <span class="author-g-frc9o9ihh5c9qyd0"><a href="https://github.com/mdn/">dépôts Github</a></span> (ou un JSBin, Codepen ou similaire) et fournissez ensuite le lien vers la version complète au-dessus ou au-dessous de l'exemple.</li> - <li>N'incluez pas de code inutile côté serveur, de bibliothèques, de cadres, de préprocesseurs et d'autres dépendances de ce type <span class="author-g-frc9o9ihh5c9qyd0">—</span> ils rendent le code moins portable et plus difficile à exécuter et à comprendre. Utilisez du code "vanilla" lorsque c'est possible.</li> - <li>Ne supposez pas que vous connaissez des bibliothèques, des cadres, des préprocesseurs ou d'autres caractéristiques non natives. Par exemple, utilisez des noms de classe qui ont un sens dans l'exemple plutôt que des noms de classe qui ont un sens pour les utilisateurs de BEM ou de Bootstrap.</li> - <li>Écrivez votre code de la façon la plus propre et la plus compréhensible possible, même si ce n'est pas la façon la plus efficace de le faire.</li> - <li>N'utilisez pas de mauvaises pratiques par souci de brièveté (comme les éléments de présentation tels que<span class="author-g-frc9o9ihh5c9qyd0"> {{HTMLElement("big")}} ou {{domxref("Document.write", "document.write()")}}); </span>faites-le correctement.</li> - <li>Dans le cas de démonstrations d'API, si vous utilisez plusieurs API ensemble, indiquez quelles API sont incluses et quelles fonctionnalités proviennent d'où.</li> -</ul> -</div> +<p>Les autres meilleures pratiques générales sont les suivantes :</p> <ul> + <li>L'échantillon doit être court et, idéalement, ne montrer que la caractéristique qui vous intéresse immédiatement.</li> + <li><strong>Seulement</strong> inclure le code qui est essentiel pour l'exemple. Une grande quantité de code non pertinent peut facilement distraire ou embrouiller le public. Si vous souhaitez fournir un exemple complet, plus long, mettez-le dans l'un de nos <a href="https://github.com/mdn/">Dépôts GitHub</a> (ou un JSBin, CodePen, ou similaire) et fournissez ensuite le lien vers la version complète au-dessus ou au-dessous de l'échantillon.</li> + <li>N'incluez pas de code côté serveur, de bibliothèques, de frameworks, de préprocesseurs et autres dépendances inutiles - ils rendent le code moins portable et plus difficile à exécuter et à comprendre. Utilisez du code "vanilla" lorsque cela est possible.</li> + <li>Ne présumez pas de la connaissance des bibliothèques, des frameworks, des préprocesseurs ou d'autres fonctionnalités non natives. Par exemple, utilisez des noms de classe qui ont un sens dans l'exemple plutôt que des noms de classe qui ont un sens pour les utilisateurs de BEM ou Bootstrap.</li> + <li>Écrivez votre code de manière aussi propre et compréhensible que possible, même si ce n'est pas la manière la plus efficace de le faire.</li> + <li>N'utilisez pas de mauvaises pratiques pour faire court (comme des éléments de présentation tels que <a href="/fr/docs/Web/HTML/Element/big"><code><big></code></a> ou <a href="/fr/docs/Web/API/Document/write"><code>document.write()</code></a>) ; faites-le correctement.</li> + <li>Dans le cas des démonstrations d'API, si vous utilisez plusieurs API ensemble, indiquez quelles API sont incluses ainsi que l'origine des fonctionnalités.</li> </ul> diff --git a/files/fr/mdn/guidelines/code_guidelines/javascript/index.html b/files/fr/mdn/guidelines/code_guidelines/javascript/index.html new file mode 100644 index 0000000000..9d390983eb --- /dev/null +++ b/files/fr/mdn/guidelines/code_guidelines/javascript/index.html @@ -0,0 +1,504 @@ +--- +title: Lignes directrices pour JavaScript +slug: MDN/Guidelines/Code_guidelines/JavaScript +tags: + - Code + - Guide + - Directives + - JavaScript + - MDN Meta +translation_of: MDN/Guidelines/Code_guidelines/JavaScript +--- +<div>{{MDNSidebar}}</div> + +<p class="summary">Les directives suivantes couvrent la manière d'écrire le JavaScript pour les exemples de code MDN.</p> + +<p>Ce qui suit est un ensemble assez simple de directives JavaScript. Nous pourrions aller beaucoup plus en profondeur sur ce sujet, mais nous voulons essentiellement fournir des directives simples pour écrire des exemples concis qui seront compréhensibles par le plus grand nombre de personnes possible, plutôt que des directives détaillées pour écrire des applications web complexes. Si vous voulez quelque chose qui entre dans plus de détails, nous vous recommandons le <a href="https://github.com/airbnb/javascript">guide stylistique JavaScript d'AirBnB</a>, qui est généralement compatible avec nos directives.</p> + +<h2 id="In_this_article">Dans cet article</h2> + +<ul> + <li><a href="#general_javascript_guidelines">Directives générales sur le JavaScript</a> + <ul> + <li><a href="#use_expanded_syntax">Utiliser une syntaxe étendue</a></li> + <li><a href="#javascript_comments">Commentaires JavaScript</a></li> + <li><a href="#use_es6_features">Utiliser les fonctions ES6</a></li> + </ul> + </li> + <li><a href="#variables">Variables</a> + <ul> + <li><a href="#variable_naming">Nommage des variables</a></li> + <li><a href="#declaring_variables">Déclaration des variables</a></li> + </ul> + </li> + <li><a href="#operators_and_comparison">Opérateurs et comparaison</a> + <ul> + <li><a href="#ternary_operators">Opérateurs ternaires</a></li> + <li><a href="#use_strict_equality">Utiliser l'égalité stricte</a></li> + <li><a href="#use_shortcuts_for_boolean_tests">Utiliser des raccourcis pour les tests booléens</a></li> + </ul> + </li> + <li><a href="#control_statements">Instructions de contrôle</a></li> + <li><a href="#strings">Chaînes de caractères</a> + <ul> + <li><a href="#use_template_literals">Utiliser des modèles littéraux</a></li> + <li><a href="#use_textcontent_not_innerhtml">Utiliser textContent, et non innerHTML</a></li> + </ul> + </li> + <li><a href="#conditionals">Conditions</a> + <ul> + <li><a href="#general_purpose_looping">Usage général des boucles</a></li> + <li><a href="#switch_statements">Les instructions switch</a></li> + </ul> + </li> + <li><a href="#functions_and_objects">Fonctions et objets</a> + <ul> + <li><a href="#function_naming">Nommage des fonctions</a></li> + <li><a href="#defining_functions">Définition des fonctions</a></li> + <li><a href="#creating_objects">Création d'objets</a></li> + <li><a href="#object_classes">Classes d'objets</a></li> + <li><a href="#object_naming">Nommage des objets</a></li> + </ul> + </li> + <li><a href="#arrays">Tableaux</a> + <ul> + <li><a href="#creating_arrays">Création de tableaux</a></li> + <li><a href="#adding_to_an_array">Ajout à un tableau</a></li> + </ul> + </li> + <li><a href="#error_handling">Traitement des erreurs</a></li> +</ul> + +<h2 id="General_JavaScript_guidelines">Directives générales sur le JavaScript</h2> + +<h3 id="Use_expanded_syntax">Utiliser une syntaxe étendue</h3> + +<p>Pour JavaScript, nous utilisons une syntaxe étendue, chaque ligne de JS étant placée sur une nouvelle ligne, l'accolade d'ouverture d'un bloc sur la même ligne que l'instruction associée et l'accolade de fermeture sur une nouvelle ligne. Cela permet d'optimiser la lisibilité et de favoriser la cohérence sur le MDN.</p> + +<p>Faites ceci</p> + +<pre class="brush: js example-good">function myFunc() { + console.log('Hello!'); +};</pre> + +<p>Évitez cela</p> + +<pre class="brush: js example-bad">function myFunc() { console.log('Hello!'); };</pre> + +<p>Nous avons également quelques règles spécifiques concernant l'espacement à l'intérieur des caractéristiques du langage. Vous devez inclure des espaces entre les opérateurs et les opérandes, les paramètres, etc.</p> + +<p>C'est plus lisible</p> + +<pre class="brush: js example-good">if(dayOfWeek === 7 && weather === 'soleil') { + goOnTrip('plage', 'voiture', ['crême glacée', 'pelle et sceau', 'serviette de plage']); +}</pre> + +<p>que ceci</p> + +<pre class="brush: js example-bad">if(dayOfWeek===7&&weather==='soleil'){ + goOnTrip('plage','voiture',['crême glacée','pelle et sceau','serviette de plage']); +}</pre> + +<p>En outre, gardez ces spécificités à l'esprit :</p> + +<ul> + <li>N'incluez pas d'espaces de remplissage après les parenthèses ouvrantes ou avant les parenthèses fermantes - <code>(myVar)</code>, et non <code>( myVar )</code>.</li> + <li>Toutes les instructions doivent se terminer par un point-virgule (";"). Nous les exigeons dans tous nos exemples de code, même s'ils sont techniquement facultatifs en JavaScript, car nous pensons que cela permet d'obtenir un code plus clair et plus précis quant à la fin de chaque instruction.</li> + <li>Utilisez des guillemets simples en JavaScript, chaque fois que des guillemets simples sont nécessaires dans la syntaxe.</li> + <li>Il ne doit pas y avoir d'espace entre un mot-clé d'instruction, une fonction ou une boucle et sa parenthèse ouvrante (par exemple, <code>if() { .... }</code>, <code>fonction myFunc() { ... }, for(...) { ... }</code>).</li> + <li>Il doit y avoir un espace entre les parenthèses et l'accolade ouvrante dans les cas décrits au point précédent.</li> +</ul> + +<h3 id="JavaScript_comments">Commentaires JavaScript</h3> + +<p>Utilisez des commentaires de style JS pour commenter le code qui n'est pas auto-documenté :</p> + +<pre class="brush: js example-good">// This is a JavaScript-style comment</pre> + +<p>Mettez vos commentaires sur des lignes séparées précédant le code auquel ils se réfèrent :</p> + +<pre class="brush: js example-good">function myFunc() { + // Affiche la chaîne de caractères "Bonjour" dans la console JS du navigateur. + console.log('Bonjour'); + // Crée un nouveau paragraphe, le remplit de contenu et l'ajoute au <body> + let para = document.createElement('p'); + para.textContent = 'Mon nouveau paragraphe'; + document.body.appendChild(para); +}</pre> + +<p>Notez également que vous devez laisser un espace entre les barres obliques et le commentaire, dans chaque cas.</p> + +<h3 id="Use_ES6_features">Utiliser les fonctions ES6</h3> + +<p>Pour un usage général*, vous pouvez utiliser les fonctionnalités ES6 courantes (telles que les <a href="/fr/docs/Web/JavaScript/Reference/Functions/Arrow_functions">fonctions fléchées</a>, <a href="/fr/docs/Web/JavaScript/Reference/Global_Objects/Promise">promesses</a>, <code><a href="/fr/docs/Web/JavaScript/Reference/Statements/let">let</a></code>/<code><a href="/fr/docs/Web/JavaScript/Reference/Statements/const">const</a></code>, <a href="/fr/docs/Web/JavaScript/Reference/Template_literals">littéraux de gabarits</a>, et le <a href="/fr/docs/Web/JavaScript/Reference/Operators/Spread_syntax">syntaxe de décomposition</a>) dans les exemples MDN. Nous les incluons à de nombreux endroits dans ces directives, car nous pensons que l'industrie du Web a généralement atteint un point où ces fonctionnalités sont suffisamment familières pour être compréhensibles. Et pour ceux qui ne les utilisent pas encore, nous aimerions jouer notre rôle en aidant les gens à développer leurs compétences.</p> + +<p>Cependant, nous ne recommandons pas encore l'utilisation générale des nouvelles fonctionnalités ES telles que <a href="/fr/docs/Web/JavaScript/Reference/Statements/async_function">async</a>/<a href="/fr/docs/Web/JavaScript/Reference/Operators/await">await</a>, les virgules de fin sur les listes d'arguments, etc. Nous préférerions que vous ne les utilisiez pas, sauf si cela est strictement nécessaire, et si vous les utilisez, incluez une explication dans votre exemple pour dire ce qu'ils font, avec un lien vers le matériel de référence approprié.</p> + +<div class="notecard note"> + <p><b>Note :</b></p> + <p>* Par "usage général", nous entendons la rédaction d'exemples généraux. Les pages de référence couvrant des fonctionnalités spécifiques de l'ES moderne doivent évidemment utiliser les fonctionnalités qu'elles documentent !</p> +</div> + +<h2 id="Variables">Variables</h2> + +<h3 id="Variable_naming">Nommage des variables</h3> + +<p>Pour les noms de variables, utilisez la casse minuscule au format chameau « lowerCamelCase » et, le cas échéant, des noms concis, lisibles par l'homme et sémantiques.</p> + +<p>Écrivez comme suit :</p> + +<pre class="brush: js example-good">let playerScore = 0; + +let speed = distance / time;</pre> + +<p>Éviter ce genre de chose :</p> + +<pre class="brush: js example-bad">let thisIsaveryLONGVariableThatRecordsPlayerscore345654 = 0; + +let s = d/t; +</pre> + +<div class="notecard note"> + <p><b>Note :</b></p> + <p>The only place where it is OK to not use human-readable semantic names is where a very common recognized convention exists, such as using <code>i</code>, <code>j</code>, etc. for loop iterators.</p> +</div> + +<h3 id="Declaring_variables">Déclaration des variables</h3> + +<p>Lorsque vous déclarez des variables et des constantes, utilisez les mots-clés <code><a href="/fr/docs/Web/JavaScript/Reference/Statements/let">let</a></code> et <code><a href="/fr/docs/Web/JavaScript/Reference/Statements/const">const</a></code>, pas <code><a href="/fr/docs/Web/JavaScript/Reference/Statements/var">var</a></code>.</p> + +<p>Si une variable ne sera pas réaffectée, préférez <code>const</code> :</p> + +<pre class="brush: js example-good">const myName = 'Chris'; +console.log(myName); +</pre> + +<p>Sinon, utilisez <code>let</code> :</p> + +<pre class="brush: js example-good">let myAge = '40'; +myAge++; +console.log('Happy birthday!'); +</pre> + +<p>Cet exemple utilise <code>let</code> là où il devrait préférer <code>const</code>. Il fonctionnera mais devrait être évité dans les exemples de code MDN :</p> + +<pre class="brush: js example-bad">let myName = 'Chris'; +console.log(myName); +</pre> + +<p>Cet exemple utilise <code>const</code> pour une variable qui est réaffectée. La réaffectation entraînera une erreur :</p> + +<pre class="brush: js example-bad">const myAge = '40'; +myAge++; +console.log('Happy birthday!'); +</pre> + +<p>Cet exemple utilise <code>var</code>, ce qui doit être évité dans les exemples de code MDN, sauf si cela est vraiment nécessaire :</p> + +<pre class="brush: js example-bad">var myAge = '40'; +var myName = 'Chris';</pre> + +<h2 id="Operators_and_comparison">Opérateurs et comparaison</h2> + +<h3 id="Ternary_operators">Opérateurs ternaires</h3> + +<p>Les opérateurs ternaires doivent être placés sur une seule ligne :</p> + +<pre class="brush: js example-good">let status = (age >= 18) ? 'adult' : 'minor';</pre> + +<p>Pas emboîtés :</p> + +<pre class="brush: js example-bad">let status = (age >= 18) + ? 'adult' + : 'minor';</pre> + +<p>C'est beaucoup plus difficile à lire.</p> + +<h3 id="Use_strict_equality">Utiliser l'égalité stricte</h3> + +<p>Utilisez toujours une égalité et une inégalité strictes.</p> + +<p>Comme ceci :</p> + +<pre class="brush: js example-good">name === 'Chris'; +age !== 25;</pre> + +<p>N'écrivez pas comme ça :</p> + +<pre class="brush: js example-bad">name == 'Chris'; +age != 25;</pre> + +<h3 id="Use_shortcuts_for_boolean_tests">Utiliser des raccourcis pour les tests booléens</h3> + +<p>Utilisez des raccourcis pour les tests booléens - utilisez <code>x</code> et <code>!x</code>, et non <code>x === true</code> et <code>x === false</code>.</p> + +<h2 id="Control_statements">Instructions de contrôle</h2> + +<p>Écrivez des instructions de contrôle comme ceci :</p> + +<pre class="brush: js example-good">if(iceCream) { + alert('Woo hoo!'); +}</pre> + +<p>Pas comme cela :</p> + +<pre class="brush: js example-bad">if (iceCream){ + alert('Woo hoo!'); +}</pre> + +<p>N'oubliez pas non plus :</p> + +<ul> + <li>Il ne doit y avoir <em>aucun espace</em> entre un mot-clé de déclaration de contrôle et sa parenthèse ouvrante.</li> + <li>Il doit y avoir <em>un espace</em> entre les parenthèses et l'accolade ouvrante.</li> +</ul> + +<h2 id="Strings">Chaînes de caractères</h2> + +<h3 id="Use_template_literals">Utiliser des modèles littéraux</h3> + +<p>Pour insérer des valeurs dans des chaînes de caractères, utilisez des chaînes de caractères littérales.</p> + +<p>Comme suit :</p> + +<pre class="brush: js example-good">let myName = 'Chris'; +console.log(`Hi! I'm ${myName}!`);</pre> + +<p>En évitant d'écrire :</p> + +<pre class="brush: js example-bad">let myName = 'Chris'; +console.log('Hi! I\'m' + myName + '!');</pre> + +<h3 id="Use_textContent_not_innerHTML">Utiliser textContent, et non innerHTML</h3> + +<p>Lorsque vous insérez des chaînes de caractères dans les nœuds du DOM, utilisez la fonction <a href="/fr/docs/Web/API/Node/textContent"><code>Node.textContent</code></a>:</p> + +<pre class="brush: js example-good">let text = 'Bonjour à vous tous, braves gens'; +const para = document.createElement('p'); +para.textContent = text;</pre> + +<p>Et pas <a href="/fr/docs/Web/API/Element/innerHTML"><code>Element.innerHTML</code></a>:</p> + +<pre class="brush: js example-bad">let text = 'Bonjour à vous tous, braves gens'; +const para = document.createElement('p'); +para.innerHTML = text;</pre> + +<p>Le <code>textContent</code> est beaucoup plus efficace, et moins sujet aux erreurs que le <code>innerHTML</code>.</p> + +<h2 id="Conditionals">Conditions</h2> + +<h3 id="General_purpose_looping">Usage général des boucles</h3> + +<p>When <a href="/fr/docs/Learn/JavaScript/Building_blocks/Looping_code">loops</a> are required, feel free to choose an appropriate loop out of the available ones (<code><a href="/fr/docs/Web/JavaScript/Reference/Statements/for">for</a></code>, <code><a href="/fr/docs/Web/JavaScript/Reference/Statements/for...of">for...of</a></code>, <code><a href="/fr/docs/Web/JavaScript/Reference/Statements/while">while</a></code>, etc.) Just make sure to keep the code as understandable as possible.</p> + +<p>Lorsque vous utilisez des boucles <code>for</code>/<code>for...of</code>, veillez à définir correctement l'initialisateur, avec un mot clé <code>let</code> :</p> + +<pre class="brush: js example-good">let cats = ['Athena', 'Luna']; +for(let i of cats) { + console.log(i); +} +</pre> + +<p>Pas</p> + +<pre class="brush: js example-bad">let cats = ['Athena', 'Luna']; +for(i of cats) { + console.log(i); +} +</pre> + +<p>Gardez également à l'esprit :</p> + +<ul> + <li>Il ne doit y avoir <em>aucun espace</em> entre un mot-clé de boucle et sa parenthèse ouvrante.</li> + <li>Il doit y avoir <em>un espace</em> entre les parenthèses et l'accolade ouvrante.</li> +</ul> + +<h3 id="Switch_statements">Les instructions switch</h3> + +<p>Formatez les instructions <code>switch</code> comme suit :</p> + +<pre class="brush: js example-good">let expr = 'Papayes'; +switch(expr) { + case 'Oranges': + console.log('Les oranges sont à 1,10 € le kilo.'); + break; + case 'Papayes': + console.log('Les mangues et les papayes sont à 5,24 € le kilo.'); + // résultat attendu : "Les mangues et les papayes sont à 5,24 € le kilo." + break; + default: + console.log('Désolé, nous n'avons plus de ' + expr + '.'); +}</pre> + +<h2 id="Functions_and_objects">Fonctions et objets</h2> + +<h3 id="Function_naming">Nommage des fonctions</h3> + +<p>Pour les noms de fonctions, utilisez la casse minuscule au format chameau « lowevCamelCase » et, le cas échéant, des noms concis, lisibles par l'homme et sémantiques.</p> + +<p>Par exemple :</p> + +<pre class="brush: js example-good">function sayHello() { + alert('Bonjour !'); +};</pre> + +<p>En évitant de faire :</p> + +<pre class="brush: js example-bad">function SayHello() { + alert('Bonjour !'); +}; + +function notVeryObviousName() { + alert('Bonjour !'); +}; +</pre> + +<div class="notecard note"> + <p><b>Note :</b></p> + <p>Le seul endroit où il est acceptable de ne pas utiliser des noms sémantiques lisibles par l'homme est lorsqu'une convention reconnue très courante existe, comme l'utilisation de <code>i</code>, <code>j</code>, etc. pour les itérateurs de boucle.</p> +</div> + +<h3 id="Defining_functions">Définition des fonctions</h3> + +<p>Dans la mesure du possible, utilisez la déclaration <code>fonction</code> pour définir des fonctions sur des expressions de fonction :</p> + +<p>Faites comme ça :</p> + +<pre class="brush: js example-good">function sum(a, b) { + return a + b; +}</pre> + +<p>Pas comme ça :</p> + +<pre class="brush: js example-bad">let sum = function(a, b) { + return a + b; +}</pre> + +<p>Lorsque vous utilisez des fonctions anonymes à l'intérieur d'une méthode qui requiert une fonction comme paramètre, il est acceptable (mais pas obligatoire) d'utiliser une fonction flèche pour rendre le code plus court et plus propre.</p> + +<p>Donc, au lieu de ça :</p> + +<pre class="brush: js example-good">const array1 = [1, 2, 3, 4]; +let sum = array.reduce(function(a, b) { + return a + b; +});</pre> + +<p>vous pourriez écrire ceci :</p> + +<pre class="brush: js example-good">const array = [1, 2, 3, 4]; +let sum = array.reduce((a, b) => + a + b +);</pre> + +<p>N'oubliez pas non plus :</p> + +<ul> + <li>Il ne doit y avoir <em>aucun espace</em> entre un nom de fonction et sa parenthèse ouvrante.</li> + <li>Il doit y avoir <em>un espace</em> entre les parenthèses et l'accolade ouvrante.</li> +</ul> + +<h3 id="Creating_objects">Création d'objets</h3> + +<p>Utilisez des littéraux - et non des constructeurs - pour créer des objets généraux (c'est-à-dire lorsque les classes ne sont pas concernées) :</p> + +<p>Par exemple :</p> + +<pre class="brush: js example-good">let myObject = { };</pre> + +<p>Et pas :</p> + +<pre class="brush: js example-bad">let myObject = new Object();</pre> + +<h3 id="Object_classes">Classes d'objets</h3> + +<p>Utilisez la syntaxe de classe ES pour les objets, et non les constructeurs à l'ancienne.</p> + +<p>À titre d'exemples :</p> + +<pre class="brush: js example-good">class Person { + constructor(name, age, gender) { + this.name = name; + this.age = age; + this.gender = gender; + } + + greeting() { + console.log(`Salut ! Je m'appelle ${this.name}`); + }; +}</pre> + +<p>Utilisez <code>extends</code> pour l'héritage :</p> + +<pre class="brush: js example-good">class Teacher extends Person { + ... +}</pre> + +<h3 id="Object_naming">Nommage des objets</h3> + +<p>Lorsque vous définissez une classe d'objets (comme ci-dessus), utilisez l'écriture de casse au format chameau en majuscule « UpperCamelCase » (également connue sous le nom de « PascalCasing ») pour le nom de la classe, et la casse en minuscule « lowerCamelCase » pour les noms des propriétés et des méthodes de l'objet.</p> + +<p>Lors de la définition d'une instance d'objet, qu'il s'agisse d'un littéral ou d'un constructeur, utilisez le lowerCamelCase pour le nom de l'instance :</p> + +<pre class="brush: js example-good">let hanSolo = new Person('Han Solo', 25, 'male'); + +let hanSolo = { + name: 'Han Solo', + age: 25, + gender: 'male' +}</pre> + +<h2 id="Arrays">Tableaux</h2> + +<h3 id="Creating_arrays">Création de tableaux</h3> + +<p>Utilisez des littéraux - et non des constructeurs - pour créer des tableaux :</p> + +<p>Comme ceci :</p> + +<pre class="brush: js example-good">let myArray = [ ];</pre> + +<p>Pas comme ça :</p> + +<pre class="brush: js example-bad">let myArray = new Array(length);</pre> + +<h3 id="Adding_to_an_array">Ajout à un tableau</h3> + +<p>Pour ajouter des éléments à un tableau, utilisez <code><a href="/fr/docs/Web/JavaScript/Reference/Global_Objects/Array/push">push()</a></code>, et non l'affectation directe. Étant donné le tableau suivant :</p> + +<pre class="brush: js">const pets = [];</pre> + +<p>faites ça :</p> + +<pre class="brush: js example-good">pets.push('cat');</pre> + +<p>et pas ça :</p> + +<pre class="brush: js example-bad">pets[pets.length] = 'cat';</pre> + +<h2 id="Error_handling">Traitement des erreurs</h2> + +<p>Si certains états de votre programme lancent des erreurs non attrapées, ils interrompent l'exécution et réduisent potentiellement l'utilité de l'exemple. Vous devriez donc attraper les erreurs en utilisant un bloc <code><a href="/fr/docs/Web/JavaScript/Reference/Statements/try...catch">try...catch</a></code> :</p> + +<pre class="brush: js example-good">try { + console.log(results); +} +catch(e) { + console.error(e); +}</pre> + +<h2 id="Good_JavaScript_examples_on_MDN">De bons exemples de JavaScript sur MDN</h2> + +<p>Vous pouvez trouver de bons extraits de JavaScript, concis et significatifs, en haut de nos pages <a href="/fr/docs/Web/JavaScript/Reference">Référence du langage JavaScript</a> - parcourez-les pour en trouver.</p> + +<p>Nos exemples interactifs (et autres) sont généralement rédigés de manière à suivre les directives ci-dessus, mais sachez qu'ils peuvent différer à certains endroits, car ils ont été rédigés pour la plupart avant que les directives ne soient nouvellement rédigées.</p> + +<p>En ce qui concerne les exemples d'API, nous aimerions mettre en avant quelques exemples qui nous semblent bons :</p> + +<ul> + <li><a href="/fr/docs/Web/API/WindowOrWorkerGlobalScope/fetch#examples">Exemples de <code>fetch()</code></a></li> + <li><a href="/fr/docs/Web/API/CanvasRenderingContext2D/fillRect#examples">Exemples de <code>fillRect()</code></a> (les exemples de Canvas 2D sont généralement bons, bien qu'ils utilisent toujours l'ancienne déclaration <code>var</code>).</li> + <li><a href="/fr/docs/Web/API/PaymentRequest/show">Payment Request API <code>show()</code></a> (Les exemples de <a href="/fr/docs/Web/API/PaymentRequest"><code>PaymentRequest</code></a> sont généralement assez bons).</li> + <li><a href="/fr/docs/Web/API/Web_Audio_API/Using_Web_Audio_API">Utilisations de l'API Web Audio</a> (les bonnes pratiques générales en matière de HTML, CSS et JavaScript, ainsi qu'une bonne démonstration de l'utilisation des extraits et des liens vers des exemples complets ailleurs).</li> + <li><a href="/fr/docs/Web/API/Media_Capabilities_API/Using_the_Media_Capabilities_API">Utilisations de l'API Media Capabilities</a> (des bonnes pratiques plus générales pour l'utilisation des extraits de code dans un guide).</li> +</ul> diff --git a/files/fr/mdn/guidelines/code_guidelines/shell/index.html b/files/fr/mdn/guidelines/code_guidelines/shell/index.html new file mode 100644 index 0000000000..d00ea40c41 --- /dev/null +++ b/files/fr/mdn/guidelines/code_guidelines/shell/index.html @@ -0,0 +1,37 @@ +--- +title: Lignes directrices des exemples de lignes de commande +slug: MDN/Guidelines/Code_guidelines/Shell +tags: + - Code + - Guide + - Guidelines + - MDN Meta + - Shell +translation_of: MDN/Guidelines/Code_guidelines/Shell +--- +<div>{{MDNSidebar}}</div> + +<p class="summary">Les directives suivantes expliquent comment rédiger des exemples de lignes de commande sur MDN.</p> + +<h2 id="Shell_prompts_in_brief">Les commandes Shell en bref</h2> + +<p>Un <i>shell</i> est un programme qui attend que vous tapiez une commande et que vous appuyiez sur la touche retour. Pour indiquer les commandes que vous devez taper, la documentation MDN les répertorie dans un bloc de code, similaire aux exemples de code. Un tel bloc ressemble à ceci :</p> + +<pre class="brush: bash example-good"># Cela peut prendre un certain temps… +hg clone https://hg.mozilla.org/mozilla-central/ firefox +cd firefox</pre> + +<h2 id="Guidelines">Directives</h2> + +<p>Il existe quelques directives à suivre lors de l'écriture d'un bloc de code shell :</p> + +<ul> + <li>N'incluez pas de "$" ou de ">" au début d'une instruction shell. Cela perturbe plus qu'il n'aide et n'est pas utile pour copier les instructions.</li> + <li>Les commentaires commencent par "#".</li> + <li>Choisissez la coloration syntaxique "bash".</li> +</ul> + +<h2 id="Good_shell_prompt_examples_on_MDN">De bons exemples de commandes shell sur le MDN</h2> + +<p>Nos <a href="/fr/docs/Learn/Server-side/Django">Documents de développement côté serveur de Django</a> montrent une bonne pratique de présentation des commandes de l'invite shell, etc. sur le MDN. Regardez <a href="/fr/docs/Learn/Server-side/Django/development_environment">Configurer un environnement de développement Django</a> par exemple.</p> + diff --git a/files/fr/mdn/guidelines/conventions_definitions/index.html b/files/fr/mdn/guidelines/conventions_definitions/index.html new file mode 100644 index 0000000000..eabb1b964f --- /dev/null +++ b/files/fr/mdn/guidelines/conventions_definitions/index.html @@ -0,0 +1,175 @@ +--- +title: Conventions et définitions relatives à MDN +slug: MDN/Guidelines/Conventions_definitions +tags: + - Documentation + - Guide + - Guidelines + - MDN + - MDN Meta +translation_of: MDN/Guidelines/Conventions_definitions +--- +<div>{{MDNSidebar}}</div> + +<p class="summary">Cet article définit certaines conventions et définitions couramment utilisées sur MDN et qui pourraient ne pas être évidentes au sein de la documentation.</p> + +<h2 id="Definitions">Définitions</h2> + +<h3 id="Deprecated_and_obsolete">Déprécié et obsolète</h3> + +<p>Les adjectifs <strong>déprécié</strong> et <strong>obsolète</strong> sont souvent associés à des technologies ou à des spécifications : qu'est-ce que cela signifie ?</p> + +<dl> + <dt>Déprécié (<i>deprecated</i> en anglais)</dt> + <dd>Sur MDN, le terme <strong>déprécié</strong> est utilisé afin d'indiquer qu'une API ou une technologie n'est plus recommandée bien qu'elle soit toujours implémentée et qu'elle puisse encore fonctionner. Nous avons mis à jour la définition utilisée <a href="https://github.com/mdn/browser-compat-data/blob/master/schemas/compat-data-schema.md#status-information">pour le projet browser-compat-data</a> qui indique "cette fonctionnalité n'est désormais plus recommandée. Elle pourra être supprimée à l'avenir ou être conservée uniquement à des fins de compatibilité. Veuillez éviter d'utiliser cette fonctionnalité."</dd> + <dt>Obsolète</dt> + <dd>Sur MDN, le terme <strong>obsolète</strong> est utilisé afin d'indiquer une API ou une technologie qui n'est plus recommandée et qui n'est plus implémentée dans les navigateurs. Cette nuance avec la dépréciation pouvait être source de confusion et peu utile (dans les deux cas, on doit éviter d'utiliser une telle fonctionnalité pour un site ou une application en production). Nous n'utilisons plus cette notion désormais et toute occurrence devrait être retirée/remplacée par « déprécié ».</dd> +</dl> + +<h3 id="Experimental">Expérimental</h3> + +<p><strong>Expérimental</strong> peut avoir différentes significations en fonction du contexte. Lorsqu'on décrit une technologie comme expérimentale sur MDN, cela signifie qu'elle est en cours de conception/implémentation et en train d'être ajoutée à la plateforme web (ou que son ajout est envisagé).</p> + +<p>Au moins un des deux points qui suivent sera vérifié :</p> + +<ul> + <li>Elle est implémentée et activée par défaut dans moins de deux des navigateurs principaux.</li> + <li>La spécification sous-jacente peut changer de façon significative et entraîner des ruptures de rétro-compatibilité (autrement dit, ces modifications peuvent casser le code qui exploite ces fonctionnalités).</li> +</ul> + +<p>Si l'une ou l'autre (ou les deux) de ces propositions est vraie, il est préférable de réfléchir avant d'ajouter cette technologique à un projet de production (qui n'est ni une démonstration ni une expérimentation). Voir aussi la définition d'« expérimental » dans <a href="https://github.com/mdn/browser-compat-data/blob/master/schemas/compat-data-schema.md#status-information">le projet browser-compat-data</a>.</p> + +<p>À l'inverse, quelque chose n'est plus expérimental lorsque :</p> + +<ul> + <li>C'est implémenté dans deux navigateurs principaux ou plus ou</li> + <li>Que sa spécification risque peu d'évoluer d'une façon qui casserait la compatibilité avec le Web.</li> +</ul> + +<p>Le <em>ou</em> a toute son importance ici. Généralement, si une technologie est implémentée sur différents navigateurs principaux, la spécification sera stable. Toutefois, ce n'est pas toujours le cas. On a aussi des technologies dont la spécification est stable mais qui ne sont pas implémentées nativement dans les navigateurs (voir <a href="/fr/docs/Related/IMSC">IMSC</a>, par exemple).</p> + +<h3 id="Archived_pages">Pages archivées</h3> + +<p>Les pages archivées sont des pages stockées dans <a href="/fr/docs/Archive">les archives MDN pour le contenu obsolète</a>. Ces pages contiennent des informations caduques qui ne sont plus directement utiles.</p> + +<p>Pour la plupart, elles concernent des projets Mozilla qui ont été arrêtés et qu'on ne devrait plus utiliser. Elles ne sont cependant pas supprimées en raison de leur valeur historique et de certains concepts ou idées qui pourraient s'avérer utiles pour de futurs projets (un bon exemple est <a href="/fr/docs/Archive/B2G_OS">le projet B2G (Firefox OS)</a>).</p> + +<h4 id="When_should_a_page_be_archived">Comment décider de l'archivage d'une page ?</h4> + +<p>Une page devrait être archivée si elle s'inscrit dans la description précédente. Pour archiver une page, voir <a href="https://github.com/mdn/content#archiving-and-unarchiving-pages">la documentation correspondante sur GitHub</a>.</p> + +<h3 id="Deleted_pages">Pages supprimées</h3> + +<p>Les pages supprimées ont été explicitement supprimées de MDN. On aura par exemple l'interface <code><a href="/fr/docs/Web/API/SharedKeyframeList">SharedKeyframeList</a></code> et le constructeur <code><a href="/fr/docs/Web/API/SharedKeyframeList/SharedKeyframeList">SharedKeyframeList()</a></code>. Ces pages contenaient des informations qui ne sont plus utiles à qui que ce soit et/ou qui sont incorrectes au point qu'elles peuvent être source de confusion ou d'interprétations erronées.</p> + +<p>Il peut s'agir :</p> + +<ul> + <li>De pages de référence pour les fonctionnalités d'API qui ont été retirées de la spécification avant toute implémentation dans les navigateurs.</li> + <li>D'articles couvrant des techniques qui se sont avérés de mauvaises pratiques par la suite ou qui ont été remplacées par de meilleures pratiques.</li> + <li>D'articles contenant des informations remplacés par d'autres articles, de meilleure qualité.</li> + <li>D'articles contenant du contenu inapproprié pour MDN.</li> + <li>De traductions obsolètes pour lesquelles la version anglaise est préférable en tout point et pour lesquelles il serait plus judicieux de démarrer une nouvelle traduction.</li> +</ul> + +<h4 id="When_should_a_page_be_deleted">Comment décider de la suppression d'une page ?</h4> + +<p>Une page devrait être supprimée si elle correspond à la description précédente. Pour supprimer une page, voir <a href="https://github.com/mdn/content#deleting-a-document">la documentation sur GitHub</a>.</p> + +<h3 id="When_to_document_new_technologies">Quand documenter de nouvelles technologies</h3> + +<p>Sur MDN, nous cherchons continuellement à documenter les technologies web standard comme il se doit. Il faut donc trouver un équilibre entre une documentation publiée suffisamment tôt afin que les développeurs puissent découvrir les nouvelles fonctionnalités lorsqu'ils en ont besoin et une documentation publiée suffisamment tard afin que la technologie en question soit suffisamment mature et stable afin que la documentation n'ait pas à être réécrite constamment ou à être supprimée rapidement suite à des changements de rupture dans les spécifications.</p> + +<p>En général, le seuil pour déclencher la documentation d'une nouvelle technologie web correspond au moment où :</p> + +<p><em>« La fonctionnalité est en voie de standardisation et implémentée quelque part. »</em></p> + +<p>Une nouvelle technologie mérite sans doute d'être documentée si :</p> + +<ul> + <li>Elle est spécifiée dans une spécification publiée par une organisation de standardisation reconnue (tel que le W3C, le WHATWG, Khronos, l'IETF, etc.) et qu'elle a atteint un certain niveau de stabilité (pour le W3C, par exemple, il peut s'agir du statut « <i>working draft</i> » ou « <i>candidate recommendation</i> ») qui peut également se traduire par le volume de tickets renseignés à son propos).</li> + <li>Elle est implémentée par au moins un navigateur et que d'autres navigateurs témoignent d'un intérêt pour l'implémentation (par exemple avec un ticket « <i>intent to implement</i> »).</li> +</ul> + +<p>Il faut prendre ses précautions quant à la documentation d'une nouvelle technologie si :</p> + +<ul> + <li>Elle ne dispose d'aucune spécification ou si cette spécification est une note/un brouillon sujet à changement.</li> + <li>Un ou aucun navigateur ne l'implémente et que le reste des navigateurs ne témoigne pas d'intérêt pour son implémentation (ce qui peut être déterminé en demandant aux développeuses et développeurs de ces navigateurs ou en consultant les systèmes de ticket ou les listes de diffusion, etc.).</li> +</ul> + +<p>Une nouvelle technologie ne doit pas être documentée si :</p> + +<ul> + <li>Il ne s'agit pas d'une technologie web et/ou qu'il s'agit d'une technologie propriétaire.</li> + <li>Il existe déjà des signes de dépréciation ou de remplacement par une fonctionnalité similaire.</li> +</ul> + +<h2 id="Conventions">Conventions</h2> + +<h3 id="When_something_is_removed_from_the_specification">Lors du retrait d'une fonctionnalité de la spécification</h3> + +<p>Il arrive parfois, pendant le développement d'une spécification et au fur à et mesure de l'évolution de standards évolutifs que de nouveaux éléments, de nouvelles méthodes ou propriétés ou autres soient ajoutés à la spécification, y restent pendant quelque temps avant d'être retirés. Cela arrive parfois rapidement et peut aussi prendre plusieurs mois ou années avant que la suppression soit effectuée. Gérer cette suppression dans la documentation peut alors s'avérer délicat. Voici quelques lignes directrices pour vous aider à décider de ce qu'il faut faire.</p> + +<div class="note"> +<p>Pour la suite de cette discussion, le terme « élément » sera utilisé de façon générique pour indique n'importe quel objet qui peut faire partie d'une spécification : un élément, un attribut d'un élément, une interface, une méthode spécifique, une propriété, un membre d'une interface, etc.</p> +</div> + +<ul> + <li>Si l'élément n'a <em>jamais</em> été implémenté dans une version release d'<em>aucun</em> navigateur (y compris derrière une préférence ou un marqueur/flag), on supprimera toute référence à cet élément de la documentation. + + <ul> + <li>Si l'élément n'est décrit dans la documentation que par une ou des pages concernant uniquement cet élément (tel que <a href="/fr/docs/Web/API/RTCPeerConnection/close()"><code>RTCPeerConnection.close()</code></a>), on supprimera cette page. Si l'élément à retirer est une interface, on retirera également toutes les sous-pages pour chacune des propriétés et des méthodes pour cette interface.</li> + <li>On supprimera l'élément de toute liste de propriétés, d'attributs, de méthodes, etc. Pour les méthodes d'une interface, cela signifie qu'on retirera le lien de la section « Méthodes » de la page générale sur l'interface.</li> + <li>On cherchera dans le texte de la page de l'interface toute mention à cet élément afin de les supprimer. Lors de cette suppression on fera attention à vérifier que la modification ne cause pas d'erreur de grammaire ou d'incohérence. Aussi, il faudra parfois reformuler une phrase ou un paragraphe lors de la suppression. On peut aussi avoir à supprimer des sections entières si la description de l'élément est verbeuse.</li> + <li>De même, on cherchera les références à cet élément dans les guides, les tutoriels et dans la documentation connexe. Là encore, on veillera à la cohérence et à la grammaire lors de la suppression, quitte à reformuler ce qui doit l'être.</li> + <li>On cherchera parmi le contenu de référence sur MDN pour vérifier qu'il n'y a pas d'autres mentions autre part (on les retirera également le cas échéant).</li> + <li>Si les fichiers JSON du <a href="https://github.com/mdn/browser-compat-data">dépôt pour les données de compatibilité des navigateurs</a> contiennent des données relatives aux éléments supprimés, on les supprimera des fichiers et on fournira une PR expliquant la raison de cette suppression dans le message de commit et dans la description de la PR. Ce faisant, on veillera à ne pas casser la structure syntaxique du JSON.</li> + </ul> + </li> + <li>Si l'élément a été implémenté dans au moins une release d'au moins un des principaux navigateurs <em>mais uniquement derrière une préférence</em> ou un marqueur, on ne supprimera pas immédiatement la documentation associée. À la place, on indiquera que l'élément est déprécié de la façon suivante : + <ul> + <li>Si la documentation possède des pages décrivant uniquement cet élément (tel que <a href="/fr/docs/Web/API/RTCPeerConnection/close()"><code>RTCPeerConnection.close()</code></a>), on ajoutera la macro {{TemplateLink("deprecated_header")}} en haut de la page et on ajoutera la balise <i>Deprecated</i> à la liste des étiquettes de la page.</li> + <li>Sur la page de présentation de l'élément, de l'interface ou de l'API, on trouvera la liste des éléments qui incluent cet élément retiré et on ajoutera la macro {{TemplateLink("deprecated_inline")}} après le nom de l'élément dans la liste.</li> + <li>On cherchera les mentions de cet élément parmi les textes d'informations sur la page générale de l'interface, de l'élément et on ajoutera des avertissements pertinents au sein de ces textes en indiquant « [telle fonctionnalité] a été retirée de la spécification et sera prochainement retiré des navigateurs. Voir [lien vers un autre article] pour une autre façon de procéder ».</li> + <li>De même, on cherchera les mentions dans les guides ou tutoriels et on ajoutera des avertissements semblables.</li> + <li>On cherchera sur l'ensemble de MDN les différentes références à l'élément supprimé afin d'ajouter des avertissements.</li> + <li>Plus tard, une décision pourra être prise quant au retrait définitif de cet élément dans la spécification. Ce n'est pas la démarche normale mais si l'élément était particulièrement peu utilisé ou mineur, on pourra choisir cette voie.</li> + <li>On mettra à jour les données <a href="https://github.com/mdn/browser-compat-data">du dépôt de données quant à la compatibilité des navigateurs</a> pour refléter cette obsolescence.</li> + </ul> + </li> + <li>Si l'élément a été implémenté dans au moins une release d'au moins un navigateur sans préférence ou marqueur nécessaire, on marquera la dépréciation de l'élément ainsi : + <ul> + <li>Si l'élément est documenté dans des pages de référence qui lui sont spécifiques (par exemple <a href="/fr/docs/Web/API/RTCPeerConnection/close()"><code>RTCPeerConnection.close()</code></a>), on ajoutera {{TemplateLink("deprecated_header")}} en haut de la page et on ajoutera l'étiquette « Deprecated » aux méta-données de la page.</li> + <li>Sur la page qui présente l'élément, l'interface ou l'API, on ajoutera la macro {{TemplateLink("deprecated_inline")}} pour les mentions de l'élément supprimé dans les différentes listes.</li> + <li>Pour tout texte d'information ou de description sur la page de présentation générale, on ajoutera des avertissements indiquant que l'élément a été supprimé de la spécification et qu'il est désormais déprécié et pourra être supprimé des navigateurs. On indiquera que son utilisation est déconseillée et on ajoutera des liens vers toute page qui documenterait des méthodes alternatives.</li> + <li>On fera de même pour toute mention dans les guides et tutoriels qui mentionnent cet élément.</li> + <li>On fera de même pour toute mention autre part sur MDN.</li> + <li>Il est très peu probable que ces mentions soient retirées de la documentation. Toutefois, il est possible que certaines de ces pages soient déplacées dans les <a href="/fr/docs/Archive">Archives</a>.</li> + <li>On mettra à jour les éléments concernés <a href="https://github.com/mdn/browser-compat-data">dans le dépôt de données de compatibilité des navigateurs </a> afin d'indiquer la dépréciation de l'élément.</li> + </ul> + </li> +</ul> + +<p>Les formulations exactes des avertissements et autres messages doivent être adaptées si besoin. En cas de doute sur la formulation, n'hésitez pas à vous rendre sur <a href="https://chat.mozilla.org/#/room/#mdn:mozilla.org">le canal MDN</a> sur <a href="https://wiki.mozilla.org/Matrix">Matrix</a> ou sur le forum de discussion <a href="https://discourse.mozilla.org/c/mdn">Discourse</a>.</p> + +<h3 id="Copying_content_from_elsewhere">Copier du contenu d'une source tierce sur MDN</h3> + +<p>Il existe souvent du contenu utile sur un sujet donné en dehors de MDN. Toutefois, copier ce contenu peut s'accompagner de pénalités légales ou techniques.</p> + +<p>Sur le plan technique, les moteurs de recherche ont tendance à pénaliser le classement d'un site qui reproduit du contenu existant par ailleurs. Il est donc préférable d'avoir du contenu original sur MDN pour veiller au bon référencement. On peut tout à fait ajouter des liens vers du contenu externe.</p> + +<p>Sur le plan légal, il faut être autorisé à contribuer au contenu et il doit être sous une licence et une attribution compatible avec <a href="/fr/docs/MDN/About#copyrights_and_licenses">celle de MDN</a>.</p> + +<ul> + <li><strong>Si vous avez créé le contenu en question</strong> (pour votre propre intérêt et en dehors de tout travail rémunéré) et que vous souhaitez contribuer à MDN sous la licence de MDN, c'est la situation la plus simple, n'hésitez pas à contribuer avec ce contenu.</li> + <li><strong>Si les droits d'auteur du contenu appartiennent à quelqu'un d'autre</strong>, il devra être sous une licence et attribué de façon compatible avec la licence de MDN. Il n'est souvent pas facile de déterminer la compatibilité entre deux licences sans bagage juridique. Pour ne pas prendre de risque inutile, vous pouvez contacter quelqu'un de l'équipe MDN sur <a href="https://chat.mozilla.org/#/room/#mdn:mozilla.org">le canal MDN</a> sur <a href="https://wiki.mozilla.org/Matrix">Matrix</a> ou sur le forum de discussion <a href="https://discourse.mozilla.org/c/mdn">Discourse</a>.</li> +</ul> + +<h3 id="How_to_communicate_a_spec_conflict">Comment indiquer un conflit de spécification</h3> + +<p>Il arrive (rarement) qu'il y ait un conflit entre les différentes versions d'une spécification (généralement pour celles du W3C et du WHATWG). Par exemple, une des spécifications peut indiquer une fonctionnalité comme dépréciée tandis que l'autre n'indique pas cet état. Dans ces cas, on étudiera le comportement réel des navigateurs et on écrira une note afin d'indiquer cet état. Ainsi, en janvier 2019, l'attribut global <code><a href="/fr/docs/Web/HTML/Global_attributes/inputmode">inputmode</a></code> était touché par un conflit de spécification qui était indiqué ainsi sur la page :</p> + +<div class="notecard warning"> +<p><strong>Conflit de spécification </strong>: La <a href="https://html.spec.whatwg.org/multipage/interaction.html#attr-inputmode">spécification WHATWG liste l'attribut <code>inputmode</code></a> et les navigateurs travaillent à son implémentation. La <a href="https://www.w3.org/TR/html52/index.html#contents">spécification W3C HTML 5.2</a> ne le mentionne plus en revanche (ce qui indique qu'il est considéré comme obsolète). Jusqu'à ce qu'un consensus soit atteint, on pourra considérer que c'est la définition du WHATWG qui est correcte.</p> +</div> diff --git a/files/fr/mdn/guidelines/css_style_guide/index.html b/files/fr/mdn/guidelines/css_style_guide/index.html new file mode 100644 index 0000000000..9b0fc4111b --- /dev/null +++ b/files/fr/mdn/guidelines/css_style_guide/index.html @@ -0,0 +1,382 @@ +--- +title: Guide relatif aux classes et styles utilisés dans le contenu de MDN +slug: MDN/Guidelines/CSS_style_guide +tags: + - Classes + - Guide + - Guidelines + - MDN + - MDN Meta + - Styles +translation_of: MDN/Guidelines/Conventions_definitions +--- +<p>{{MDNSidebar}}</p> + +<p class="summary"><span class="seoSummary">MDN dispose de nombreux styles prédéfinis qui peuvent être utilisés dans les articles. Cette page recense les différentes classes disponibles et comment les utiliser.</span></p> + +<p>On gardera à l'esprit que ces styles ont été développés afin d'aborder la plupart des situations pour la mise en forme du contenu d'un article. Autant que possible, on devra utiliser ces classes disponibles pour éviter de créer une hétérogénéité de styles. Si vous pensez qu'une page nécessite une mise en forme spécifique, commencez <a href="/fr/docs/MDN/Contribute/Getting_started#step_4_ask_for_help">par en discuter</a>.</p> + +<h2 id="Inline_styles">Styles en incise (inline)</h2> + +<p>Cette section référence les différents styles en incise qui sont disponibles pour les blocs de contenu sur MDN.</p> + +<h3 id=".button"><code>.button</code></h3> + +<p>Met en forme comme un bouton. Généralement utilisé pour mettre en forme des liens (les éléments <a href="/fr/docs/Web/HTML/Element/button"><code><button></code></a> sont supprimés des sources des articles pour des raisons de sécurité).</p> + +<p><a class="button" href="https://github.com/mdn/simple-web-worker/archive/gh-pages.zip">Télécharger le code source</a></p> + +<h4 id="Example_syntax">Exemple de syntaxe</h4> + +<pre class="brush: html"><a href="https://github.com/mdn/simple-web-worker/archive/gh-pages.zip" class="button">Télécharger le code source</a></pre> + +<h3 id=".hidden"><code>.hidden</code></h3> + +<p>Permet de masquer le contenu dans la vue affichée au lecteur. Elle est généralement utilisée afin de fournir des blocs de code HTML, CSS et JavaScript complémentaires pour les exemples interactifs pour n'afficher que le contenu pertinent pour la page courante.</p> + +<h4 id="Example_syntax_3">Exemple de syntaxe</h4> + +<pre class="brush: html"><h4 id="Hidden_Code_Sample">Exemple de code masqué</h4> + +<div class="hidden"> +<h5 id="HTML">HTML</h5> + +<pre class="brush: html;"> +&lt;button id="test"&gt; Cliquez ici&lt;/button&gt; + +<h5 id="CSS">CSS</h5> + +<pre class="brush: css;"> +button { + background-color: #a00; + color:#fff; + font-size: 20px; +} +</pre> +</div> + +<h5 id="JavaScript_Content">JavaScript</h5> + +<pre class="brush: js;"> +document.getElementById("test").addEventListener("click", works); +function works() { + console.log("vous avez cliqué !"); +} +</pre> + +<p>\{{EmbedLiveSample("Hidden_Code_Sample")}}</p> +</pre> + +<h4 id="Hidden_code_sample">Exemple de code masqué</h4> + +<div class="hidden"> +<h5 id="HTML">HTML</h5> + +<pre class="brush: html"><button id="test">Cliquez ici</button> +</pre> + +<h5 id="CSS">CSS</h5> + +<pre class="brush: css">button{ + background-color: #a00; + color:#fff; + font-size: 20px; +} +</pre> +</div> + +<h5 id="JavaScript">JavaScript</h5> + +<pre class="brush: js">document.getElementById("test").addEventListener("click", works); +function works(){ + console.log("vous avez cliqué !"); +} +</pre> + +<p>{{EmbedLiveSample("Hidden_code_sample", "100%", 150)}}</p> + +<h3 id=".seoSummary"><code>.seoSummary</code></h3> + +<p>Il s'agit d'une classe sans effet visible sur le contenu de la page. Toutefois, si la classe est appliquée à un élément (généralement un <a href="/fr/docs/Web/HTML/Element/span"><code><span></code></a>), KumaScript utilisera le contenu de l'élément afin de créer une <code>description</code> via une balise <a href="/fr/docs/Web/HTML/Element/meta"><code><meta></code></a>. Celle-ci sera utilisée pour fournir une courte description dans les moteurs de recherche et sur les tuiles générées dans les messages sur les réseaux sociaux comme Facebook et Twitter.</p> + +<div class="notecard note"> + <h4>Note</h4> + <p>Si <code>.seoSummary</code> n'est pas explicitement utilisée sur une page, le premier paragraphe sera automatiquement utilisé comme telle description.</p> +</div> + +<h4 id="Example_syntax_4">Exemple de syntaxe</h4> + +<pre class="brush: html"><span class="seoSummary"> + Les extensions permettent aux développeuses et développeurs d'étendre les fonctionnalités d'un navigateur. +</span></pre> + +<h4 id="Example_of_the_generated_HTMLElementmeta_elements">Exemple de <a href="/fr/docs/Web/HTML/Element/meta"><code><meta></code></a> généré</h4> + +<pre class="brush: html;"><meta name="description" + content="Les extensions permettent aux développeuses et développeurs d'étendre les fonctionnalités d'un navigateur."></pre> + +<h2 id="Block_level_styles">Styles pour les éléments de bloc</h2> + +<p>Cette section énumère les différents styles permettant de mettre en forme les éléments de bloc sur MDN.</p> + +<h3 id="Code_syntax_highlighting">Coloration syntaxique du code</h3> + +<p>Pour créer un exemple de bloc de code sur MDN, on utilisera un élément <code><pre></code> :</p> + +<pre> +<pre>p { + color: red; + /* Voici mon exemple de code */ +}</pre> +</pre> + +Cela fournira le résultat suivant : + +<pre>p { + color: red; + /* Voici mon exemple de code */ +}</pre> + +<p>Si vous souhaitez indiquer une coloration syntaxique dans l'exemple de code, il faudra inclure un attribut <code>class</code> avec une valeur <code>brush: <em>type-de-langage</em></code> où <code><em>type-de-langage</em></code> pourra être une valeur parmi :</p> + +<ul> + <li><code>bash</code></li> + <li><code>cpp</code> (pour C/C++)</li> + <li><code>css</code></li> + <li><code>html</code></li> + <li><code>java</code></li> + <li><code>js</code> (pour JavaScript)</li> + <li><code>json</code></li> + <li><code>php</code></li> + <li><code>python</code></li> + <li><code>sql</code></li> + <li><code>xml</code></li> + <li><code>wasm</code> (pour le format texte WebAssembly)</li> +</ul> + +<p>Par exemple, pour utiliser une coloration syntaxique pour CSS, on pourra écrire :</p> + +<pre> +<pre class="brush: css">p { + color: red; + /* Voici mon exemple de code */ +}</pre> +</pre> + +Ce qui fournira le résultat suivant : + +<pre class="brush: css">p { + color: red; + /* Voici mon exemple de code */ +}</pre> + +<p>Si aucun langage pertinent n'est disponible, on pourra n'utiliser aucune valeur ou <code>brush: plain</code> afin d'avoir du code sans coloration syntaxique.</p> + +<h3 id="details"><code>details</code></h3> + +<p>Un élément <code><details></code> peut être utilisé autour d'un bloc de contenu afin de masquer ce contenu et d'afficher un lien "▶︎ Détails" qui, lorsqu'on cliquera dessus, dévoilera son contenu.</p> + +<details open> + <summary> +<h4 id="Example_syntax_9">Exemple de syntaxe</h4> + </summary> +<p>Voici un exemple de syntaxe pour l'élément <a href="/fr/docs/Web/HTML/Element/details"><code><details></code></a> qui a été masqué avec <a href="/fr/docs/Web/HTML/Element/details"><code><details></code></a>.</p> + +<pre class="brush: html;"><details> + <summary> +<h4>Exemple de syntaxe</h4> + </summary> +<p>Voici un exemple de syntaxe pour l'élément <code>.detail</code> qui a été masqué avec <code>.detail</code>.</p> +</details></pre> +</details> + +<div class="notecard note"> + <h4>Note</h4> + <p>On peut inclure un attribut <code>open</code> sur l'élément <code><details></code> afin que celui-ci soit ouvert par défaut.</p> +</div> + +<h3 id=".example-bad_and_.example-good"><code style="white-space: nowrap;">.example-bad</code> et <code style="white-space: nowrap;">.example-good</code></h3> + +<p>Les exemples de bonnes et de mauvaises pratiques peuvent être signalés respectivement par les classes <code>.example-good</code> et <code>.example-bad</code>. Elles sont généralement utilisées pour les blocs <code><pre></code> indiquant des fragments de code à éviter. On peut cependant les utiliser sur d'autres blocs.</p> + +<h5 id="Good_code_example">Exemple de code correct</h5> + +<pre class="brush: html example-good"><label for="test">Libellé de formulaire:</label> +<input type="text" id="test"> +</pre> + +<h5 id="Bad_code_example">Exemple de code incorrect</h5> + +<pre class="brush: html example-bad"><input type="text"> +</pre> + +<p><strong>Il est nécessaire d'utiliser des titres pour ces classes (voir ci-après).</strong> En effet, CSS ne permet pas d'ajouter le message localisé qui indique si l'exemple est correct ou incorrect et qui permet de comprendre pour les personnes utilisant un lecteur d'écran ou celles pour qui rouge et vert ne signifient pas nécessairement mauvais/bon.</p> + +<h4 id="Example_syntax_10">Exemple de syntaxe</h4> + +<pre class="brush: html"><h5 id="Good_code_example">Exemple de code correct</h5> + +<pre class="brush: html example-good"> + &lt;label for="test"&gt;Libellé de formulaire:&lt;/label&gt; + &lt;input type="text" id="test"&gt; +</pre> + +<h5 id="Bad_code_example">Exemple de code incorrect</h5> + +<pre class="brush: html example-bad"> + &lt;input type="text"&gt; +</pre></pre> + +<h3 id=".note.notecard"><code>.note.notecard</code></h3> + +<p>Affiche le contenu d'une section dans une boîte signalant une note. Cette classe s'avère utile lorsqu'on souhaite indiquer quelque chose de relatif au contenu principal sans que cette information s'intègre directement dans le flux de l'article.</p> + +<div class="notecard note"> +<h4>Note</h4> +<p>Voici comment une note est généralement affichée sur MDN.</p> +</div> + +<p>Nous avons ici utilisé un titre <code><h4></code> pour cet exemple mais il conviendra de choisir le niveau de titre qui correspond à la hiérarchie des titres du document courant.</p> + +<h4 id="Example_syntax_12">Exemple de syntaxe</h4> + +<pre class="brush: html"><div class="notecard note"> + <h4>Note</h4> + <p>Voici comment une note est généralement affichée sur MDN.</p> +</div></pre> + +<h3 id=".notecard.warning"><code>.notecard.warning</code></h3> + +<p>Affiche le contenu d'une section dans une boîte signalant un avertissement. Cela permet d'indiquer une information à laquelle la lectrice ou le lecteur doit faire particulièrement attention (par exemple lorsqu'il est nécessaire de faire quelque chose ou d'éviter quelque chose).</p> + +<div class="notecard warning"> + <h4>Attention !</h4> + <p>La balise <blink> est obsolète !</p> +</div> + +<p>Nous avons ici utilisé un titre <code><h4></code> pour cet exemple mais il conviendra de choisir le niveau de titre qui correspond à la hiérarchie des titres du document courant.</p> + +<h4 id="Example_syntax_17">Exemple de syntaxe</h4> + +<pre class="brush: html"><div class="notecard warning"> + <h4>Attention !</h4> + <p>La balise &lt;blink&gt; est obsolète !</p> +</div></pre> + +<h2 id="Table_styles">Styles pour les tableaux</h2> + +<p>MDN fournit quelques styles pour la mise en forme des éléments <a href="/fr/docs/Web/HTML/Element/table"><code><table></code></a>.</p> + +<p>Sans classe ajoutée :</p> + +<table> + <caption>Thés préférés, décembre 2015</caption> + <thead> + <tr> + <th scope="row">Variété</th> + <th scope="col">Caféine</th> + <th scope="col">Durée d'infusion</th> + <th scope="col">Température de l'eau</th> + </tr> + </thead> + <tbody> + <tr> + <th scope="row">Noir</th> + <td>Élevée</td> + <td>2-3 minutes</td> + <td>99°C</td> + </tr> + <tr> + <th scope="row">Vert</th> + <td>Faible à moyen</td> + <td>1-2 minutes</td> + <td>75 à 80°C</td> + </tr> + <tr> + <th colspan="4">Caféine free</th> + </tr> + <tr> + <th scope="row">Tisane</th> + <td>Aucune</td> + <td>3-6 minutes</td> + <td>99°C</td> + </tr> + </tbody> +</table> + +<h3 id=".standard-table"><code style="white-space: nowrap;">.standard-table</code></h3> + +<table class="standard-table"> + <caption>Thés préférés, décembre 2015</caption> + <thead> + <tr> + <th scope="row">Variété</th> + <th scope="col">Caféine</th> + <th scope="col">Durée d'infusion</th> + <th scope="col">Température de l'eau</th> + </tr> + </thead> + <tbody> + <tr> + <th scope="row">Noir</th> + <td>Élevée</td> + <td>2-3 minutes</td> + <td>99°C</td> + </tr> + <tr> + <th scope="row">Vert</th> + <td>Faible à moyen</td> + <td>1-2 minutes</td> + <td>75 à 80°C</td> + </tr> + <tr> + <th colspan="4">Caféine free</th> + </tr> + <tr> + <th scope="row">Tisane</th> + <td>Aucune</td> + <td>3-6 minutes</td> + <td>99°C</td> + </tr> + </tbody> +</table> + +<h4 id="Style_notes">Notes</h4> + +<ul> + <li>On notera les différents styles appliqués aux en-têtes (<a href="/fr/docs/Web/HTML/Element/th"><code><th></code></a>) et les attributs <a href="/fr/docs/Web/HTML/Element/th#attr-scope"><code>scope</code></a> utilisés pour l'accessibilité.</li> +</ul> + +<h4 id="Example_syntax_18">Exemple de syntaxe</h4> + +<pre class="brush: html"><table class="standard-table"> + <caption>Thés préférés, décembre 2015</caption> + <thead> + <tr> + <th scope="row">Variété</th> + <th scope="col">Caféine</th> + <th scope="col">Durée d'infusion</th> + <th scope="col">Température de l'eau</th> + </tr> + </thead> + <tbody> + <tr> + <th scope="row">Noir</th> + <td>Élevée</td> + <td>2-3 minutes</td> + <td>99&nbsp;°C</td> + </tr> + <tr> + <th scope="row">Vert</th> + <td>Faible à moyen</td> + <td>1-2 minutes</td> + <td>75 à 80&nbsp;°C</td> + </tr> + <tr> + <th scope="row">Infusion</th> + <td>Aucune</td> + <td>3-6 minutes</td> + <td>99&nbsp;°C</td> + </tr> + </tbody> +</table></pre> diff --git a/files/fr/mdn/guidelines/does_this_belong_on_mdn/index.html b/files/fr/mdn/guidelines/does_this_belong_on_mdn/index.html new file mode 100644 index 0000000000..9dc5b44c7f --- /dev/null +++ b/files/fr/mdn/guidelines/does_this_belong_on_mdn/index.html @@ -0,0 +1,87 @@ +--- +title: Ceci a-t-il sa place sur MDN ? +slug: MDN/Guidelines/Does_this_belong_on_MDN +tags: + - Guide + - Guidelines + - MDN Meta +translation_of: MDN/Guidelines/Does_this_belong_on_MDN +--- +<div>{{MDNSidebar}}</div> + +<p><span class="seoSummary">Dans cet article, nous verrons comment décider de si un sujet ou un type de contenu doit être documenté sur MDN.</span> Nous verrons également les autres emplacements où ce contenu pourra résider.</p> + +<h2 id="The_question">La question</h2> + +<p>Si vous préparez la documentation d'un sujet, vous vous demandez peut-être si sa place est sur MDN. Vous envisagez peut-être de maintenir la documentation dans votre code source ou de publier sur le <a href="https://wiki.mozilla.org/">wiki de Mozilla</a> ou dans les fichiers README d'un dépôt Git. Voyons quelles sont les meilleures options pour votre contenu.</p> + +<p>Les deux aspects principaux qui permettent de déterminer si un contenu a sa place sur MDN sont :</p> + +<ul> + <li>Le sujet du document (de quoi il s'agit)</li> + <li>La nature du document (de quel type de document il s'agit)</li> +</ul> + +<p>Attention, toute contribution à MDN s'inscrit avec des licences open source. Celles-ci sont <a href="/fr/docs/MDN/About#copyrights_and_licenses">décrites en détail</a> dans notre <a href="/fr/docs/MDN/About">page À propos de MDN</a>.</p> + +<div class="note notecard"> +<p><strong>Note </strong>: Les <a href="https://www.mozilla.org/fr/about/legal/terms/mozilla/">Conditions d'utilisation des sites web et de communication</a> de Mozilla s'appliquent lorsque vous contribuez à MDN. Lisez ce document pour connaître ce qui peut et ce qui ne peut pas être publié sur les sites de Mozilla.</p> +</div> + +<h2 id="What_topics_belong_on_MDN_Web_Docs">Ce qui a sa place sur MDN</h2> + +<p>En général, MDN est utilisé pour documenter les technologies web open source. Cela comprend toute fonctionnalité qui peut être utilisée par les développeuses et développeurs web afin de créer des sites et des applications web. S'il s'agit d'une fonctionnalité implémentée par plusieurs navigateurs et spécifiée de façon standard ou en voie de standardisation, alors sa documentation a pleinement sa place sur MDN. S'il s'agit d'une fonctionnalité expérimentale et qui n'est pas implémentée dans plusieurs navigateurs ou qui est sujette à modification alors elle pourra être documentée mais ne sera pas forcément priorisée.</p> + +<p>Les sujets majeurs de MDN sont les technologies web côté client :</p> + +<ul> + <li><a href="/fr/docs/Web/HTML">HTML</a></li> + <li><a href="/fr/docs/Web/CSS">CSS</a></li> + <li><a href="/fr/docs/Web/JavaScript">JavaScript</a></li> + <li><a href="/fr/docs/Web/SVG">SVG</a></li> + <li><a href="/fr/docs/Web/API">Les API Web</a></li> + <li><a href="/fr/docs/Web/API/WebGL_API">WebGL</a></li> + <li>etc.</li> +</ul> + +<div class="note notecard"> +<p><strong>Note </strong>: Les technologies côté serveur sont généralement documentées autre part et cette documentation n'est pas remplacée par MDN, mais il existe <a href="/fr/docs/Learn/Server-side">quelques exceptions</a>.</p> +</div> + +<p>Les sujets relatifs au développement web et qui portent sur différentes technologies sont également les bienvenus sur MDN :</p> + +<ul> + <li><a href="/fr/docs/Web/Accessibility">Accessibilité</a></li> + <li><a href="/fr/docs/Web/Guide/AJAX">AJAX</a></li> + <li><a href="/fr/docs/Web/Guide/Graphics">Graphisme sur le Web</a></li> + <li><a href="/fr/docs/Web/Progressive_web_apps">Applications web progressives (PWA)</a></li> + <li><a href="/fr/docs/Games">Jeux sur le Web</a></li> +</ul> + +<div class="note notecard"> +<p><strong>Note :</strong> MDN documente certaines fonctionnalités non-standard lorsqu'elles sont exposées sur le Web et que leur usage est important (comme les propriétés CSS spécifiques à WebKit par exemple). MDN documente également certaines technologies standard, hors du Web, si celles-ci s'avèrent utiles aux développeuses et développeurs web : voir <a href="/fr/docs/Related">la section sur les technologies connexes au Web</a>.</p> +</div> + +<h2 id="What_topics_dont_belong_on_MDN_Web_Docs">Ce qui n'a pas sa place sur MDN</h2> + +<p>De façon générale, tout ce qui n'est pas décrit par un standard ouvert du Web n'appartient pas à MDN. Cette section indique quelques règles complémentaires.</p> + +<h3 id="Mozilla_products">Produits Mozilla</h3> + +<p>Le contenu de MDN portait auparavant également sur les produits de Mozilla. Cette documentation a été migrée vers d'autres projets :</p> + +<ul> + <li><a href="https://firefox-source-docs.mozilla.org/">La documentation relative au développement de Firefox</a></li> + <li><a href="https://firefox-dev.tools/">La documentation relative aux outils de développement web (devtools) dans Firefox</a></li> + <li><a href="https://extensionworkshop.com">La documentation des extensions pour tout ce qui a trait à la publication dans Firefox</a></li> +</ul> + +<h3 id="What_else">Quoi d'autre ?</h3> + +<p>Voici d'autres exemples de sujets inappropriés pour MDN :</p> + +<ul> + <li>Les technologies non exposées au web et spécifique à un navigateur en particulier.</li> + <li>Les technologies qui ne sont pas relatives au Web.</li> + <li>La documentation des produits Mozilla à destination des utilisatrices et utilisateurs finaux qui ont leur place <a href="https://support.mozilla.org">sur le site de support Mozilla</a>.</li> +</ul>
\ No newline at end of file diff --git a/files/fr/mdn/guidelines/editorial/index.html b/files/fr/mdn/guidelines/editorial/index.html new file mode 100644 index 0000000000..14395d8492 --- /dev/null +++ b/files/fr/mdn/guidelines/editorial/index.html @@ -0,0 +1,37 @@ +--- +title: Règles éditoriales +slug: MDN/Guidelines/Editorial +tags: + - Documentation + - MDN + - MDN Meta + - Writing +translation_of: MDN/Guidelines/Editorial +--- +<div>{{MDNSidebar}}</div> + +<p><span class="seoSummary">Cet article décrit les règles définies par l'équipe MDN pour le contenu de MDN.</span> Toute personne qui contribue à MDN se doit de respecter ces règles.</p> + +<h2 id="Relevance">Pertinence</h2> + +<p>Le contenu de MDN doit être pertinent par rapport à la section dans laquelle il apparaît. Le spam et les publicités ou tout autre contenu inapproprié ne sera jamais accepté. Les personnes qui éditent afin d'ajouter ce type de contenu pourront être bannies sans avertissement.</p> + +<p>Les liens sortants vers des sites commerciaux mais qui sont pertinents pour le sujet seront examinés au cas par cas. Leur valeur ajoutée à destination des développeuses et développeurs web doit dépasser le bénéfice commercial que tirera le site cible.</p> + +<h2 id="Neutrality">Neutralité</h2> + +<p>Le contenu d'un article de MDN doit conserver <a href="https://fr.wikipedia.org/wiki/Wikip%C3%A9dia:Neutralit%C3%A9_de_point_de_vue">un point de vue neutre</a> et les différences entre les navigateurs doivent être documentées sans biais. Les commentaires subjectifs et péjoratifs à propos d'un navigateur ou d'un agent utilisateur en particulier ne sont pas acceptables.</p> + +<h3 id="Open_web_topics">Web ouvert</h3> + +<p>MDN contient des documentations <em>agnostiques aux différents navigateurs</em> afin de permettre aux développeuses et développeurs web d'écrire du code qui fonctionne dans les différents navigateurs.</p> + +<p>Les technologies documentées sur MDN doivent a minima être en voie de standardisation et être implémentée par au moins un navigateur. Les différences de compatibilité sont documentées dans <a href="/fr/docs/MDN/Structures/Compatibility_tables">les tableaux de compatibilité</a> des articles.</p> + +<h2 id="Structure">Structure</h2> + +<p>Les pages de référence doivent suivre la même structure que les autres pages du même type. Voir <a href="/fr/docs/MDN/Structures/Page_types">les types de page</a> pour une liste d'exemple des structures communément utilisées sur MDN.</p> + +<h2 id="Other_guidelines">Règles générales</h2> + +<p>Les contributrices et contributeurs doivent suivre <a href="/fr/docs/MDN/Guidelines">les lignes directrices de MDN</a> quant au style d'écriture, aux exemples de code, etc.</p> diff --git a/files/fr/mdn/guidelines/index.html b/files/fr/mdn/guidelines/index.html index 613181debd..e761129b94 100644 --- a/files/fr/mdn/guidelines/index.html +++ b/files/fr/mdn/guidelines/index.html @@ -2,12 +2,13 @@ title: Guides du style et du contenu MDN slug: MDN/Guidelines tags: - - Documentation - - MDN + - Guidelines + - Landing + - MDN Meta translation_of: MDN/Guidelines --- -<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/fr/docs/MDN")}}</div> +<div>{{MDNSidebar}}</div> -<p><span class="seoSummary">Ces guides fournissent des détails sur la manière de rédiger et de présenter la documentation MDN, mais également sur la façon dont les extraits de code et le contenu en général devraient être présentés.</span> En respectant ces guides, vous êtes garantis que ce que vous produisez est propre et facile à utiliser.</p> +<p class="summary">Ces guides fournissent des détails sur la manière de rédiger et de présenter la documentation MDN, mais également sur la façon dont les extraits de code et le contenu en général devraient être présentés. En respectant ces guides, vous vous assurez que ce que vous produisez est propre et facile à utiliser.</p> <p>{{LandingPageListSubpages}}</p> diff --git a/files/fr/mdn/guidelines/video/index.html b/files/fr/mdn/guidelines/video/index.html new file mode 100644 index 0000000000..ec85ceeab3 --- /dev/null +++ b/files/fr/mdn/guidelines/video/index.html @@ -0,0 +1,230 @@ +--- +title: Contenu vidéo sur MDN +slug: MDN/Guidelines/Video +tags: + - Guidelines + - Meta + - Video +translation_of: MDN/Guidelines/Video +--- +<div>{{MDNSidebar}}</div> + +<p class="summary">MDN n'est pas un site contenant beaucoup de vidéos. Toutefois, certaines documentations sont propices à ce type de média. <span class="seoSummary">Dans cet article, nous verrons quand inclure des vidéos sur MDN et quelques conseils permettant de créer des vidéos simples et efficaces.</span></p> + +<h2 id="When_to_use_video_on_MDN">Quand utiliser des vidéos sur MDN</h2> + +<p>L'utilisation de vidéo pour de la documentation technique n'est pas indiquée par défaut pour plusieurs raisons :</p> + +<ul> + <li> + <p>Une vidéo est linéaire. Les personnes ne consultent pas la documentation de façon linéaire, du début à la fin : <a href="https://www.sensible.com/chapter.html">ils scannent la documentation</a>. Faire de même pour une vidéo est quasi impossible et cela force à visualiser le contenu de A à Z.</p> + </li> + <li> + <p>Une vidéo possède une densité d'information plus faible que le texte. Il faut plus de temps pour regarder une vidéo expliquant une notion que de lire un article texte équivalent.</p> + </li> + <li> + <p>Une vidéo a un poids numérique plus élevé et est donc plus coûteuse et moins performante que le texte.</p> + </li> + <li> + <p>Une vidéo peut poser des problèmes d'accessibilité : elle est plus coûteuse à réaliser, à localiser ou à rendre accessible aux personnes qui utilisent des lecteurs d'écran.</p> + </li> + <li> + <p>Enfin, une vidéo est beaucoup plus difficile à éditer/mettre à jour/maintenir que du texte.</p> + </li> +</ul> + +<div class="note notecard"> +<p><strong>Note </strong>: Il est important de garder ces limitations en tête lorsqu'on réalise des vidéos afin de les minimiser autant que possible.</p> +</div> + +<p>Il existe de nombreux sites populaires qui fournissent de nombreux tutoriels vidéo. MDN n'est pas un site dont la majorité du contenu est de la vidéo, toutefois, il est possible d'intégrer des vidéos dans certains articles MDN selon le contexte.</p> + +<p>Sur MDN, les vidéos sont particulièrement utilisées lorsqu'on souhaite décrire une suite d'instruction ou un procédé en plusieurs étapes qu'il serait difficile d'exprimer de façon concise avec du texte. Cela s'avère notamment utile lorsqu'on tente de décrire des procédés qui utilisent plusieurs applications ou fenêtres et qui incluent des interactions avec l'interface graphique qui pourraient ne pas être simples à décrire : <em>« maintenant, cliquez sur le bouton situé en haut à gauche et qui ressemble à un canard »</em>.</p> + +<p>Dans de telles situations, il est souvent plus pratique de <strong>montrer</strong> ce qu'on indique.</p> + +<h2 id="What_should_MDN_videos_look_like">À quoi doit ressembler une vidéo sur MDN ?</h2> + +<p>Une vidéo à destination de MDN devrait être :</p> + +<ul> + <li> + <p><strong>Courte </strong>: On essaiera d'avoir des vidéos dont la durée est inférieure à 30 secondes, idéalement inférieure à 20 secondes. Elle sera ainsi suffisamment courte pour ne pas demander un temps d'attention trop long au spectateur.</p> + </li> + <li> + <p><strong>Simple </strong>: On essaiera de garder un cheminement simple avec 2 à 4 fragments distincts pour que les étapes soient faciles à suivre.</p> + </li> + <li> + <p><strong>Silencieuse </strong>: Le son permet d'avoir des vidéos plus impactantes mais demande également plus de temps pour la réalisation et l'implication d'un spectateur qui peut ne pas pouvoir écouter au moment où il/elle regarde la vidéo. Cela peut également rallonger la vidéo et rajoute des coûts de maintenance et de localisation.</p> + </li> +</ul> + +<p>Pour expliquer quelque chose de complexes, on pourra utiliser un ensemble de vidéos courtes et de captures d'écran avec du texte. Le texte permettra ainsi d'insister sur les notions vues dans les vidéos et la personne qui consulte le contenu pourra alors choisir de suivre le texte et/ou la vidéo.</p> + +<p>De plus, on fera attention aux conseils suivants :</p> + +<ul> + <li>La vidéo sera uploadée sur YouTube avant d'être intégrée à la page MDN. On recommande un format 16:9 afin que tout le cadre soit rempli et qu'il n'y ait pas de barres noires. Voici quelques résolutions qui peuvent être utilisées : 1024×576, 1152×648 ou 1280×720.</li> + <li>La vidéo devra être enregistrée en HD afin qu'elle ait le meilleur aspect possible lors de l'upload.</li> + <li>Le curseur de la souris ne doit pas couvrir les éléments qu'on souhaite indiquer.</li> + <li>Si c'est utile, on configurera l'outil d'enregistrement afin d'enregistrer les clics et/ou le pointeur de la souris.</li> +</ul> + +<h2 id="Video_tools">Outils</h2> + +<p>Il vous faudra un outil pour enregistrer la vidéo. Il en existe une variété allant d'outils gratuits à payants, de simples à complexes. Si vous avez déjà créé du contenu vidéo : parfait. Sinon, nous vous conseillons de commencer avec un outil simple puis de choisir ensuite quelque chose de plus complexe si besoin.</p> + +<p>Le tableau qui suit fournit quelques recommandations d'outils pour commencer.</p> + +<table class="standard-table"> + <thead> + <tr> + <th scope="col">Outil</th> + <th scope="col">Système d'exploitation</th> + <th scope="col">Coût</th> + <th scope="col">Fonctionnalités de post-production ?</th> + </tr> + </thead> + <tbody> + <tr> + <td>Open Broadcaster Software</td> + <td>macOS, Windows, Linux</td> + <td>Gratuit</td> + <td>Oui</td> + </tr> + <tr> + <td>CamStudio</td> + <td>Windows</td> + <td>Gratuit</td> + <td>Limitées</td> + </tr> + <tr> + <td>Camtasia</td> + <td>Windows, macOS</td> + <td>Élevé</td> + <td>Oui</td> + </tr> + <tr> + <td>QuickTime Player</td> + <td>macOS</td> + <td>Gratuit</td> + <td>Aucune</td> + </tr> + <tr> + <td>ScreenFlow</td> + <td>macOS</td> + <td>Intermédiaire</td> + <td>Oui</td> + </tr> + <tr> + <td>Kazam</td> + <td>Linux</td> + <td>Gratuit</td> + <td>Minimales</td> + </tr> + </tbody> +</table> + +<h3 id="QuickTime_tips">Conseils pour QuickTime</h3> + +<p>Si vous utilisez macOS, Quicktime Player est disponible et dispose de quelques fonctionnalités pour l'enregistrement :</p> + +<ol> + <li>Choisissez <em>Fichier</em> > <em>Nouvel enregistrement d'écran</em> à partir du menu principal.</li> + <li>Dans la boîte <em>Enregistrement d'écran</em>, utilisez le bouton d'enregistrement (le bouton rouge).</li> + <li>Dessinez un rectangle sur la zone de l'écran que vous souhaitez enregistrer.</li> + <li>Appuyez sur le bouton <em>Démarrer l'enregistrement</em>.</li> + <li>Effectuez les actions que vous souhaitez enregistrer.</li> + <li>Appuyez sur le bouton <em>Stop</em>.</li> + <li>Choisissez <em>Fichier</em> > <em>Exporter en tant que…</em> > <em>1080p</em> à partir du menu principal afin d'avoir une définition suffisamment élevée.</li> +</ol> + +<h3 id="Other_resources">Autres ressources</h3> + +<ul> + <li><a href="https://photography.tutsplus.com/tutorials/how-to-add-custom-callouts-to-screencast-videos-in-screenflow--cms-27122">How to Add Custom Callouts to Screencast Videos in Screenflow (en anglais)</a></li> +</ul> + +<h2 id="A_workflow_for_creating_videos">Étapes de création d'une vidéo</h2> + +<p>Les sections qui suivent décrivent les étapes principales à suivre pour créer une vidéo et l'intégrer à une page MDN.</p> + +<h3 id="Preparation">Préparation</h3> + +<p>Tout d'abord, planifiez la suite d'actions que vous souhaitez enregistrer et choisissez les meilleures façons de commencer et de finir.</p> + +<p>Assurez vous que votre arrière-plan de bureau et votre profil de navigateur soient vierges. Planifier les tailles et le positionnement des fenêtres, notamment si vous utilisez plusieurs fenêtres.</p> + +<p>Planifiez soigneusement les étapes que vous allez enregistrer et pratiquez cette séquence d'actions plusieurs fois avant d'enregistrer :</p> + +<ul> + <li> + <p>Ne commencez pas une vidéo au milieu d'une suite d'étape. Veillez à ce que le spectateur ait suffisamment de contexte pour que les actions illustrées aient du sens.</p> + </li> + <li> + <p>Pour chacune de vos actions, assurez vous de les réaliser suffisamment lentement et de les mettre en évidence. Par exemple, lorsqu'on doit cliquer quelque part on pourra :</p> + + <ol> + <li> + <p>Déplacer la souris sur l'icône</p> + </li> + <li> + <p>Mettre en évidence ou zoomer (selon ce qui est le plus pertinent)</p> + </li> + <li> + <p>Suspendre le mouvement pendant un instant</p> + </li> + <li> + <p>Cliquer sur l'icône</p> + </li> + </ol> + </li> + <li>Planifiez les niveaux de zoom pour les portions de l'interface utilisateur que vous afficherez. Tout le monde ne pourra pas forcément consulter la vidéo en haute définition. Vous pourrez également zoomer sur certaines parties en post-production mais ça peut être une bonne idée de zoomer dès l'enregistrement.</li> +</ul> + +<div class="note notecard"> +<p><strong>Note </strong>: Ne zoomez pas au point que les éléments d'interfaces soient déformés ou semblent étranges.</p> +</div> + +<h3 id="Recording">Enregistrement</h3> + +<p>Lorsque vous enregistrez, avancez dans les étapes de façon calme et régulière. Effectuez des pauses d'une seconde ou deux aux moments importants (lorsqu'il faut cliquer sur un bouton par exemple) et assurez vous que le pointeur de la souris n'occulte pas d'icône ou de texte important.</p> + +<p>N'oubliez pas de faire une pause d'une ou deux secondes à la fin pour montrer le résultat final de la séquence d'actions.</p> + +<div class="note notecard"> +<p><strong>Note </strong>: Si vous utilisez un outil simple comme QuickTime Player ou que vous ne pouvez pas effectuer de post-production, veillez à ce que la taille de la fenêtre soit de la bonne taille pour ce que vous voulez montrer.</p> +</div> + +<h3 id="Post-production">Post-production</h3> + +<p>En post-production, vous pourrez mettre en avant certains éléments notamment grâce à :</p> + +<ul> + <li>Du zoom sur certaines parties de l'écran.</li> + <li>L'atténuation de l'arrière-plan.</li> +</ul> + +<p>Mettez en avant les moments-clés et les détails difficiles à voir comme les clics sur une icône donnée ou la saisie d'une URL particulière. La mise en avant doit durer au moins 1 à 2 secondes et il sera généralement utile d'ajouter une courte transition (200 à 300 millisecondes) au début et à la fin de la mise en évidence.</p> + +<p>Attention à ne pas abuser de ces effets, on ne veut pas que les spectateurs aient le mal de mer à force de voir des zooms/dézooms.</p> + +<p>Si besoin, redimensionnez la vidéo aux proportions souhaitées.</p> + +<h3 id="Uploading">Upload</h3> + +<p>Actuellement, les vidéos doivent être uploadées sur YouTube afin d'être affichées sur MDN.</p> + +<div class="note notecard"> +<p><strong>Note </strong>: Marquez la vidéo en « non répertoriée » si celle-ci n'a pas de sens particulier en dehors du contexte de la page MDN.</p> +</div> + +<h3 id="Embedding">Intégration</h3> + +<p>Une fois la vidéo uploadée, vous pouvez intégrer la vidéo à la page avec la macro {{TemplateLink("EmbedYouTube")}}. Elle permet d'insérer la vidéo à l'emplacement de la macro :</p> + +<p>\{{EmbedYouTube("you-tube-url-slug")}}</p> + +<p>Cette macro utilise un seul argument qui correspond à la fin de l'URL de la vidéo. Ainsi, pour afficher la vidéo disponible à l'URL https://www.youtube.com/watch?v=ELS2OOUvxIw, on appellera la macro ainsi :</p> + +<p>\{{EmbedYouTube("ELS2OOUvxIw")}}</p> diff --git a/files/fr/mdn/guidelines/writing_style_guide/index.html b/files/fr/mdn/guidelines/writing_style_guide/index.html new file mode 100644 index 0000000000..ae9babcc20 --- /dev/null +++ b/files/fr/mdn/guidelines/writing_style_guide/index.html @@ -0,0 +1,124 @@ +--- +title: Guide stylistique +slug: MDN/Guidelines/Writing_style_guide +tags: + - Documentation + - Guide + - Guidelines + - MDN + - MDN Meta + - MDN Web Docs + - MDN style guide + - Style guide + - Writing style guide +translation_of: MDN/Guidelines/Writing_style_guide +--- +<div>{{MDNSidebar}}</div> + +<p><span class="seoSummary">Afin de présenter la documentation de façon organisée, cohérente et facile à lire, le guide stylistique de MDN décrit la façon dont le texte doit être organisé, orthographié, mis en forme, etc. Il s'agit ici de règles générales plutôt que de consignes strictes.</span> Le contenu importe plus que la forme et il n'y a pas d'obligation à apprendre ce guide avant de contribuer. Toutefois, ne soyez pas surpris⋅e si une contributrice ou un contributeur édite une de vos éditions pour respecter ce guide.</p> + +<p>La suite de ce guide vise avant tout la documentation francophone. Elle reprend des parties du <a href="/en-US/docs/MDN/Guidelines/Writing_style_guide">guide stylistique anglophone</a> lorsque c'est pertinent. Vous pouvez également consulter <a href="https://github.com/mozfr/besogne/wiki/Guide-stylistique-pour-la-traduction">le guide stylistique de la communauté francophone</a>. Si vous souhaitez contribuer au contenu en anglais, rapportez vous au <a href="/en-US/docs/MDN/Guidelines/Writing_style_guide">guide stylistique anglophone</a>.</p> + +<h2 id="Basics">Règles de base</h2> + +<p>Voici quelques règles simples qui permettent de conserver une cohérence dans la documentation.</p> + +<h3 id="Page_titles">Titres des pages</h3> + +<p>Les titres des pages sont utilisés dans les résultats des recherches et affichés dans les fils d'Ariane en haut de la page. Le titre de la page pourra être différent de la partie d'URL du document. En français, il devra l'être (car le fragment d'URL sera anglophone).</p> + +<h4 id="Title_and_heading_capitalization">Titres et capitales</h4> + +<p>Seul le premier terme d'un titre (de page ou de section) devra être en capitale :</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span> : « Une nouvelle méthode pour créer des objets JavaScript »</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: « Une Nouvelle Méthode pour Créer des Objets JavaScript »</li> +</ul> + +<p>Si vous voyez certains titres qui enfreignent cette règle, n'hésitez pas à contribuer pour les corriger.</p> + +<h4 id="Choosing_titles_and_slugs">Choix des titres</h4> + +<p>Contrairement au fragment d'URL de la page (court et fixé par la version anglophone), on pourra choisir un titre descriptif suffisamment long.</p> + +<h4 id="Creating_new_subtrees">Création de nouvelles pages</h4> + +<p>Le contenu francophone « suit » le contenu anglophone. Toute nouvelle page de MDN devra d'abord être créée avec sa version anglaise avant d'être traduite.</p> + +<h3 id="Code_sample_style_and_formatting">Style et mise en forme des exemples de code</h3> + +<p>On pourra traduire les noms de certaines variables pour les franciser (par exemple <code>toto</code> à la place de <code>foo</code>) et on traduira les commentaires</p> + +<h4 id="Tabs_and_line_breaks">Sauts de ligne</h4> + +<p>Pour un fragment de code, on évitera d'avoir une ligne trop longue qui nécessite de faire défiler le contenu horizontal. On privilégiera les ruptures de lignes naturelles :</p> + +<pre class="brush: js">if (class.CONDITION || class.OTHER_CONDITION || class.SOME_OTHER_CONDITION + || class.YET_ANOTHER_CONDITION ) { + /* quelque chose */ +} + +var toolkitProfileService = Components.classes["@mozilla.org/toolkit/profile-service;1"] + .createInstance(Components.interfaces.nsIToolkitProfileService); +</pre> + +<h3 id="Latin_abbreviations">Abréviations</h3> + +<div class="note notecard"> + <p><strong>Note</strong> : les abréviations sont à utiliser à bon escient et il faudra bien connaître leur sens (notamment pour les abrévations latines) afin de les utiliser correctement. Il faut être conscient que leur usage peut être source de confusion pour les lectrices et lecteurs qui pourraient ne pas y être habitués.</p> +</div> + +<h4 id="In_notes_and_parentheses">Dans les notes et parenthèses</h4> + +<p>Les abréviations communes (etc., i.e.) pourront être utilisées dans les notes et entre parenthèses. Attention, on utilisera ex. plutôt que e.g. qui est usité en anglais (ou que p. ex. qui est moins usité).</p> + +<h4 id="In_running_text">Dans le texte</h4> + +<ul> + <li>Dans le texte principal (en dehors des notes ou des parenthèses), on privilégiera les formes développées plutôt que les abréviations. + <ul> + <li><span class="correct"><strong>Correct</strong></span> : les navigateurs web tels que Firefox peuvent être utilisés…</li> + <li><span class="incorrect"><strong>Incorrect</strong></span> : les navigateurs, ex. Firefox, peuvent être utilisés…</li> + </ul> + </li> +</ul> + + +<h3 id="Acronyms_and_abbreviations">Acronymes et abréviations</h3> + +<h4 id="Capitalization_and_periods">Capitalisation et usage des points</h4> + +<p>Les acronymes seront écrits en capitales et sans point.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span> : API</li> + <li><span class="incorrect"><strong>Incorrect</strong></span> : A.P.I. ; Api</li> +</ul> + +<h4 id="Expansion">Explication</h4> + +<p>Lors de la première mention d'un terme abrégé sur une page, on expliquera l'acronyme et/ou on liera vers le <a href="/fr/docs/Glossary">glossaire</a>.</p> + +<h4 id="Plurals_of_acronyms_and_abbreviations">Pluriels des acronymes</h4> + +<p>Contrairement aux pratiques anglophones, on n'apportera pas de s pour les formes plurielles des acronymes.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span> : les API du Web</li> + <li><span class="incorrect"><strong>Incorrect</strong></span> : les APIs du Web</li> +</ul> + +<h3 id="Punctuation">Ponctuation</h3> + +<h4 id="Apostrophes_and_quotation_marks">Apostrophes et guillemets</h4> + +<p><strong>On n'utilisera pas d'apostrophe courbe sur MDN.</strong> L'usage des guillemets français est autorisé (mais pas obligatoire) et ceux-ci ne doivent pas servir dans du code pour délimiter des chaînes de caractères où il faudra utiliser les doubles quotes.</p> + +<h3 id="Spelling">Orthographe</h3> + +<p>On recommandera l'utilisation de <a href="https://addons.mozilla.org/fr/firefox/addon/grammalecte-fr/">Grammalecte</a> pour vérifier l'orthographe d'un document.</p> + +<h3 id="Terminology">Terminologie</h3> + +<p>En cas de doute sur la formulation en français d'un terme ou d'une expression anglaise, on privilégiera l'usage, <a href="transvision.mozfr.org/">Transvision</a>, <a href="https://fr.wikipedia.org">Wikipédia</a>.</p>
\ No newline at end of file |