From f6f0c1509a262eb9a5e7bd5d1a84a7b24551eee6 Mon Sep 17 00:00:00 2001 From: julieng Date: Thu, 11 Nov 2021 06:45:13 +0100 Subject: move *.html to *.md --- .../convert_code_samples_to_be_live/index.html | 27 ----- .../howto/convert_code_samples_to_be_live/index.md | 27 +++++ .../howto/create_and_edit_pages/index.html | 44 -------- .../howto/create_and_edit_pages/index.md | 44 ++++++++ files/fr/mdn/contribute/howto/index.html | 13 --- files/fr/mdn/contribute/howto/index.md | 13 +++ .../write_a_new_entry_in_the_glossary/index.html | 112 --------------------- .../write_a_new_entry_in_the_glossary/index.md | 112 +++++++++++++++++++++ 8 files changed, 196 insertions(+), 196 deletions(-) delete mode 100644 files/fr/mdn/contribute/howto/convert_code_samples_to_be_live/index.html create mode 100644 files/fr/mdn/contribute/howto/convert_code_samples_to_be_live/index.md delete mode 100644 files/fr/mdn/contribute/howto/create_and_edit_pages/index.html create mode 100644 files/fr/mdn/contribute/howto/create_and_edit_pages/index.md delete mode 100644 files/fr/mdn/contribute/howto/index.html create mode 100644 files/fr/mdn/contribute/howto/index.md delete mode 100644 files/fr/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.html create mode 100644 files/fr/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.md (limited to 'files/fr/mdn/contribute/howto') diff --git a/files/fr/mdn/contribute/howto/convert_code_samples_to_be_live/index.html b/files/fr/mdn/contribute/howto/convert_code_samples_to_be_live/index.html deleted file mode 100644 index 5575715390..0000000000 --- a/files/fr/mdn/contribute/howto/convert_code_samples_to_be_live/index.html +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Comment convertir des exemples de code pour qu'ils soient "live" -slug: MDN/Contribute/Howto/Convert_code_samples_to_be_live -translation_of: MDN/Contribute/Howto/Convert_code_samples_to_be_live -original_slug: MDN/Contribute/Howto/convertir_code_pour_etre_direct ---- -
{{MDNSidebar}}
-

MDN dispose d'un système d'exemples "live", grâce auxquels le code présent sur une page est exécuté pour afficher les résultats de l'exécution de ce code. Cependant, beaucoup d'articles existants affichent du code sans utiliser ce système, et ont donc besoin d'être convertis.

- -

Les exemples "live", vous permettent de voir à quoi ressemble le résultat d'un exemple, faire une documentation plus dynamique et instructive. Ce guide vous explique comment prendre des exemples existants et leur rajouter la fonctionnalité "live".

- -

Compétences nécessaires pour cette tâche

- - - -

Quelles étapes pour réaliser cette tâche ?

- -
    -
  1. Choisissez un article dans la liste de ceux marqués NeedsLiveSample, pour lequel le code présenté porte sur des notions qui vous sembles familières.
    2. -
  2. Convertissez le code pour qu'il soit "live"
    3. -
  3. Supprimer le code ou l'image qui montrait les sorties et résultats du programme. Votre exemple "live" le remplace désormais.
    4. -
- -

Pour plus d'information sur la création et l'édition d'exemples "live", voir Utiliser le système d'exemple "live" (en anglais).

diff --git a/files/fr/mdn/contribute/howto/convert_code_samples_to_be_live/index.md b/files/fr/mdn/contribute/howto/convert_code_samples_to_be_live/index.md new file mode 100644 index 0000000000..5575715390 --- /dev/null +++ b/files/fr/mdn/contribute/howto/convert_code_samples_to_be_live/index.md @@ -0,0 +1,27 @@ +--- +title: Comment convertir des exemples de code pour qu'ils soient "live" +slug: MDN/Contribute/Howto/Convert_code_samples_to_be_live +translation_of: MDN/Contribute/Howto/Convert_code_samples_to_be_live +original_slug: MDN/Contribute/Howto/convertir_code_pour_etre_direct +--- +
{{MDNSidebar}}
+

