MoodleDocs - Wkład użytkownika [pl]

Metacourse

2012-07-15T02:14:34Z

Stephenla: Corrected spelling of "techer" to "teacher"

==What is a metacourse?==

A '''meta course''' is a course that is "with" or linked to one or more courses for its student [[Enrolment|enrolment]] (enrollment to some). Adding or subtracting participants in a metacourse can only be done from the courses it is linked to. The linked courses push enrolment information to the metacourse(s) every time [[Cron|cron]] is run. There are [[Metacourse examples of use|many uses for a metacourse]].

The course meta link option must be turned on by the site adminstrator.
''Settings > Site administration > Plugins > Enrolments > Manage enrol plugins > Course meta link''. The standard package default is to hide this feature.

''Concept note:'' When using a meta course, Moodle calls the courses it is linked to '''child''' courses. Some people like to think of them as parent courses. In any case a meta course has a kinship with one or more non-meta courses when it comes to enrolment.

In the simplest form, a linked course only needs to contain just the Students who are to be enrolled in a meta course. There do not need to be resources, assignments, or wikis, etc., just the Students in the linked course. In the simplest form, a meta course '''cannot''' enroll Students, but will have resources and activities for students in the linked courses.

{| class="nicetable" align="center"
|-
![[Image:simplemetacourse0.png|thumb|left|200px|Created - a child course and a meta course.]]
![[Image:simplemetacourse1.png|thumb|left|200px|Associating one child course and one meta course.]]
|}

Examples: one "child" course (a course linked to a meta course) can be associated with many meta courses. Or one meta course can have many child courses associated with it. Both the child courses (non-meta courses) and the meta courses are independent and can be recycled many times, that is, each can be associated with many of the other.

{| class="nicetable" align="center"
|-
![[Image:simplemetacourse2.png|thumb|left|200px|2 child courses and a meta course.]]
![[Image:simplemetacourse3.png|thumb|left|200px|1 child course and 2 meta courses.]]
![[Image:simplemetacourse4a.png|thumb|left|200px|3 child courses and 2 meta courses.]]
|}

