TutorialTemplate
Jump to navigation
Jump to search
Under Construction
This page shows the preferred basic layout of a tutorial. It contains the standard sections and formatting to be used. Copy the whole page text to make a new tutorial.
Key
This article uses these graphical conventions
Window ⟩⟩ Tab/Panel in Window
Button … Menu → Choice … Keyboard
Button … Menu → Choice … Keyboard
Introduction
This is where you tell the reader something about what the tutorial does.
You should include a message telling the reader what sort of difficulty level the tutorial is for.
Specific techniques used in this tutorial
- First technique.
- Second technique.
Set-up
Here you should tell the reader what sort of things they need to do before starting the tutorial.
For example, this might be to download a font or image to be used later.
First Section
Each tutorial should be split into a number of logical sections.
You can use the {{Annotation}} template, as below, to make some text stand out from the rest of the text.
This is an example of an Annotation. It calls the reader's attention to something that's either important or extra information. An Annotation can also have a filled background to make it stand out even more.
Second Section
With each section following on the the one before it.
Conclusion
Here you can give the reader a summary of what they've done and/or give suggestions for further reading and/or experiment.