MDN dispose d'un système d'exemples "live", grâce auxquels le code présent sur une page est exécuté pour afficher les résultats de l'exécution de ce code. Cependant, beaucoup d'articles existants affichent du code sans utiliser ce système, et ont donc besoin d'être convertis.

+ +

Les exemples "live", vous permettent de voir à quoi ressemble le résultat d'un exemple, faire une documentation plus dynamique et instructive. Ce guide vous explique comment prendre des exemples existants et leur rajouter la fonctionnalité "live".

+ +

Compétences nécessaires pour cette tâche

+ + + +

Quelles étapes pour réaliser cette tâche ?

+ +
    +
  1. Choisissez un article dans la liste de ceux marqués NeedsLiveSample, pour lequel le code présenté porte sur des notions qui vous sembles familières.
    2. +
  2. Convertissez le code pour qu'il soit "live"
    3. +
  3. Supprimer le code ou l'image qui montrait les sorties et résultats du programme. Votre exemple "live" le remplace désormais.
    4. +
+ +

Pour plus d'information sur la création et l'édition d'exemples "live", voir Utiliser le système d'exemple "live" (en anglais).

diff --git a/files/fr/mdn/contribute/howto/create_and_edit_pages/index.html b/files/fr/mdn/contribute/howto/create_and_edit_pages/index.html deleted file mode 100644 index 70cb353739..0000000000 --- a/files/fr/mdn/contribute/howto/create_and_edit_pages/index.html +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Créer et modifier des pages -slug: MDN/Contribute/Howto/Create_and_edit_pages -translation_of: 'MDN/Contribute/Howto/Create_and_edit_pages' ---- -
{{MDNSidebar}}
- -

Cet article est destiné à présenter aux personnes souhaitant contribuer à MDN le processus de modification de pages existantes et de création de nouvelles pages.

- -
-

Note : Le contenu de MDN s'organise au sein de deux dépôts Git : mdn/content avec le contenu en anglais et mdn/translated-content avec le contenu traduit (y compris en français). C'est le dépôt mdn/content qui constitue la référence. Si vous souhaitez créer une page en français, celle-ci devra au préalable avoir été créée en anglais.

-
-

Modifier une page existante

- -

Pour modifier une page, vous devez trouver la page source :

-. -

La façon la plus rapide de la trouver est d'aller sur la page que vous souhaitez modifier, puis de vous rendre en bas de cette page et enfin de cliquer sur le lien « Source on GitHub ».

- -

Une fois que vous avez trouvé la source à modifier, rendez-vous sur notre fichier README et parcourez notre guide sur la contribution (en anglais). Vous pouvez également consulter ce billet en français pour savoir comment contribuer.

- -

Prévisualiser vos modifications

- -

SI vous modifiez la page en local, vous pouvez voir à quoi ressembleront vos modifications en allant sur le dossier du dépôt nommé content, en exécutant la commande CLI yarn start, puis en vous rendant à l'URL localhost:5000 dans votre navigateur, et enfin en retrouvant la page sur laquelle vous travaillez. Pour la trouver plus facilement, utilisez la boîte de recherche. La page que vous prévisualisez sera rafraîchie automatiquement au fur et à mesure que vous modifiez son code source.

- -

Ajouter des pièces jointes

- -

Pour ajouter un fichier en pièce jointe à votre article, vous avez simplement besoin de l'inclure dans le même répertoire du fichier index.html de votre article, puis de l'ajouter dans votre page, typiquement à l'aide d'un élément <a>.

- -

Créer une nouvelle page

- -

Pour créer une nouvelle page, consultez les instructions fournies sur la documentation concernant l'ajout de nouveaux documents (en anglais).

- -
-

Attention : Pour créer une page en français (ou dans une autre langue), celle-ci devra préalablement exister/avoir été créée en anglais.

-
-

Voir aussi

