Skip to content

Building a Software Carpentry style lesson on the wiki/fr

Il peut être intéressant d'utiliser notre wiki pour présenter des tutoriels Software Carpentry. GitHub héberge des leçons de Software Carpentry comme celle-ci; elles sont préparées avec la syntaxe Markdown qui offre plusieurs gabarits préformatés. L'hébergement d'un tutoriel sur un wiki a aussi l'avantage d'en permettre aisément la traduction. Nous présentons ici quelques gabarits utiles.

Prérequis

La boîte de prérequis typique de SWC peut être obtenue en utilisant le gabarit {{Prerequisites}}. Par exemple, le code suivant :

{{Prerequisites
  |title=Prerequisites for this lesson
  |content=
This lesson requires you to first know X.
}}

donne la boîte suivante :

Prérequis pour cette leçon

Cette leçon exige que vous connaissiez d'abord X.

Préparation

La boîte de « préparation » de SWC peut être obtenue en utilisant le gabarit {{Getready}}. Par exemple, le code suivant :

{{Getready
  |title=Getting ready for this lesson
  |content=
You should download the following files prior to starting the lesson.
}}

donne la boîte suivante :

Préparation pour cette leçon

Vous devriez télécharger les fichiers suivants avant de commencer la leçon.

Objectifs d'apprentissage

La boîte d'« objectifs » de SWC peut être obtenue en utilisant le gabarit {{Objectives}}. Par exemple, le code suivant :

{{Objectives
  |title=Learning Objectives
  |content=
* You will learn A
* You will also learn B
}}

donne la boîte suivante :

Objectifs d'apprentissage

  • Vous apprendrez A
  • Vous apprendrez également B

Mises en évidence

La boîte de « mise en évidence » de SWC peut être obtenue en utilisant le gabarit {{Callout}}. Par exemple, le code suivant :

{{Callout
  |title=Using auto completion
  |content=
You can use the <TAB> key to auto complete.
}}

donne la boîte suivante :

Utilisation de l'autocomplétion

Vous pouvez utiliser la touche TAB pour l'autocomplétion.

Défi

La boîte de « défi » de SWC peut être obtenue en utilisant le gabarit {{Challenge}}. Par exemple, le code suivant :

{{Challenge
  |title=Practicing using the commands.
  |content=
Assuming a ...
}}

donne la boîte suivante :

Pratique des commandes

En supposant qu'un...