Wiki text for course guide navigation template

From WikiEducator
Jump to: navigation, search

Back to Quicklinks for OERu developers

Instructions and conventions

The course guide is a generic resource recommended by the anchor partners for all OERu courses. The course guide includes the following components as illustrated by the AST1000 course example:

Please follow these conventions:

  1. The navigation template for the Course Guide should be transcluded from a sub-page of the relevant OERu course.
  2. The subpage for the navigation template should be prefaced with an underscore (_) to distinguish this from ordinary content pages, for example:
  3. Copy the wiki boilerplate text below to create a navigation template by saving it on the _Nav sub-page of the parent page, i.e.
  4. To transclude the navigation template from the subpage within the relevant sub-pages of the Course Guide, put a colon (:) in front of the page name of the navigation template contained withing two curly brackets, for example {{:Course_name/Course_guide/_Nav}} representing the page where the navigation template is stored for transclusion.
  • For example the wiki text: {{:AST1000/Course_guide/_Nav}} transcludes the navigation template on this sub-page to each of the target page(s) using the wiki text {{:AST1000/Course_guide/_Nav}} on the target page.

Wiki boilerplate text for OERu navigation template

These instructions assume the following nomenclature for the sub-components of an OERu course:

  • Course name --> Course guide --> name of subpage (eg Introduction and course aims, Course team, getting started etc.)
  • Step 1: Copy all the text contained in the grey box below and paste this on the sub-page you are using to create and transclude the navigation template for the Course guide (e.g. Remember to save your page.
  • Step 2: Replace the green text highlighted below with the relevant wiki page urls for your course. Tip: open this window in a new tab to view what text needs to be changed.


|state = iframe

|title = [[Course_homepage|Link Display text eg name of course (#Hashtag)]]

|image =

|above =

|topic1 = <font color=green>Course guide</font>

|section1 = [[../Introduction|Introduction & Aims]] {{vbar}} [[../Development team|Development team]] {{vbar}} [[../Video signpost|Video signpost]] {{vbar}} [[../Getting started |Getting started]] {{vbar}} [[../Resources|Resources]] {{vbar}} [[../Assessment|Assessment overview]] {{vbar}} [[../Schedule|Course schedule]]

|topic2 = <font color=green>Assignments</font>

|section2 = [[../Assignment 1| Assignment 1]] {{vbar}} [[../Assignment 2| Assignment 2]] {{vbar}} [[../Assignment 3| Assignment 3]]

|below = [[Course_homepage/StudyDesk|StudyDesk]] {{vbar}} [[OERu/Learner support|OERu learner support]]

|note = [[Course_homepage/Course_guide/Copyright|Copyright]]

{{ShortTitle}}<includeonly>[[Category:Course_code|{{SUBPAGENAME}}]] </includeonly> <noinclude> [[Category:Course_code|τ]] </noinclude>


  • Inserting the following syntax on the target OERu course page will transclude the navigation template from the navigation sub-page on every page it is used.

It will display as follows in the published view of the course guide.