Quickstart guide/Pedagogical templates

From WikiEducator
Jump to: navigation, search

Quicksteps

Inserting pedagogical templates is a three step process:

  1. Copy the wiki text for the template below.
  2. Paste this on the page where you would like to use it.
  3. Edit and customise the content of the template in the wiki.

Step 1: Copy the wiki text

Copy the following wiki text:

{{IDevice
|theme=
|type=
|title=
|body=
}}

Step 2: Paste and save on a wiki page

On the page you wish to add a pedagogical template, click on the "Edit source" link (not the "Edit" link), and paste the copied wiki text onto the page. Save your page. The wiki text will render as follows:

Icon activity.jpg
Activity




Step 3: Edit and customise

Consult the instructions on this page to change the theme, type of iDevice and corresponding icon or display title for the icon.

Introduction

Pedagogical templates are used when authoring teaching resources in WikiEducator. A number of predefined templates are available to save you time with more complex layouts. A pedagogical template displays an icon, title and body text with the option to specify a small number of themes. The following shows the published rendering of the "Objectives" template using the standard "WikiEducator" theme:

Icon objectives.jpg
Objectives

After reading this help resource, you will be:

  • familiar with the list of pedagogical templates available in WikiEducator.
  • able to change the theme.
  • able to customise templates using your own body text or alternate display titles.



The "Next steps" example below illustrates the "Line" theme and use of a custom title.

Icon key points line.svg
Next steps

The next steps on your journey to implement pedagogical templates include the acquisition of knowledge about:

  • the list of predefined templates.
  • how to customise titles.
  • how to insert, edit and customise your own templates.



List of predefined template types

The type parameter is used to associate the icon with a predefined list of templates. The table below lists the icons used for the WikiEducator and Line theme with corresponding wiki text which should be used.

Templates and corresponding icons
Icon
(Wikieducator theme)
Icon
(Line theme)
Type Wiki text for type parameter
Icon activity.jpg
Icon activity line.svg
Activity |type=Activity or
|type=Activities
Icon activity.jpg
Icon activity line.svg
Portfolio Activity |type=Portfolio activity
Icon activity.jpg
Icon activity line.svg
Extension exercise |type=Extension activity
Icon assess.gif
Icon assess line.svg
Assignment |type=Assignment
Icon qmark.gif
Icon qmark line.svg
Question |type=Question or
|type=Questions
Icon qmark.gif
Icon qmark line.svg
Did you know? |type=Did you know?
Icon qmark.gif
Icon qmark line.svg
Did you notice? |type=Did you notice?
Icon define.gif
Icon define line.svg
Definition |type=Definition or
|type=Definitions
Icon discussion.gif
Icon discussion line.svg
Discussion |type=Discussion
Icon discussion.gif
Icon discussion line.svg
Tell us a story |type=Tell us a story
Icon casestudy.gif
Icon casestudy line.svg
Case study |type=Case study
Icon casestudy.gif
Icon casestudy line.svg
Example |type=Example
Icon objectives.jpg
Icon objectives line.svg
Aim |type=Aim or
|type=Aims
Icon objectives.jpg
Icon objectives line.svg
Objective |type=Objective or
|type=Objectives
Icon objectives.jpg
Icon objectives line.svg
Outcomes |type=Outcomes
Icon key points.gif
Icon key points line.svg
Key point |type=Key point or
|type=Key points
Icon multimedia.gif
Icon multimedia line.svg
Media required |type=Media required
Icon multimedia.gif
Icon multimedia line.svg
Media |type=Media
Icon reading.jpg
Icon reading line.svg
Reading |type=Reading
Icon review.gif
Icon review line.svg
Competency |type=Competency or
|type=Competencies
Icon summary.gif
Icon summary line.svg
Summary |type=Summary
Icon qmark.gif
Icon qmark line.svg
Self assessment |type=Self assessment
Icon qmark.gif
Icon qmark line.svg
Assessment |type=Assessment
Icon reflection.gif
Icon reflection line.svg
Reflection |type=Reflection
Icon preknowledge.gif
Icon preknowledge line.svg
Preknowledge |type=Preknowledge
Icon inter.gif
Icon inter line.svg
Web resources |type=Web resources

Editing and customising pedagogical templates

Theme, type, title, and body are parameters you can use for editing and customising your template. The parameter labels are case sensitive and will not function properly if, for example, you use "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.

Type the name of the theme next to the theme parameter (for example : theme=line). There are currently two theme options:

  • wikieducator (the default theme from WikiEducator)
  • line (which mirrors the OERu inspired themes)
type Type specifies the associated icon for a predetermined list of iDevices. Consult the list of options in the Quickstart guide.
title 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 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.

Examples

IDevice for "Aims" using the "Line" theme

The wiki text below illustrates the use of the "Line" theme to generate the layout for an IDevice of type "Aims". The content of the IDevice is specified using the "body" parameter.

{{IDevice
|theme = Line
|type= Aims
|title=
|body= '''Digital skills for collaborative OER development''' is a free micro Open Online Course (mOOC) designed for educators who want to learn more about open education resources and practices. This course will help you to:
# Acquire and demonstrate digital skills for open and cooperative design, development and publishing of an OER course site on the open web.
# Use social media technologies to support your learning.
# Connect with educators around the world to share thoughts, experiences and establish and build professional networks.
}}

The wiki text above will be rendered as follows in the wiki:

Icon objectives line.svg
Aims

Digital skills for collaborative OER development is a free micro Open Online Course (mOOC) designed for educators who want to learn more about open education resources and practices. This course will help you to:

  1. Acquire and demonstrate digital skills for open and cooperative design, development and publishing of an OER course site on the open web.
  2. Use social media technologies to support your learning.
  3. Connect with educators around the world to share thoughts, experiences and establish and build professional networks.



IDevice using the "Discussion" icon with custom title

The wiki text below illustrates the use of the "title" parameter and the "Wikieducator" theme.

{{IDevice
|theme = Wikieducator
|type= Discussion
|title= This is a custom title
|body= You can change the title of any IDevice. Choose the IDevice which uses an icon suited to your custom title.
}}

The wiki text above will be rendered as follows in the wiki:

Icon discussion.gif
This is a custom title

You can change the title of any IDevice. Choose the IDevice which uses an icon suited to your custom title.