Building a Software Carpentry style lesson on the wiki

From CC Doc
Jump to: navigation, search

Other languages:

It may be interesting to use the Compute Canada wiki to host Software Carpentry-style lessons. Software Carpentry lessons, such as this one, are usually hosted on Github. They can be written with a Markdown syntax, and provide many pre-formatted styles. Hosting a lesson on a wiki also offers the advantage of supporting translation. In order to facilitate the writing of such lesson, a few templates may be useful, and are listed below.

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


Prerequisites for this lesson

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


Getting ready for this lesson

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


Learning Objectives
  • 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


Using auto completion

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


Practicing using the commands

Assuming a ...