We have already seen some of the key words, Prerequisites and Schedule in the schedule notebook and Overview and Key Points in the episodes. There are an additional three key words that are used to add richness and each unlike those seen up until now require additional 'arguments'.
To highlight specific information before you get to key points you can use:
## Information: This is important!
Reminder to you, the tutor and students to pay extra attention here.
renders to:
Perhaps you want to a task or comment related to writing(?):
## Pen: Take note this is about writing!
This could be a written exercise or just bringing attention
renders to:
Perhaps you want to pin a task for someone to take note:
## Pin: Add em-pha-sis to this point!
Reminder to you, the tutor and students to pay extra attention here.
renders to:
If you want to include references within an episode:
## References
[1] [Software Carpentry](https://software-carpentry.org)
Any references within the episode then need to be kept up-to-date manually.
We all know that it is important to give students exercises to reinforce and assess learning. In the original software carpentry lessons javascript was used to produce fancy drop down solutions to exercises. Fortunately for various reasons we do not have this possibility. Instead we take quite a simple approach:
Tasks are denoted with:
## Exercise: Can you think on you feet?
Simply answer me this, can you think and stand at the same time?which renders as:
We create the example with the same 'subtitle'
## Solution: Can you think on you feet?
Let me see, I'll have to get up and think about it.which renders as:
Where did it go? If it was ever there at all, perhaps in the tutorial I just forgot to add the cell? If you have been observant however or check back at the exercise cell, you will see some additional decoration introduced during the render. There is a link which if followed takes you to the solutions. Currently this is enabled by default, but if there is interest there could be an option to turn off the links or introduce dummy pages so that solutions couldbe held back from students for an initial period.
The key words operate very simplistically at the moment. You may have noted that I did not use Exercise or Solution in the subtitle, calling the section 'Student Tasks and Example Answers', this is because they would have then triggered the key words, so you have to be careful not to use these features when you don't intend to. There are a few other features that are detailed below, we hope to address them and any others users find as soon as we can.
Code blocks ending cells cause issues to the build system when renderingCode blocks ending cells cause issues to the build system when renderingBut work just fine if you add some additional text.