Docs:Course Structure/Course

From DevWiki
Jump to navigation Jump to search
IMPORTANT: This page contains specification information. You should read it carefully, and periodically verify that your work conforms to the specification if appropriate.


The 'root' of any course in the wiki is the Course page. The name of this page is case sensitive: it must be in title case. Generally this page will have been created for you by an administrator during namespace allocation.

The Course page is distinct from the CourseData page because none of the content on the Course page, or in any page linked from it (with the exception of the CourseData page), will be exported by wiki2course.pl). As a result, the formatting and content requirements for the Course page are considerably less strict than for other pages in a course.

The only absolute requirement for the Course page is that it must contain a link to the CourseData page at some point. The location of the link is irrelevant, as long as it appears somewhere. You may include other resources on the Course page, some suggestions are given later. The link to the CourseData page may be as simple as

[[NS:CourseData]]

Or it may include a title if desired:

[[NS:CourseData|Course Data]]

Layout example

The suggested layout for the course page is (replacing NS with the namespace of your course):

== Development resources ==
[[NS:CourseData|Course Data]]<br/>
[[NS:TODO]]<br/>
[[NS:CourseNav]]

== Source data ==
[[NS:Anim Source]]<br/>
[[NS:Image Source]]<br/>

<noinclude>{{NS:CourseNav}}</noinclude>

This example includes links to a TODO list page and source data list pages for animations and images. It also includes a link to the course navigation block page, you will find a full description of that in the course navigation page. The special <noinclude>{{NS:CourseNav}}</noinclude> line at the end of the page is a transclusion of the contents of the course's CourseNav page: this will make your course's navigation block appear at the bottom of the course page, and it should appear at the bottom of every page in your course material (for more about this, see the CourseNav documentation.)

In addition to the content shown above, you may also want to consider using your Course page to store VLE support materials (workpackages, lists of files, question texts), archives of courses generated by the processor, and any support files you need during development.

For an example of a valid Course page, please see C:Course