Docs:Wiki2course Configuration
Jump to navigation
Jump to search
The course processor configuration file may contain a section that allows you to modify the behaviour of the wiki2course.pl application in various ways. This section is optional, as are all the directives it contains, and the primary purpose of the section is to allow material in the wiki to use non-standard names for course elements.
[wiki2course]
wiki_url = http://elearn.cs.man.ac.uk/devwiki/
api_url = http://elearn.cs.man.ac.uk/devwiki/api.php
upload_url = http://elearn.cs.man.ac.uk/devwiki/index.php/Special:Upload
course_page = Course
data_page = coursedata
themes_title = Themes
modules_title = Modules
metadata = Metadata
media_page = Media
[wiki2course] introduces the section in which the settings for wiki2course.pl can be specified. The following directives may be specified within this section (any other directives in this section will be ignored):
wiki_url- This directive must be specified
- The URL of the wiki to export material from (when using course2wiki, this will be the wiki the course will be imported into).
api_url- This directive must be specified
- The URL of the wiki api to communicate with when exporting (or importing when using course2wiki).
upload_url- This directive must be specified
- The URL of the Special:Upload page to use when uploading files to the wiki (usually only needed by course2wiki).
course_page- This directive is optional.
- Sets the course front page name within the course namespace, for example the OWB project uses "Book". This is case sensitive, and defaults to "Course".
data_page- This directive is optional.
- Sets the coursedata page name searched for when processing the course page. This defaults to "coursedata" but other projects may use a different name (OWB uses "BookContents" for example). This is not case sensitive, so you will generally specify it in lowercase, unless you really want to do otherwise.
themes_title- This directive is optional.
- The string that should appear within a level two == ... == header marking the location of the list of themes on the course data page, for example OWB uses 'Book Parts'. This is case sensitive, and defaults to 'Themes'.
modules_title- This directive is optional.
- The string that should appear within a level two == ... == header marking the location of the list of modules on theme pages, for example OWB uses 'Chapters'. This is case sensitive, and defaults to 'Modules'.
metadata- This directive is optional.
- The string that should appear within a level two == ... == header marking the location of the metadata block on course data and theme pages. This is case sensitive and defaults to 'Metadata'.
media_page- This directive is optional.
- The name of the course media page. This is case sensitive and defaults to 'Media'.
| |||||||||||||||||||||||||||||||