- - diff --git a/files/fr/mdn/contribute/howto/create_and_edit_pages/index.md b/files/fr/mdn/contribute/howto/create_and_edit_pages/index.md new file mode 100644 index 0000000000..70cb353739 --- /dev/null +++ b/files/fr/mdn/contribute/howto/create_and_edit_pages/index.md @@ -0,0 +1,44 @@ +--- +title: Créer et modifier des pages +slug: MDN/Contribute/Howto/Create_and_edit_pages +translation_of: 'MDN/Contribute/Howto/Create_and_edit_pages' +--- +
{{MDNSidebar}}
+ +

Cet article est destiné à présenter aux personnes souhaitant contribuer à MDN le processus de modification de pages existantes et de création de nouvelles pages.

+ +
+

Note : Le contenu de MDN s'organise au sein de deux dépôts Git : mdn/content avec le contenu en anglais et mdn/translated-content avec le contenu traduit (y compris en français). C'est le dépôt mdn/content qui constitue la référence. Si vous souhaitez créer une page en français, celle-ci devra au préalable avoir été créée en anglais.

+
+

Modifier une page existante

+ +

Pour modifier une page, vous devez trouver la page source :

+. +

La façon la plus rapide de la trouver est d'aller sur la page que vous souhaitez modifier, puis de vous rendre en bas de cette page et enfin de cliquer sur le lien « Source on GitHub ».

+ +

Une fois que vous avez trouvé la source à modifier, rendez-vous sur notre fichier README et parcourez notre guide sur la contribution (en anglais). Vous pouvez également consulter ce billet en français pour savoir comment contribuer.

+ +

Prévisualiser vos modifications

+ +

SI vous modifiez la page en local, vous pouvez voir à quoi ressembleront vos modifications en allant sur le dossier du dépôt nommé content, en exécutant la commande CLI yarn start, puis en vous rendant à l'URL localhost:5000 dans votre navigateur, et enfin en retrouvant la page sur laquelle vous travaillez. Pour la trouver plus facilement, utilisez la boîte de recherche. La page que vous prévisualisez sera rafraîchie automatiquement au fur et à mesure que vous modifiez son code source.

+ +

Ajouter des pièces jointes

+ +

Pour ajouter un fichier en pièce jointe à votre article, vous avez simplement besoin de l'inclure dans le même répertoire du fichier index.html de votre article, puis de l'ajouter dans votre page, typiquement à l'aide d'un élément <a>.

+ +

Créer une nouvelle page

+ +

Pour créer une nouvelle page, consultez les instructions fournies sur la documentation concernant l'ajout de nouveaux documents (en anglais).

+ +
+

Attention : Pour créer une page en français (ou dans une autre langue), celle-ci devra préalablement exister/avoir été créée en anglais.

+
+

Voir aussi

+ + diff --git a/files/fr/mdn/contribute/howto/index.html b/files/fr/mdn/contribute/howto/index.html deleted file mode 100644 index 59b33bbba6..0000000000 --- a/files/fr/mdn/contribute/howto/index.html +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Guides "Comment faire" -slug: MDN/Contribute/Howto -tags: - - Landing - - MDN Meta -translation_of: MDN/Contribute/Howto ---- -
{{MDNSidebar}}
{{IncludeSubnav("/fr/docs/MDN")}}
- -

Ces articles fournissent des guides pas-à-pas pour la réalisation d'objectifs spécifiques lorsque vous contribuez sur MDN.

- -

{{LandingPageListSubpages}}

diff --git a/files/fr/mdn/contribute/howto/index.md b/files/fr/mdn/contribute/howto/index.md new file mode 100644 index 0000000000..59b33bbba6 --- /dev/null +++ b/files/fr/mdn/contribute/howto/index.md @@ -0,0 +1,13 @@ +--- +title: Guides "Comment faire" +slug: MDN/Contribute/Howto +tags: + - Landing + - MDN Meta +translation_of: MDN/Contribute/Howto +--- +
{{MDNSidebar}}
{{IncludeSubnav("/fr/docs/MDN")}}
+ +

