EDT4OL/Intermediate wiki skills/Pedagogical templates
Start here
The Mediawiki software has a powerful feature called templates, which enables more advanced features to help manage the layout and structure of elements more consistently in the wiki. So, for example, a template can be created to manage the display of a feature on a particular page in the wiki. Every time the template is used on any page in the wiki, it will re-produce the layout features defined in the original template without the need to code the wiki text on the page where it is used.
The layout for the Mini-challenge, Purpose, and Stimulus resources on this page was created using this pedagogical template feature.
Don't worry! In this course, you are not required to code new templates. You will be using templates we have already created. We will show you how to use a number of popular templates in WikiEducator. They are very easy to use once you know how. It's a simple process of:
- Copy the wiki text for the template
- Paste this on the page where you would like to use it
- Edit and customise the content of the template in the wiki
A pedagogical template associates an icon with the type of activity and applies a distinctive layout to differentiate iDevices from normal body text. Consequently, templates provide a way to manage structure and form on wiki pages in a consistent way, not unlike styles used in word processing.
Step 1: Create a practice page for pedagogical templates
Create a subpage from your Sandbox page to practise editing pedagogical templates.
- Log in to WikiEducator and go to your Sandbox page
- Click on the edit link, then add a subpage for pedagogical templates using the following syntax:
[[/Pedagogical templates/|Pedagogical templates]]. (Make sure that there is a "/" (forward slash) before and after the wiki page name. This is a shortcut for creating sub-pages from a parent page) - You should see a red link for a new 'Pedagogical template' page which is a placeholder for creating the new subpage below
Step 2: Copy the wiki text for a pedagogical template
In wiki text, the beginning of a template is indicated by two curly braces like this {{ and is closed using two curly braces like this }}. These curly braces instruct the wiki software to apply the specified template's formatting, in our case the template called IDevice.
The pedagogical templates also support parameters. These are variables using pre-defined text phrases for manipulating the behaviour of the template. Each parameter is signaled by a vertical bar like this "|" followed by the name of the parameter. The variable text is entered after the equals sign ("="), which will be explained in Step 3 below.
All you need to do is to highlight and copy the wiki text for the template in the box below:
{{IDevice
|theme=line
|type=
|title=
|body=
}}
Step 3: Paste the wiki text for the template on your page
- Go to your Sandbox page and click on the red link for the 'Pedagogical template' subpage to create this new page
- Paste the wiki text you copied from Step 2 above onto this page
- Remember to save your page
If you have done this correctly, you should see the following example after you save the page:
Step 4: Edit and customise a pedagogical template
Theme, type, title, and body are parameters you can use for editing and customising your template. The parameter names are case sensitive and, in the case of pedagogical templates, they are all lower case. They will not function properly if, for example, you use "Theme=" instead of the lowercase "theme". The list below provides a summary of the parameters and options.
| Parameter | Purpose and options |
|---|---|
| theme | The user can specify a theme which manages how templates are displayed in WikiEducator. The display of templates in the published course site will use the theme of the target website.
Check the name of the theme next to the theme parameter, which in our case will always be: |
| type (Required) |
Type specifies the associated icon for a pre-determined list of iDevices. Consult the list of options in the Quickstart guide |
| title (Optional) |
The title parameter enables the user to specify an alternate title associated with the designated icon for the corresponding type. So for example, the author could use "title=Next steps" to be associated with the icon for "type=Key point"
|
| body (Required) |
This parameter is used to display the body text of the iDevice. It will accept any standard wiki text and formatting, including bold, italics, lists, images, etc. |
Tasks
- Consult the list of options in the Quickstart guide and choose a 'type' of pedagogical template you can include in your online learning materials (for example: "Objectives")
- Prepare some draft text to provide learner instructions for the iDevice you have chosen
- Go to the Sandbox page you created in Step 2 above, and open the 'Pedagogical template' subpage in edit mode to start populating the variables of the Wiki markup you copied in Step 3
- Enter the type variable from the list after the "
type=" parameter, for example: "|type=Definition" - After the "
body=" parameter, enter the body text you prepared to provide instructions for your learners - Click on save to see what your template looks like in published view
- Now change the title for your iDevice, providing alternate text after the "
title=" parameter; This demonstrates how you can change the default heading text associated with each icon in the style - Experiment creating a few different iDevices from list of options