==Creating a meta course==
For information on how to create a metacourse, see [https://docs.moodle.org/20/en/admin/setting/enrolsettingsmeta Course meta link plugin] and see this screencast [http://www.youtube.com/watch?v=hA5QcTb13no&feature=player_embedded| How to make a metacourse in Moodle 2.0]

==Tips and Tricks==

===For Administrators===
You must change permissions and capabilities for Teachers to allow them to link Meta courses. To do this go to:
Site Administration > Users > Permissions > Define Roles
Select the Teacher Role and click on the Edit button. Scroll down to Course Meta Link as shown in the images below:
{| class="nicetable" align="center"
|-
|[[Image:metacoursepermissionset00.png|Permission block for allowing Teachers to link Meta courses.]]
|-
| style="text-align: center;"| The default setting is "Not Set"
|-
|[[Image:metacoursepermissionset01.png|Permission changes for editing.]]
|-
| style="text-align: center;"| When the Edit button is clicked, the panel changes to "Allow" and a checkbox
|-
|[[Image:metacoursepermissionset02.png|Setting permission to allow Teachers to link Meta courses.]]
|-
| style="text-align: center;"| Change to "Allow" by a click on the checkbox.
|}
Scroll to the bottom of the page to '''Save''' your changes.

=== Example Procedure for Experimenting with Metacourses ===
In this example, there are 2 sections of students in the "Parent" course: "Section 001" and "Section 002". Students are enrolled in the section courses.

# Turn Metacourses on by going to Site administration -> Plugins -> Enrolments -> Manage enrol plugins and enabled Course meta link.
# Created the following courses:
## Parent
## Section 001
## Section 002
# Enroll users into Section 001 and Section 002. Leave Parent enrollment empty.
# Go to Parent course. Go to Settings -> Course admin -> Users -> Enrolment methods. On that screen, add method "Course Meta link" and choose Section 001. Repeat steps for Section 002. If you look at participants for the parent course, you will see the users from Section 001 and 002.
# If you log-in as a student from section 001, you will see section 001 and parent in your course listings. If you want only students to see the parent course, then go to:
## Site Administration -> Courses -> Add/edit courses. Choose the category for the section 001 course. Find the course section 001. Click the eye icon to hide the course.
## '''OR''' search for the course from the home page logged in as site admin. Click the eye icon to hide the appropriate courses.
# Repeat above for section 002. If you log in as a student, you can't see/search for section 001. However, an admin can still see/search for these now hidden child courses. The will be grayed out to indicate that they are hidden.

===Draw a map of your courses===
Get an oversized piece of paper (A3 or 11"x17'), draw boxes for courses and give them names. Add lines to connect the boxes to show relationships. Label the meta courses (alternatively, color the meta course boxes). Add arrows to the lines so you will know where enrolments come from. This is a great tip from the Business Uses forum.

===Groups do not transfer===
Meta course enrolments do not transfer groups from the and enrolment does not happen immediately, but occurs next time the [[Cron|cronjob]] runs.

===Transfer of roles===
By default all role assignments from child courses are synchronised to meta courses. However, the "Roles that are not synchronised to metacourses" setting in ''Site administration > Plugins > Enrolments > Manage enrol plugins > Course meta link > Settings'' enables administrators to exclude particular roles.

===Restoring a meta course===
When restoring a meta course with the option "deleting the course first", you will notice that the enrolments that were used by the course previously are now gone. In order to re-link the course, navigate to the new course and select the link "Child Courses" from the "Administration" block on the main course page and re-link the course to its parent.

==See also==
*[https://docs.moodle.org/24/en/admin/setting/enrolsettingsmeta Enroll Settings for meta courses in 2.x]
*[[Metacourse examples of use]] - Why use a metacourse? here are many examples
*[[Related courses block]] - contributed code that shows meta or child course relationships

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=48901 Metacourses?] Forum discussion
*[http://moodle.org/mod/forum/discuss.php?d=39438 Best reference for describing a metacourse] Forum discussion
*[http://moodle.org/mod/forum/discuss.php?d=89741 Assign student in course] Forum discussion
*[http://moodle.org/mod/forum/discuss.php?d=156900#p686857 Confusion over meta-courses] Forum discussion

[[cs:Metakurzy]]
[[de:Metakurs]]
[[es:Metacourses]]
[[fr:Méta-cours]]
[[ja:メタコース]]
[[ru:Метакурсы]]

Mahara portfolio

2011-12-12T16:11:57Z

Stephenla: Just added a conjunction for clarity.

{{Portfolios}}
According to the [http://www.mahara.org/ Mahara web site] "Mahara is an open source e-portfolio, weblog, résumé builder and social networking system, connecting users and creating online learner communities. Mahara is designed to provide users with the tools to demonstrate their life-long learning, skills and development over time to selected audiences."

Mahara has close links with Moodle. There is a built in single sign on facility called [[Mahoodle]].

Mahara can serve as a Portfolio into which users can "push" files they want to keep and it is hoped soon that it will also serve as a Repository from which users can "pull" files they need for their course. Both options need to be enabled by the administrator before they are available for teachers and students

==Enabling the Mahara portfolio==
* In order to enable and export items to Mahara you first need an installation of Mahara linked to your Moodle. See here [[Mahoodle]] for instructions.
* Go to ''Settings > Site administration > Advanced features'' and ensure "Enable portfolios" is checked/ticked
* Go to ''Settings > Site administration > Plugins > Portfolios > Manage Portfolios''
* Select from the drop down next to Mahara ePortfolio "Enabled and visible"
* If desired,click on "Settings" and give Mahara a customised name (not essential)
[[File:Maharaportfolio.png]]

==Sending or "pushing" your files to Mahara==
*You can export items such as assignments, chat and forum posts to enabled portfolios. Here is an example with a forum post:
*At the bottom of your completed forum post are the words "export to portfolio".

[[File:Brigitteforum.png]]

*Click the words "export to portfolio" and then select from the dropdown Mahara. (If it is the only portfolio enabled, it wil be the only choice!)

[[File:Maharaexport.png]]

* Click "Next"
* Choose the export type you want. Mahara offers HTML or LEAP 2A format. Then click "Next" again.
* On the next screen, click "continue " to confirm your export.

[[File:Maharaformat.png]]

* The "export complete" message will appear. Clicking "continue" will take you to Mahara.

[[File:Maharaexportcomplete2.png]]

== Mahara as a repository ==
* Progress on the Mahara repository plug in can be followed in the tracker: MDL-16909

[[Category:Site administration]]

[[eu:Mahara]]

Building Lesson

2011-11-26T02:12:40Z

Stephenla: minor grammar fix (changed "effects" to "affects"

{{Improve}}

{{Lesson}}
In planning out a lesson module, it is important to remember each lesson page can be about the student making a choice that is scored or not scored. The choice a student makes affects the way the lesson appears to that student. The teacher will determine what happens with each choice that is offered to the student.

The lesson can be a series of pages presented in a linear fashion, like a slide show, or presented in a non-linear, branching manner, or a combination of the two. For example, a particular question's answer might send the student back in the lesson for a review of content pages, while another answer will advance the student to a new page. Sometimes the student will only be given the choice to "continue", or may see a series of labeled buttons below the content that will take them to different pages.

== Presentation Lesson ==
The Lesson activity uses the standard Moodle [[HTML editor]] tool to make any [[Page content|page's content]] interesting. This tool can assist the teacher with pictures, links, fonts, tables and other graphics to engage the student's attention. Lesson settings also can keep students from straying from the overall teacher's plan with various settings including password protection, time limits and dependency on a previous lesson's activity.

Navigation pages are only seen by the teacher but will affect the order of the pages the student views. For example, a [[Clusters|cluster]] is a series of pages bracketed by a navigational pages called a "start cluster" and a "end of cluster" page. Navigation pages are an advanced feature and are best added after the teacher has laid out their lesson with the pages that will be seen by the student.

===Pages, questions, answers and responses===
A [[Lesson_Pages|lesson is made up of pages]]. For the teacher there are two basic types of Lesson pages: choice and navigation. The student sees choice pages that are called [[Adding a content page|Content]] and [[Adding a question page|Question pages]]. Content pages can provide links to one or more other pages in the lesson. Each question page can do the same but also can give an individual response and an individual score for each choice (the student's answer). The teacher decides upon the page type and how to best use its flexibility to achieve the educational goals of the specific Lesson or course.

:For example, the default lesson question is a multiple choice page. The teacher might place content on the page and ask a question about it. The teacher can provide 1 to 20 answers. In a simple use of the multiple choice question, the teacher might decided to send the student back to the question again after a student selects a wrong answer, but with a correct answer move the student to the next page. On some answers, the teacher may decide to provide some explanation before sending the student along. Unlike a piece of paper, the answers are going to re arrange themselves every time the student enters the question page.

:Of course the teacher can decide a more complex approach in constructing Lesson or a page. Using our multiple choice example,the teacher may give each answer a different score. And/or depending upon the answer, send the student to a different page for an appropriate review. The teacher may decide that a specific Lesson is a series of pages filled with information and only one choice (the continue button) that always sends the student to the next page, perhaps saving the question pages for the end.

===Edit order and navigation order===

The teacher sees the pages in what is called the ''[[Edit page order (Lesson)|edit order]]'' when they edit a lesson. Teachers can move pages in the edit order.

The students see the lesson pages in the ''[[Navigation Page Order|navigation order]]'', which can depend upon Jumps. The teacher can see this order using the [[Viewing_a_lesson#When_the_lesson_already_has_content:|Preview tab]] or switching roles in the course to that of a student.

===Jumps===

Jumps are the primary tool the teacher will use to determine a student's navigation. For example, each different answer to a question, might send the student to a different page.
Thus jumps allow the teacher to design a lesson for the students with "branches", loops and a non-linear structure.

There are two types of jumps, ''relative'' and ''absolute''. The default jumps used by most pages are the ''relative'' jumps "Next page", "This page" and "Previous page". For example, the destination of the Next Page jump is always the next page in the edit order of the lesson. An ''absolute'' jump sends the student to a specific page, usually identified by the page title. A pull down list will show all available possible jumps.

===Answers===

Typically each question within a lesson will have one correct [[Answers|answer]] and several wrong answers. For example, in a multiple choice question, each answer can receive an individual response from the teacher before sending the student (with a jump setting) to view the question again or to another page.

As will be seen later, there are two ways to score an answer. In one method, the direction students are sent in the edit order of pages determines if the answer was correct or wrong for scoring purposes. Usually a correct answer advances the student in the edit order and wrong answers send the students back to the question page or back in the edit order. The other method uses custom scoring and an answer is given a score to calculate the grade.

When a question page is added, the jumps with each answer have a default setting. The jump for the first answer is the "Next page" and it is a good practice to keep this as a right answer. The jumps for the other answers are set to "This page". These settings can be changed by editing the question. Remember the order of the answers is going to be random each time a student enters the question page.

When Custom Scoring is turned on in the Lesson settings, then each answer has a point value associated with it. Usually a correct answer receives a score of 1 and a wrong answer receive a score 0. It is possible to give a negative score or partial credit (say 3 for the best answer and 1 for a marginal answer) in some question types.

===Grading===
A students answers to questions can be graded. The [[Lesson score|lesson scores]] and grades can be viewed on the [[Lesson reports|"Reports" tab]] in edit mode and become part of the [[Grades|gradebook]]. A relatively simple formula is used to [[Lesson score|score]] the lesson. It is the number of correct answers divided by the number of question pages seen. This number score can be use by the [[Scales|grade scale]].

When [[Adding/editing_a_lesson#Custom_Scoring|Custom Scoring]] is selected in the Lesson settings, then the grading method changes. With this option, the grade is based on earned points by the user, which is divided by the total points possible. When this option is turned on, the teacher can assign a score for each answer, this can be a negative or 0 (zero) or a positive number. Usually the score is 0 for a wrong answer and 1 for a correct answer. The point values associated with each of the user's answers are added up. That is then divided by the total of the maximum points that the user could have earned for each page answered. This number is then scaled by the grade parameter of the lesson.

The overall score is computed when the Lesson is completed by the student. A completed lesson usually means the student has viewed every page, or answered every question or is directed by a jump to the "[[Lesson_Pages#End_of_Lesson_Page|end of lesson]]".

:''TIP:'' Grading can be continued when student leaves the lesson for some reason before completing it. The student does not have to go through all of the lesson in one "[[Adding/editing_a_lesson#User_can_re-take|sitting]]". For example, if a student goes through some pages and then breaks off, the next time they view the lesson they are asked whether they want to start at the beginning of the lesson or at the point where they left off. The latter point is actually the page they reached with their last correct answer. The previous "attempts" are recorded and the grade for "broken" sessions will include pages seen and questions answered in the previous viewings.

*The main focus of a lesson should be the transfer of knowledge in a reasonably interesting way. Giving a grade may well turn the lesson into a kind of quiz where giving the correct answer is the sole goal instead of exploring different ways of thinking about an idea. On the other hand, students like to get a perfect "score" and giving grades may well be the carrot needed to get the student to repeat the lesson until they get the magic 100%.

*Some instructors use Lessons as Formative Assignments where the grades, although some measure of activity, are not generally counted in the final mark for the course. If lessons are used in a formal way then it is probably best to use their grades in thresholds.
*Many instructors use lessons to get across chunks of knowledge. The grading options enable instructors to utilize the [http://www.wcln.org/Flow_Documentation.htm#The_Practice_Principle "Practice Principle"] of eLearning, in which immediate practice in answering questions about content leads to improved retention and understanding of the material.

With that in mind, a lesson has a Retake option.

===Teacher review of students answers===
The teacher has several options to review students answers in a lesson. The [[Lesson reports|report tab]] provides both an overview of each student's attempt of a lesson, and a detailed summary of the class's answers to each question. It is also possible to see the same report via [[Grades|gradebook]] in the course administration block.

===Student Review===

Enabling student review will override custom feedback for questions. [http://moodle.org/mod/forum/discuss.php?d=70798 Forum discussion]

===Re-takes===
Allowing a student to re take a lesson is the default lesson setting under [[Adding/editing_a_lesson#User_can_re-take|grade options]]. Each attempt at a lesson is normally recorded and the student can see a record of their performance by viewing their [[Student_tutorials#Settings|activity page]]. The teacher when creating a lesson has the option of showing the "final" grade as either the mean of all the attempts or the best (maximum score) of their attempts. This "final" grade is the one shown on the [[Grades]] page and the "Lessons" page. By default the mean of the grades is used.

In some learning environments, the teacher may not wish the students to have more than one attempt at a lesson. A particular lesson may be being used in an exam-like situation. Here the Lesson parameter for re-take is set to "No. Once completed the lesson will then not allow students to re-take the lesson. If, however, the lesson is not completed in one "sitting", students are still allowed to restart the lesson at the beginning or the page after the last question they answered.

*As mentioned earlier a lesson can be used as a formative assignment, imparting some knowledge while at the same time making some demands on the students. It seems natural that students should be allowed to re-visit lessons and because they are given a grade many will want to achieve a good grade. This promotes re-takes.

*Remember that even if a student has achieved the maximum possible grade in a lesson, allowing them to revisit the lesson to explore the various "wrong" paths in the lesson, may provide the student, you and your class additional insights.

===Building lessons===

When creating a lesson the teacher must put some content using the [[HTML editor]] tool into the first page. Once the first page is in place the teacher has the option of adding more pages in front or after that page. Once a question or content page has been created, the pages can be edited by the teacher at any time. When the lesson contains more than one page the teacher also has the option of moving pages, that is, changing the order of the pages.

*A lesson will normally cover a limited amount of material. A topic or week might contain many lessons. Lessons are shown to the student in the home page for the course within "weeks" or "topics", and/or in the activity block when it is part of the course home page.

*As with any lesson, it is a good idea to have a plan before starting the presentation. Simple lessons that basically go from the start to the end in a straight line path, one page after the other, can be created from an outline. More complicated lessons require more planning. The good news is that a teacher can create a simple lesson and then based upon feedback and performance, can add refinements or complexity.

[[Adding_a_question_page]]- more help on adding question pages <br>
[[Adding_a_content_page]] - more help on adding Content (Branch Table) pages

== Types of questions available within a lesson ==
Questions types in the Lesson module are similar to those in the Quiz module. However, the two modules are very different and questions may act different for both the student and teacher.

See [[Lesson questions]] for more information about using specific question types with this module. Remember that the powerful HTML tool bar will allow the teacher to add pictures to content and to question answers.

===Multiple choice ===
In a multiple choice question, the student is given a question and a list of answers. In a Lesson, the answer list will be shuffled every time the question is view by a student. In a multiple choice question, the student selects one answer.

====With multianswer box checked====
A check in the multianswer box allows the teacher to determine that more than 1 answer is required for the student to receive credit for the question. There is no partial credit and the student must select just correct answers from a list.

See also [[Multiple_Choice_question_type]] which is a quiz question and works differently.

===Short answer===
In a short answer question the student is expected to answer with one word or a few words. [[Short-Answer question type]] gives more information about this kind of question

There are two different ''student answer'' analysis systems available for the Short Answer type of question in the Lesson Module: the '''simple system ''' and the new '''regular expressions system'''. The simple system is the default and is the same used by the Quiz Module. There is a "Use Regular Expressions" option box on the Edit Question Page screen in the Lesson Module.

We suggest first reading about the [[Short-Answer question type|Short answer question page]] with the examples of the "simple analysis", and then read the [[Short answer analysis]] page that gives more information about "Regular Expression analysis".

===True / false===

The True/False question type is a special case of the multiple choice question. The student is prompted to choose which is the correct option. See [[Lesson_module#Multiple_choice|multiple choice question]] above for details.

===Matching questions===
[[Image:Question Matching pulldown 1.JPG||thumb|80px|right|Matching]]
Matching questions consist of a list of names or statements, or pictures which must be correctly matched against another list. For example "Match the letter with its position in the alphabet. One list would have A, B, C, D, Z and the other in a pull down menu next to each item would have 2, 4, 3, 1, 26 .

See [[Matching question type]] for more information.

===Numerical Question===
This type of question requires a number as the answer. In it's simplest form it requires just one answer to be specified. For example "What is 2 plus 2?", where 4 is the correct answer. A numerical question will also accept a number in a range as being correct. The answers are similar to short answer, where the order that the teacher lists the answers is important.

See [[Numerical question type]] for more information about a Quiz question.

The lesson numerical question differs from the numerical quiz question and the numerical embedded question (Cloze)when it evaluates answers. For example there is no wild card.

===Essay Questions===
Short essay questions were introduced in Moodle version 1.5. These are meant for short, paragraph or two type of essays one often finds on exams. Thus we did not use the html editor, preferring a simple text field. For longer essays, the assignment module is a better choice.

The student simply enters their essay in the box provided. The teacher sees ungraded essay questions when opening the lesson. After grading, the teacher can email their responses to the student.

[[Essay question type]] page has more information.

== Branches and content pages ==
If your lesson delivers quite a lot of information, you can divide it into sections that are called "branches". One way of moving between these branches is by adding a content page.
:''Tip:'' You can also move between branches with a question page. For example: a poor answer choice might send the student to a branch for some additional information.

Content pages are pages which have a set of [[Jumps|jumps/links]] to other pages in the lesson. The student sees labeled buttons under the page content to provide their choices. Content pages are similar to many question page types. They have a title, [[Page content|content]] section, student choices (called descriptions) and [[Jumps|jumps]] associated with each choice. Content pages are grade neutral, so there are no scores. Content pages also can be put to special uses by a teacher. To help understand these concepts we are going to call one use a "ordered branch" and the other a "classic branch".

===Ordered branches===
A table of contents is an example of a use of ordered branches. Typically a lesson may start with a Content page with the title "Table of Contents". The student selects a Description button and jumps to a page in the edit order that starts a series of pages about that subject. At the end of an ordered branch, the student is given several options by a question or a content page, such as: "Go to the next page", "Start of the series again", "End the lesson", or "Return to the Table of Contents. [[Image:Lesson visual order graphic1.png|thumb|100px|center|TOC that leads to 3 ordered branches]]

===Classic branches===
The classic branch is an advanced navigational feature. It introduces random movement within a series of pages that the teacher determines. A classic branch needs a Branch Table at the start of the series and a special navigation page called "End of Branch" at the end of the series.

The default jump in an "End of Branch" page is the preceding content page as an absolute jump. After a classic branch has been created, the teacher will see 3 new relative jump options: "Unseen question within a branch", "Random question within a branch" and "Random branch page". The classic branch with its "end of branch" navigation page is similar to a [[Clusters|cluster]].

:''Tip:'' As with any advanced navigational feature, it is best to add it after the basic question and content pages have been created. Checking the Lesson's behavior in a student role is another best practice with highly adaptive lesson formats.

===Tips when using branches===
*The number of links shown when setting up or editing a content or a question page is set by the [[Lesson settings]]. This parameter can be changed on the fly by clicking on the Settings block >Lesson administration >edit settings link.
*When a lesson includes one or more ordered or classic branches, teachers need to decide if their students must visit every branch. By adding a question or two in each branch, the teacher can set the "Edit settings" Minimum number of Questions]]" parameter to some reasonable number of questions that must be answered. Without this parameter a student might visit a single branch in the lesson, answer all its questions correctly and leave the lesson with the maximum grade based upon their attempts, not the total number of available questions.

*Remember that using branches may encourage a student to revisit a question page more than once. This can impact scoring. Since scores can not be displayed for a teacher, it is a good practice for a new Moodling Teacher to log in as a student to check how the score is kept in their Lesson.

*[[Lesson_Pages#Branch_.28Branch_Table.29-_Choice_Pages|Choice pages gives]] detailed help about editing a branch . [[Adding_a_content_page|Adding a content page (branch table)]] reviews process.

== Lesson dependencies and linking ==
===Dependency===
Lesson has dependency setting similar to [[Conditional activities]]. It allows the current lesson to be dependent upon a student's performance in one specific lesson that is in the same course. If the conditions(s) is not met, then the student will not be able to access the current lesson. This feature is independent of [[Restrict access settings]] which only will appear if [[Conditional access} has been enabled on the site.

These "Dependent on" conditions include: time spent, completed or receive a better than grade one specific lesson. Any combination of the conditions can be used. Please note, a Lesson must include one question for the dependent "completed" condition to be met.

*A typical use of this feature is to "daisy chain" a series of Lessons to make sure the students take the lessons in order. This might be useful in a training type of course which has no open or close dates because it can be started and finished at any time.

===Links to other places===
Use the "Link to" in the [[Lesson settings]] to offer the student a direct link button to another activity in the course when they complete the lesson.

Another handy Lesson setting "Pop-Up to file or web page" will create a window the student can view while in the lesson.

:'''Tip:'''More advanced Moodlers can figure out how to place HTML links on a lesson page. Thus it is possible to create a link to another lesson/activity, a lesson/activity in another course, or even to a specific page in a lesson. While this method can be useful, the student may not be able to find their way back to the page with the link. In general, the links can be created by copying the location of the desired link from the browser's address bar, then pasting it as a link.

Wiki permissions

2010-10-23T03:22:40Z

Stephenla: I deleted an off-topic link to a private business. *[http://customwritingservices.org/index.php writing services]

{{Wiki}}
{{Moodle 1.7}}
Roles and capabilities in Moodle 1.7 onwards enable possibilities such as students being given permission to manage wikis. The following capabilities are related to wikis:

*[[Capabilities/mod/wiki:participate|mod/wiki:participate]]
*[[Capabilities/mod/wiki:manage|mod/wiki:manage]]
*[[Capabilities/mod/wiki:overridelock|mod/wiki:overridelock]]

[[Category:Wiki]]
[[Category:Roles]]
[[eu:Wikiaren_baimenak]]
[[fr:Permissions des wikis]]
[[de:Wiki-Rechte]]
[[ja:Wikiパーミッション]]

Themes 2.0

2010-06-15T01:38:35Z

Stephenla: /* Layouts */ just fixed minor punctuation in text

{{Template:Themes}}{{Moodle 2.0}}Welcome to the new world of themes within Moodle 2.0!

This document explains how themes work in Moodle and is intended to help you create or modify most themes for Moodle 2.0.

==Introduction==

Moodle themes are responsible for much of the "look" of a Moodle site. They provide the CSS for colours, layouts, fonts and so on, and can also change the structural XHTML code below that.

A theme can either contain all the definitions (completely stand alone) or it can extend an existing theme with one or more customizations.

Most theme developers use the second method and simply add a few new CSS or layout definitions to their new theme. If a definition or element is not found in the new theme, it looks to the "parent" (or up the hierarchy of themes) to find one. It an easy way to achieve just about any look you want for a theme.

==What's new in 2.0==

The theme system was completely redesigned in Moodle 2.0. Known issues have been addressed and new features have been added to meet community requests.

Unfortunately it was not possible to maintain backward compatibility, so all Moodle 1.x themes need to be recreated for Moodle 2.0.

Major changes include:
* Clearer and more consistent CSS classes and IDs throughout all pages in Moodle
* Introduction of layout files (templates) describing overall layout HTML for many different types of pages in Moodle.
* Introduction of renderers, which produce the smaller "parts" of a HTML page. Advanced themes can choose to override these too if they choose.
* Introduction of standard methods for adding Javascript to themes.
* Easier control over icons and images in Moodle.
* The old "standard" theme has been split into two themes:
**'''base''' - contains absolutely basic layout, and
**'''standard''' - which adds CSS to the base theme to make it look like the old standard theme.
* Performance tuning: In normal production mode CSS files are combined into a single optimised file, and both CSS and JavaScript files are minimised to ensure there are no wasted connections or traffic. Files are heavily cached, but also versioned, so that users never need to clear their caches.

==The structure of a theme==

Some important things to know when building good themes:

# '''config.php''' - this file is required in every theme. It defines configuration settings and definitions required to make the theme work in Moodle. These include theme, file, region, default region and options.
# '''Layouts and layout files''' - in config.php there is one definition for each page type (see [[#theme_layouts_table|Appendix A: Theme layouts]] for a list of over 12 types). Each page type definition tells Moodle which layout file will be used, what block regions this page type should display and so on. The layout file contains the HTML and the minimum PHP required to display basic structure of pages. (If you know Moodle 1.9, it's like a combination of header.html and footer.html).
# '''The base theme''' - is not intended to be used for production sites. It sets up the simplest possible generic layout and includes only CSS essential to that layout ''or'' to Moodle as a whole. It tries not to make any unnecessary rules and makes as few assumptions as possible. It's the perfect base on which to start designing a theme, as there are very few colours, borders, margins, and alignments to override. You can just start adding what you need.

===Files and folders===
A theme's files are placed in a folder with under moodle/theme folder and have subfolders. They are laid out like this:

{| class="nicetable"
|-
! Directory
! File
! Description
|-
|
| /config.php
| Contains all of the configuration and definitions for each theme
|-
|
| /lib.php
| Contains speciality classes and functions that are used by theme
|-
|
| /renderers.php
| Contains any custom renderers for the theme.
|-
|
| /settings.php
| Contains custom theme settings. These local settings are defined by the theme allowing the theme user to easily alter something about the way it looks or operates. (eg a background colour, or a header image)
|-
| /javascript/
|
| All speciality JavaScript files the theme requires should be located in here.
|-
| /lang/
|
| Any special language files the theme requires should be located in here.
|-
| /layout/
|
| Contains the layout files for the theme.
|-
| /pix/
|
| Contains any images the theme makes use of either in CSS or in the layout files.
|-
| /pix
| /favicon.ico
| The favicon to display for this theme.
|-
| /pix
| /screenshot.jpg
| A screenshot of the theme to be displayed in on the theme selection screen.
|-
| /style
|
| Default location for CSS files.
|-
|
|/*.css
|CSS files the theme requires
|}

There are also several other places that stylesheets can be included from (see the CSS how and why section below).

==Theme options==
All theme options are set within the config.php file for the theme. The settings that are most used are: parents, sheets, layouts, and javascripts. Have a look at the '''[[#theme_options_table|theme options table]]''' for a complete list of theme options which include lesser used specialised or advanced settings.

===Basic theme config example===
Lets have a look at a basic theme configuration file and the different bits that make it up:
<code php>
$THEME->name = 'newtheme';

$THEME->parents = array(
'base'
);

$THEME->sheets = array(
'admin',
'blocks',
'calendar',
'course',
'grade',
'message',
'question',
'user'
);

$THEME->layouts = array(
'base' => array(
'theme' => 'newtheme',
'file' => 'general.php',
'regions' => array(),
),
'standard' => array(
'theme' => 'newtheme',
'file' => 'general.php',
'regions' => array('side-pre', 'side-post'),
'defaultregion' => 'side-post',
)
//.......
);

$THEME->javascripts_footer = array(
'navigation'
);
</code>

===Basic theme example settings explained===
First up you will notice everything is added to $THEME. This is the theme's configuration object, it is created by Moodle using default settings and is then updated by whatever settings you add to it.

The first setting, $THEME->name is the theme's name. This should simply be whatever your theme's name is, most likely whatever you named your theme directory.

$THEME->parents defines the themes that the theme will extend. In this case it is extending only the base theme.

After this is the $THEME->sheets array containing the names of the CSS stylesheets to include for this theme. Note that it is just the name of the stylesheet and does not contain the directory or the file extension. Moodle assumes that the theme's stylesheets will be located in the styles directory of the theme and have .css as an extension.

Next we see the $THEME->layouts definition. In this example, two layouts have been defined to override the layouts from the base theme. For more information see the [[#Layouts|layouts]] section below.

The final setting is to include a JavaScript file, as $THEME->javascripts_footer. Much like stylesheets, you only need to provide the files name. Moodle will assume it is in your themes JavaScript directory and be a .js file.

'''''Note''''': When you start out theming, make sure you take a look at the configuration files of the other themes that get shipped with Moodle. You will get a good picture of how everything works, and what is going on in a theme, simply by reading it and taking notice of what it is including or excluding.

==CSS==
===Locations of CSS files===
First lets look at where CSS can be included from within Moodle:
; \theme\themename\styles\*.css : This is the default location for all of the stylesheets that are used by a theme and the place which should be used by a theme designer.

New theme developers should note that the order in which CSS files are found and included creates a hierarchy. This order ensures that the rules, within a theme's style sheets, take precedence over identical rules in other files that may have been introduced before. This can both extend another files definitions (see parent array in the config file) and also ensures that the current theme's CSS rules/definitions have the last say.

There are other locations that can be used (although very rarely) to include CSS in a page. A developer of a php file can manually specify a stylesheet from anywhere within Moodle, like the database. Usually, if code is doing this, it is because there is a non-theme config or plugin setting that contains information requires special CSS information. As a theme designer you should aware of but not have to worry about these locations of CSS files. Here are some examples:

; {pluginpath}\styles.css e.g. \block\blockname\styles.css or \mod\modname\styles.css : Every plugin can have its own styles.css file. This file should only contain the required CSS rules for the module and should not add anything to the look of the plugin such as colours, font sizes, or margins other than those that are truly required.<br />Theme specific styles for a plugin should be located within the themes styles directory.
; {pluginpath}\styles_themename.css : This should only ever be used by plugin developers. It allows them to write CSS that is designed for a specific theme without having to make changes to that theme. You will notice that this is never used within Moodle and is designed to be used only by contributed code.

As theme designers, we will only use the first method of introducing CSS: adding rules to a stylesheet file located in the themes styles directory.

===Moodle's core CSS organisation===
The next thing to look at is the organisation of CSS and rules within a theme. Although as a theme designer it is entirely up to you as to how you create and organise your CSS. Please note that within the themes provided in the standard install by Moodle there is a very clear organisation of CSS.

First is the pagelayout.css file. This contains the CSS required to give the layouts their look and feel. It doesn't contain any rules that affect the content generated by Moodle.

Next is the core.css file. If you open up core you will notice that it contains all manner of general (usually simple) rules that don't relate to a specific section of Moodle but to Moodle as a whole.

There can also be rules that relate to specific sections. However, this is done only when there are only a handful of rules for that section. These small clusters of rules are grouped together and separated by comments identifying for which section each relates.

Finally there are all the other CSS files, you will notice that there is a file for each section of Moodle that has a significant collection of rules.

:For those who are familiar with Moodle 1.9 theme's, this organisation will be a big change. In 1.9, CSS was organised by its nature (for example: colours, layout, other).

===How to write effective CSS rules within Moodle===
In Moodle 2.0, writing good CSS rules is an incredibly important.

Due to performance requirements and browser limitations, all of the CSS files are combined into a single CSS file that gets included every time. This means that rules need to be written in such a way as to minimise the chances of a collision leading to unwanted styles being applied. Whilst writing good CSS is something most designers strive for we have implemented several new body classes and put more emphasis on developers for using classes more appropriately.

====The body tag====
As of Moodle 2.0 the ID tag that gets applied to the body will always be a representation of the URI. For example if you are looking at a forum posting and the URI is '/mod/forum/view.php' then the body tags ID will be '#page-mod-forum-view'.

As well as the body's ID attribute the URI is also exploded to form several CSS classes that get added to the body tag, so in the above example '/mod/forum/view' you would end up with the following classes being added to the body tag '.path-mod', '.path-mod-forum'. Note that '.path-mod-forum-view' is not added as a class, this is intentionally left out to lessen confusion and duplication as rules can relate directly to the page by using the ID and do not require the final class.

The body ID and body classes described above will form the bread and butter for many of the CSS rules you will need to write for your theme, however there are also several other very handy classes that get added to the body tag that will be beneficial to you once you start your journey down the rabbit hole that is themeing. Some of the more interesting classes are listed below.

* If JavaScript is enabled then 'jsenabled' will be added as a class to the body tag allowing you to style based on JavaScript being enabled or not.
* Either 'dir-rtl' or 'dir-ltr' will be added to the body as a class depending on the direction of the language pack: rtl = right to left, ltr = left to right. This allows you to determine your text-alignment based on language if required.
* A class will be added to represent the language pack currently in use, by default en_utf8 is used by Moodle and will result in the class 'lang-en_utf8' being added to the body tag.
* The wwwroot for Moodle will also be converted to a class and added to the body tag allowing you to stylise your theme based on the URL through which it was reached. e.g. http://sam.moodle.local/moodle/ will become '.sam-moodle-local—moodle'
* If the current user is not logged then '.notloggedin' will be added to the body tag.

What does all of this look like in practise? Well using the above example /mod/forum/view.php you would get at least the following body tag:
<code html4strict><body id=”page-mod-forum-view” class=”path-mod path-mod-forum” /></code>

====Writing your rules====
The best use of body ids and classes and writing selectors will reduce problems.

There are many specific classes used within Moodle. We try to put them everywhere where anyone may want to apply their own styles. It is important to recognise that no one developer can be aware of the all of the class names that have been used all throughout Moodle, let alone within all of the different contributed bits and pieces available for Moodle. It is up to the theme developer to write good rules and minimise the chances of a collision between rules because in this case good CSS is FAR more effective.

When starting to write rules make sure that you have a good understanding of where you want those rules to be applied, it is a good idea to make the most of the body classes mentioned above.
If you want to write a rule for a specific page make use of the body tag's ID, e.g.:

<code css>#page-mod-forum-view .forumpost {border:1px solid orange;)</code>

If you want to write a rule that will be applied all throughout the forum.:

<code css>.path-mod-forum .forumpost {border:1px solid orange;}</code>

The other very important thing to take into consideration is the structure leading up to the tag you want to style. Browsers apply conflicting styles with priority on the more specific selectors. It can be very beneficial to keep this in mind and write full selectors that rely on the structure of the tags leading to the tag you wish to style.

By making use of body id's and classes and writing selectors to take into account the leading structure you can greatly minimise the chance of a collision both with Moodle now and in the future.

==Layouts==
All themes are required to define the layouts they wish to be responsible for as well as create; however, many layout files are required by those layouts. If the theme is overriding another theme then it is a case of deciding which layouts this new theme should override. If the theme is a completely fresh start then you will need to define a layout for each of the different possibilities. For both situations these layouts should be defined within config.php.

It is also important to note that a new theme that will base itself on another theme (overriding it) does not need to define any layouts or use any layout files if there are no changes that it wishes to make to the layouts of the existing theme. The standard theme in Moodle is a good example of this as it extends the base theme simply adding CSS to achieve its look and feel.

So layouts... as mentioned earlier layouts are defined in config.php within $THEME->layouts. The following is an example of one such layout definition:
<code php>
$THEME->layouts = array(
// Standard layout with blocks, this is recommended for most pages with general information
'standard' => array(
'theme' => 'base',
'file' => 'general.php',
'regions' => array('side-pre', 'side-post'),
'defaultregion' => 'side-post'
)
)
</code>
The first thing Moodle looks at is the name of the layout, in this case it is `standard` (the array key in PHP), it then looks at the settings for the layout, this is the theme, file, regions, and default region. There are also a couple of other options that can be set by a layout.

; theme : is the theme the layout file exists in. That's right you can make use of layouts from other installed themes.
; file : is the name of the layout file this layout wants to use.
; regions : is the different block regions (places you can put blocks) within the theme.
; defaultregion : is the default location when adding new blocks.
; options : an array of layout specific options described in detail below.

The first four settings are required by each layout definition however the final setting `options` is a special case that only needs to be set if you want to make use of it. This setting allows the theme designer to specify special options that they would like to create that can be later accessed within the layout file. This allows the theme to make design decisions during the definition and react upon those decisions in what ever layout file is being used.

One such place this has been used is infact within the base theme. If you take a look first at theme/base/config.php you will notice that several layouts specify options '''nonavbar''' and '''nofooter''' which can both be set to either true or false. Then if we take a look at theme/base/layout/general.php you will spot lines like the following:
<code php>
<?php
$hasnavbar = (empty($PAGE->layout_options['nonavbar']) && $PAGE->has_navbar());
$hasfooter = (empty($PAGE->layout_options['nofooter']));
?>
............
<?php if ($hasnavbar) { ?>
<div class="navbar clearfix">
<div class="breadcrumb"><?php echo $OUTPUT->navbar(); ?></div>
<div class="navbutton"> <?php echo $PAGE->button; ?></div>
</div>
<?php } ?>
</code>
What you are seeing here is the use of those settings from the layout within the layout file. In this case it is being used to toggle the display of the navigation bar and page footer.

==Layout files==
A layout file is a file that contains the core HTML structure for a layout including the header, footer, content and block regions.
For those of you who are familiar with themes in Moodle 1.9 this is simply header.html and footer.html combined.
Of course it is not all HTML, there is bits of HTML and content that Moodle needs to put into the page, within each layout file this will be done by a couple of VERY simple PHP calls to get bits and pieces including content.

The following is a very simple layout file to illustrate the different bits that make it up:
<code php>
<?php echo $OUTPUT->doctype() ?>
<html <?php echo $OUTPUT->htmlattributes() ?>>
<head>
<title><?php echo $PAGE->title ?></title>
<?php echo $OUTPUT->standard_head_html() ?>
</head>
<body id="<?php echo $PAGE->bodyid ?>" class="<?php echo $PAGE->bodyclasses; ?>">
<?php echo $OUTPUT->standard_top_of_body_html() ?>
<table id="page">
<tr>
<td colspan="3">
<h1 class="headermain"><?php echo $PAGE->heading ?></h1>
<div class="headermenu"><?php echo $OUTPUT->login_info(); echo $PAGE->headingmenu; ?></div>
</td>
</tr>
<tr>
<td>
<?php echo $OUTPUT->blocks_for_region('side-pre') ?>
</td>
<td>
<?php echo core_renderer::MAIN_CONTENT_TOKEN ?>
</td>
<td>
<?php echo $OUTPUT->blocks_for_region('side-post') ?>
</td>
</tr>
<tr>
<td colspan="3">
<p class="helplink"><?php echo page_doc_link(get_string('moodledocslink')) ?></p>
<?php
echo $OUTPUT->login_info();
echo $OUTPUT->home_link();
echo $OUTPUT->standard_footer_html();
?>
</td>
</tr>
</table>
<?php echo $OUTPUT->standard_end_of_body_html() ?>
</body>
</html>
</code>

Lets assume you know a enough HTML to understand the basic structure above, what you probably don't understand are the PHP calls so lets look at them.
<code php>
<?php echo $OUTPUT->doctype() ?>
</code>
This occurs at the VERY top of the page, it must be the first bit of output and is responsible for adding the (X)HTML document type definition to the page. This of course is determined by the settings of the site and is one of the things that the themer has no control over.

<code php>
<html <?php echo $OUTPUT->htmlattributes() ?>>
</code>
Here we have started writing the opening html tag and have asked Moodle to give us the HTML attributes that should be applied to it. This again is determined by several settings within the actual HTML install.

<code php>
<?php echo $PAGE->title ?>
</code>
This gets us the title for the page.

<code php>
<?php echo $OUTPUT->standard_head_html() ?>
</code>
This very important call gets us the standard head HTML that needs to be within the HEAD tag of the page. This is where CSS and JavaScript requirements for the top of the page will be output as well as any special script or style tags.

<code php>
<body id="<?php echo $PAGE->bodyid; ?>" class="<?php echo $PAGE->bodyclasses; ?>">
</code>
Much like the html tag above we have started writing the body tag and have asked for Moodle to get us the desired ID and classes that should be applied to it.

<code php>
<h1 class="headermain"><?php echo $PAGE->heading; ?></h1>
<div class="headermenu"><?php echo $OUTPUT->login_info(); echo $PAGE->headingmenu; ?></div>
</code>
Here we are creating the header for the page. In this case we want the heading for the page, we want to display the login information which will be the current users username or a link to log in if they are not logged in, and we want the heading menu if there is one.

<code php>
<?php echo $OUTPUT->blocks_for_region('side-pre') ?>
</code>
Here we get the HTML to display the blocks that have been added to the page. In this case we have asked for all blocks that have been added to the area labelled ''side-pre''.

<code php>
<?php echo core_renderer::MAIN_CONTENT_TOKEN ?>
</code>
This is one of the most important calls within the file, it determines where the actual content for the page gets inserted.

<code php>
<?php echo $OUTPUT->blocks_for_region('side-post') ?>
</code>
Here we get the HTML to display the blocks that have been added to the page. In this case we have asked for all blocks that have been added to the area labelled ''side-post''.

<code php>
<?php
echo $OUTPUT->login_info();
echo $OUTPUT->home_link();
echo $OUTPUT->standard_footer_html();
?>
</code>
This final bit of code gets the content for the footer of the page. It gets the login information which is the same as in the header, a home link, and the standard footer HTML which like the standard head HTML contains all of the script and style tags required by the page and requested to go in the footer.

'''''Note''''': Within Moodle 2.0 most of the JavaScript for the page will be included in the footer. This greatly helps reduce the loading time of the page.

When writing layout files think about the different layouts and how the HTML that each makes use of will differ. You will most likely find you do not need a different layout file for each layout, most likely you will be able to reuse the layout files you create across several layouts. You can of course make use of layout options as well to further reduce the number of layout files you need to produce.

Of course as mentioned above if you are customising an existing theme then you may not need to create any layouts or layout files at all.

==Making use of images==
Right at the start when listing the features of the new themes system one of the features mentioned was the ability to override any of the standard images within Moodle from within your theme. At this point we will look at both how to make use of your own images within your theme, and secondly how to override the images being used by Moodle.
So first up a bit about images within Moodle,

# Images you want to use within your theme '''need''' to be located within your theme's pix directory.
# You can use sub directories within the pix directory of your theme.
# Images used by Moodle's core are located within the pix directory of Moodle.
# Modules, blocks and other plugins should also store there images within a pix directory.

So making use of your own images first up. Lets assume you have added two image files to the pix directory of your theme.

* /theme/yourthemename/pix/imageone.jpg
* /theme/yourthemename/pix/subdir/imagetwo.png

Notice that one image is a JPEG image, and the second is a PNG. Also the second image is in a subdirectory.

The following code snippet illustrates how to make use of your images within HTML, such as if you wanted to use them within a layout file.
<code php>
<img src="<?php echo $OUTPUT->pix_url('imageone', 'theme');?>" alt="" />
<img src="<?php echo $OUTPUT->pix_url('subdir/imagetwo', 'theme');?>" alt="" />
</code>
In this case rather than writing out the URL to the image we use a method of Moodle's output library. Its not too important how that functions works but it is important that we use it as it is what allows images within Moodle to be over-rideable.

The following is how you would use the images from within CSS as background images.
<code css>
.divone {background-image:url([[pix:theme|imageone]]);}
.divtwo {background-image:url([[pix:theme|subdir/imagetwo]]);}
</code>
If this case we have to use some special notations that Moodle looks for. Whenever Moodle hands out a CSS file it first searches for all ''[[something]]'' tags and replaces them with what is required.

The final thing to notice with both of the cases above is that at no point do we include the images file extension.
The reason for this leads us into the next topic, how to override images.

From within a theme you can VERY easily override any standard image within Moodle by simply adding the replacement image to the theme's pix directory in the same sub directory structure as it is in Moodle.
So for instance we wanted to override the following two images:
# /pix/moodlelogo.gif
# /pix/i/user.gif
We would simply need to add our replacement images to the theme in the following locations
# /theme/themename/pix/moodlelogo.gif
# /theme/themename/pix/i/user.gif
How easy is that!

Now the other very cool thing to mention is that Moodle looks for not just replacements of the same image type (jpg, gif, etc...) but also replacements in any image format. This is why above when working with our images we never specified the images file extension.
This means that the following would also work:
# /theme/themename/pix/moodlelogo.png
# /theme/themename/pix/i/user.bmp

For a more detailed description of how this all works see the page on [[Development:Themes_2.0_How_to_use_images_within_your_theme|using images within your theme]]

==Appendix A==
===Theme options as of April 28th, 2010===
{| class="nicetable" id="theme_options_table"
|-
! Setting
! Effect
|-
| $THEME->'''csspostprocess'''
| Allows the user to provide the name of a function that all CSS should be passed to before being delivered.
|-
| $THEME->'''editor_sheets'''
| An array of stylesheets to include within the body of the editor.
|-
| $THEME->'''enable_dock'''
| If set to true the side dock is enabled for blocks
|-
| $THEME->'''hidefromselector'''
| Used to hide a theme from the theme selector (unless theme designer mode is on). Accepts true or false.
|-
| $THEME->'''filter_mediaplugin_colors'''
| Used to control the colours used in the small media player for the filters
|-
| $THEME->'''javascripts'''
| An array containing the names of JavaScript files located in /javascript/ to include in the theme. (gets included in the head)
|-
| $THEME->'''javascripts_footer'''
| As above but will be included in the page footer.
|-
| $THEME->'''larrow'''
| Overrides the left arrow image used throughout Moodle
|-
| $THEME->'''layouts'''
| An array setting the layouts for the theme
|-
| $THEME->'''name'''
| Name of the theme. Most likely the name of the directory in which this file resides.
|-
| $THEME->'''parents'''
| An array of themes to inherit from
|-
| $THEME->'''parents_exclude_javascripts'''
| An array of JavaScript files NOT to inherit from the themes parents
|-
| $THEME->'''parents_exclude_sheets'''
| An array of stylesheets not to inherit from the themes parents
|-
| $THEME->'''plugins_exclude_sheets'''
| An array of plugin sheets to ignore and not include.
|-
| $THEME->'''rarrow'''
| Overrides the right arrow image used throughout Moodle
|-
| $THEME->'''renderfactory'''
| Sets a custom render factory to use with the theme, used when working with custom renderers.
|-
| $THEME->'''resource_mp3player_colors'''
| Controls the colours for the MP3 player
|-
| $THEME->'''sheets'''
| An array of stylesheets to include for this theme. Should be located in the theme's style directory.
|}
===The different layouts as of March 29th, 2010===
{| class="nicetable" id="theme_layouts_table"
|-
! Layout
! Purpose
|-
| base
| Most backwards compatible layout without the blocks - this is the layout used by default.
|-
| standard
| Standard layout with blocks, this is recommended for most pages with general information.
|-
| course
| Main course page.
|-
| coursecategory
| Use for browsing through course categories.
|-
| incourse
| Default layout while browsing a course, typical for modules.
|-
| frontpage
| The site home page.
|-
| admin
| Administration pages and scripts.
|-
| mydashboard
| My dashboard page.
|-
| mypublic
| My public page.
|-
| login
| The login page.
|-
| popup
| Pages that appear in pop-up windows - no navigation, no blocks, no header.
|-
| frametop
| Used for legacy frame layouts only. No blocks and minimal footer.
|-
| embedded
| Embeded pages, like iframe/object embedded in moodleform - it needs as much space as possible
|-
| maintenance
| Used during upgrade and install. This must not have any blocks, and it is good idea if it does not have links to other places - for example there should not be a home link in the footer.
|}

==See also==
* [[Development:Themes 2.0 creating your first theme]] - A quick step by step guide to creating your first theme.
* [[Development:Themes 2.0 overriding a renderer]] - A tutorial on creating a custom renderer and changing the HTML Moodle produces.
* [[Development:Themes 2.0 How to use images within your theme]] - Explains how to use and override images within your theme.
* [[Development:Themes 2.0 adding a settings page]] - Looks at how to add a setting page making your theme easily customisable.
* [[Development:Styling_and_customising_the_dock]] - How to style and customise the dock.
* [[Development:Theme changes in 2.0]]
* [[Development:Using jQuery with Moodle 2.0]]