Préparer un tutoriel Software Carpentry pour le wiki
This site replaces the former Compute Canada documentation site, and is now being managed by the Digital Research Alliance of Canada. Ce site remplace l'ancien site de documentation de Calcul Canada et est maintenant géré par l'Alliance de recherche numérique du Canada. |
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.
[TRADUCTION À COMPLÉTER]
Prerequisites
The typical SWC prerequisites box can be obtained using the {{Prerequisites}} template. For example, the following code
{{Prerequisites
|title=Prerequisites for this lesson
|content=
This lesson requires you to first know X.
}}
results in the following box
This lesson requires you to first know X.
Getting ready
The SWC "getting ready" box can be obtained using the {{Getready}} template. For example, the following code
{{Getready
|title=Getting ready for this lesson
|content=
You should download the following files prior to starting the lesson.
}}
results in the following box
You should download the following files prior to starting the lesson.
Learning Objectives
The SWC "objectives" box can be obtained using the {{Objectives}} template. For example, the following code
{{Objectives
|title=Learning Objectives
|content=
* You will learn A
* You will also learn B
}}
results in the following box
- You will learn A
- You will also learn B
Callouts
The SWC "callout" box can be obtained using the {{Callout}} template. For example, the following code
{{Callout
|title=Using auto completion
|content=
You can use the <TAB> key to auto complete.
}}
results in the following box
You can use the <TAB> key to auto complete.
Challenge
The SWC "challenge" box can be obtained using the {{Challenge}} template. For example, the following code
{{Challenge
|title=Practicing using the commands.
|content=
Assuming a ...
}}
results in the following box
Assuming a ...