diff options
Diffstat (limited to 'files/fr/mdn/guidelines/css_style_guide/index.html')
| -rw-r--r-- | files/fr/mdn/guidelines/css_style_guide/index.html | 382 |
1 files changed, 382 insertions, 0 deletions
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> |