Ces articles fournissent des guides pas-à-pas pour la réalisation d'objectifs spécifiques lorsque vous contribuez sur MDN.

+ +

{{LandingPageListSubpages}}

diff --git a/files/fr/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.html b/files/fr/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.html deleted file mode 100644 index b70818e6d9..0000000000 --- a/files/fr/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.html +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: Écrire et référencer une entrée de glossaire -slug: MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary -tags: - - Comment… - - Glossaire - - Guide - - MDN Méta(2) -translation_of: MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary ---- -
{{MDNSidebar}}
- -

Le glossaire MDN est le lieu privilégié où nous définissons la terminologie, le jargon et les abréviations utilisés dans la documentation et les codes.  Contribuer à ce glossaire est une moyen simple de rendre le Web plus compréhensible pour n'importe qui. Nul besoin de posséder un haut niveau de compétence pour écrire des entrées du glossaire,  elles doivent rester simples et évidentes.

- -

Comment créer une entrée

- -

Pour trouver des sujets ayant besoin d'entrées de glossaire, consultez la liste des termes à documenter à la fin de la page concernant le sujet en question ; cliquez n'importe lequel de ses liens pour commencer une nouvelle page de glossaire, puis suivez les étapes ci-dessous.

- -

Étape 1: écrire un résumé

- -

Le premier paragraphe d'une page de glossaire consiste en une description courte et simple du terme — de préférence n'exédant pas les deux lignes. Assurez-vous que n'importe qui lisant cette description puisse immédiatement saisir le sens du terme concerné.

- -
-

Note : ne copiez-collez pas la définition d'un autre endroit (spécialement pas de Wikipédia, puisque leurs licences sont réduites et donc incompatiles avec celles de MDN).

-
- -
-

Note : il est important également de s'assurer que le contenu est simple et compréhensible. Cela vaut la peine de passer un peu de temps dessus plutôt que de trahir le sens. Ce glossaire doit contenir du contenu nouveau et utile, pas répéter ce que l'on peut trouver partout ailleurs.

-
- -

Les liens conduisant à cette entrée de glossaire feront apparaitre ce résumé au survol de la souris, de telle sorte que le lecteur pourra obtenir une définition sans avoir à naviguer jusqu'à la page concernée (voyez ci-dessous comment insérer un lien vers une entrée de glossaire avec la macro \{{Glossary}}).

- -

Si vous y tenez, vous pouvez ajouter quelques paragraphes supplémentaires, mais prenez garde de ne pas vous retrouver à écrire tout un article. Écrire un article complet est une bonne chose, mais ne le placez pas dans le glossaire. Si vous ne savez pas où placer cet article, n'hésitez pas à prendre la parole pour en parler ici.

- -

Étape 2 : offrir d'autres sources

- -

Pour terminer, une entrée de glossaire devrait toujours s'achever sur une section « En savoir plus ». Cette section devrait contenir des liens qui aideront le lecteur à aller plus loin : découvrir le sujet plus en détail, apprendre à utiliser la technologie en question, etc.

- -

Il est recommandé de trier ces liens en au moins trois groupes :

- -
-
Connaissance générale
-
Liens qui fournissent plus d'information générale ; par exemple, un lien vers Wikipédia est un excellent début.
-
Références techniques
-
Liens vers une information technique plus avancée, sur MDN par exemple.
-
Apprentissage et tutoriels
-
Liens vers des tutoriels, des exercices ou tout autre matériel susceptible d'apprendre au lecteur à maitriser les technologies liées au terme défini.
-
- -

Termes suggérés

- -

Vous désirez contribuer mais vous ignorez quel terme doit être défini ? Voici une liste de suggestions. Cliquez un mot et lancez-vous !

- -

Gérer les ambiguïtés

- -

Parfois, en fonction du contexte, un même terme peut connaitre plusieurs définitions. Pour traiter ces ambiguïtés, vous devez suivre ce guide :

- - - -

Illustrons cela par un exemple. Le terme signature peut avoir différentes significations dans au moins trois contextes différents : la sécurité, les fonctions et les mèls.

