Course formats: Difference between revisions
(Adding to a top level category) |
|||
Line 1: | Line 1: | ||
Course formats are plugins that determine the layout of [[:en:Course|course]] resources. | Course formats are plugins that determine the layout of [[:en:Course|course]] resources. | ||
=Components= | =Components= | ||
'''course/format/ | '''course/format/FORMATNAME/lang/en/format_FORMATNAME.php''' | ||
Contains the language strings used in the format. | Contains the English language strings used in the format. You can also submit strings for other languages. | ||
'''course/format/config.php''' | '''course/format/FORMATNAME/config.php''' | ||
Contains $format['defaultblocks'] which defines the default [[:en:blocks|blocks]] loaded with the format. | Contains $format['defaultblocks'] which defines the default [[:en:blocks|blocks]] loaded with the format. | ||
'''course/format/format.php''' | '''course/format/FORMATNAME/format.php''' | ||
This is is the layout itself. It is loaded by course/view.php. | This is is the layout itself. It is loaded by course/view.php. | ||
'''course/format/lib.php''' | '''course/format/FORMATNAME/lib.php''' | ||
The main library of the format. | The main library of the format. | ||
'''course/format/styles.css''' | '''course/format/FORMATNAME/styles.css''' | ||
Optional stylesheet. | Optional stylesheet. | ||
'''course/format/version.php''' | '''course/format/FORMATNAME/version.php''' | ||
Optional version definitions. | Optional version definitions. | ||
=Creating a New Format= | =Creating a New Format= | ||
The easiest way to create a new course format is to copy an existing one. | The easiest way to create a new course format is to copy an existing one. |
Revision as of 01:28, 30 November 2011
Course formats are plugins that determine the layout of course resources.
Components
course/format/FORMATNAME/lang/en/format_FORMATNAME.php
Contains the English language strings used in the format. You can also submit strings for other languages.
course/format/FORMATNAME/config.php
Contains $format['defaultblocks'] which defines the default blocks loaded with the format.
course/format/FORMATNAME/format.php
This is is the layout itself. It is loaded by course/view.php.
course/format/FORMATNAME/lib.php
The main library of the format.
course/format/FORMATNAME/styles.css
Optional stylesheet.
course/format/FORMATNAME/version.php
Optional version definitions.
Creating a New Format
The easiest way to create a new course format is to copy an existing one.
1. Copy the folder containing the format files.
2. Rename the folder to the new name. NOTE: course format names cannot exceed ten characters. This is a limit set in the database.
3. Change $string['pluginname'] in course/format/format_name/lang/language_code/format_name.php to the new name.
4. The new format is ready for modification.