- -
    -
  1. La page Glossaire/Signature est la page de « désambiguïsation » avec la macro {{TemplateLink("GlossaryDisambiguation")}} macro.
    2. -
  2. La sous-page Glossaire/Signature/Sécurité est la page définissant le terme dans le contexte de la sécurité informatique.
    3. -
  3. La sous-page Glossaire/Signature/Fonction est la page définissant les signatures de fonction.
    4. -
  4. La sous-page Glossaire/Signature/Mèl est la page définissant les signatures de mèl.
    5. -
- -

Utiliser la macro \{{Glossary}}

- -

Le glossaire devient beaucoup plus utile lorsque le lecteur peut atteindre les définitions depuis un autre document sans avoir à  naviguer hors de ce document. C'est la raison pour laquelle nous vous incitons à créer des liens vers le glossaire dès que vous le pouvez, en utilisant la macro {{TemplateLink("Glossary")}} :

- - - - - - - - - - - - - - - - - - - - - - - - - - -
MacroResultNote
\{{Glossary("browser")}}{{Glossary("browser")}}Quand un terme correspond à un terme à définir, utilisez simplement la macro telle quelle (notez qu'elle est sensible à la casse — minuscule/majuscule)
\{{Glossary("browser", "Web browser")}}{{Glossary("browser","Web browser")}}Fournissez en deuxième argument un texte alternatif à afficher.
\{{Glossary("browser", "Web browser", 1)}}{{Glossary("browser","Web browser",1)}}Optionnellement, entrez le chiffre 1 comme troisième argument pour afficher le lien de façon classique plutôt que comme une mise en exergue subtile.
- -

Les liens créés avec la macro \{{Glossary}} affichent toujours un texte au survol de la souris, qui contient le résumé de l'entrée du glossaire (cf. ci-dessus).

- -

Conventions

- -

Dans la plupart des cas, sur MDN, l'usage de la macro est sûr. Il y a cependant quelques exceptions que vous devez aborder avec précaution :

- - diff --git a/files/fr/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.md b/files/fr/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.md new file mode 100644 index 0000000000..b70818e6d9 --- /dev/null +++ b/files/fr/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.md @@ -0,0 +1,112 @@ +--- +title: Écrire et référencer une entrée de glossaire +slug: MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary +tags: + - Comment… + - Glossaire + - Guide + - MDN Méta(2) +translation_of: MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary +--- +
{{MDNSidebar}}
+ +

Le glossaire MDN est le lieu privilégié où nous définissons la terminologie, le jargon et les abréviations utilisés dans la documentation et les codes.  Contribuer à ce glossaire est une moyen simple de rendre le Web plus compréhensible pour n'importe qui. Nul besoin de posséder un haut niveau de compétence pour écrire des entrées du glossaire,  elles doivent rester simples et évidentes.

+ +

Comment créer une entrée

+ +

Pour trouver des sujets ayant besoin d'entrées de glossaire, consultez la liste des termes à documenter à la fin de la page concernant le sujet en question ; cliquez n'importe lequel de ses liens pour commencer une nouvelle page de glossaire, puis suivez les étapes ci-dessous.

+ +

Étape 1: écrire un résumé

+ +

Le premier paragraphe d'une page de glossaire consiste en une description courte et simple du terme — de préférence n'exédant pas les deux lignes. Assurez-vous que n'importe qui lisant cette description puisse immédiatement saisir le sens du terme concerné.

+ +
+

Note : ne copiez-collez pas la définition d'un autre endroit (spécialement pas de Wikipédia, puisque leurs licences sont réduites et donc incompatiles avec celles de MDN).

+
+ +
+

Note : il est important également de s'assurer que le contenu est simple et compréhensible. Cela vaut la peine de passer un peu de temps dessus plutôt que de trahir le sens. Ce glossaire doit contenir du contenu nouveau et utile, pas répéter ce que l'on peut trouver partout ailleurs.

+
+ +

Les liens conduisant à cette entrée de glossaire feront apparaitre ce résumé au survol de la souris, de telle sorte que le lecteur pourra obtenir une définition sans avoir à naviguer jusqu'à la page concernée (voyez ci-dessous comment insérer un lien vers une entrée de glossaire avec la macro \{{Glossary}}).

+ +

Si vous y tenez, vous pouvez ajouter quelques paragraphes supplémentaires, mais prenez garde de ne pas vous retrouver à écrire tout un article. Écrire un article complet est une bonne chose, mais ne le placez pas dans le glossaire. Si vous ne savez pas où placer cet article, n'hésitez pas à prendre la parole pour en parler ici.

+ +

Étape 2 : offrir d'autres sources

+ +

Pour terminer, une entrée de glossaire devrait toujours s'achever sur une section « En savoir plus ». Cette section devrait contenir des liens qui aideront le lecteur à aller plus loin : découvrir le sujet plus en détail, apprendre à utiliser la technologie en question, etc.

+ +

Il est recommandé de trier ces liens en au moins trois groupes :

+ +
+
Connaissance générale
+
Liens qui fournissent plus d'information générale ; par exemple, un lien vers Wikipédia est un excellent début.
+
Références techniques
+
Liens vers une information technique plus avancée, sur MDN par exemple.
+
Apprentissage et tutoriels
+
Liens vers des tutoriels, des exercices ou tout autre matériel susceptible d'apprendre au lecteur à maitriser les technologies liées au terme défini.
+
+ +

Termes suggérés

+ +

Vous désirez contribuer mais vous ignorez quel terme doit être défini ? Voici une liste de suggestions. Cliquez un mot et lancez-vous !

+ +

Gérer les ambiguïtés

+ +

Parfois, en fonction du contexte, un même terme peut connaitre plusieurs définitions. Pour traiter ces ambiguïtés, vous devez suivre ce guide :

+ + + +

Illustrons cela par un exemple. Le terme signature peut avoir différentes significations dans au moins trois contextes différents : la sécurité, les fonctions et les mèls.

+ +
    +
  1. La page Glossaire/Signature est la page de « désambiguïsation » avec la macro {{TemplateLink("GlossaryDisambiguation")}} macro.
    2. +
  2. La sous-page Glossaire/Signature/Sécurité est la page définissant le terme dans le contexte de la sécurité informatique.
    3. +
  3. La sous-page Glossaire/Signature/Fonction est la page définissant les signatures de fonction.
    4. +
  4. La sous-page Glossaire/Signature/Mèl est la page définissant les signatures de mèl.
    5. +
+ +

Utiliser la macro \{{Glossary}}

+ +

Le glossaire devient beaucoup plus utile lorsque le lecteur peut atteindre les définitions depuis un autre document sans avoir à  naviguer hors de ce document. C'est la raison pour laquelle nous vous incitons à créer des liens vers le glossaire dès que vous le pouvez, en utilisant la macro {{TemplateLink("Glossary")}} :

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
MacroResultNote
\{{Glossary("browser")}}{{Glossary("browser")}}Quand un terme correspond à un terme à définir, utilisez simplement la macro telle quelle (notez qu'elle est sensible à la casse — minuscule/majuscule)
\{{Glossary("browser", "Web browser")}}{{Glossary("browser","Web browser")}}Fournissez en deuxième argument un texte alternatif à afficher.
\{{Glossary("browser", "Web browser", 1)}}{{Glossary("browser","Web browser",1)}}Optionnellement, entrez le chiffre 1 comme troisième argument pour afficher le lien de façon classique plutôt que comme une mise en exergue subtile.
+ +

Les liens créés avec la macro \{{Glossary}} affichent toujours un texte au survol de la souris, qui contient le résumé de l'entrée du glossaire (cf. ci-dessus).

+ +

Conventions

+ +

Dans la plupart des cas, sur MDN, l'usage de la macro est sûr. Il y a cependant quelques exceptions que vous devez aborder avec précaution :

+ + -- cgit v1.2.3-54-g00ecf