MoodleDocs - User contributions [en]

Question categories

2012-05-03T21:41:14Z

Rcollman: /* Question Sharing */ minor

{{Template:Managing questions}}
A question category can contain individual questions or other question categories. They can be found by using the [[Question bank]] or when [[Building Quiz|building a quiz]].

==What are question categories and how are they organized?==

[[Image:question-categories.png|thumb|300px|Question category as a folder]]
Imagine a question category as a folder that contains questions that are unique to that folder. You can put one or more question categories within another question category. This is similar to a file system on a computer. You can have the same file name, with identical content (an identical question) located in many folders, but each file (question) is unique. Like a file, when you edit one question in a folder, it does not change any other question.

Moodle 2.x introduced context levels. In short, each context level can have unique question categories and subcategories. However, the user's context determines which question categories they can see. Generally speaking, the System level context question categories can always be seen. A course level context question category can not be seen/used by another course. There are other context levels.

:''TIP:'' The robust potential for question organization deserves some planning. Fortunately, it is possible to move question categories between and in context levels, and move questions between question categories.

===Question Sharing===

You can share questions by placing them in a [[Context|context]] level question category. For example, placing a question category categories in the 'System' context is similar to publishing the question category so many teachers can potentially use it. Or for example, placing a question category in a Course category context level (say Math) will hide it from a course in a different course category (say Biology). See the [[Question contexts]] page for more information.

By default a course teacher cannot see or use any Question context above the course level.

:'''''Note:''''' In 2.x the "System" is the top context level. In previous versions of Moodle it was call the "Core System"

==Adding and managing question categories==
Settings > Question bank > Categories
The "Editing categories" page has two sections. The top is for managing existing categories, and the bottom is for adding categories.

===Adding categories===
To add a question category you will need to name it, place it within a context level (see [[Question contexts]]) and perhaps place it as a sub category of an existing category.
* At the bottom of the category page link, below current categories, you will see a form to add a new category.
* Choose the 'parent' context level with the pull down menu
** Placing your category in another category makes it a sub-category of the parent category.
** Choosing 'Top' in any of the context means that your category is a top level category, not a sub category of an existing category.
** Remember, your current context may hide question categories that exist, but are not available. For example, a question category that is in a course context level of a different course will be hidden.
* Type the name of your new question category in the text box.
* Add an optional description in the category info area.
* Click the 'Add Category' button. Your new question category will appear in the list of current categories.

===Moving question categories between context levels===
Settings > Question bank > Categories "Edit categories section".

*Select the edit icon of the category which you wish to move. This will bring you to the "Edit this category" form.
*Use the pull down menu to select the context level, as described in the adding categories section.
*Click "Save Changes"

===Using arrow icons for moving categories within a context level===
Settings > Question bank > Categories "Edit categories section"
You can also arrange the question categories with a context level (only) by using the arrow keys, instead of opening up the "Edit this category" form. The arrow keys effect is similar to working with an outline on a word processor.

* The up/down arrow icons change the order in which question category 'peers' are displayed within a single context level.
* The right arrow icon changes a category to be a sub category of the category listed immediately above it.
* The left arrow icon moves the sub category to be a peer of the category above it.

:''TIP:'' You can not use the arrow icons to move a question category between context levels. Thus you can not use an arrow icon to move a question category that is in the course context level to the system context level.

===Deleting Categories===
Categories can also be created or deleted at will. However, if you try to delete a category containing questions, then you will be asked to specify another category to move them to. You cannot delete or move the last category in any context, there must always be one category in a context.

==See also==
*[[Question contexts]]
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=47540 I can see other teacher's categories] forum discussion

[[fr:Catégories de questions]]
[[ru:Категории вопросов]]
[[de:Fragenkategorien]]

Question categories

2012-05-03T21:33:30Z

Rcollman: /* What are question categories? */ got rid of 1.9 stuff

{{Template:Managing questions}}
A question category can contain individual questions or other question categories. They can be found by using the [[Question bank]] or when [[Building Quiz|building a quiz]].

==What are question categories and how are they organized?==

[[Image:question-categories.png|thumb|300px|Question category as a folder]]
Imagine a question category as a folder that contains questions that are unique to that folder. You can put one or more question categories within another question category. This is similar to a file system on a computer. You can have the same file name, with identical content (an identical question) located in many folders, but each file (question) is unique. Like a file, when you edit one question in a folder, it does not change any other question.

Moodle 2.x introduced context levels. In short, each context level can have unique question categories and subcategories. However, the user's context determines which question categories they can see. Generally speaking, the System level context question categories can always be seen. A course level context question category can not be seen/used by another course. There are other context levels.

:''TIP:'' The robust potential for question organization deserves some planning. Fortunately, it is possible to move question categories between and in context levels, and move questions between question categories.

==Question Sharing==

You can share questions in several different [[Context|contexts]]. Sharing categories in the 'System' contex or 'Course' context has a similar effect to publishing the category so others can see them or hiding a question category from specific users. See the [[Question contexts]] page for more infromation.

By default a course teacher cannot see or use any Question context above the course level.

:'''''Note:''''' "Core System" and "System" refer to the same thing when we are describing or showing screen shots of question categories. "System" is the current term you will see in 2.x releases of Moodle.

==Adding and managing question categories==
Settings > Question bank > Categories
The "Editing categories" page has two sections. The top is for managing existing categories, and the bottom is for adding categories.

===Adding categories===
To add a question category you will need to name it, place it within a context level (see [[Question contexts]]) and perhaps place it as a sub category of an existing category.
* At the bottom of the category page link, below current categories, you will see a form to add a new category.
* Choose the 'parent' context level with the pull down menu
** Placing your category in another category makes it a sub-category of the parent category.
** Choosing 'Top' in any of the context means that your category is a top level category, not a sub category of an existing category.
** Remember, your current context may hide question categories that exist, but are not available. For example, a question category that is in a course context level of a different course will be hidden.
* Type the name of your new question category in the text box.
* Add an optional description in the category info area.
* Click the 'Add Category' button. Your new question category will appear in the list of current categories.

===Moving question categories between context levels===
Settings > Question bank > Categories "Edit categories section".

*Select the edit icon of the category which you wish to move. This will bring you to the "Edit this category" form.
*Use the pull down menu to select the context level, as described in the adding categories section.
*Click "Save Changes"

===Using arrow icons for moving categories within a context level===
Settings > Question bank > Categories "Edit categories section"
You can also arrange the question categories with a context level (only) by using the arrow keys, instead of opening up the "Edit this category" form. The arrow keys effect is similar to working with an outline on a word processor.

* The up/down arrow icons change the order in which question category 'peers' are displayed within a single context level.
* The right arrow icon changes a category to be a sub category of the category listed immediately above it.
* The left arrow icon moves the sub category to be a peer of the category above it.

:''TIP:'' You can not use the arrow icons to move a question category between context levels. Thus you can not use an arrow icon to move a question category that is in the course context level to the system context level.

===Deleting Categories===
Categories can also be created or deleted at will. However, if you try to delete a category containing questions, then you will be asked to specify another category to move them to. You cannot delete or move the last category in any context, there must always be one category in a context.

==See also==
*[[Question contexts]]
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=47540 I can see other teacher's categories] forum discussion

[[fr:Catégories de questions]]
[[ru:Категории вопросов]]
[[de:Fragenkategorien]]

Question categories

2012-05-03T21:05:25Z

Rcollman: /* Category Set Up and Management */ rewrote the way it works in 2.1.3 :) Deleted the image as not being helpful

{{Template:Managing questions}}
A question category can contain individual questions or other question categories. They can be found by using the [[Question bank]] or when [[Building Quiz|building a quiz]].

==What are question categories?==

[[Image:question-categories.png|thumb|300px|Question category as a folder]]
You can imagine a question category as a folder on your desktop computer. Then, questions are stored in these categories in a similar way as your files are stored in a file system.

Each category must have a name and you can include a short description of the category. You can create a ''category hierarchy''. For example, you can specify a parent category for each category or the 'Top' as the parent, when a category has no parent.

:''Tip:'' Creating question categories and sub categories is a good practice. It is better than keeping all your questions in one big list in the quiz module. The hierarchy feature enables you to separate categories into sub categories and sub categories into sub sub categories etc. indefinitely. Categories and sub categories, etc., are very powerful when combined with random questions that can select either from one category or from a category or any of its sub categories.

==Question Sharing==

You can share questions in several different [[Context|contexts]]. Sharing categories in the 'System' contex or 'Course' context has a similar effect to publishing the category so others can see them or hiding a question category from specific users. See the [[Question contexts]] page for more infromation.

By default a course teacher cannot see or use any Question context above the course level.

:'''''Note:''''' "Core System" and "System" refer to the same thing when we are describing or showing screen shots of question categories. "System" is the current term you will see in 2.x releases of Moodle.

==Adding and managing question categories==
Settings > Question bank > Categories
The "Editing categories" page has two sections. The top is for managing existing categories, and the bottom is for adding categories.

===Adding categories===
To add a question category you will need to name it, place it within a context level (see [[Question contexts]]) and perhaps place it as a sub category of an existing category.
* At the bottom of the category page link, below current categories, you will see a form to add a new category.
* Choose the 'parent' context level with the pull down menu
** Placing your category in another category makes it a sub-category of the parent category.
** Choosing 'Top' in any of the context means that your category is a top level category, not a sub category of an existing category.
** Remember, your current context may hide question categories that exist, but are not available. For example, a question category that is in a course context level of a different course will be hidden.
* Type the name of your new question category in the text box.
* Add an optional description in the category info area.
* Click the 'Add Category' button. Your new question category will appear in the list of current categories.

===Moving question categories between context levels===
Settings > Question bank > Categories "Edit categories section".

*Select the edit icon of the category which you wish to move. This will bring you to the "Edit this category" form.
*Use the pull down menu to select the context level, as described in the adding categories section.
*Click "Save Changes"

===Using arrow icons for moving categories within a context level===
Settings > Question bank > Categories "Edit categories section"
You can also arrange the question categories with a context level (only) by using the arrow keys, instead of opening up the "Edit this category" form. The arrow keys effect is similar to working with an outline on a word processor.

* The up/down arrow icons change the order in which question category 'peers' are displayed within a single context level.
* The right arrow icon changes a category to be a sub category of the category listed immediately above it.
* The left arrow icon moves the sub category to be a peer of the category above it.

:''TIP:'' You can not use the arrow icons to move a question category between context levels. Thus you can not use an arrow icon to move a question category that is in the course context level to the system context level.

===Deleting Categories===
Categories can also be created or deleted at will. However, if you try to delete a category containing questions, then you will be asked to specify another category to move them to. You cannot delete or move the last category in any context, there must always be one category in a context.

==See also==
*[[Question contexts]]
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=47540 I can see other teacher's categories] forum discussion

[[fr:Catégories de questions]]
[[ru:Категории вопросов]]
[[de:Fragenkategorien]]

Talk:Question categories

2012-05-03T20:26:24Z

Rcollman: Will make some changes

==Using Arrow Icons for Moving Categories==
Moving categories does not exactly work this way.

You can not move categories between the contextual levels (System, course category, course, activity) with the arrow icons. You have to edit the category and change the parent level with the drop down box.

However, you can use the arrow icons within a context level to make a category a sub category of another, or to move a category out of being a sub category of the category directly above it.

The word hierarchy is confusing because it applies both to the contextual levels and category/sub-category relationships.

Will work on it :) Maybe images would help. --[[User:chris collman|chris collman]] 04:26, 4 May 2012 (WST)

Cron

2012-04-30T16:51:00Z

Rcollman: minor

{{Installing Moodle}}
The Moodle 'cron' process is a script that is usually triggered by a web server program. The Moodle cron script runs different tasks at differently scheduled intervals.

'''IMPORTANT: Do not skip setting up the cron process on your server for your Moodle. Your site will not work properly without it'''

A cron web server program is programmed to run the Moodle cron script at a regular interval. The Moodle cron script determines which tasks need to be completed. For example these tasks include sending mail, updating Moodle reports, RSS feeds, activity completions, posting forum messages and other tasks. Since different tasks have different schedules, not every task will run in Moodle when the cron script is triggered.

On so

== Setting up cron on your system ==

Choose the information for your server type:

*[[Cron with Unix or Linux]]- Cron services on various UNIX and Linux flavored operating systems.
*[[Cron with Windows OS]] - Cron services in Windows
*''Apple OSX'' - use the built-in 'crontab' service which is exactly the same as [[Cron with Unix or Linux]]. However, you might want to do it the 'Apple way' using launchd - see [[Cron with MAC OS X]]
*[[Cron with web hosting services]]- Cron services in various web hosting examples.

=== Cron settings in Moodle ===

There are settings within Moodle that control aspects of cron operation:

*[[Cron settings]] - Moodle cron process password and CLI settings

== Setting up cron on your system ==

Choose the information for your server type:

*[[Cron with Unix or Linux]]- Cron services on various UNIX and Linux flavored operating systems.
*[[Cron with Windows OS]] - Cron services in Windows
*''Apple OSX'' - use the built-in 'crontab' service which is exactly the same as [[Cron with Unix or Linux]]. However, you might want to do it the 'Apple way' using launchd - see [[Cron with MAC OS X]]
*[[Cron with web hosting services]]- Cron services in various web hosting examples.

=== Cron settings in Moodle ===

There are settings within Moodle that control aspects of cron operation:

*[[Cron settings]] - Moodle cron process password and CLI settings

===Remote cron===
Using the 'web based' version of cron it is perfectly ok to place the cron process on a different machine to the Moodle server. For example, the cron service on a Unix server can invoke the cron web 'page' on a Windows based Moodle server.

==See also==
Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=41827 Cron - can someone give me a quick confirmation of function?]
*[http://moodle.org/mod/forum/discuss.php?d=97684 Cronjob Question]
*[http://moodle.org/mod/forum/discuss.php?d=97457 Slow cron : avoiding simultaneous cron]
*[http://moodle.org/mod/forum/discuss.php?d=117168 Visibility of cron.php]
*[http://moodle.org/mod/forum/discuss.php?d=139263#p609060 How to log the output of a Scheduled Task on Windows] - this discussion explains a nice trick that can be very useful when you are experiencing problems with your Windows Scheduled Task and you need to log the output of the Scheduled Task to a log file.

[[es:Cron]]
[[fr:Cron]]
[[nl:Cron]]
[[sk:Cron]]
[[pl:Cron]]
[[ja:Cron]]

Cron

2012-04-30T16:14:37Z

Rcollman: update intro

{{Installing Moodle}}
The Moodle 'cron' process is a script that runs in the background different tasks at scheduled intervals. In Moodle, these scheduled tasks include sending mail, updating course or activity completions, posting forum messages or other tasks. Cron is a server operating system program, which needs to be told to trigger the Moodle cron scripts.

'''IMPORTANT: Do not skip setting up the cron process on your server for your Moodle. Your site will not work properly without it'''

On some Moodle sites it is possible to trigger the Moodle cron script by running yourmoodle/admin/cron.php in the address bar of a web browser.

== Setting up cron on your system ==

Choose the information for your server type:

*[[Cron with Unix or Linux]]- Cron services on various UNIX and Linux flavored operating systems.
*[[Cron with Windows OS]] - Cron services in Windows
*''Apple OSX'' - use the built-in 'crontab' service which is exactly the same as [[Cron with Unix or Linux]]. However, you might want to do it the 'Apple way' using launchd - see [[Cron with MAC OS X]]
*[[Cron with web hosting services]]- Cron services in various web hosting examples.

=== Cron settings in Moodle ===

There are settings within Moodle that control aspects of cron operation:

*[[Cron settings]] - Moodle cron process password and CLI settings

== Setting up cron on your system ==

Choose the information for your server type:

*[[Cron with Unix or Linux]]- Cron services on various UNIX and Linux flavored operating systems.
*[[Cron with Windows OS]] - Cron services in Windows
*''Apple OSX'' - use the built-in 'crontab' service which is exactly the same as [[Cron with Unix or Linux]]. However, you might want to do it the 'Apple way' using launchd - see [[Cron with MAC OS X]]
*[[Cron with web hosting services]]- Cron services in various web hosting examples.

=== Cron settings in Moodle ===

There are settings within Moodle that control aspects of cron operation:

*[[Cron settings]] - Moodle cron process password and CLI settings

===Remote cron===
Using the 'web based' version of cron it is perfectly ok to place the cron process on a different machine to the Moodle server. For example, the cron service on a Unix server can invoke the cron web 'page' on a Windows based Moodle server.

==See also==
Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=41827 Cron - can someone give me a quick confirmation of function?]
*[http://moodle.org/mod/forum/discuss.php?d=97684 Cronjob Question]
*[http://moodle.org/mod/forum/discuss.php?d=97457 Slow cron : avoiding simultaneous cron]
*[http://moodle.org/mod/forum/discuss.php?d=117168 Visibility of cron.php]
*[http://moodle.org/mod/forum/discuss.php?d=139263#p609060 How to log the output of a Scheduled Task on Windows] - this discussion explains a nice trick that can be very useful when you are experiencing problems with your Windows Scheduled Task and you need to log the output of the Scheduled Task to a log file.

[[es:Cron]]
[[fr:Cron]]
[[nl:Cron]]
[[sk:Cron]]
[[pl:Cron]]
[[ja:Cron]]

Lesson FAQ

2012-04-22T21:43:32Z

Rcollman: /* Import PowerPoint does not work */ add link to new page

{{Lesson}}
==What's a Branch Table?==
Older versions of Moodle called Lesson module Content pages "Branch tables".

==Import PowerPoint does not work==
"No data" or some other error shows up after an attempt to import.
*Please read [[Import PowerPoint]]. Most common causes:
#Complicated PowerPoint. Too many images, text boxes or fancy features.
#Wrong version of PowerPoint
#Site error - try the tested zip file at [http://tracker.moodle.org/browse/MDL-15755 Tracker.Moodle.org]
*For some other alternatives see [[Inserting_content_into_a_lesson_activity]]

==Jumps not working in a question==
A wrong answer should go to "this page" in my lesson. But after the student answers it, the student goes to the next page.
*See adding/editing a lesson and Maximum Attempts in Lesson settings. If maximum attempt is set to 1, then the student will be advanced to the next page after they choice a wrong answer that is sent to "this page". If it is set to 2, after the student selects the wrong answer the 2nd time they will be sent to the next page. This can be used to keep the student out of an endless loop when than can not answer a question correctly.

==Edits of answers or branch buttons are not saved==
I have a 4 answer multiple choice question. I can only seem to save the first two answers, their jumps and feedback. Any edits on the last answers, their jumps and feedbacks are not saved. Moodle does not tell me there is anything wrong. Same thing happened with a Content page. I can not seem to get the last two descriptions change after I save an edit. GRRRRR!

*Go back to your lesson settings. Maximum number of answers is probably set to 2; change it to 4 or the maximum number of answers or descriptions in your lesson. Now the edits can be saved.
::''Tip:'' Changing the "Maximum number" as a teacher builds a lesson is a trick used to limit scrolling passed unused answers or branch choices to get to the save button. For example, 15 pages have 4 choices but one page will have 8 choices. The teacher will use "Maximum number" at 8 setting only when they initially create that page, then switch it back to 4. They (and their students) will always see all 8 answers but the lesson setting will prevent them from editing some of them.

==What is a Branch ?==
Many Moodlers call a series of pages in their lesson "'''a branch'''". Usually the student will enter the series by jumping from a page that is not directly before the "branch". Thus, a student will "branch" off the lesson path from a missed question and visit a series of pages for review before they are returned to the main lesson path again.

Lesson also have special pages that create a [[Lesson clusters|cluster]]. These are also a series of page.

Confused yet? :) Maybe [[Branch structures]] will help.

==Multiple Choice and Multianswer issues==
When I check the multianswer box in a multiple choice question, it does not work. It makes random jumps and does not put the teacher's response with the students choice.

*In a Lesson module [[Lesson_module#Multiple_choice|multianswer question]], all the correct choices must have the same jump and teacher response. All the wrong choices must also have the same jump and teacher response.

==Are there some examples of Lessons I can see?==
I have been to demo.moodle and looked at the [http://demo.moodle.org/mod/lesson/view.php?id=224 Lesson section], are there more examples of Lessons used in a real course?
*[[Lesson samples]] is one place to look.

==The lesson was completed but it does not record it==
*Every lesson must have one question that a student must answer in order for it to show up in some reports. This can affect [[Grades]] and a Lesson's dependency setting (see other FAQs below).
::''Tip:'' There are lots of creative ways to put in a question, such as setting a multiple choice question so that all answers are correct and the answers act like a content page. Or put in content and then award 1 point for "next page" as the answer and do not include the score in grades.
::''Tip:'' Due to a specific Lesson's design, some students can complete the lesson without answering one or more questions which have been placed in the Lesson. When Lesson can not record any scores for a student, no grade is pushed to the gradebook. It may appear therefore that Lesson is being inconsistent in recording grades.

==Dependency in Lesson does not work==
The second lesson tells the student they must complete the first one. They did, what is wrong?
*For dependency to work, you need to have at least 1 question page in the lesson. The student may not need a minimum score, but Lesson needs to know that the student tried a question. You can always put a question as the first or last page, You don't need to ask a question but do put in an answer of "continue" with a jump of the next page.

*Also for dependency to work, the lesson can not be a practice lesson.

==How to add sound to a lesson page==
*[[Audio in Moodle]] has an overview and tool recommendations.

==Can I turn off the answer shuffle in a lesson?==
* In short, no. Turning off the page and answer shuffle are Quiz options, but neither is found in Lesson. A minor hack to the Lesson code is possible but that would impact the entire Moodle site.
::''TIP:'' If you don't need to score students answers in a question, then consider using a Content page instead of a Multiple Choice or a True/False question.

==Can I change standard words used by Lesson?==
*Yes. You or your site administrator can edit the language file called Lesson.php. This will impact the whole site. Your site administrator might create a language just for you and then in Lesson settings use the force language option.

==Grrr something happened -lesson list is not right - I can't move things==
Try a backup and restore of your course to solve some of those "quirky" issues.
*Example: I was building a course, started adding lessons to topic 2 and then realized I should move it up to become Topic 1. Did that and continue to add lessons to topic 1, then lessons to topic 2 etc. Later I had to add lessons to topic 1. I did but could not move them between those first lessons I created. Every time I tried to move them they went to the bottom of topic 2! I also noticed that my list of just lessons, showed those first lessons as being in the correct course display order but showed they were in Topic 2!.
*Moral: Sometimes a backup and a restore will re-establish harmony and fix things.

==What happened to my HTML code on a Lesson page?==
I had the lesson page formatted just the way I wanted by using the HTML source toggle on the tool bar. I went back in to tweak my code and some of my code was missing!
*Lesson will "clean" up your HTML code every time you toggle into HTML text. This can be frustrating, especially if you are trying to get a flash file to display just right. Save you work in a text editor, so the next time you tweak it, you can paste all your code back in.

==Pages are not displayed in the lesson's left menu==
The Lesson module's left menu navigation feature, only displays content (branch table) pages. If your lesson only has question pages, it will not display any pages. Use a content page before a series of question pages, so your students will know where the series starts. Alternative, use the same content page and put links to each of the question using descriptions and jumps. Remember, you can effectively have the student jump past (not view) this content page as they go through the lesson and only reach it via the left menu.

==Students are not returning to where they left the lesson==
A student has left the lesson after looking at 10 pages. The next time they return to the lesson they start at the beginning again. How can the student return to the same place?
:You have seen more than one page of this lesson already. Do you want to start at the last page you saw?

Several things must be met before this will happen. First make sure your lesson settings allow the student to retake the lesson and that this lesson is not a "practice" lesson. The important thing is that the above words are not exactly correct. They are correct only when the student left immediately after answering a question in a Lesson. For the purposes of returning to the same place, Lesson only remembers question pages as benchmarks. So lastly, make sure you have questions scattered in your Lesson for this feature to work and tell students.

:''TIPs:'' Use a content page at the start of the lesson as a table of contents, so the student are forced to remember where they are but can jump to your teaching points. Or put a question at the start or end of every "teaching point". And of course, you can tell your students how it is going to work.

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?f=333 Lesson module forum]

[[Category:FAQ]]
[[de:Lektion_FAQ]]

Import PowerPoint

2012-04-22T21:42:45Z

Rcollman: /* See also */ add link to new page

{{Lesson}}

This page deals with the option to import a Powerpoint 2003 file into Moodle's [[Lesson]] module. If you simply wish to display a Powerpoint in your course, then see [[File]]

==Importing a Powerpoint presentation - Why and Why not==
If you have a Powerpoint 2003 presentation already made, you can - with many limitations- import it into your Moodle Lesson to save recreating each slide from scratch. However; the method outlined below is not really recommended. It will not bring
complex elements such as background images, multiple text boxes and multiple images on a page. It is not a particularly successful way of creating lessons, and '''does not work with later versions of Powerpoint''' There is a tracker entry MDL-21801 requesting that Import Powerpoint be removed from the Lesson module because it does not work properly.

=== Powerpoint 2003 Instructions===
#Create your MS Powerpoint 2003 presentation.
#*In the "File" menu click on "Save as Webpage"
#*Change or note "Save In" setting location and name
#**''The Save "file type" should be "Web Page"''
#*Click on "Save"
#**''This will create a file and a folder. The HTML file has links to files in the new folder of the same name as the HTML file. ''
#Using Windows Explorer or your favorite program
#*Zip the new folder that contains the webpage files ***NB - DO NOT INCLUDE THE HTML FILE OR THE IMPORT WILL FAIL***
#**''This is the file you will import into a new lesson. ''

===Moodle instructions===
After you have created the zip file above
*Add a new Lesson activity to a course; set the setting; save the settings.
**''This will bring you to a screen with several choices''
*Select "Import PowerPoint"
*Use the browse button to select the zipped file that contains the webpage folder
*Select "Continue"
*Start editing the Content pages

===Basic tips===
# Keep it simple: text only is best
#* No page numbers (see masterslide)
#* No text boxes with graphic or filled backgrounds
#* Masterslide content will not import, but delete all the footers
#* Watermarks and text over graphics is probably not a good idea
#* It will import some bullet formats but not all
#* It probably does not like "special characters" (any non-english letters)
# Graphic images can be imported as a part of the presentation but
#* Graphic images will have to be moved in the Lesson page
#* More than one graphic image might not always import to a Lesson page

==An alternative method of importing presentation pages==
It is possible to save presentation slides as images by selecting an image file type such as .png from the ''save as...'' drop down menu in either Powerpoint or Open/Libre Office. These images can then be embedded into individual content pages of a lesson. As with the previous Powerpoint 2003 option however; this is only suitable for plain text and images. Animations/transitions will not work and care also must be taken regarding the dimensions and loading time of the images in each content page.

==See also==

* MDL-17413 to vote for an improvement to insert (by importing) a series of pictures or a series of text pages into a series of lesson branch pages at any point in the lesson. (Like a series of questions).
*[[Inserting_content_into_a_lesson_activity]]

[[Category:Teacher]]
[[Category:Lesson]]
[[fr:Importer un fichier PowerPoint]]
[[de:PowerPoint importieren]]

Inserting content into a lesson activity

2012-04-22T21:41:38Z

Rcollman: copied content of 2.2

A common question. "We have many course documents in Word and PDF format at the moment. We ant to put them in a lesson, where 1 chapter would be 1 lesson. Is there anyway to easily do this and retain the formatting, esp around screenshots with arrows and description around them?"

*The only import option is powerpoint (and if you are using Moodle version 1.9 or below this basically doesn't work anyway).
*Create some image files of your pdf or word document converted to pdf.
*Create some image files of your PowerPoint and insert those
*Reference the PDF for a lesson by the "pop to file or web page" option
*Convert your pdf files a movie files
*Do not have lessons, use a word or pdf file as a resource, use conditional activities to link it to a quiz that is loaded with feedback to each question

==Creating manageable PDFs==
PDF files can be split into chapters. There are free "pdf splitter" utilities that will do this. Google "pdf splitter" and you'll find a bunch. In your situation, you might want to attach the chapter as a resource in this form. You can also, obviously split the PDF more granularly (if that's a word?) than chapter, and some of the utilities probably have a feature to automatically split all the pages.

The quality of the resulting small PDFs is usually higher than the same PDF exported as an image. Your PDF can be referenced by the lesson in the "pop-to file or web page" option, or as a URL - you obviously need to host the PDF on your Moodle site.

==Copy and pasting Word into Moodle==
Word does add hidden formatting to be copied when it is pasted into Moodle directly. There are solutions.

Start by using Word's "File> Save As > Filtered HTML" option. This had different names in different versions of Word, but basically gets rid of a lot of the Word-specific junk. This does a fair job in the context of Moodle.

Next you could run a utility on this to make it better. For some free tools search for "clean word html" on the web. The "granddaddy" of these tools is HTMLTidy.

At this point you have a really good html document as your source.

*Use the "popup to file or web page" for the lesson to reference that "chapter" (IOW host the HTML you created; see next point).
*Add the file as a URL resource if you host what you have created (NB: do *not* forget the folder of images that is created in tandem with the HTML file)
*Copy and paste into the Moodle editor after opening the cleaned HTML in Word or browser
:Tip: you will probably have to reload the images

==See also==
*{http://moodle.org/mod/forum/discuss.php?d=200976 Lesson forum thread] which had these ideas
*[http://www.rogerobeid.com/2011/02/24/clean-up-microsoft-word-html/ Here's a nice little blog post] on using HTMLTidy options to deal with Word

CSS

2011-11-29T15:27:21Z

Rcollman: Provided links to moved information in devDocs and elsewhere

CSS stands for Cascading Style Sheets. CSS supplements HTML code and is used in Moodle themes. Moodle developers define and edit the standard CSS codes. Those who wish to learn more about these codes should visit:

*<b>[https://docs.moodle.org/dev/CSS CSS documentation in devDocs]</b>

==See also==
* [https://docs.moodle.org/dev/CSS_FAQ CSS FAQ]
* [[Themes|Themes]]
* [[Themes FAQ]]
* [https://docs.moodle.org/dev/CSS_styles_ layout.css CSS_styles_ layout.css] contains the layout specifications for various page elements.
* [https://docs.moodle.org/dev/CSS_styles_color.css CSS_styles_color.css] contains the colors used in the page elements.
* [https://docs.moodle.org/dev/CSS_styles_fonts.css CSS_styles_fonts.css]] defines the fonts used in the page elements.
* [https://docs.moodle.org/dev/CSS styles moz.css CSS styles moz.css]
* [http://en.wikipedia.org/wiki/Cascading_Style_Sheets Wikipedia Cascading Style Sheets]
* [http://www.w3schools.com/css/default.asp W3schools]

Certificate customizing

2011-11-27T15:26:08Z

Rcollman: /* Adding a New Line of Text */ add a second page, will check this out later. Thanks to J-M !

{{Certificate}}
[[Certificate module|Certificate]] is a contributed module and it can be customized.

Often customization can be accomplished by adding images to one of the /mod/certificate/pix folders, so they will appear as an option in the certificate settings page. Additionally, you can change the language strings located in /mod/certificate/lang.

:''In November 2011 the Certificate "Type" php code has been modified for Moodle 2.x. These code changes will impact string and image positions in the generated pdf document. Please see the "[[#Nov 2011 changes]]" section below.''

==Certificate examples==
<gallery caption="Certificate examples - click on any to enlarge" widths="200px" heights="100px" perrow="6">
Image:Certificate 1.gif|Fancy border, signature line, seal, code
Image:Certificate199 example lines.png|Lines, signature, seal, watermark, code, grade, outcomes, custom text
Image:Certificate199 example creative.png|New border, new signature, new seal, new watermark, code, outcome
</gallery>

==Customizing==
The certificate code is located in the /mod/certificate folder. There are sub-folders for backup, db, lang (holds language sub-folders), pix (holds sub-folders for borders, seals, signatures and watermarks) and type (holds standard certificate types, each in their own sub-folder).

===Adding images===
[[Image:Certificate199 example creative.png|thumb|Creative customized example]] The easiest way to customize your certificate is to add your own JPG or PNG images. Place these in the appropriate mod/certificate/pix folder on your site. The added JPG or PNG image will appear in the dropdown list by its file name.

Make sure your new files are the same size as the standard images. For example, the standard signature file is 150x31 pixels. If the signature file is a different size, you may need to modify the code line. The same will be true for seals, borders and watermarks.

In the creative example, a custom border, watermark, signature and seal were added to the right folders. All were sized and in the same file format as the one supplied with the initial certificate install.

===Customize format===
It is a good idea to create your own custom certificate type, that will appear on a list along with the standard certificates types. You will know which is your custom certificate type and it will survive when you upgrade. Here is how:

1. Choose the certificate/type folder with the size/orientation you desire, copy and paste it in the certificate/type folder and give the copied folder a new name. For example copy the /type/letter_non_embedded folder and rename it 'mycertificate'.

2. Open the certificate/lang/en/certificate.php file and add the name of your new folder type. Following the above example, you would add:

:$string['typemycertificate'] = 'My New Certificate';

Now, when you add a certificate to a course, your new type will appear on the drop down list as "My New Certificate".

:''Tip:'' You should add the proper string as shown in step 2 above or you may receive an error message and it will appear as if the code is broken. And remember if you update your certificate module that this file maybe erased with a new version.

====Modifying image position code example====
We will change the signature position that is found in the type/letter_non_embedded/certificate.php file when we generate a pdf in landscape mode. There are at least 2 ways to change the code. Say we want to move it to the left at 100 and up to 435 line.
*Around line 100 you should notice there are a set of variables for "Landscape" which are followed by another set for "Portrait". We can overrule some of the landscape and portrait codes the $sigx and $sigy position variables, so they read $sigx = 100 and $sigy = 435 .
*Alternatively, we can overrule some of the landscape and portrait codes, in this case the signature block. Around line 145 we see the code that actually prints in the correct position:
:print_signature($pdf, $certificate, $sigx, $sigy, '', '');
By changing the variables to fix numbers it will not matter if the teacher selects landscape or portrait. For example:
:print_signature($pdf, $certificate, 100, 435, '', '');

If others have not added a standard signature line, you might want to fix it to a certain size. For example, you want the image to print 150px by 75px.

:print_signature($pdf, $certificate, $sigx, $sigy, '150', '75');

This should give you a good idea about how to change the position of other images.
:''Tip:'' Call your custom folder "a_landscape_special". Now you can use the second method and nobody should be surprised if they can read and been trained properly.

====Adjusting transparency of an image====
It is possible to put in a strong image as a watermark and adjust the transparency setting when the PDF is created. Look for the SetAlpha code in front of a print element. For example infront of the "print_watermark.." line, you will see $pdf_SetAlpha(0.1); It is currently set to .1, a .5 would be less transparent.

:''Tip:'' In older version of certificate, the watermark image itself was dimmed before it was placed in the folder. If you had a custom watermark, this is the way it was done. You can change the SetAlpha in the code to 1 and it should appear as it did in previous version of certificate.

===Changing printed text===
There are two ways to change the language strings. A best practice is to customize your language pack via site administration. You will find the certificate.php in the mod group. If you use the method below, when you update all your certificate files, then your changes will not be saved.

You can edit the language file found in the certificate folder, such as certificate/lang/en/certificate.php if you are not worried about losing you changes. Lets say you want to change the words at the top of all certificates on your site.

Find the default strings:
:$string['title'] = 'CERTIFICATE OF ACHIEVEMENT';
:$string['intro'] = 'This is to certify that';
:$string['statement'] = 'has completed the course';

Change them to read (for example):
:$string['title'] = 'DIP0LOMA';
:$string['intro'] = 'I am proud to state that';
:$string['statement'] = 'has successfully passed the final exam';

===Adding a New Line of Text===
You have created a couple of custom certificate types. In these certificates you want some new words to appear. There are basically 2 choices, you can have it look up a new string, or hard code the words in the certificate type instead of looking for a string.

*Add new string method.
**Open the certificate/lang/en/certificate.php file and add your new string giving it a unique name.
:$string['mynewtext'] = 'This is what I want to print on the certificate';

**Open the file for your certificate type and change the string reference. For example, go to certificate/type/mycertificate/certificate.php. Near the end of the file find "// Add Text". This is the area that prints--you guessed it--text on the certificate. Find the current line below which you would like your new text to be printed. For example, if you want your text to print below the course name, find the line:

:cert_printtext($pdf, $x, $y, 'C', 'Helvetica', '', 30, get_string('title', 'certificate'));

3. Add a new line below that to print your new text using the name you gave your new lang string like this:
:cert_printtext($pdf, $x, $y+25, 'C', 'Helvetica', 'B', 10, $mynewtext);

Quick review. We want the string mynewtext to start on the $x position from the left, on the $y+25 line, and the line should be center aligned (C, L, R or ' '), in Helvetica type, in bold, with a font size of 10.

5. You can add a hard coded line of text. For example, add signature title block line under the signature image:
:cert_printtext($pdf, $sigx, $sigy+30,'', 'Helvetica', 'B', 10, 'Martin Dougiamas, Lead Developer');

===Adding a second page===
After you have created your first page (or copied an existing page), add this bit of code:

$pdf->AddPage();

Then you in the code for the second page. You can create a certificate with as many pages as you want.

==Nov 2011 changes==
[https://github.com/PukunuiAustralia/moodle-mod_certificate PukunuiAustralia / moodle-mod_certificate] version 2011110107 is the basis for these comments. There maybe earlier versions which are different.
*Standard types of certificates. There are 4 standard certificate types based upon paper size and if the fonts are embedded or non-embedded in the pdf documents. The orientation of landscape or portrait is located within each of these types. This is different from the 1.9.x versions.
*The code for printing strings has changed. While similar to the pre 2.0, be careful.

==Tips & Tricks==
*Start with one of the existing certificate types, copy it and modify it.
*Try your customized code on a non production site, such as a local host.
*In Administration>>Server set debugging to maximum (to show any coding error messages).
*While you can leave a php file open in edit mode, you must save the file before your changes become active.
*Make code changes one at a time, test and then backup after each successful change. For example,after adding a new string to the certificate lang file), go to your course page and click on a certificate to see if it appears on the list.
*If you broke the code you may get a blank screen for a certificate.
**So it might be a good idea to make a backup of each successful change before starting the next change. For example, after the 3rd code change, save certificate.php as certificate3.txt.
*Certificate icon location-If you are using your own theme you have to put the icon.gif inside a folder called certificate and put in your mod folder image. For example, if your theme uses custom icons, you must put a certificate folder with the certificate icon.gif in it under your theme/pix/mod folder.
*Consider editing you language pack rather than the /certificate/lang/en/certificate.php file. You can do this through the Settings > Site administration >Language > Language customization menu. Look for mod/certificate.php. Then when you update your certificate and it's language,it will keep your changes for the standard strings.

==See also==
* [[mod/certificate/mod|Add/Edit Certificate]]
* [[mod/certificate/view|Viewing a Certificate]]
* Moodle 2.x and later versions of certificate can be found at [https://github.com/PukunuiAustralia/moodle-mod_certificate PukunuiAustralia / moodle-mod_certificate].

About Moodle

2011-11-23T20:39:52Z

Rcollman: Reverted edits by Nataliaposadaseverino (talk) to last revision by Tsala

{{Main page}}
'''[[Moodle]]''' is a [http://download.moodle.org/ software package] for producing Internet-based courses and web sites. It is a global development project designed to support a [[Philosophy|social constructionist]] framework of education.

Moodle is provided freely as [http://opensource.org/docs/osd Open Source] software (under the [http://www.gnu.org/copyleft/gpl.html GNU Public License]). Basically this means Moodle is copyrighted, but that you have additional freedoms. You are allowed to copy, use and modify Moodle provided that you agree to: '''provide the source to others; not modify or remove the original license and copyrights''', and '''apply this same license to any derivative work'''. Read the [[:dev:License|full license]] for details and please contact the [http://moodle.com/helpdesk copyright holder via the Moodle.com helpdesk] if you have any questions.

Moodle can be [[Installing Moodle|installed]] on any computer that can run PHP, and can support an SQL type database (for example MySQL). It can be run on [[Complete_install_packages|Windows and Mac]] operating systems and many flavors of linux (for example [[RedHat Linux installation| Red Hat]] or [[Debian GNU/Linux installation|Debian GNU]]). There are many '''knowledgeable''' [http://moodle.com/partners/ Moodle Partners] to assist you, even [http://moodle.com/hosting/ host your Moodle site].

The word Moodle was originally an acronym for Modular Object-Oriented Dynamic Learning Environment, which is mostly useful to programmers and education theorists. It's also a verb that describes the process of lazily meandering through something, doing things as it occurs to you to do them, an enjoyable tinkering that often leads to insight and creativity. As such it applies both to the way Moodle was developed, and to the way a student or teacher might approach studying or teaching an online course. Anyone who uses Moodle is a Moodler.

Come [http://moodle.org/community/ moodle with us]!

*[[Philosophy]]
*[[Pedagogy]]
*[[Moodle site - basic structure]]
*[[Moodle key terms]]

[[Category:About Moodle]]

[[ca:Quant al Moodle]]
[[es:Acerca de Moodle]]
[[eu:Moodle-ri buruz]]
[[fr:À propos de Moodle]]
[[nl:Over Moodle]]
[[de:Was ist Moodle?]]
[[hr:O_Moodle_rješenju]]
[[ja:Moodleとは]]
[[pt:Sobre o Moodle]]
[[zh:关于Moodle]]
[[ru:О Moodle]]
[[ko:무들에 대하여]]

Talk:Cron

2011-11-23T20:38:38Z

Rcollman: Go Howard, Go :)

Upload users

2011-11-22T13:28:55Z

Rcollman: /* Hints */ list of all valid fields

{{Accounts}}
An administrator can upload multiple user accounts via text file in ''Settings > Site administration > Users > Accounts > Upload users''.

There are many robust options for uploading information (fields associated with a user) with this method: from enrolling users in multiple courses with course specific [[Roles|roles]] to updating user information in the [[User profile]] to deleting users from the site.

''Tip:'' It is usually not necessary to upload users in bulk with Upload users. To keep maintenance work down you should first explore forms of authentication that do not require manual maintenance, such as [[External database authentication|connecting to existing external databases]] or letting the users create their own accounts ([[Self enrolment]]). See [[Authentication]] for more information.

[[File:Upload users initial 2.0.JPG|thumb|center|Initial upload users screen 2.1]]

==Upload user process==
Here is an outline of the process:

# Create file for uploading
# Go to ''Settings > Site administration > Users > Accounts > Upload users''
# Add file to upload
# Upload users preview - check settings and default user profile settings
# Upload users preview - click "Upload users"
# Upload users results - shows list of users, exceptions made in upload and summary of number of users
# Upload users results - click "Continue"
# Returns to Upload users screen

==Updating users preview==
There are settings for the kind of Upload user function you want to perform on the "Upload users preview" page.
[[File:Upload users preview 2.0.JPG|thumb|center|Upload users preview in Moodle 2.x]]

===Updating existing accounts===

By default Moodle adds new user accounts and skips existing users lines where the <code>username</code> matches an existing account. Set "Upload Type" to '''Add new and update existing users''', and existing user account will be updated.
*Add all, append number to usernames if needed
*Add new and update existing users
*Update existing users only
There are also fields settings to force password change, allow renames, allow deletes, prevent email address duplicates, standardise usernames and select for bulk operations(new users. updated users, all users).

'''Warning''': errors updating existing accounts can affect your users badly. Be careful when using the options to update.

===Set default user values===

You may be able to set default user field values, if the fields were not included in the uploaded file on this page.

==Upload user results ==
After accepting the preview settings by clicking on "Upload users", you should see the the Upload users results screen.
[[File:Upload users results 2.0.JPG|thumb|center|The 2.0 results screen, everything went well]]
This screen will show you any exceptions or changes that were made to each user in the upload process. For example if you were updating user information, the updated information will be shown. Or if a user was not added that record will be highlighted.

The screen will summarize how many users were uploaded or updated, indicate the number of week passwords and the number of errors.

==File formats for upload users file==
The upload files have their fields separated by a comma (or other delimiter). The first line contains the valid field names. The rest of the lines (records) contain information about each user.

'':Tip:'' If you are not an expert, avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload. Remember there are other ways to authenticate users on you site or enroll users in a course.

'':Tip:'' You can use a spread sheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can be opened with simple text editors for verification.

===Valid upload file for testing===
Here is an example of a simple valid upload file:

<code>username, password, firstname, lastname, email, course1, group1<br />
jonest, verysecret, Tom, Jones, jonest@someplace.edu, math102, Section 1<br />
reznort, somesecret, Trent, Reznor, reznort@someplace.edu, math102, Section 3</code>

===Fields that can be included===
'':Tip:'' We strongly recommend that you test a file that contains fields you proposed to use with one user before attempting a file upload for the first time. demo.moodle.net might be a good place to see if your test file works.

*'''Required fields''':
:<p><code>username, firstname, lastname, email</code>
:Validity checks are performed for:
#<code>username</code> can only contain alphabetical '''lowercase''' letters , numbers, hypen '-', underscore '_', period '.', or at-sign '@'
#<code>email</code> is in the form: ''name@example.com'' .</p>

*'''Password field''': "password" field is optional if "Create password if needed" setting is chosen (default).
**If included, values should meet the requirements for the site's [[Site_policies#Password_policy|Password policy]]. To force password change for a particular user, set the password field to <code>changeme</code>.
**If omitted, a password will be generated for each user (during the next Cron job) and welcome e-mails sent out (not working in v2.0.2?).

*'''Optional fields''': To provide values other than the default include one or more of these
:<p><code>institution, department, city, country, lang, auth, ajax, timezone, idnumber, icq, phone1, phone2, address, url, description, mailformat, maildisplay, htmleditor, autosubscribe</code></p>
*Country- use a country TWO LETTER CODE
*Some fields have a maximum number of characters that are allow. See hints below.
*Maildisplay, htmleditor and autosubscribe can be set from an import screen in Moodle 2.0.

*'''Custom profile field names''': (Optional). xxxxx is the real custom user profile field name (i.e. the unique shortname)
:<p><code>profile_field_xxxxx</code></p>
: Create the custom fields BEFORE importing. Use the standard header. The "shortname" for your custom field is xxxxx (NB: as at v2.0.2, the shortname must be all lowercase, otherwise won't be recognised). The first record must include "profile_field_xxxxx".
:'''Example''': To create a custom field "genre", you must write a shortname "genre" in the new field, and write "profile_field_genre" in the header of the .csv file.

*'''Special fields''': Used for changing of usernames or deleting of users
:<p><code>oldusername</code>, <code>deleted</code></p>

*'''Enrolment fields''': (Optional):
:<p><code>course1, type1, role1, group1, enrolperiod1, course2, type2, role2, group2, enrolperiod2</code> etc.
**<code>course</code> is the "shortname" of the course, if present the user will be enrolled in those courses.
** <code>type</code> refers to the role to be used for associated course enrolment. Value 1 is default course role, 2 is legacy Teacher role and 3 is legacy Non-editing Teacher.
** You can use role field instead to specify roles directly - use either role short name or id (numeric names of roles are not supported).
** Users may be also assigned to groups in course (group1 in course1, group2 in course2, etc.).
*** A group is identified by name or id (numeric group names are not supported).
** From Moodle 2.0, you can set the enrolment duration, in days, for each course (<code>enrolperiod1</code> for <code>course1</code>, <code>enrolperiod2</code> for <code>course2</code>, etc.).

Commas within a field must be encoded as &#44 - the script will decode these back to commas.

For Boolean fields, use <code>0</code> for false and <code>1</code> for true.

To prevent users from receiving a large number of emails from courses or forced subscription forums use the '''maildigest'''. The options for this field are 0 = No digest, 1 = Complete digest and 2 = Digest with just subjects.

==Advanced potentials of Upload user==
===Templates===

''Note: This section needs checking and updating if necessary for Moodle 2.0. Please do so and remove this note when finished.''

The default values are processed as templates in which the following codes are allowed:

* %l - will be replaced by the lastname
* %f - will be replaced by the firstname
* %u - will be replaced by the username
* %% - will be replaced by the %

Between the percent sign (%) and any code letter (l, f or u) the following modifiers are allowed:

* (-) minus sign - the information specified by the code letter will be converted to lowercase
* (+) plus sign - the information specified by the code letter will be converted to UPPERCASE
* (~) tilde sign - the information specified by the code letter will be converted to Title Case
* a decimal number - the information specified by the code letter will be truncated to that many characters

For example, if the firstname is John and the lastname is Doe, the following values will be obtained with the specified templates:

* %l%f = DoeJohn
* %l%1f = DoeJ
* %-l%+f = doeJOHN
* %-f_%-l = john_doe
*<nowiki> http://www.example.com/~%u/</nowiki> results in <nowiki>http://www.example.com/~jdoe/</nowiki> (if the username is jdoe or %-1f%-l)

Template processing is done only on default values, and not on the values retrieved from the CSV file.

In order to create correct Moodle usernames, the username is always converted to lowercase. Moreover, if the "Allow extended characters in usernames" option in the Site policies page is off, characters different to letters, digits, dash (-) and dot (.) are removed. For example if the firstname is John Jr. and the lastname is Doe, the username %-f_%-l will produce john jr._doe when Allow extended characters in usernames is on, and johnjr.doe when off.

When the "New username duplicate handling" setting is set to Append counter, an auto-increment counter will be append to duplicate usernames produced by the template. For example, if the CSV file contains the users named John Doe, Jane Doe and Jenny Doe without explicit usernames, the default username is %-1f%-l and New username duplicate handling is set to Append counter, then the usernames produced will be jdoe, jdoe2 and jdoe3.

===Deleting accounts===

If the <code>deleted</code> field is present, users with value 1 for it will be deleted. In this case, all the fields may be omitted, except for <code>username</code>. After uploading the file, be sure to change the "Upload type" to "Update existing users only" and the "Allow deletes" option to "Yes".

Deleting and uploading accounts could be done with a single CSV file. For example, the following file will add the user Tom Jones and delete the user reznort:

username, firstname, lastname, deleted
jonest, Tom, Jones, 0
reznort, , , 1

==Encoding file format==
On the initial Upload user screen, you may select the file encoding format from a pull down list. These include UTF-8 (the default), ASCII, ISO-8859-1 to ISO-8859-11 or any one of over 36 formats.

==Hints==

===Spreadsheet===

If you use a spreadsheet program such as Excel to create your .csv file, check the resulting output in a text editor before you upload it. It is possible to get trailing commas on each line from an empty field if you have added and deleted columns of information prior to saving the final file. Also check the character encoding. A csv file is a simple text file (ASCII or Unicode) that can be used to upload user accounts.

Excel translates passwords that begin with - (minus) or + (plus) as zero. Even when saving as .csv and saying "Yes" to "Keep this format, and leave out any incompatible features." Check for this before uploading, as a zero halts the upload process.

If you use a formula in Excel to create fields (for example, the concatenate function to create a user name), then remember to copy the cells with the formula and use special paste with values checked to make them into an acceptable data for a csv file.

===Country===
The country should be written as a two letter code, in capitals. For example, use BE for Belgium or NL for the Netherlands. Using "be" or "nl" as a country code will result in a database error.
:''Tip:'' If you are having trouble working out the two-letter code for a country, you can consult this Moodle source code file /moodle/lang/en_utf8/countries.php [http://cvs.moodle.org/moodle/lang/en_utf8/countries.php?view=markup&pathrev=MOODLE_19_STABLE or click here for a 1.9 STABLE list].
ISO Website: [http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm]
===Field size limits===
Some fields have maximum character lengths. Typically the file will import to the preview list screen but not finish the process. Turn on debug to see the fields that are too long. A common field to cause problems is the "Institution" field which has a limit of 40 characters.
===All fields listed here===
:All the fields that are valid in 2.1 are listed below, except for any custom fields you may have created.
firstname, lastname, username, email, city, country, lang, timezone, mailformat, maildisplay, maildigest, htmleditor, ajax, autosubscribe ,institution, department, idnumber, skype , msn, aim, yahoo, icq, phone1, phone2, address, url, description, descriptionformat, password, auth, oldusername , deleted, course1, course2, course3, course4

== See also ==

*[[Flat file]] enrolment

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=36851 Can I auto enroll from Excel?]
*[http://moodle.org/mod/forum/discuss.php?d=58215 Making Email Optional]
*[http://moodle.org/mod/forum/discuss.php?d=97903 Uploading users to custom roles]
*[http://moodle.org/mod/forum/discuss.php?d=181259 User upload option: standardise usernames]
*[http://moodle.org/mod/forum/discuss.php?d=144569 Matriculacion con flat file csv] - discussion in Spanish

[[fr:Importer des utilisateurs]]
[[ja:ユーザのアップロード]]
[[zh:上传用户]]
[[ru:Загрузка пользователей]]

Talk:Upload users

2011-11-22T13:23:54Z

Rcollman: /* Notes from Moodle 2.1 uploaduser.php */

==Notes from Moodle 2.1 uploaduser.php==
firstname, lastname, username, email, city, country, lang, timezone, mailformat, maildisplay, maildigest, htmleditor, ajax, autosubscribe ,institution, department , idnumber, skype , msn, aim, yahoo, icq, phone1, phone2, address, url, description, descriptionformat, password, auth, oldusername , deleted, course1, course2, course3, course4

// watch out when changing auth type or using external auth plugins!
// use oldusername when renaming users - this is the original username
// 1 means delete user
//course# not sure about these put short course name

--[[User:chris collman|chris collman]] 21:22, 22 November 2011 (WST)

Talk:Upload users

2011-11-22T13:22:26Z

Rcollman: /* Notes from Moodle 2.1 uploaduser.php */

==Notes from Moodle 2.1 uploaduser.php==
firstname, lastname, username, email, city, country, lang, timezone, mailformat, maildisplay, maildigest, htmleditor, ajax, autosubscribe ,institution, department , idnumber, skype , msn, aim, yahoo, icq, phone1, phone2, address, url, description, descriptionformat, password, auth, oldusername , deleted, course1, course2, course3, course4
// watch out when changing auth type or using external auth plugins!
// use oldusername when renaming users - this is the original username
// 1 means delete user
//course# not sure about these

--[[User:chris collman|chris collman]] 21:22, 22 November 2011 (WST)

Talk:Upload users

2011-11-22T13:21:59Z

Rcollman: List of valid fields forlater reference

==Notes from Moodle 2.1 uploaduser.php==
firstname, lastname, username, email, city, country, lang, timezone, mailformat, maildisplay, maildigest, htmleditor, ajax, autosubscribe ,institution, department , idnumber, skype , msn, aim, yahoo, icq, phone1, phone2, address, url, description, descriptionformat, password, auth, oldusername , deleted, course1, course2, course3, course4
// watch out when changing auth type or using external auth plugins!
// use oldusername when renaming users - this is the original username
// 1 means delete user
//course# not sure about these

Upload users

2011-11-22T12:15:58Z

Rcollman: /* Templates */

{{Accounts}}
An administrator can upload multiple user accounts via text file in ''Settings > Site administration > Users > Accounts > Upload users''.

There are many robust options for uploading information (fields associated with a user) with this method: from enrolling users in multiple courses with course specific [[Roles|roles]] to updating user information in the [[User profile]] to deleting users from the site.

''Tip:'' It is usually not necessary to upload users in bulk with Upload users. To keep maintenance work down you should first explore forms of authentication that do not require manual maintenance, such as [[External database authentication|connecting to existing external databases]] or letting the users create their own accounts ([[Self enrolment]]). See [[Authentication]] for more information.

[[File:Upload users initial 2.0.JPG|thumb|center|Initial upload users screen 2.1]]

==Upload user process==
Here is an outline of the process:

# Create file for uploading
# Go to ''Settings > Site administration > Users > Accounts > Upload users''
# Add file to upload
# Upload users preview - check settings and default user profile settings
# Upload users preview - click "Upload users"
# Upload users results - shows list of users, exceptions made in upload and summary of number of users
# Upload users results - click "Continue"
# Returns to Upload users screen

==Updating users preview==
There are settings for the kind of Upload user function you want to perform on the "Upload users preview" page.
[[File:Upload users preview 2.0.JPG|thumb|center|Upload users preview in Moodle 2.x]]

===Updating existing accounts===

By default Moodle adds new user accounts and skips existing users lines where the <code>username</code> matches an existing account. Set "Upload Type" to '''Add new and update existing users''', and existing user account will be updated.
*Add all, append number to usernames if needed
*Add new and update existing users
*Update existing users only
There are also fields settings to force password change, allow renames, allow deletes, prevent email address duplicates, standardise usernames and select for bulk operations(new users. updated users, all users).

'''Warning''': errors updating existing accounts can affect your users badly. Be careful when using the options to update.

===Set default user values===

You may be able to set default user field values, if the fields were not included in the uploaded file on this page.

==Upload user results ==
After accepting the preview settings by clicking on "Upload users", you should see the the Upload users results screen.
[[File:Upload users results 2.0.JPG|thumb|center|The 2.0 results screen, everything went well]]
This screen will show you any exceptions or changes that were made to each user in the upload process. For example if you were updating user information, the updated information will be shown. Or if a user was not added that record will be highlighted.

The screen will summarize how many users were uploaded or updated, indicate the number of week passwords and the number of errors.

==File formats for upload users file==
The upload files have their fields separated by a comma (or other delimiter). The first line contains the valid field names. The rest of the lines (records) contain information about each user.

'':Tip:'' If you are not an expert, avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload. Remember there are other ways to authenticate users on you site or enroll users in a course.

'':Tip:'' You can use a spread sheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can be opened with simple text editors for verification.

===Valid upload file for testing===
Here is an example of a simple valid upload file:

<code>username, password, firstname, lastname, email, course1, group1<br />
jonest, verysecret, Tom, Jones, jonest@someplace.edu, math102, Section 1<br />
reznort, somesecret, Trent, Reznor, reznort@someplace.edu, math102, Section 3</code>

===Fields that can be included===
'':Tip:'' We strongly recommend that you test a file that contains fields you proposed to use with one user before attempting a file upload for the first time. demo.moodle.net might be a good place to see if your test file works.

*'''Required fields''':
:<p><code>username, firstname, lastname, email</code>
:Validity checks are performed for:
#<code>username</code> can only contain alphabetical '''lowercase''' letters , numbers, hypen '-', underscore '_', period '.', or at-sign '@'
#<code>email</code> is in the form: ''name@example.com'' .</p>

*'''Password field''': "password" field is optional if "Create password if needed" setting is chosen (default).
**If included, values should meet the requirements for the site's [[Site_policies#Password_policy|Password policy]]. To force password change for a particular user, set the password field to <code>changeme</code>.
**If omitted, a password will be generated for each user (during the next Cron job) and welcome e-mails sent out (not working in v2.0.2?).

*'''Optional fields''': To provide values other than the default include one or more of these
:<p><code>institution, department, city, country, lang, auth, ajax, timezone, idnumber, icq, phone1, phone2, address, url, description, mailformat, maildisplay, htmleditor, autosubscribe</code></p>
*Country- use a country TWO LETTER CODE
*Some fields have a maximum number of characters that are allow. See hints below.
*Maildisplay, htmleditor and autosubscribe can be set from an import screen in Moodle 2.0.

*'''Custom profile field names''': (Optional). xxxxx is the real custom user profile field name (i.e. the unique shortname)
:<p><code>profile_field_xxxxx</code></p>
: Create the custom fields BEFORE importing. Use the standard header. The "shortname" for your custom field is xxxxx (NB: as at v2.0.2, the shortname must be all lowercase, otherwise won't be recognised). The first record must include "profile_field_xxxxx".
:'''Example''': To create a custom field "genre", you must write a shortname "genre" in the new field, and write "profile_field_genre" in the header of the .csv file.

*'''Special fields''': Used for changing of usernames or deleting of users
:<p><code>oldusername</code>, <code>deleted</code></p>

*'''Enrolment fields''': (Optional):
:<p><code>course1, type1, role1, group1, enrolperiod1, course2, type2, role2, group2, enrolperiod2</code> etc.
**<code>course</code> is the "shortname" of the course, if present the user will be enrolled in those courses.
** <code>type</code> refers to the role to be used for associated course enrolment. Value 1 is default course role, 2 is legacy Teacher role and 3 is legacy Non-editing Teacher.
** You can use role field instead to specify roles directly - use either role short name or id (numeric names of roles are not supported).
** Users may be also assigned to groups in course (group1 in course1, group2 in course2, etc.).
*** A group is identified by name or id (numeric group names are not supported).
** From Moodle 2.0, you can set the enrolment duration, in days, for each course (<code>enrolperiod1</code> for <code>course1</code>, <code>enrolperiod2</code> for <code>course2</code>, etc.).

Commas within a field must be encoded as &#44 - the script will decode these back to commas.

For Boolean fields, use <code>0</code> for false and <code>1</code> for true.

To prevent users from receiving a large number of emails from courses or forced subscription forums use the '''maildigest'''. The options for this field are 0 = No digest, 1 = Complete digest and 2 = Digest with just subjects.

==Advanced potentials of Upload user==
===Templates===

''Note: This section needs checking and updating if necessary for Moodle 2.0. Please do so and remove this note when finished.''

The default values are processed as templates in which the following codes are allowed:

* %l - will be replaced by the lastname
* %f - will be replaced by the firstname
* %u - will be replaced by the username
* %% - will be replaced by the %

Between the percent sign (%) and any code letter (l, f or u) the following modifiers are allowed:

* (-) minus sign - the information specified by the code letter will be converted to lowercase
* (+) plus sign - the information specified by the code letter will be converted to UPPERCASE
* (~) tilde sign - the information specified by the code letter will be converted to Title Case
* a decimal number - the information specified by the code letter will be truncated to that many characters

For example, if the firstname is John and the lastname is Doe, the following values will be obtained with the specified templates:

* %l%f = DoeJohn
* %l%1f = DoeJ
* %-l%+f = doeJOHN
* %-f_%-l = john_doe
*<nowiki> http://www.example.com/~%u/</nowiki> results in <nowiki>http://www.example.com/~jdoe/</nowiki> (if the username is jdoe or %-1f%-l)

Template processing is done only on default values, and not on the values retrieved from the CSV file.

In order to create correct Moodle usernames, the username is always converted to lowercase. Moreover, if the "Allow extended characters in usernames" option in the Site policies page is off, characters different to letters, digits, dash (-) and dot (.) are removed. For example if the firstname is John Jr. and the lastname is Doe, the username %-f_%-l will produce john jr._doe when Allow extended characters in usernames is on, and johnjr.doe when off.

When the "New username duplicate handling" setting is set to Append counter, an auto-increment counter will be append to duplicate usernames produced by the template. For example, if the CSV file contains the users named John Doe, Jane Doe and Jenny Doe without explicit usernames, the default username is %-1f%-l and New username duplicate handling is set to Append counter, then the usernames produced will be jdoe, jdoe2 and jdoe3.

===Deleting accounts===

If the <code>deleted</code> field is present, users with value 1 for it will be deleted. In this case, all the fields may be omitted, except for <code>username</code>. After uploading the file, be sure to change the "Upload type" to "Update existing users only" and the "Allow deletes" option to "Yes".

Deleting and uploading accounts could be done with a single CSV file. For example, the following file will add the user Tom Jones and delete the user reznort:

username, firstname, lastname, deleted
jonest, Tom, Jones, 0
reznort, , , 1

==Encoding file format==
On the initial Upload user screen, you may select the file encoding format from a pull down list. These include UTF-8 (the default), ASCII, ISO-8859-1 to ISO-8859-11 or any one of over 36 formats.

==Hints==

===Spreadsheet===

If you use a spreadsheet program such as Excel to create your .csv file, check the resulting output in a text editor before you upload it. It is possible to get trailing commas on each line from an empty field if you have added and deleted columns of information prior to saving the final file. Also check the character encoding. A csv file is a simple text file (ASCII or Unicode) that can be used to upload user accounts.

Excel translates passwords that begin with - (minus) or + (plus) as zero. Even when saving as .csv and saying "Yes" to "Keep this format, and leave out any incompatible features." Check for this before uploading, as a zero halts the upload process.

If you use a formula in Excel to create fields (for example, the concatenate function to create a user name), then remember to copy the cells with the formula and use special paste with values checked to make them into an acceptable data for a csv file.

===Country===
The country should be written as a two letter code, in capitals. For example, use BE for Belgium or NL for the Netherlands. Using "be" or "nl" as a country code will result in a database error.
:''Tip:'' If you are having trouble working out the two-letter code for a country, you can consult this Moodle source code file /moodle/lang/en_utf8/countries.php [http://cvs.moodle.org/moodle/lang/en_utf8/countries.php?view=markup&pathrev=MOODLE_19_STABLE or click here for a 1.9 STABLE list].
ISO Website: [http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm]
===Field size limits===
Some fields have maximum character lengths. Typically the file will import to the preview list screen but not finish the process. Turn on debug to see the fields that are too long. A common field to cause problems is the "Institution" field which has a limit of 40 characters.

== See also ==

*[[Flat file]] enrolment

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=36851 Can I auto enroll from Excel?]
*[http://moodle.org/mod/forum/discuss.php?d=58215 Making Email Optional]
*[http://moodle.org/mod/forum/discuss.php?d=97903 Uploading users to custom roles]
*[http://moodle.org/mod/forum/discuss.php?d=181259 User upload option: standardise usernames]
*[http://moodle.org/mod/forum/discuss.php?d=144569 Matriculacion con flat file csv] - discussion in Spanish

[[fr:Importer des utilisateurs]]
[[ja:ユーザのアップロード]]
[[zh:上传用户]]
[[ru:Загрузка пользователей]]

Talk:Cron with Unix or Linux

2011-11-22T12:09:43Z

Rcollman: copy MoodleDocs some of 2.0 Talk:Cron

== Since wget is being used to run the cron.php script anyway, you can really run this ANYWHERE ==
:Brought this comment from 2.0 Cron comment page. It was unsigned/undated --[[User:chris collman|chris collman]] 20:09, 22 November 2011 (WST)
It is important to note that since the cron.php script is not run internally by Moodle, but by an outside interaction, you can really run a cron job on ANY server that runs the cron.php on your Moodle installation.

So, for example, if you have a Moodle install at an ISP that does not let you run cron jobs, but you have, say, a DSLline at home, you can use any of your Linux computers at home to run cron. (you do use Linux at home, right? :)

And the beauty of it is, the crontab line is *exactly* the same as listed in the main article. It just points to an outside URL.

Now, I mention this because at one point I had configured a server to run Moodle but, in the interest of security, I did not have wget available on the server. (cron was available, but not wget).

Well, the easiest thing to do was to just run a cron job somewhere else.

Alrighty, seeyalater!

== Update and clarify ==
:Brought this comment from 2.0 Cron comment page. It was unsigned/undated --[[User:chris collman|chris collman]] 20:09, 22 November 2011 (WST)

* The whole cronclionly vs. shell invocation vs. "using wget" is completely misleading.
** while you can call cron.php using a web browser or a command line web "browser" like wget, curl, lynx from outside or inside the server. The latter commands can be scripted, e.g. to be called by cron.
** the "cronclionly" checkbox restricts the call to cron.php to calling it from inside the server and only using "bin/php". This can be scripted to be called by cron, as well.
* It should be said somewhere that using e.g. the "www-data" user in e.g. /etc/cron.d/moodle is far better than using /etc/crontab which is executed by root. AFAICS this is nowhere mentioned.

Talk:Cron

2011-11-22T12:05:52Z

Rcollman: delete temp draft of mine

Cron

2011-11-22T11:53:36Z

Rcollman: Upgrade page, split into many pages that are linked with template

{{Installing Moodle}}
Cron is the name of a Unix program that runs predefined tasks on a computer at regular intervals. The cron process in Moodle assists some modules to perform tasks on a scheduled basis. For example, the cron process might tell Moodle to check all discussion forums so it can mail out copies of new posts to people who have subscribed to that forum.

The Moodle cron process can not tell itself to run. It is a best practice to set up a cron service either on the hosting web server, another server or on another computer that will tell the Moodle cron process to run.

*[[Cron reports]] - Examples of reports shown after admin/cron.php was triggered
*[[Cron settings]] - Moodle cron process password and CLI settings
*[[Cron with Windows OS]] - Cron services in Windows
*[[Cron with MAC OS X]]- Cron services in a MAC environment
*[[Cron with web hosting services]]- Cron services in various web hosting examples.
*[[Cron with UNIX]]- Cron services on various UNIX and Linux flavored operating systems.

:Note: Asking a human to use their browser to run the Moodle cron process every five or ten minutes,or when anybody on the site thinks it needs to be run is not a best practice. The outside cron service provides a "heartbeat" so that the Moodle cron process can perform functions at periods defined for each module that needs it.

==Starting cron==
There are a number of way to invoke Moodle cron process. Cron can be started from the address bar in a browser (For example http:demo.moodle.net/admin/cron.php), via a [[Daemon]], or wq1et, curl or some other form of a cron service.

===Cron service location and timing===
Note that the machine providing the cron service '''does not need to be the same machine that is running Moodle'''. For example, if you have a limited web hosting service that does not have a cron service, then you might choose to run cron on another server or on your home computer. All that matters is that the Moodle cron process is run on a regular basis.

The load of the Moodle cron process on the Moodle server is not very high, so 5 minutes is usually reasonable. However if you're worried about it you can reduce the time period to something like 15 minutes or even 30 minutes.
:It's best not to make the time period too long. For example delaying mail-outs can slow down activity within the course and create a large mail outbox to process. Or student want to see their activity and course completions updated quickly.

===Testing cron and manual trigger===
On a new Moodle install or upgrade, it is a good idea to test the Moodle cron process directly from your browser: ''<nowiki>http://example.com/moodle/admin/cron.php</nowiki>'' (See [[Cron settings]] if this does not work).

Next, you need to set up a way to manage an automatic scheduled process to run the script on a regular basis. This will depend upon the operating system and program you select.

:Note: When the Moodle cron process is called from cron service, 'the command line' trigger creates a temporary admin environment (similar to a login) in order to run and then deletes that environment. You can disable command line running of cron by disabling the appropriate section in the cron.php file.

==Moodle cron process ==
The Moodle cron process basically finds and determines if certain functions need to run. These functions are defined in code associated with specific activities and processes. Usually the function looks for new activity that has occurred since cron was last run. Some of the functions may use a timestamp to determine if they should look for new activity. A few functions are run on a random basis.

===Examples of Moodle cron processes===
Moodle's cron processes include:
*updating reports such as quiz, admin, gradebook
*updating course and activity completion (if enabled in advanced settings)
*updating portfolio
*plagiarism checks
*updates activity modules. It looks through the mod directory for lib.php files that contain the function activity-name_cron and will call it. In a standard install this includes assignment, chat, forum, and SCROM.
*updates blocks. It looks for blocks for their cron methods (object functions) to be run. It then, for each such block, runs the cron method for a new object associated with that block (for more details read admin/cron.php). These files (the lib.php files and the files where the block classes are defined) can contain cleanup functions, email functions or anything that needs to be run on a regular basis.
*create the backups of courses at the time specified in the administration settings.
*updating messaging module or forum email notifications.
*unenrol students - this is done on a random basis about 20% of the time Moodle's cron process is triggered.
*deleting users who have not filled out their profile via the 20% random trigger
*deleting old logs are also checked 20% of the time via the 20% random trigger
*deletes old cached text
*generates new passwords for new users and notifies users
*runs authentication enrolments processes
*updates stats if enabled.
*runs blog cleanups
*updates registrations

The code in lib/cronlib.php shows the places that are being checked when the admin/cron.php is run and the report which is displayed on the screen after it has run. As mentioned elsewhere admin/cli/cron.php is the file which outside cron services run to trigger the Moodle cron process.

==See also==
Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=41827 Cron - can someone give me a quick confirmation of function?]
*[http://moodle.org/mod/forum/discuss.php?d=97684 Cronjob Question]
*[http://moodle.org/mod/forum/discuss.php?d=97457 Slow cron : avoiding simultaneous cron]
*[http://moodle.org/mod/forum/discuss.php?d=117168 Visibility of cron.php]
*[http://moodle.org/mod/forum/discuss.php?d=139263#p609060 How to log the output of a Scheduled Task on Windows] - this discussion explains a nice trick that can be very useful when you are experiencing problems with your Windows Scheduled Task and you need to log the output of the Scheduled Task to a log file.

[[es:Cron]]
[[fr:Cron]]
[[nl:Cron]]
[[sk:Cron]]
[[pl:Cron]]
[[ja:Cron]]

Talk:Cron

2011-11-22T11:50:32Z

Rcollman: /* =Examples of Moodle cron processes */

Comment from Eloy:

"If there is some template to mark one page as "require some love" I'd say https://docs.moodle.org/en/Cron requires it. It talks 99% of the time to use web-browser cron. Only 1 line talks about cli cron." --[[User:Helen Foster|Helen Foster]] 20:44, 9 November 2011 (WST)
:I just noticed this comment. Cron is not one of my special areas of knowledge but obviously use it. Did a quick "Cron CLI" on the web and got lost in how to program a php file to run cron jobs. Saw the note about 2.0 and CLI on this page.

I think Eloy's comment is also saying that this page is too long and could be split up? For example use a navtrail and a Cron template. Proposed pages:
*Cron page - Overview section
*[[Cron with Windows OS]] page - move section.
*[[Cron with MAC OS X]] page - move section
*[[Cron with web hosting services]] page - move section
*[[Cron with UNIX]] page - move section
*[[Cron reports]]
*[[Cron settings]]
Comments? --[[User:chris collman|chris collman]] 23:25, 12 November 2011 (WST)

Notice that I am using the phrase "the Moodle cron process". As I understand it, this process can be triggered via admin/cron.php OR via a cron service at admin/cli/cron.php. Frankly, I am not sure how lib/cronlib.php works with either of these trigeer points but I don't think that is important for the site admin. The old cron page refered to cron.php with the assumption that it was in admin. To avoid confusion for a new user, I decided to call it a Moodle cron process.--[[User:chris collman|chris collman]] 23:57, 19 November 2011 (WST)

==Will create change on this page later==
Not hearing any immediate response to my proposals, I will wait a few days before I change things. I will go back and change the 2.0 Docs as well--[[User:chris collman|chris collman]] 22:58, 17 November 2011 (WST)

::'''DRAFT OF NEW CRON PAGE STARTS HERE''' (will remove later)
'''Change Moodle 2.0 Docs as well'''
Cron is the name of a Unix program that runs predefined tasks on a computer at regular intervals. The cron process in Moodle assists some modules to perform tasks on a scheduled basis. For example, the cron process might tell Moodle to check all discussion forums so it can mail out copies of new posts to people who have subscribed to that forum.

The Moodle cron process can not tell itself to run. It is a best practice to set up a cron service either on the hosting web server, another server or on another computer that will tell the Moodle cron process to run.

*[[Cron reports]] - Examples of reports shown after admin/cron.php was triggered
*[[Cron settings]] - Moodle cron process password and CLI settings
*[[Cron with Windows OS]] - Cron services in Windows
*[[Cron with MAC OS X]]- Cron services in a MAC environment
*[[Cron with web hosting services]]- Cron services in various web hosting examples.
*[[Cron with UNIX]]- Cron services on various UNIX and Linux flavored operating systems.

:Note: Asking a human to use their browser to run the Moodle cron process every five or ten minutes,or when anybody on the site thinks it needs to be run is not a best practice. The outside cron service provides a "heartbeat" so that the Moodle cron process can perform functions at periods defined for each module that needs it.

==Starting cron==
There are a number of way to invoke Moodle cron process. Cron can be started from the address bar in a browser (For example http:demo.moodle.net/admin/cron.php), via a [[Daemon]], or wq1et, curl or some other form of a cron service.

===Cron service location and timing===
Note that the machine providing the cron service '''does not need to be the same machine that is running Moodle'''. For example, if you have a limited web hosting service that does not have a cron service, then you might choose to run cron on another server or on your home computer. All that matters is that the Moodle cron process is run on a regular basis.

The load of the Moodle cron process on the Moodle server is not very high, so 5 minutes is usually reasonable. However if you're worried about it you can reduce the time period to something like 15 minutes or even 30 minutes.
:It's best not to make the time period too long. For example delaying mail-outs can slow down activity within the course and create a large mail outbox to process. Or student want to see their activity and course completions updated quickly.

===Testing cron and manual trigger===
On a new Moodle install or upgrade, it is a good idea to test the Moodle cron process directly from your browser: ''<nowiki>http://example.com/moodle/admin/cron.php</nowiki>'' (See [[Cron settings]] if this does not work).

Next, you need to set up a way to manage an automatic scheduled process to run the script on a regular basis. This will depend upon the operating system and program you select.

:Note: When the Moodle cron process is called from cron service, 'the command line' trigger creates a temporary admin environment (similar to a login) in order to run and then deletes that environment. You can disable command line running of cron by disabling the appropriate section in the cron.php file.

==Moodle cron process ==
The Moodle cron process basically finds and determines if certain functions need to run. These functions are defined in code associated with specific activities and processes. Usually the function looks for new activity that has occurred since cron was last run. Some of the functions may use a timestamp to determine if they should look for new activity. A few functions are run on a random basis.

===Examples of Moodle cron processes===
Moodle's cron processes include:
*updating reports such as quiz, admin, gradebook
*updating course and activity completion (if enabled in advanced settings)
*updating portfolio
*plagiarism checks
*updates activity modules. It looks through the mod directory for lib.php files that contain the function activity-name_cron and will call it. In a standard install this includes assignment, chat, forum, and SCROM.
*updates blocks. It looks for blocks for their cron methods (object functions) to be run. It then, for each such block, runs the cron method for a new object associated with that block (for more details read admin/cron.php). These files (the lib.php files and the files where the block classes are defined) can contain cleanup functions, email functions or anything that needs to be run on a regular basis.
*create the backups of courses at the time specified in the administration settings.
*updating messaging module or forum email notifications.
*unenroll students - this is done on a random basis about 20% of the time Moodle's cron process is triggered.
*deleting users who have not filled out their profile via the 20% random trigger
*deleting old logs are also checked 20% of the time via the 20% random trigger
*deletes old cached text
*generates new passwords for new users and notifies users
*runs authentication enrolments processes
*updates stats if enabled.
*runs blog cleanups
*updates registrations

The code in lib/cronlib.php shows the places that are being checked when the admin/cron.php is run and the report which is displayed on the screen after it has run. As mentioned elsewhere admin/cli/cron.php is the file which outside cron services run to trigger the Moodle cron process.

==See also==
Using Moodle forum discussions:'''No wiki start'''<nowiki>
*[http://moodle.org/mod/forum/discuss.php?d=41827 Cron - can someone give me a quick confirmation of function?]
*[http://moodle.org/mod/forum/discuss.php?d=97684 Cronjob Question]
*[http://moodle.org/mod/forum/discuss.php?d=97457 Slow cron : avoiding simultaneous cron]
*[http://moodle.org/mod/forum/discuss.php?d=117168 Visibility of cron.php]
*[http://moodle.org/mod/forum/discuss.php?d=139263#p609060 How to log the output of a Scheduled Task on Windows] - this discussion explains a nice trick that can be very useful when you are experiencing problems with your Windows Scheduled Task and you need to log the output of the Scheduled Task to a log file.

[[es:Cron]]
[[fr:Cron]]
[[nl:Cron]]
[[sk:Cron]]
[[pl:Cron]]
[[ja:Cron]]</nowiki>'''No wiki end'''

::'''END OF DRAFT PAGE HERE'''

Template:Lesson

2011-11-20T15:51:42Z

Rcollman:

<div class="navtrail">[[Main page]] ► [[Managing a Moodle course]] ► [[Activities]] ► [[Lesson module]] ► [[{{PAGENAME}}]]</div>
<div class="sideblock right" style="width: 12em;">
<div class="header">[[Lesson module]]</div>
<div class="content">
* [[Lesson settings]]
* [[Building Lesson]]
* [[Using Lesson]]
* [[Lesson reports]]
* [[Lesson FAQ]]
* [[Jumps]]
* [[Adding a content page|Adding content page]]
* [[Adding a question page|Adding question page]]
* [[Lesson clusters|Clusters]]

</div>
</div>

<includeonly>[[Category:Lesson]]</includeonly>
<noinclude>This template will categorize articles that include it into [[:Category:Lesson]].</noinclude>

Template:Lesson

2011-11-20T15:50:54Z

Rcollman: expand to include most of pages that contain this template

<div class="navtrail">[[Main page]] ► [[Managing a Moodle course]] ► [[Activities]] ► [[Lesson module]] ► [[{{PAGENAME}}]]</div>
<div class="sideblock right" style="width: 12em;">
<div class="header">[[Lesson module]]</div>
<div class="content">
* [[Lesson settings]]
* [[Building Lesson]]
* [[Using Lesson]]
* [[Lesson reports]]
* [[Lesson FAQ]]
* [[Jumps]]
* [[Adding content page]]
* [[Adding question page]]
* [[Lesson clusters|Clusters]]

</div>
</div>

<includeonly>[[Category:Lesson]]</includeonly>
<noinclude>This template will categorize articles that include it into [[:Category:Lesson]].</noinclude>

Template:Lesson

2011-11-20T15:45:37Z

Rcollman: reports has template

<div class="navtrail">[[Main page]] ► [[Managing a Moodle course]] ► [[Activities]] ► [[Lesson module]] ► [[{{PAGENAME}}]]</div>
<div class="sideblock right" style="width: 12em;">
<div class="header">[[Lesson module]]</div>
<div class="content">
* [[Lesson settings]]
* [[Building Lesson]]
* [[Using Lesson]]
* [[Lesson reports]]
* [[Lesson FAQ]]
</div>
</div>

<includeonly>[[Category:Lesson]]</includeonly>
<noinclude>This template will categorize articles that include it into [[:Category:Lesson]].</noinclude>

Answers

2011-11-20T15:43:49Z

Rcollman: /* The Ultimate Answer to Everything */

This page is about Answers used in a Course [[Lesson module]] question or in a Course [[Quiz module]] or a [[Question bank]] question. Typically students are presented with a question, they select or create an answer, which maybe scored and bring additional information to the student or present a new set of information to consider.

==Links to answers==
*[[Lesson module#Answers | Answers used in Lesson Page]]
*[[Lesson module#Types_of_questions_available_within_a_lesson|Types of questions]] in a Lesson that have answers
*[[Quiz]] page in MoodleDocs
*[[Question types]] available in a Quiz that have answers
* The [https://docs.moodle.org/en/Category:Quiz Quiz Topic Index Quiz index] is also an excellent source of information about different types of questions and their types of answers. Lesson and Quiz questions types are the same

==Links to places to find answers==
*Moodle Documentation article- do not click your mouse, you are here. Use the search field on the left side of the page.
**Go looks for a specific page with that text
**Search looks for every use of the text
*Moodle Documentation page comments - not a good place for questions but sometimes they have answers
*[http://moodle.org/mod/forum/index.php?id=5 Moodle forums] - these are organized by interest and there are lots of them.
*[http://moodle.org/mod/forum/view.php?id=6801 Moodle social forum] - for answers to real philosophical or non Moodle questions
*[[Tracker|Moodle Tracker]] - Not only a place to report bugs but a place to answer the question if others have noticed the same thing.
*[http://demo.moodle.org/ demo.moodle.org] find your own answers in the demonstration. You can't break it, every hour it restores itself.

==The Ultimate '''Answer''' to Everything==
The ultimate answer to everything is of course [http://en.wikipedia.org/wiki/Answer_to_Life%2C_the_Universe%2C_and_Everything 42]. For something more specific than '''The Ultimate Answer to EVERYTHING''', um.... may we suggest you look at
*[[Table_of_Contents]] and to find the answer, or
*Seek out your favorite spiritual adviser for additional help, or perhaps
*Go to one of the [http://moodle.org/course/view.php?id=5 Using Moodle forums]

==See also==

[[Category:Lesson]]
[[Category:Quiz]]

Lesson FAQ

2011-11-20T15:24:38Z

Rcollman: /* Students do not see content in end of branch page */ delete

{{Lesson}}
==Where were Branch Tables?==
In Moodle 2.0, the official name of a branch table page was changed to "'''Content'''" page. The documentation is slowly being changed to reflect this change. The features of this page type did not change.

==Import PowerPoint does not work==
"No data" or some other error shows up after an attempt to import.
*Please read [[Import PowerPoint]]. Most common causes:
#Complicated PowerPoint. Too many images, text boxes or fancy features.
#Wrong version of PowerPoint
#Site error - try the tested zip file at [http://tracker.moodle.org/browse/MDL-15755 Tracker.Moodle.org]

==Jumps not working in a question==
A wrong answer should go to "this page" in my lesson. But after the student answers it, the student goes to the next page.
*See adding/editing a lesson and Maximum Attempts in Lesson settings. If maximum attempt is set to 1, then the student will be advanced to the next page after they choice a wrong answer that is sent to "this page". If it is set to 2, after the student selects the wrong answer the 2nd time they will be sent to the next page. This can be used to keep the student out of an endless loop when than can not answer a question correctly.

==Edits of answers or branch buttons are not saved==
I have a 4 answer multiple choice question. I can only seem to save the first two answers, their jumps and feedback. Any edits on the last answers, their jumps and feedbacks are not saved. Moodle does not tell me there is anything wrong. Same thing happened with a Branch table, I can not seem to get the last two descriptions change after I save an edit. GRRRRR!

*Go back to your lesson settings. Maximum number of answers/branches is probably set to 2, change it to 4 or the maximum number of answers or branch descriptions in your lesson. Now the edits can be saved.
::''Tip:'' Changing the "Maximum number" as a teacher builds a lesson is a trick used to limit scrolling passed unused answers or branch choices to get to the save button. For example, 15 pages have 4 choices but one page will have 8 choices. The teacher will use "Maximum number" at 8 setting only when they initially create that page, then switch it back to 4. They (and their students) will always see all 8 answers but the lesson setting will prevent them from editing some of them.

==What is a Branch ?==
Many Moodlers call a series of pages in their lesson "'''a branch'''". Usually the student will enter the series by jumping from a page that is not directly before the "branch". Thus, a student will "branch" off the lesson path from a missed question and visit a series of pages for review before they are returned to the main lesson path again.

Lesson also have special pages that create a [[Lesson clusters|cluster]]. These are also a series of page.

Confused yet? :) Maybe [[Branch structures]] will help.

==Multiple Choice and Multianswer issues==
When I check the multianswer box in a multiple choice question, it does not work. It makes random jumps and does not put the teacher's response with the students choice.

*In a Lesson module [[Lesson_module#Multiple_choice|multianswer question]], all the correct choices must have the same jump and teacher response. All the wrong choices must also have the same jump and teacher response.

==Are there some examples of Lessons I can see?==
I have been to demo.moodle and looked at the [http://demo.moodle.org/mod/lesson/view.php?id=224 Lesson section], are there more examples of Lessons used in a real course?
*[[Lesson samples]] is one place to look.

==The lesson was completed but it does not record it==
*Every lesson must have one question that a student must answer in order for it to show up in some reports. This can effect [[Grades]] and a Lesson's dependency setting (see other FAQs below).
::''Tip:'' There are lots of creative ways to put in a question, such as setting a multiple choice question so that all answers are correct and the answers act like a content (branch table) page. Or put in content and then award 1 point for "next page" as the answer, do not include the score in grades.
::''Tip:'' Due to a specific Lesson's design, some students can complete the lesson without answering one or more questions which have been placed in the Lesson. When Lesson can not record any scores for a student, no grade is pushed to the gradebook. It may appear therefore that Lesson is being inconsistent in recording grades.

==Dependency in Lesson does not work==
The second lesson tells the student they must complete the first one. They did, what is wrong?
*For dependency to work, you need to have at least 1 question page in the lesson. The student may not need a minimum score, but Lesson needs to know that the student tried a question. You can always put a question as the first or last page, You don't need to ask a question but do put in an answer of "continue" with a jump of the next page.

*Also for dependency to work, the lesson can not be a practice lesson.

==How to add sound to a lesson page==
There are some detailed instructions and options on linking to sound files.

*[[MP3_player#Inserting_sounds_into_questions|Here is the best place to look]] - adding sounds to questions.
*[[Audio in Moodle]] has an overview and tool recommendations.

==Can I turn off the answer shuffle in a lesson?==
* In short, no. Turning off the page and answer shuffle are Quiz options, but neither is found in Lesson. A minor hack to the Lesson code is possible but that would impact the entire Moodle site.
::''TIP:'' If you don't need to score students answers in a question, then consider using a Content page instead of a Multiple Choice or a True/False question.

==How can I change the default for Arrange content page buttons horizontally? ==
I used to know, now I am clueless. Just imported 200 slides and the box is checked on every one. How can I change the default?

==Can I change standard words used by Lesson?==
*Yes. You or your site administrator can edit the language file called Lesson.php. This will impact the whole site. Your site administrator might create a language just for you, in Lesson settings use the force language option.

==Grrr something happened, lesson list is not right, I can't move things==
Try a backup and restore of your course to solve some of those "quirky" issues.
*Example: I was building a course, started adding lessons to topic 2 and then realized I should move it up to become Topic 1. Did that and continue to add lessons to topic 1, then lessons to topic 2 etc. Later I had to add lessons to topic 1. I did but could not move them between those first lessons I created. Every time I tried to move them they went to the bottom of topic 2! I also noticed that my list of just lessons, showed those first lessons as being in the correct course display order but showed they were in Topic 2!.
*Moral: Sometimes a backup and a restore will re-establish harmony and fix things.

==What happened to my HTML code on a Lesson page?==
I had the lesson page formatted just the way I wanted by using the HTML source toggle on the tool bar. I went back in to tweak my code and some of my code was missing!
*Lesson will "clean" up your HTML code every time you toggle into HTML text. This can be frustrating, especially if you are trying to get a flash file to display just right. Save you work in a text editor, so the next time you tweak it, you can paste all your code back in.

==Pages are not displayed in the lesson's left menu==
The Lesson module's left menu navigation feature, only displays content (branch table) pages. If your lesson only has question pages, it will not display any pages. Use a content page before a series of question pages, so your students will know where the series starts. Alternative, use the same content page and put links to each of the question using descriptions and jumps. Remember, you can effectively have the student jump past (not view) this content page as they go through the lesson and only reach it via the left menu.

==Students are not returning to where they left the lesson==
A student has left the lesson after looking at 10 pages. The next time they return to the lesson they start at the beginning again. How can the student return to the same place?
:You have seen more than one page of this lesson already. Do you want to start at the last page you saw?

Several things must be met before this will happen. First make sure your lesson settings allow the student to retake the lesson and that this lesson is not a "practice" lesson. The important thing is that the above words are not exactly correct. They are correct only when the student left immediately after answering a question in a Lesson. For the purposes of returning to the same place, Lesson only remembers question pages as benchmarks. So lastly, make sure you have questions scattered in your Lesson for this feature to work and tell students.

:''TIPs:'' Use a content page at the start of the lesson as a table of contents, so the student are forced to remember where they are but can jump to your teaching points. Or put a question at the start or end of every "teaching point". And of course, you can tell your students how it is going to work.

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?f=333 Lesson module forum]

[[Category:FAQ]]
[[de:Lektion_FAQ]]

Lesson FAQ

2011-11-20T15:22:44Z

Rcollman: /* How can I change the default for Arrange Branch buttons horizontally? */

{{Lesson}}
==Where were Branch Tables?==
In Moodle 2.0, the official name of a branch table page was changed to "'''Content'''" page. The documentation is slowly being changed to reflect this change. The features of this page type did not change.

==Import PowerPoint does not work==
"No data" or some other error shows up after an attempt to import.
*Please read [[Import PowerPoint]]. Most common causes:
#Complicated PowerPoint. Too many images, text boxes or fancy features.
#Wrong version of PowerPoint
#Site error - try the tested zip file at [http://tracker.moodle.org/browse/MDL-15755 Tracker.Moodle.org]

==Jumps not working in a question==
A wrong answer should go to "this page" in my lesson. But after the student answers it, the student goes to the next page.
*See adding/editing a lesson and Maximum Attempts in Lesson settings. If maximum attempt is set to 1, then the student will be advanced to the next page after they choice a wrong answer that is sent to "this page". If it is set to 2, after the student selects the wrong answer the 2nd time they will be sent to the next page. This can be used to keep the student out of an endless loop when than can not answer a question correctly.

==Edits of answers or branch buttons are not saved==
I have a 4 answer multiple choice question. I can only seem to save the first two answers, their jumps and feedback. Any edits on the last answers, their jumps and feedbacks are not saved. Moodle does not tell me there is anything wrong. Same thing happened with a Branch table, I can not seem to get the last two descriptions change after I save an edit. GRRRRR!

*Go back to your lesson settings. Maximum number of answers/branches is probably set to 2, change it to 4 or the maximum number of answers or branch descriptions in your lesson. Now the edits can be saved.
::''Tip:'' Changing the "Maximum number" as a teacher builds a lesson is a trick used to limit scrolling passed unused answers or branch choices to get to the save button. For example, 15 pages have 4 choices but one page will have 8 choices. The teacher will use "Maximum number" at 8 setting only when they initially create that page, then switch it back to 4. They (and their students) will always see all 8 answers but the lesson setting will prevent them from editing some of them.

==What is a Branch ?==
Many Moodlers call a series of pages in their lesson "'''a branch'''". Usually the student will enter the series by jumping from a page that is not directly before the "branch". Thus, a student will "branch" off the lesson path from a missed question and visit a series of pages for review before they are returned to the main lesson path again.

Lesson also have special pages that create a [[Lesson clusters|cluster]]. These are also a series of page.

Confused yet? :) Maybe [[Branch structures]] will help.

==Multiple Choice and Multianswer issues==
When I check the multianswer box in a multiple choice question, it does not work. It makes random jumps and does not put the teacher's response with the students choice.

*In a Lesson module [[Lesson_module#Multiple_choice|multianswer question]], all the correct choices must have the same jump and teacher response. All the wrong choices must also have the same jump and teacher response.

==Are there some examples of Lessons I can see?==
I have been to demo.moodle and looked at the [http://demo.moodle.org/mod/lesson/view.php?id=224 Lesson section], are there more examples of Lessons used in a real course?
*[[Lesson samples]] is one place to look.

==The lesson was completed but it does not record it==
*Every lesson must have one question that a student must answer in order for it to show up in some reports. This can effect [[Grades]] and a Lesson's dependency setting (see other FAQs below).
::''Tip:'' There are lots of creative ways to put in a question, such as setting a multiple choice question so that all answers are correct and the answers act like a content (branch table) page. Or put in content and then award 1 point for "next page" as the answer, do not include the score in grades.
::''Tip:'' Due to a specific Lesson's design, some students can complete the lesson without answering one or more questions which have been placed in the Lesson. When Lesson can not record any scores for a student, no grade is pushed to the gradebook. It may appear therefore that Lesson is being inconsistent in recording grades.

==Dependency in Lesson does not work==
The second lesson tells the student they must complete the first one. They did, what is wrong?
*For dependency to work, you need to have at least 1 question page in the lesson. The student may not need a minimum score, but Lesson needs to know that the student tried a question. You can always put a question as the first or last page, You don't need to ask a question but do put in an answer of "continue" with a jump of the next page.

*Also for dependency to work, the lesson can not be a practice lesson.

==How to add sound to a lesson page==
There are some detailed instructions and options on linking to sound files.

*[[MP3_player#Inserting_sounds_into_questions|Here is the best place to look]] - adding sounds to questions.
*[[Audio in Moodle]] has an overview and tool recommendations.

==Can I turn off the answer shuffle in a lesson?==
* In short, no. Turning off the page and answer shuffle are Quiz options, but neither is found in Lesson. A minor hack to the Lesson code is possible but that would impact the entire Moodle site.
::''TIP:'' If you don't need to score students answers in a question, then consider using a Content page instead of a Multiple Choice or a True/False question.

==How can I change the default for Arrange content page buttons horizontally? ==
I used to know, now I am clueless. Just imported 200 slides and the box is checked on every one. How can I change the default?

==Can I change standard words used by Lesson?==
*Yes. You or your site administrator can edit the language file called Lesson.php. This will impact the whole site. Your site administrator might create a language just for you, in Lesson settings use the force language option.

==Grrr something happened, lesson list is not right, I can't move things==
Try a backup and restore of your course to solve some of those "quirky" issues.
*Example: I was building a course, started adding lessons to topic 2 and then realized I should move it up to become Topic 1. Did that and continue to add lessons to topic 1, then lessons to topic 2 etc. Later I had to add lessons to topic 1. I did but could not move them between those first lessons I created. Every time I tried to move them they went to the bottom of topic 2! I also noticed that my list of just lessons, showed those first lessons as being in the correct course display order but showed they were in Topic 2!.
*Moral: Sometimes a backup and a restore will re-establish harmony and fix things.

==What happened to my HTML code on a Lesson page?==
I had the lesson page formatted just the way I wanted by using the HTML source toggle on the tool bar. I went back in to tweak my code and some of my code was missing!
*Lesson will "clean" up your HTML code every time you toggle into HTML text. This can be frustrating, especially if you are trying to get a flash file to display just right. Save you work in a text editor, so the next time you tweak it, you can paste all your code back in.

==Students do not see content in end of branch page==
"End of Branch", "Start" and "End Cluster" pages are special navigational pages that students do not see. A teacher can see their content in edit mode but this content is never displayed to a student, nor in preview mode to the teacher. Use a different kind of page and figure out how the student will reach it via jumps at the right time.

:Moodle 2.0 uses the words "Content page", instead of "Branch Table".

==Pages are not displayed in the lesson's left menu==
The Lesson module's left menu navigation feature, only displays content (branch table) pages. If your lesson only has question pages, it will not display any pages. Use a content page before a series of question pages, so your students will know where the series starts. Alternative, use the same content page and put links to each of the question using descriptions and jumps. Remember, you can effectively have the student jump past (not view) this content page as they go through the lesson and only reach it via the left menu.

==Students are not returning to where they left the lesson==
A student has left the lesson after looking at 10 pages. The next time they return to the lesson they start at the beginning again. How can the student return to the same place?
:You have seen more than one page of this lesson already. Do you want to start at the last page you saw?

Several things must be met before this will happen. First make sure your lesson settings allow the student to retake the lesson and that this lesson is not a "practice" lesson. The important thing is that the above words are not exactly correct. They are correct only when the student left immediately after answering a question in a Lesson. For the purposes of returning to the same place, Lesson only remembers question pages as benchmarks. So lastly, make sure you have questions scattered in your Lesson for this feature to work and tell students.

:''TIPs:'' Use a content page at the start of the lesson as a table of contents, so the student are forced to remember where they are but can jump to your teaching points. Or put a question at the start or end of every "teaching point". And of course, you can tell your students how it is going to work.

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?f=333 Lesson module forum]

[[Category:FAQ]]
[[de:Lektion_FAQ]]

Lesson FAQ

2011-11-20T15:21:15Z

Rcollman: /* What is a Branch ? */

{{Lesson}}
==Where were Branch Tables?==
In Moodle 2.0, the official name of a branch table page was changed to "'''Content'''" page. The documentation is slowly being changed to reflect this change. The features of this page type did not change.

==Import PowerPoint does not work==
"No data" or some other error shows up after an attempt to import.
*Please read [[Import PowerPoint]]. Most common causes:
#Complicated PowerPoint. Too many images, text boxes or fancy features.
#Wrong version of PowerPoint
#Site error - try the tested zip file at [http://tracker.moodle.org/browse/MDL-15755 Tracker.Moodle.org]

==Jumps not working in a question==
A wrong answer should go to "this page" in my lesson. But after the student answers it, the student goes to the next page.
*See adding/editing a lesson and Maximum Attempts in Lesson settings. If maximum attempt is set to 1, then the student will be advanced to the next page after they choice a wrong answer that is sent to "this page". If it is set to 2, after the student selects the wrong answer the 2nd time they will be sent to the next page. This can be used to keep the student out of an endless loop when than can not answer a question correctly.

==Edits of answers or branch buttons are not saved==
I have a 4 answer multiple choice question. I can only seem to save the first two answers, their jumps and feedback. Any edits on the last answers, their jumps and feedbacks are not saved. Moodle does not tell me there is anything wrong. Same thing happened with a Branch table, I can not seem to get the last two descriptions change after I save an edit. GRRRRR!

*Go back to your lesson settings. Maximum number of answers/branches is probably set to 2, change it to 4 or the maximum number of answers or branch descriptions in your lesson. Now the edits can be saved.
::''Tip:'' Changing the "Maximum number" as a teacher builds a lesson is a trick used to limit scrolling passed unused answers or branch choices to get to the save button. For example, 15 pages have 4 choices but one page will have 8 choices. The teacher will use "Maximum number" at 8 setting only when they initially create that page, then switch it back to 4. They (and their students) will always see all 8 answers but the lesson setting will prevent them from editing some of them.

==What is a Branch ?==
Many Moodlers call a series of pages in their lesson "'''a branch'''". Usually the student will enter the series by jumping from a page that is not directly before the "branch". Thus, a student will "branch" off the lesson path from a missed question and visit a series of pages for review before they are returned to the main lesson path again.

Lesson also have special pages that create a [[Lesson clusters|cluster]]. These are also a series of page.

Confused yet? :) Maybe [[Branch structures]] will help.

==Multiple Choice and Multianswer issues==
When I check the multianswer box in a multiple choice question, it does not work. It makes random jumps and does not put the teacher's response with the students choice.

*In a Lesson module [[Lesson_module#Multiple_choice|multianswer question]], all the correct choices must have the same jump and teacher response. All the wrong choices must also have the same jump and teacher response.

==Are there some examples of Lessons I can see?==
I have been to demo.moodle and looked at the [http://demo.moodle.org/mod/lesson/view.php?id=224 Lesson section], are there more examples of Lessons used in a real course?
*[[Lesson samples]] is one place to look.

==The lesson was completed but it does not record it==
*Every lesson must have one question that a student must answer in order for it to show up in some reports. This can effect [[Grades]] and a Lesson's dependency setting (see other FAQs below).
::''Tip:'' There are lots of creative ways to put in a question, such as setting a multiple choice question so that all answers are correct and the answers act like a content (branch table) page. Or put in content and then award 1 point for "next page" as the answer, do not include the score in grades.
::''Tip:'' Due to a specific Lesson's design, some students can complete the lesson without answering one or more questions which have been placed in the Lesson. When Lesson can not record any scores for a student, no grade is pushed to the gradebook. It may appear therefore that Lesson is being inconsistent in recording grades.

==Dependency in Lesson does not work==
The second lesson tells the student they must complete the first one. They did, what is wrong?
*For dependency to work, you need to have at least 1 question page in the lesson. The student may not need a minimum score, but Lesson needs to know that the student tried a question. You can always put a question as the first or last page, You don't need to ask a question but do put in an answer of "continue" with a jump of the next page.

*Also for dependency to work, the lesson can not be a practice lesson.

==How to add sound to a lesson page==
There are some detailed instructions and options on linking to sound files.

*[[MP3_player#Inserting_sounds_into_questions|Here is the best place to look]] - adding sounds to questions.
*[[Audio in Moodle]] has an overview and tool recommendations.

==Can I turn off the answer shuffle in a lesson?==
* In short, no. Turning off the page and answer shuffle are Quiz options, but neither is found in Lesson. A minor hack to the Lesson code is possible but that would impact the entire Moodle site.
::''TIP:'' If you don't need to score students answers in a question, then consider using a Content page instead of a Multiple Choice or a True/False question.

==How can I change the default for Arrange Branch buttons horizontally? ==
I used to know, now I am clueless. Just imported 200 slides and the box is checked on every one. How can I change the default?

==Can I change standard words used by Lesson?==
*Yes. You or your site administrator can edit the language file called Lesson.php. This will impact the whole site. Your site administrator might create a language just for you, in Lesson settings use the force language option.

==Grrr something happened, lesson list is not right, I can't move things==
Try a backup and restore of your course to solve some of those "quirky" issues.
*Example: I was building a course, started adding lessons to topic 2 and then realized I should move it up to become Topic 1. Did that and continue to add lessons to topic 1, then lessons to topic 2 etc. Later I had to add lessons to topic 1. I did but could not move them between those first lessons I created. Every time I tried to move them they went to the bottom of topic 2! I also noticed that my list of just lessons, showed those first lessons as being in the correct course display order but showed they were in Topic 2!.
*Moral: Sometimes a backup and a restore will re-establish harmony and fix things.

==What happened to my HTML code on a Lesson page?==
I had the lesson page formatted just the way I wanted by using the HTML source toggle on the tool bar. I went back in to tweak my code and some of my code was missing!
*Lesson will "clean" up your HTML code every time you toggle into HTML text. This can be frustrating, especially if you are trying to get a flash file to display just right. Save you work in a text editor, so the next time you tweak it, you can paste all your code back in.

==Students do not see content in end of branch page==
"End of Branch", "Start" and "End Cluster" pages are special navigational pages that students do not see. A teacher can see their content in edit mode but this content is never displayed to a student, nor in preview mode to the teacher. Use a different kind of page and figure out how the student will reach it via jumps at the right time.

:Moodle 2.0 uses the words "Content page", instead of "Branch Table".

==Pages are not displayed in the lesson's left menu==
The Lesson module's left menu navigation feature, only displays content (branch table) pages. If your lesson only has question pages, it will not display any pages. Use a content page before a series of question pages, so your students will know where the series starts. Alternative, use the same content page and put links to each of the question using descriptions and jumps. Remember, you can effectively have the student jump past (not view) this content page as they go through the lesson and only reach it via the left menu.

==Students are not returning to where they left the lesson==
A student has left the lesson after looking at 10 pages. The next time they return to the lesson they start at the beginning again. How can the student return to the same place?
:You have seen more than one page of this lesson already. Do you want to start at the last page you saw?

Several things must be met before this will happen. First make sure your lesson settings allow the student to retake the lesson and that this lesson is not a "practice" lesson. The important thing is that the above words are not exactly correct. They are correct only when the student left immediately after answering a question in a Lesson. For the purposes of returning to the same place, Lesson only remembers question pages as benchmarks. So lastly, make sure you have questions scattered in your Lesson for this feature to work and tell students.

:''TIPs:'' Use a content page at the start of the lesson as a table of contents, so the student are forced to remember where they are but can jump to your teaching points. Or put a question at the start or end of every "teaching point". And of course, you can tell your students how it is going to work.

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?f=333 Lesson module forum]

[[Category:FAQ]]
[[de:Lektion_FAQ]]

Lesson FAQ

2011-11-20T15:20:19Z

Rcollman: /* What is the difference between a Branch and a Branch Table? */ change this question for 2.1

{{Lesson}}
==Where were Branch Tables?==
In Moodle 2.0, the official name of a branch table page was changed to "'''Content'''" page. The documentation is slowly being changed to reflect this change. The features of this page type did not change.

==Import PowerPoint does not work==
"No data" or some other error shows up after an attempt to import.
*Please read [[Import PowerPoint]]. Most common causes:
#Complicated PowerPoint. Too many images, text boxes or fancy features.
#Wrong version of PowerPoint
#Site error - try the tested zip file at [http://tracker.moodle.org/browse/MDL-15755 Tracker.Moodle.org]

==Jumps not working in a question==
A wrong answer should go to "this page" in my lesson. But after the student answers it, the student goes to the next page.
*See adding/editing a lesson and Maximum Attempts in Lesson settings. If maximum attempt is set to 1, then the student will be advanced to the next page after they choice a wrong answer that is sent to "this page". If it is set to 2, after the student selects the wrong answer the 2nd time they will be sent to the next page. This can be used to keep the student out of an endless loop when than can not answer a question correctly.

==Edits of answers or branch buttons are not saved==
I have a 4 answer multiple choice question. I can only seem to save the first two answers, their jumps and feedback. Any edits on the last answers, their jumps and feedbacks are not saved. Moodle does not tell me there is anything wrong. Same thing happened with a Branch table, I can not seem to get the last two descriptions change after I save an edit. GRRRRR!

*Go back to your lesson settings. Maximum number of answers/branches is probably set to 2, change it to 4 or the maximum number of answers or branch descriptions in your lesson. Now the edits can be saved.
::''Tip:'' Changing the "Maximum number" as a teacher builds a lesson is a trick used to limit scrolling passed unused answers or branch choices to get to the save button. For example, 15 pages have 4 choices but one page will have 8 choices. The teacher will use "Maximum number" at 8 setting only when they initially create that page, then switch it back to 4. They (and their students) will always see all 8 answers but the lesson setting will prevent them from editing some of them.

==What is a Branch ?==
Many Moodlers call a series of pages in their lesson "'''a branch'''". Usually the student will enter the series by jumping from a page that is not directly before the "branch". Thus, a student will "branch" off the lesson path from a missed question and visit a series of pages for review before they are returned to the main lesson path again.

Lesson also have special pages that create a [[Lesson cluster]] cluster. These are also a series of page.

Confused yet? :) Maybe [[Branch structures]] will help.

==Multiple Choice and Multianswer issues==
When I check the multianswer box in a multiple choice question, it does not work. It makes random jumps and does not put the teacher's response with the students choice.

*In a Lesson module [[Lesson_module#Multiple_choice|multianswer question]], all the correct choices must have the same jump and teacher response. All the wrong choices must also have the same jump and teacher response.

==Are there some examples of Lessons I can see?==
I have been to demo.moodle and looked at the [http://demo.moodle.org/mod/lesson/view.php?id=224 Lesson section], are there more examples of Lessons used in a real course?
*[[Lesson samples]] is one place to look.

==The lesson was completed but it does not record it==
*Every lesson must have one question that a student must answer in order for it to show up in some reports. This can effect [[Grades]] and a Lesson's dependency setting (see other FAQs below).
::''Tip:'' There are lots of creative ways to put in a question, such as setting a multiple choice question so that all answers are correct and the answers act like a content (branch table) page. Or put in content and then award 1 point for "next page" as the answer, do not include the score in grades.
::''Tip:'' Due to a specific Lesson's design, some students can complete the lesson without answering one or more questions which have been placed in the Lesson. When Lesson can not record any scores for a student, no grade is pushed to the gradebook. It may appear therefore that Lesson is being inconsistent in recording grades.

==Dependency in Lesson does not work==
The second lesson tells the student they must complete the first one. They did, what is wrong?
*For dependency to work, you need to have at least 1 question page in the lesson. The student may not need a minimum score, but Lesson needs to know that the student tried a question. You can always put a question as the first or last page, You don't need to ask a question but do put in an answer of "continue" with a jump of the next page.

*Also for dependency to work, the lesson can not be a practice lesson.

==How to add sound to a lesson page==
There are some detailed instructions and options on linking to sound files.

*[[MP3_player#Inserting_sounds_into_questions|Here is the best place to look]] - adding sounds to questions.
*[[Audio in Moodle]] has an overview and tool recommendations.

==Can I turn off the answer shuffle in a lesson?==
* In short, no. Turning off the page and answer shuffle are Quiz options, but neither is found in Lesson. A minor hack to the Lesson code is possible but that would impact the entire Moodle site.
::''TIP:'' If you don't need to score students answers in a question, then consider using a Content page instead of a Multiple Choice or a True/False question.

==How can I change the default for Arrange Branch buttons horizontally? ==
I used to know, now I am clueless. Just imported 200 slides and the box is checked on every one. How can I change the default?

==Can I change standard words used by Lesson?==
*Yes. You or your site administrator can edit the language file called Lesson.php. This will impact the whole site. Your site administrator might create a language just for you, in Lesson settings use the force language option.

==Grrr something happened, lesson list is not right, I can't move things==
Try a backup and restore of your course to solve some of those "quirky" issues.
*Example: I was building a course, started adding lessons to topic 2 and then realized I should move it up to become Topic 1. Did that and continue to add lessons to topic 1, then lessons to topic 2 etc. Later I had to add lessons to topic 1. I did but could not move them between those first lessons I created. Every time I tried to move them they went to the bottom of topic 2! I also noticed that my list of just lessons, showed those first lessons as being in the correct course display order but showed they were in Topic 2!.
*Moral: Sometimes a backup and a restore will re-establish harmony and fix things.

==What happened to my HTML code on a Lesson page?==
I had the lesson page formatted just the way I wanted by using the HTML source toggle on the tool bar. I went back in to tweak my code and some of my code was missing!
*Lesson will "clean" up your HTML code every time you toggle into HTML text. This can be frustrating, especially if you are trying to get a flash file to display just right. Save you work in a text editor, so the next time you tweak it, you can paste all your code back in.

==Students do not see content in end of branch page==
"End of Branch", "Start" and "End Cluster" pages are special navigational pages that students do not see. A teacher can see their content in edit mode but this content is never displayed to a student, nor in preview mode to the teacher. Use a different kind of page and figure out how the student will reach it via jumps at the right time.

:Moodle 2.0 uses the words "Content page", instead of "Branch Table".

==Pages are not displayed in the lesson's left menu==
The Lesson module's left menu navigation feature, only displays content (branch table) pages. If your lesson only has question pages, it will not display any pages. Use a content page before a series of question pages, so your students will know where the series starts. Alternative, use the same content page and put links to each of the question using descriptions and jumps. Remember, you can effectively have the student jump past (not view) this content page as they go through the lesson and only reach it via the left menu.

==Students are not returning to where they left the lesson==
A student has left the lesson after looking at 10 pages. The next time they return to the lesson they start at the beginning again. How can the student return to the same place?
:You have seen more than one page of this lesson already. Do you want to start at the last page you saw?

Several things must be met before this will happen. First make sure your lesson settings allow the student to retake the lesson and that this lesson is not a "practice" lesson. The important thing is that the above words are not exactly correct. They are correct only when the student left immediately after answering a question in a Lesson. For the purposes of returning to the same place, Lesson only remembers question pages as benchmarks. So lastly, make sure you have questions scattered in your Lesson for this feature to work and tell students.

:''TIPs:'' Use a content page at the start of the lesson as a table of contents, so the student are forced to remember where they are but can jump to your teaching points. Or put a question at the start or end of every "teaching point". And of course, you can tell your students how it is going to work.

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?f=333 Lesson module forum]

[[Category:FAQ]]
[[de:Lektion_FAQ]]

Lesson settings

2011-11-20T15:16:05Z

Rcollman: /* Restrict access */

{{Improve}}

{{Lesson}}
This page is about lesson settings that can be changed by the teacher. Some settings maybe shown by clicking on "These settings can be changed when in a lesson by the ''[[Settings block]] > Lesson administration > Edit settings''. There are excellent help files once Lesson settings window has been open.

When creating a new lesson with the "Add activity" pull down menu, Moodle will first show the lesson settings page.

After reviewing the lesson settings and saving them, you (the teacher) will jump back to the page list with its insert, edit, move or delete potentials. See [[Building Lesson]] for more help.

== General ==
There is a "Show or Hide Advanced" toggle button(s) that is found in many other activities. Remember to click on this button to see features.

===Name===
Lesson name. HTML code will not work in this field.

===Time limit===
[[Image:Lesson Timer.png|right]]
Allows teacher to set a time limit on the lesson. Students are shown a count down counter and the time is recorded in the database. The timer does not evict a student from the lesson when the time is up, but does not score a question after the time limit reaches 0:00:00. The time in the database is checked each time a student submits a question.

===The Maximum Number of Answers / Branches in a Lesson===
This value determines the maximum number of answers the teacher can see and use when editing a lesson or a page. The default value is 12. This is a useful feature in older versions of Moodle that have no collapsed view. This value can reduce the number of screens a teacher might see in the lesson edit mode.

This parameter also sets the maximum number of buttons with descriptions and jumps that can be seen by the teacher in a Content (Branch Table) page.

It is safe to change the value of this parameter at any time. It only effects what the teacher sees, not the data. For example, a teacher starting to enter a series of multiple choice questions with 6 answers, might set this value to 6. Then when the teacher starts to enter a series of questions with 2 answers, they might set this value to 2 because they don't need to see 4 blank answers for every question in the design phase.

In a similar manner, changing the value does not effect what the student sees when they view a content page, nor does it change previous information put in by the teacher.

===Password protected===
Change to "Yes" and enter the password if you want to protect the lesson

== Grade Options ==

===Practice Lesson===
A practice lesson will not show up in the Gradebook. A practice lesson can not be a dependent lesson.

===Custom Scoring===
This will allow you to put a numerical point value on each answer in a question page. Answers may have negative values or positive values. Imported questions will automatically be assigned 1 point for correct answers and 0 for incorrect, though you may change this after the import.

===Re-takes allowed===
This setting determines whether the students can take the lesson more than once or only once. The teacher may decide that the lesson contains material which the students ought to know thoroughly. In which case repeated viewing of the lesson should be allowed. If, however, the material is used more like an exam then the students should not be allowed to re-take the lesson.

===Handling of re-takes===
When the students are allowed to re-take the lesson, the grades shown in the Grades page are either their average grade over the re-takes or their best grade for the lesson. The next parameter determines which of these two grading alternatives is used.

:Note that the Question Analysis always uses the answers from the first tries of the lesson, subsequent re-takes by students are ignored.

===Display ongoing score===
This setting will allow the student to see their current score.

== Flow Control ==
Please see [[Using_Lesson#Some_Flow_control_scenarios_.26_their_implications|Some flow control scenarios]] for some examples that use these settings.
===Allow Student Review===
This will place a "Review Lesson" button on the last screen of the lesson to encourage the student to navigate through the lesson again from the start. Be sure to check other settings to allow them to change their answers.

===Display Review Button===
This will display a button after an incorrectly answered question, allowing a student to re-attempt it.

:''TIP:'' It is not compatible with essay questions, so leave this off if you are using essay questions. Sometimes this setting will override any "display default feedback" lesson setting, where the default feedback will always be displayed when the review button is shown.

===The Maximum Number of Attempts (by a Student)===
This value determines the maximum number of attempts a student (not a teacher) will have to answer any question in the lesson. Once reached, the student will not see the question again.

The default value is 5. Smaller values may discourage the student from trying different answers about a question. Larger values may lead to frustration when the student "does not get it". For example with a short answer or numerical question, the student is not given an opportunity to try different answer choices. This value provides an escape route to the next page in the lesson.

Setting this value to 1 gives the students just single chance to answer each question. This would be similar to a question in the Quiz module.

:''Note:'' this value is student global parameter and that it applies to all the questions in the lesson regardless of their type. However it does not apply to teachers checking of questions or navigating through the lesson. Checking the number of attempts relies on values stored in the database and question attempts by teachers are not recorded. The teacher should after all know the answers! So teachers should switch their roles to that of a student to observe this feature.

===Action after correct answer===
"Normal", "Show unseen", "Show unanswered"

====Action after a Correct Answer====
The usual action is to follow the jump as specified in the answer. In most cases this will probably show the Next Page of the lesson. The student is taken through the lesson in a logical way, beginning at the start and ending at the end. (In 2.0 this is an Advanced feature.)

However, the lesson module can also be used as a type of Flash Card assignment. The student is shown some information (optional) and a question in basically a random order. There is no set beginning and no set end. Just a set of Cards shown one after another in no particular order.

This option allows two very similar variants of Slide show (Flash Card) behavior. The option "Show an unseen page" never shows the same page twice (even if the student did not answer the question associated with the Card/Page correctly). The other non-default option "Show an unanswered page" allows the student to see pages that may have appeared before but only if they answered the associated question wrongly.

In either of these Flash Card-type lessons the teacher can decide to use either all the Cards/Pages in the lesson or just a (random) sub-set. This is done through the "Number of Pages (Cards) to show" parameter.

'''If you want a student to be taken directly from one question to the next irrespective of their answer being correct or incorrect''': in the Lesson Settings, set Maximum number of attempts: to 1. Please note, however, that a message "correct / incorrect" will still be displayed to the student upon answering each question. If you do not want this (default) feedback message to be displayed then enter your own feedback message (i.e. "continue", "---", etc.) In case you want no visible message displayed then enter a non-breaking space as feedback, so you'll have to put a # after the answer which may be ~3 and write & n b s p ; after that.(without spaces between these characters) To find out how Moodle works - you may export a sample of your questions with GIFT and check them out!

===Display default feedback ===

Feedback to a specific answer to a question can appear on the next page after the student makes a choice and submits it. The question, the student's answer and the feedback appear on a page with a continue button at the bottom. This lesson setting controls what appears as the feedback response and if the page appears at all.

When this option is set to Yes, the standard default response will appear. In most lessons, when this is set to yes, Lesson first looks for the teachers custom feedback and if it does not find one, will put in the default feedback. It is possible to change the words used in the standard [[Language editing|default feedbacks]] for the entire Moodle Site.

Selecting No, will only show the teacher's supplied feedbacks for each specific answer. If the teacher has not entered a response for a specific answer, then the feedback page is not displayed and the student will immediately go to the page that the specific answer's jump is set to.

:''TIP:'' Under some versions of Moodle, other lesson settings may cause the default feedback to appear, even when the teacher has supplied their own feedback. Changing the "Review button" lesson setting to "No" will show the teachers custom feedback.

===Progress bar===
A simple bar at the bottom of the lesson which will give an approximate percentage of completion. Since lessons vary greatly in their navigation, this works best with lesson that follow the logical order and do not jump around.

:''Tip:'' While calculating the percent completed, Content and Question pages that are answered correctly count toward Lesson progress. While calculating the total number of pages in the Lesson, clusters and pages within clusters only count as a single page and End of Cluster and End of Branch Table pages are excluded. All other pages count toward the total number of pages in the Lesson.

===Display left menu options===
This will show a list of the pages (Branch Tables) in the lesson. Question pages, cluster pages, etc. will not be shown by default (you may choose to show question pages by checking that option on the question).

By setting a grade greater than 0, the user taking the Lesson must have a grade equal to or greater than the grade set in order to view the Left Menu. This allows Lesson designers to force users to go through the entire lesson during the user's first attempt. Then, if a user retakes the Lesson after meeting the required grade, s/he can see the Left Menu to help with review.

=== Minimum Number of Questions ===
This value determines the '''minimum''' number of questions that will be used to calculate a student's score. It does not force students to answer that many questions in the lesson. When a lesson contains one or more [[Adding a branch table| branches]], the teacher should normally set this parameter.

:For example, setting this parameter to 20, will ensure that grades are given as though the students have seen at least this number of questions. Take the case of a student who only looks at a single branch in a lesson with 5 pages and answers all the associated questions correctly. This student then choose to end the lesson (assuming there is that option in the "top level"Branch Table, a reasonable enough assumption). If this parameter was set to 0 their grade would be 5 out of 5, that is 100%. However, with it set to 20 their grade would be reduced to 5 out of 20, that is 25%. In the case of another student who goes through all the branches and sees, say, 25 pages and answers all but two of the questions correctly, then their grade would be 23 out of 25, that is 92%.

If this parameter is used, the teacher might want to add a statement on the opening page of the lesson. For example, if the teacher set the value to 20 they might say:

:In this lesson you are expected to attempt at least ''20'' questions. You can attempt more if you wish. However, if you attempt less than ''20'' questions your grade will be calculated as though you attempted ''20''.

When this parameter is set to a value more than 0, students are told how many questions they have attempted and how many they are expected to attempt.

===Number of Pages to Show===
This setting only works when "Action after correct answer" is set to "Show an unseen page" or "Show an unanswered page". Lesson will then show a specific number of random pages to a student. For example, setting this to 10, will show 10 random pages and then bring the student to the end of the lesson with their grade. (In 2.0 this is an Advanced feature.)

If this parameter is set to a number greater than the number of pages in the lesson then the end of the lesson is reached when all the pages have been shown. When set to the default of 0 (zero), all pages are shown.

===Slideshow===
This enables the display of the lesson as a slide show, with a fixed width, height, and custom background color. A CSS based scroll bar will be displayed if the width or height of the slide is exceeded by the content of a page. Questions will 'break out' of the slide show mode, only content (branch tables) pages will be shown in a slide by default. Buttons labeled with the default for "Next" and "Previous" will be shown at the far right and left of the slide if that option is chosen on the page. Other buttons will be centered below the slide. You can also decide on the width, height and the background colour of the slide show. See site administration settings below for more information.

===Link to an activity===
You may pick another activity link that will appear on the end of lesson page that shows the student their score.

==Pop-up to file or web page==
At the start of the lesson, this creates a popup window. For example this might be a music file, an agreement or text which the student can refer while in the lesson.See site administration settings below concerning width and height.

== Dependent on ==
A lesson can be dependent upon another lesson. There are 3 possible dependencies which can be use separately or in combination with each other. Time Spent (minutes) refers to how long the student was in the lesson on their last attempt (it is not cumulative). Completed means the student has attempted one question. Grade as a percentage of a specific lesson means just that.

:''Note:'' This feature was developed before but is similar to the site wide "Restrict access" feature below.

:''TIP:'' When dependency does not seem to work when it is set to "Completed" on another lesson, you must have a question for lesson to recognize that it is complete. Put a multiple choice question at the end of the lesson and ask: "In this lesson you learned A, B, and C." Do not put in an answer or a jump. The student will see "Continue" at the end and go to the end of the lesson and fulfill the requirement of completing the lesson. The dependent on lesson can not be a practice lesson.

==Common module settings==

*Groupings: Groups must be turned on in the course
*Available for groups only check box (advanced)
*Visible (moved from Access Control section)
*ID number
*Grade category

==Restrict access==
This group of settings will show when the site administrator has activated two advanced settings in Site administration > Advanced settings. For more information see:
*[[Completion tracking]] = marks activity complete based upon criterion.
*[[Conditional activities]] - controls entry into the lesson based upon criterion.

==Site administration settings==

The lesson module has additional settings which may be changed by an administrator in ''Settings > Site administration > Plugins > Activity modules > Lesson''.

===Slideshow width===
Sets the width of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowwidth, Default 640.

===Slideshow height===
Sets the height of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowheight, Default 480.

===Slideshow background colour===
Background colour to for the slideshow if it is enabled.
*Variable name: lesson_slideshowbgcolor, Default #FFFFFF.

===Popup window width===
Sets the width of the popup displayed for a linked media file
*Variable name: lesson_mediawidth, Default 640.

===Popup window height===
Sets the height of the popup displayed for a linked media file
*Variable name: lesson_mediaheight, Default 480.

===Show close button:===
Displays a close button as part of the popup generated for a linked media file
*Variable name: lesson_mediaclose, Default No.

===Number of high scores displayed===
Sets the number of high scores to display
*Variable name: lesson_maxhighscores, Default: 10

===Maximum number of answers/branches===
Default maximum number of answers/branches per page for site
*Variable name: lesson_maxanswers, Default: 4.

===Action after correct answer===
The default action to take after a correct answer
*Variable name: lesson_defaultnextpage, Default: Normal - follow lesson path

==See also==
*[http://www.youtube.com/watch?v=4xjXelUZguw Creating a Lesson video tutorial]
*[[Lesson defaults]] - site wide defaults in Moodle 2.0

[[fr:Ajouter/modifier une leçon]]
[[de:Lektion_anlegen]]

Lesson settings

2011-11-20T15:13:39Z

Rcollman: /* Restrict access, Activity completion settings */ change group name, reformat info put links

{{Improve}}

{{Lesson}}
This page is about lesson settings that can be changed by the teacher. Some settings maybe shown by clicking on "These settings can be changed when in a lesson by the ''[[Settings block]] > Lesson administration > Edit settings''. There are excellent help files once Lesson settings window has been open.

When creating a new lesson with the "Add activity" pull down menu, Moodle will first show the lesson settings page.

After reviewing the lesson settings and saving them, you (the teacher) will jump back to the page list with its insert, edit, move or delete potentials. See [[Building Lesson]] for more help.

== General ==
There is a "Show or Hide Advanced" toggle button(s) that is found in many other activities. Remember to click on this button to see features.

===Name===
Lesson name. HTML code will not work in this field.

===Time limit===
[[Image:Lesson Timer.png|right]]
Allows teacher to set a time limit on the lesson. Students are shown a count down counter and the time is recorded in the database. The timer does not evict a student from the lesson when the time is up, but does not score a question after the time limit reaches 0:00:00. The time in the database is checked each time a student submits a question.

===The Maximum Number of Answers / Branches in a Lesson===
This value determines the maximum number of answers the teacher can see and use when editing a lesson or a page. The default value is 12. This is a useful feature in older versions of Moodle that have no collapsed view. This value can reduce the number of screens a teacher might see in the lesson edit mode.

This parameter also sets the maximum number of buttons with descriptions and jumps that can be seen by the teacher in a Content (Branch Table) page.

It is safe to change the value of this parameter at any time. It only effects what the teacher sees, not the data. For example, a teacher starting to enter a series of multiple choice questions with 6 answers, might set this value to 6. Then when the teacher starts to enter a series of questions with 2 answers, they might set this value to 2 because they don't need to see 4 blank answers for every question in the design phase.

In a similar manner, changing the value does not effect what the student sees when they view a content page, nor does it change previous information put in by the teacher.

===Password protected===
Change to "Yes" and enter the password if you want to protect the lesson

== Grade Options ==

===Practice Lesson===
A practice lesson will not show up in the Gradebook. A practice lesson can not be a dependent lesson.

===Custom Scoring===
This will allow you to put a numerical point value on each answer in a question page. Answers may have negative values or positive values. Imported questions will automatically be assigned 1 point for correct answers and 0 for incorrect, though you may change this after the import.

===Re-takes allowed===
This setting determines whether the students can take the lesson more than once or only once. The teacher may decide that the lesson contains material which the students ought to know thoroughly. In which case repeated viewing of the lesson should be allowed. If, however, the material is used more like an exam then the students should not be allowed to re-take the lesson.

===Handling of re-takes===
When the students are allowed to re-take the lesson, the grades shown in the Grades page are either their average grade over the re-takes or their best grade for the lesson. The next parameter determines which of these two grading alternatives is used.

:Note that the Question Analysis always uses the answers from the first tries of the lesson, subsequent re-takes by students are ignored.

===Display ongoing score===
This setting will allow the student to see their current score.

== Flow Control ==
Please see [[Using_Lesson#Some_Flow_control_scenarios_.26_their_implications|Some flow control scenarios]] for some examples that use these settings.
===Allow Student Review===
This will place a "Review Lesson" button on the last screen of the lesson to encourage the student to navigate through the lesson again from the start. Be sure to check other settings to allow them to change their answers.

===Display Review Button===
This will display a button after an incorrectly answered question, allowing a student to re-attempt it.

:''TIP:'' It is not compatible with essay questions, so leave this off if you are using essay questions. Sometimes this setting will override any "display default feedback" lesson setting, where the default feedback will always be displayed when the review button is shown.

===The Maximum Number of Attempts (by a Student)===
This value determines the maximum number of attempts a student (not a teacher) will have to answer any question in the lesson. Once reached, the student will not see the question again.

The default value is 5. Smaller values may discourage the student from trying different answers about a question. Larger values may lead to frustration when the student "does not get it". For example with a short answer or numerical question, the student is not given an opportunity to try different answer choices. This value provides an escape route to the next page in the lesson.

Setting this value to 1 gives the students just single chance to answer each question. This would be similar to a question in the Quiz module.

:''Note:'' this value is student global parameter and that it applies to all the questions in the lesson regardless of their type. However it does not apply to teachers checking of questions or navigating through the lesson. Checking the number of attempts relies on values stored in the database and question attempts by teachers are not recorded. The teacher should after all know the answers! So teachers should switch their roles to that of a student to observe this feature.

===Action after correct answer===
"Normal", "Show unseen", "Show unanswered"

====Action after a Correct Answer====
The usual action is to follow the jump as specified in the answer. In most cases this will probably show the Next Page of the lesson. The student is taken through the lesson in a logical way, beginning at the start and ending at the end. (In 2.0 this is an Advanced feature.)

However, the lesson module can also be used as a type of Flash Card assignment. The student is shown some information (optional) and a question in basically a random order. There is no set beginning and no set end. Just a set of Cards shown one after another in no particular order.

This option allows two very similar variants of Slide show (Flash Card) behavior. The option "Show an unseen page" never shows the same page twice (even if the student did not answer the question associated with the Card/Page correctly). The other non-default option "Show an unanswered page" allows the student to see pages that may have appeared before but only if they answered the associated question wrongly.

In either of these Flash Card-type lessons the teacher can decide to use either all the Cards/Pages in the lesson or just a (random) sub-set. This is done through the "Number of Pages (Cards) to show" parameter.

'''If you want a student to be taken directly from one question to the next irrespective of their answer being correct or incorrect''': in the Lesson Settings, set Maximum number of attempts: to 1. Please note, however, that a message "correct / incorrect" will still be displayed to the student upon answering each question. If you do not want this (default) feedback message to be displayed then enter your own feedback message (i.e. "continue", "---", etc.) In case you want no visible message displayed then enter a non-breaking space as feedback, so you'll have to put a # after the answer which may be ~3 and write & n b s p ; after that.(without spaces between these characters) To find out how Moodle works - you may export a sample of your questions with GIFT and check them out!

===Display default feedback ===

Feedback to a specific answer to a question can appear on the next page after the student makes a choice and submits it. The question, the student's answer and the feedback appear on a page with a continue button at the bottom. This lesson setting controls what appears as the feedback response and if the page appears at all.

When this option is set to Yes, the standard default response will appear. In most lessons, when this is set to yes, Lesson first looks for the teachers custom feedback and if it does not find one, will put in the default feedback. It is possible to change the words used in the standard [[Language editing|default feedbacks]] for the entire Moodle Site.

Selecting No, will only show the teacher's supplied feedbacks for each specific answer. If the teacher has not entered a response for a specific answer, then the feedback page is not displayed and the student will immediately go to the page that the specific answer's jump is set to.

:''TIP:'' Under some versions of Moodle, other lesson settings may cause the default feedback to appear, even when the teacher has supplied their own feedback. Changing the "Review button" lesson setting to "No" will show the teachers custom feedback.

===Progress bar===
A simple bar at the bottom of the lesson which will give an approximate percentage of completion. Since lessons vary greatly in their navigation, this works best with lesson that follow the logical order and do not jump around.

:''Tip:'' While calculating the percent completed, Content and Question pages that are answered correctly count toward Lesson progress. While calculating the total number of pages in the Lesson, clusters and pages within clusters only count as a single page and End of Cluster and End of Branch Table pages are excluded. All other pages count toward the total number of pages in the Lesson.

===Display left menu options===
This will show a list of the pages (Branch Tables) in the lesson. Question pages, cluster pages, etc. will not be shown by default (you may choose to show question pages by checking that option on the question).

By setting a grade greater than 0, the user taking the Lesson must have a grade equal to or greater than the grade set in order to view the Left Menu. This allows Lesson designers to force users to go through the entire lesson during the user's first attempt. Then, if a user retakes the Lesson after meeting the required grade, s/he can see the Left Menu to help with review.

=== Minimum Number of Questions ===
This value determines the '''minimum''' number of questions that will be used to calculate a student's score. It does not force students to answer that many questions in the lesson. When a lesson contains one or more [[Adding a branch table| branches]], the teacher should normally set this parameter.

:For example, setting this parameter to 20, will ensure that grades are given as though the students have seen at least this number of questions. Take the case of a student who only looks at a single branch in a lesson with 5 pages and answers all the associated questions correctly. This student then choose to end the lesson (assuming there is that option in the "top level"Branch Table, a reasonable enough assumption). If this parameter was set to 0 their grade would be 5 out of 5, that is 100%. However, with it set to 20 their grade would be reduced to 5 out of 20, that is 25%. In the case of another student who goes through all the branches and sees, say, 25 pages and answers all but two of the questions correctly, then their grade would be 23 out of 25, that is 92%.

If this parameter is used, the teacher might want to add a statement on the opening page of the lesson. For example, if the teacher set the value to 20 they might say:

:In this lesson you are expected to attempt at least ''20'' questions. You can attempt more if you wish. However, if you attempt less than ''20'' questions your grade will be calculated as though you attempted ''20''.

When this parameter is set to a value more than 0, students are told how many questions they have attempted and how many they are expected to attempt.

===Number of Pages to Show===
This setting only works when "Action after correct answer" is set to "Show an unseen page" or "Show an unanswered page". Lesson will then show a specific number of random pages to a student. For example, setting this to 10, will show 10 random pages and then bring the student to the end of the lesson with their grade. (In 2.0 this is an Advanced feature.)

If this parameter is set to a number greater than the number of pages in the lesson then the end of the lesson is reached when all the pages have been shown. When set to the default of 0 (zero), all pages are shown.

===Slideshow===
This enables the display of the lesson as a slide show, with a fixed width, height, and custom background color. A CSS based scroll bar will be displayed if the width or height of the slide is exceeded by the content of a page. Questions will 'break out' of the slide show mode, only content (branch tables) pages will be shown in a slide by default. Buttons labeled with the default for "Next" and "Previous" will be shown at the far right and left of the slide if that option is chosen on the page. Other buttons will be centered below the slide. You can also decide on the width, height and the background colour of the slide show. See site administration settings below for more information.

===Link to an activity===
You may pick another activity link that will appear on the end of lesson page that shows the student their score.

==Pop-up to file or web page==
At the start of the lesson, this creates a popup window. For example this might be a music file, an agreement or text which the student can refer while in the lesson.See site administration settings below concerning width and height.

== Dependent on ==
A lesson can be dependent upon another lesson. There are 3 possible dependencies which can be use separately or in combination with each other. Time Spent (minutes) refers to how long the student was in the lesson on their last attempt (it is not cumulative). Completed means the student has attempted one question. Grade as a percentage of a specific lesson means just that.

:''Note:'' This feature was developed before but is similar to the site wide "Restrict access" feature below.

:''TIP:'' When dependency does not seem to work when it is set to "Completed" on another lesson, you must have a question for lesson to recognize that it is complete. Put a multiple choice question at the end of the lesson and ask: "In this lesson you learned A, B, and C." Do not put in an answer or a jump. The student will see "Continue" at the end and go to the end of the lesson and fulfill the requirement of completing the lesson. The dependent on lesson can not be a practice lesson.

==Common module settings==

*Groupings: Groups must be turned on in the course
*Available for groups only check box (advanced)
*Visible (moved from Access Control section)
*ID number
*Grade category

==Restrict access==
This group of settings will show when the site administrator has activated two advanced settings in Site administration > Advanced settings. For more information see:
*[[Completion tracking]] = marks activity complete based upon criterion.
*[[Conditional access]] - controls entry into the lesson based upon criterion.

==Site administration settings==

The lesson module has additional settings which may be changed by an administrator in ''Settings > Site administration > Plugins > Activity modules > Lesson''.

===Slideshow width===
Sets the width of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowwidth, Default 640.

===Slideshow height===
Sets the height of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowheight, Default 480.

===Slideshow background colour===
Background colour to for the slideshow if it is enabled.
*Variable name: lesson_slideshowbgcolor, Default #FFFFFF.

===Popup window width===
Sets the width of the popup displayed for a linked media file
*Variable name: lesson_mediawidth, Default 640.

===Popup window height===
Sets the height of the popup displayed for a linked media file
*Variable name: lesson_mediaheight, Default 480.

===Show close button:===
Displays a close button as part of the popup generated for a linked media file
*Variable name: lesson_mediaclose, Default No.

===Number of high scores displayed===
Sets the number of high scores to display
*Variable name: lesson_maxhighscores, Default: 10

===Maximum number of answers/branches===
Default maximum number of answers/branches per page for site
*Variable name: lesson_maxanswers, Default: 4.

===Action after correct answer===
The default action to take after a correct answer
*Variable name: lesson_defaultnextpage, Default: Normal - follow lesson path

==See also==
*[http://www.youtube.com/watch?v=4xjXelUZguw Creating a Lesson video tutorial]
*[[Lesson defaults]] - site wide defaults in Moodle 2.0

[[fr:Ajouter/modifier une leçon]]
[[de:Lektion_anlegen]]

Lesson settings

2011-11-20T15:07:51Z

Rcollman: /* Dependent on */ caution, similar to restrict access

{{Improve}}

{{Lesson}}
This page is about lesson settings that can be changed by the teacher. Some settings maybe shown by clicking on "These settings can be changed when in a lesson by the ''[[Settings block]] > Lesson administration > Edit settings''. There are excellent help files once Lesson settings window has been open.

When creating a new lesson with the "Add activity" pull down menu, Moodle will first show the lesson settings page.

After reviewing the lesson settings and saving them, you (the teacher) will jump back to the page list with its insert, edit, move or delete potentials. See [[Building Lesson]] for more help.

== General ==
There is a "Show or Hide Advanced" toggle button(s) that is found in many other activities. Remember to click on this button to see features.

===Name===
Lesson name. HTML code will not work in this field.

===Time limit===
[[Image:Lesson Timer.png|right]]
Allows teacher to set a time limit on the lesson. Students are shown a count down counter and the time is recorded in the database. The timer does not evict a student from the lesson when the time is up, but does not score a question after the time limit reaches 0:00:00. The time in the database is checked each time a student submits a question.

===The Maximum Number of Answers / Branches in a Lesson===
This value determines the maximum number of answers the teacher can see and use when editing a lesson or a page. The default value is 12. This is a useful feature in older versions of Moodle that have no collapsed view. This value can reduce the number of screens a teacher might see in the lesson edit mode.

This parameter also sets the maximum number of buttons with descriptions and jumps that can be seen by the teacher in a Content (Branch Table) page.

It is safe to change the value of this parameter at any time. It only effects what the teacher sees, not the data. For example, a teacher starting to enter a series of multiple choice questions with 6 answers, might set this value to 6. Then when the teacher starts to enter a series of questions with 2 answers, they might set this value to 2 because they don't need to see 4 blank answers for every question in the design phase.

In a similar manner, changing the value does not effect what the student sees when they view a content page, nor does it change previous information put in by the teacher.

===Password protected===
Change to "Yes" and enter the password if you want to protect the lesson

== Grade Options ==

===Practice Lesson===
A practice lesson will not show up in the Gradebook. A practice lesson can not be a dependent lesson.

===Custom Scoring===
This will allow you to put a numerical point value on each answer in a question page. Answers may have negative values or positive values. Imported questions will automatically be assigned 1 point for correct answers and 0 for incorrect, though you may change this after the import.

===Re-takes allowed===
This setting determines whether the students can take the lesson more than once or only once. The teacher may decide that the lesson contains material which the students ought to know thoroughly. In which case repeated viewing of the lesson should be allowed. If, however, the material is used more like an exam then the students should not be allowed to re-take the lesson.

===Handling of re-takes===
When the students are allowed to re-take the lesson, the grades shown in the Grades page are either their average grade over the re-takes or their best grade for the lesson. The next parameter determines which of these two grading alternatives is used.

:Note that the Question Analysis always uses the answers from the first tries of the lesson, subsequent re-takes by students are ignored.

===Display ongoing score===
This setting will allow the student to see their current score.

== Flow Control ==
Please see [[Using_Lesson#Some_Flow_control_scenarios_.26_their_implications|Some flow control scenarios]] for some examples that use these settings.
===Allow Student Review===
This will place a "Review Lesson" button on the last screen of the lesson to encourage the student to navigate through the lesson again from the start. Be sure to check other settings to allow them to change their answers.

===Display Review Button===
This will display a button after an incorrectly answered question, allowing a student to re-attempt it.

:''TIP:'' It is not compatible with essay questions, so leave this off if you are using essay questions. Sometimes this setting will override any "display default feedback" lesson setting, where the default feedback will always be displayed when the review button is shown.

===The Maximum Number of Attempts (by a Student)===
This value determines the maximum number of attempts a student (not a teacher) will have to answer any question in the lesson. Once reached, the student will not see the question again.

The default value is 5. Smaller values may discourage the student from trying different answers about a question. Larger values may lead to frustration when the student "does not get it". For example with a short answer or numerical question, the student is not given an opportunity to try different answer choices. This value provides an escape route to the next page in the lesson.

Setting this value to 1 gives the students just single chance to answer each question. This would be similar to a question in the Quiz module.

:''Note:'' this value is student global parameter and that it applies to all the questions in the lesson regardless of their type. However it does not apply to teachers checking of questions or navigating through the lesson. Checking the number of attempts relies on values stored in the database and question attempts by teachers are not recorded. The teacher should after all know the answers! So teachers should switch their roles to that of a student to observe this feature.

===Action after correct answer===
"Normal", "Show unseen", "Show unanswered"

====Action after a Correct Answer====
The usual action is to follow the jump as specified in the answer. In most cases this will probably show the Next Page of the lesson. The student is taken through the lesson in a logical way, beginning at the start and ending at the end. (In 2.0 this is an Advanced feature.)

However, the lesson module can also be used as a type of Flash Card assignment. The student is shown some information (optional) and a question in basically a random order. There is no set beginning and no set end. Just a set of Cards shown one after another in no particular order.

This option allows two very similar variants of Slide show (Flash Card) behavior. The option "Show an unseen page" never shows the same page twice (even if the student did not answer the question associated with the Card/Page correctly). The other non-default option "Show an unanswered page" allows the student to see pages that may have appeared before but only if they answered the associated question wrongly.

In either of these Flash Card-type lessons the teacher can decide to use either all the Cards/Pages in the lesson or just a (random) sub-set. This is done through the "Number of Pages (Cards) to show" parameter.

'''If you want a student to be taken directly from one question to the next irrespective of their answer being correct or incorrect''': in the Lesson Settings, set Maximum number of attempts: to 1. Please note, however, that a message "correct / incorrect" will still be displayed to the student upon answering each question. If you do not want this (default) feedback message to be displayed then enter your own feedback message (i.e. "continue", "---", etc.) In case you want no visible message displayed then enter a non-breaking space as feedback, so you'll have to put a # after the answer which may be ~3 and write & n b s p ; after that.(without spaces between these characters) To find out how Moodle works - you may export a sample of your questions with GIFT and check them out!

===Display default feedback ===

Feedback to a specific answer to a question can appear on the next page after the student makes a choice and submits it. The question, the student's answer and the feedback appear on a page with a continue button at the bottom. This lesson setting controls what appears as the feedback response and if the page appears at all.

When this option is set to Yes, the standard default response will appear. In most lessons, when this is set to yes, Lesson first looks for the teachers custom feedback and if it does not find one, will put in the default feedback. It is possible to change the words used in the standard [[Language editing|default feedbacks]] for the entire Moodle Site.

Selecting No, will only show the teacher's supplied feedbacks for each specific answer. If the teacher has not entered a response for a specific answer, then the feedback page is not displayed and the student will immediately go to the page that the specific answer's jump is set to.

:''TIP:'' Under some versions of Moodle, other lesson settings may cause the default feedback to appear, even when the teacher has supplied their own feedback. Changing the "Review button" lesson setting to "No" will show the teachers custom feedback.

===Progress bar===
A simple bar at the bottom of the lesson which will give an approximate percentage of completion. Since lessons vary greatly in their navigation, this works best with lesson that follow the logical order and do not jump around.

:''Tip:'' While calculating the percent completed, Content and Question pages that are answered correctly count toward Lesson progress. While calculating the total number of pages in the Lesson, clusters and pages within clusters only count as a single page and End of Cluster and End of Branch Table pages are excluded. All other pages count toward the total number of pages in the Lesson.

===Display left menu options===
This will show a list of the pages (Branch Tables) in the lesson. Question pages, cluster pages, etc. will not be shown by default (you may choose to show question pages by checking that option on the question).

By setting a grade greater than 0, the user taking the Lesson must have a grade equal to or greater than the grade set in order to view the Left Menu. This allows Lesson designers to force users to go through the entire lesson during the user's first attempt. Then, if a user retakes the Lesson after meeting the required grade, s/he can see the Left Menu to help with review.

=== Minimum Number of Questions ===
This value determines the '''minimum''' number of questions that will be used to calculate a student's score. It does not force students to answer that many questions in the lesson. When a lesson contains one or more [[Adding a branch table| branches]], the teacher should normally set this parameter.

:For example, setting this parameter to 20, will ensure that grades are given as though the students have seen at least this number of questions. Take the case of a student who only looks at a single branch in a lesson with 5 pages and answers all the associated questions correctly. This student then choose to end the lesson (assuming there is that option in the "top level"Branch Table, a reasonable enough assumption). If this parameter was set to 0 their grade would be 5 out of 5, that is 100%. However, with it set to 20 their grade would be reduced to 5 out of 20, that is 25%. In the case of another student who goes through all the branches and sees, say, 25 pages and answers all but two of the questions correctly, then their grade would be 23 out of 25, that is 92%.

If this parameter is used, the teacher might want to add a statement on the opening page of the lesson. For example, if the teacher set the value to 20 they might say:

:In this lesson you are expected to attempt at least ''20'' questions. You can attempt more if you wish. However, if you attempt less than ''20'' questions your grade will be calculated as though you attempted ''20''.

When this parameter is set to a value more than 0, students are told how many questions they have attempted and how many they are expected to attempt.

===Number of Pages to Show===
This setting only works when "Action after correct answer" is set to "Show an unseen page" or "Show an unanswered page". Lesson will then show a specific number of random pages to a student. For example, setting this to 10, will show 10 random pages and then bring the student to the end of the lesson with their grade. (In 2.0 this is an Advanced feature.)

If this parameter is set to a number greater than the number of pages in the lesson then the end of the lesson is reached when all the pages have been shown. When set to the default of 0 (zero), all pages are shown.

===Slideshow===
This enables the display of the lesson as a slide show, with a fixed width, height, and custom background color. A CSS based scroll bar will be displayed if the width or height of the slide is exceeded by the content of a page. Questions will 'break out' of the slide show mode, only content (branch tables) pages will be shown in a slide by default. Buttons labeled with the default for "Next" and "Previous" will be shown at the far right and left of the slide if that option is chosen on the page. Other buttons will be centered below the slide. You can also decide on the width, height and the background colour of the slide show. See site administration settings below for more information.

===Link to an activity===
You may pick another activity link that will appear on the end of lesson page that shows the student their score.

==Pop-up to file or web page==
At the start of the lesson, this creates a popup window. For example this might be a music file, an agreement or text which the student can refer while in the lesson.See site administration settings below concerning width and height.

== Dependent on ==
A lesson can be dependent upon another lesson. There are 3 possible dependencies which can be use separately or in combination with each other. Time Spent (minutes) refers to how long the student was in the lesson on their last attempt (it is not cumulative). Completed means the student has attempted one question. Grade as a percentage of a specific lesson means just that.

:''Note:'' This feature was developed before but is similar to the site wide "Restrict access" feature below.

:''TIP:'' When dependency does not seem to work when it is set to "Completed" on another lesson, you must have a question for lesson to recognize that it is complete. Put a multiple choice question at the end of the lesson and ask: "In this lesson you learned A, B, and C." Do not put in an answer or a jump. The student will see "Continue" at the end and go to the end of the lesson and fulfill the requirement of completing the lesson. The dependent on lesson can not be a practice lesson.

==Common module settings==

*Groupings: Groups must be turned on in the course
*Available for groups only check box (advanced)
*Visible (moved from Access Control section)
*ID number
*Grade category

==Restrict access, Activity completion settings==
If the site administrator has enabled [[Completion tracking]] (and the teacher has enabled [[Student review]] in the course) you will see "Activity completion" settings. If the site administrator has enable [[Conditional access] on the site, then you will see the [[Restrict access settings]].

==Site administration settings==

The lesson module has additional settings which may be changed by an administrator in ''Settings > Site administration > Plugins > Activity modules > Lesson''.

===Slideshow width===
Sets the width of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowwidth, Default 640.

===Slideshow height===
Sets the height of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowheight, Default 480.

===Slideshow background colour===
Background colour to for the slideshow if it is enabled.
*Variable name: lesson_slideshowbgcolor, Default #FFFFFF.

===Popup window width===
Sets the width of the popup displayed for a linked media file
*Variable name: lesson_mediawidth, Default 640.

===Popup window height===
Sets the height of the popup displayed for a linked media file
*Variable name: lesson_mediaheight, Default 480.

===Show close button:===
Displays a close button as part of the popup generated for a linked media file
*Variable name: lesson_mediaclose, Default No.

===Number of high scores displayed===
Sets the number of high scores to display
*Variable name: lesson_maxhighscores, Default: 10

===Maximum number of answers/branches===
Default maximum number of answers/branches per page for site
*Variable name: lesson_maxanswers, Default: 4.

===Action after correct answer===
The default action to take after a correct answer
*Variable name: lesson_defaultnextpage, Default: Normal - follow lesson path

==See also==
*[http://www.youtube.com/watch?v=4xjXelUZguw Creating a Lesson video tutorial]
*[[Lesson defaults]] - site wide defaults in Moodle 2.0

[[fr:Ajouter/modifier une leçon]]
[[de:Lektion_anlegen]]

User talk:Helen Foster

2011-11-20T14:58:55Z

Rcollman: Cron?

==Cron==
Hi Helen. First to comment in 2.1 ! Do you and/or Eloy like what I am proposing for [[Cron]]? --[[User:chris collman|chris collman]] 22:58, 20 November 2011 (WST)

Certificate reports

2011-11-19T18:52:26Z

Rcollman: /* View and download certificate reports */

Certificate reports

2011-11-19T18:52:05Z

Rcollman: /* Site wide reports */

Certificate reports

2011-11-19T18:51:35Z

Rcollman:

Certificate reports

2011-11-19T18:48:02Z

Rcollman: /* Site wide reports */ post link for 2.1 version

{{Certificate}}
A teacher can view and download a report of all certificates issued in their course.

==View and download certificate reports==
{{Update}}
The teacher can see a list of all certificates by clicking on the course homepage certificate link. Then selecting the view certificates link in the upper right corner. This will present a list of certificates, showing student name, grade, and code.
If the certificate administration edit settings was set to save, they can download a copy of the certificate for a students.

This page also allows an option of downloading the report in 1 of 3 formates.
==Site wide reports==
A version of site wide reports is aavailable in 2.1.
*[http://www.KindleeBooksLibrary.com/report_my_certificates_2_1.zip Kaalgat provided this link] in the Certificate forum.

:In 1.9.x versions there was an optional block that provided a link to a report visible to administrators and students. Students could see of all their certificates on the site. Administrators (or those who have the capability of viewing site reports) will see a link on the Certificate Report page to view/download a report of all students' received certificates.

Talk:Cron

2011-11-19T16:36:18Z

Rcollman: Reminder to change MoodleDocs 2.0 as well

Comment from Eloy:

"If there is some template to mark one page as "require some love" I'd say https://docs.moodle.org/en/Cron requires it. It talks 99% of the time to use web-browser cron. Only 1 line talks about cli cron." --[[User:Helen Foster|Helen Foster]] 20:44, 9 November 2011 (WST)
:I just noticed this comment. Cron is not one of my special areas of knowledge but obviously use it. Did a quick "Cron CLI" on the web and got lost in how to program a php file to run cron jobs. Saw the note about 2.0 and CLI on this page.

I think Eloy's comment is also saying that this page is too long and could be split up? For example use a navtrail and a Cron template. Proposed pages:
*Cron page - Overview section
*[[Cron with Windows OS]] page - move section.
*[[Cron with MAC OS X]] page - move section
*[[Cron with web hosting services]] page - move section
*[[Cron with UNIX]] page - move section
*[[Cron reports]]
*[[Cron settings]]
Comments? --[[User:chris collman|chris collman]] 23:25, 12 November 2011 (WST)

Notice that I am using the phrase "the Moodle cron process". As I understand it, this process can be triggered via admin/cron.php OR via a cron service at admin/cli/cron.php. Frankly, I am not sure how lib/cronlib.php works with either of these trigeer points but I don't think that is important for the site admin. The old cron page refered to cron.php with the assumption that it was in admin. To avoid confusion for a new user, I decided to call it a Moodle cron process.--[[User:chris collman|chris collman]] 23:57, 19 November 2011 (WST)

==Will create change on this page later==
Not hearing any immediate response to my proposals, I will wait a few days before I change things. I will go back and change the 2.0 Docs as well--[[User:chris collman|chris collman]] 22:58, 17 November 2011 (WST)

::'''DRAFT OF NEW CRON PAGE STARTS HERE''' (will remove later)
'''Change Moodle 2.0 Docs as well'''
Cron is the name of a Unix program that runs predefined tasks on a computer at regular intervals. The cron process in Moodle assists some modules to perform tasks on a scheduled basis. For example, the cron process might tell Moodle to check all discussion forums so it can mail out copies of new posts to people who have subscribed to that forum.

The Moodle cron process can not tell itself to run. It is a best practice to set up a cron service either on the hosting web server, another server or on another computer that will tell the Moodle cron process to run.

*[[Cron reports]] - Examples of reports shown after admin/cron.php was triggered
*[[Cron settings]] - Moodle cron process password and CLI settings
*[[Cron with Windows OS]] - Cron services in Windows
*[[Cron with MAC OS X]]- Cron services in a MAC environment
*[[Cron with web hosting services]]- Cron services in various web hosting examples.
*[[Cron with UNIX]]- Cron services on various UNIX and Linux flavored operating systems.

:Note: Asking a human to use their browser to run the Moodle cron process every five or ten minutes,or when anybody on the site thinks it needs to be run is not a best practice. The outside cron service provides a "heartbeat" so that the Moodle cron process can perform functions at periods defined for each module that needs it.

==Starting cron==
There are a number of way to invoke Moodle cron process. Cron can be started from the address bar in a browser (For example http:demo.moodle.net/admin/cron.php), via a [[Daemon]], or wq1et, curl or some other form of a cron service.

===Cron service location and timing===
Note that the machine providing the cron service '''does not need to be the same machine that is running Moodle'''. For example, if you have a limited web hosting service that does not have a cron service, then you might choose to run cron on another server or on your home computer. All that matters is that the Moodle cron process is run on a regular basis.

The load of the Moodle cron process on the Moodle server is not very high, so 5 minutes is usually reasonable. However if you're worried about it you can reduce the time period to something like 15 minutes or even 30 minutes.
:It's best not to make the time period too long. For example delaying mail-outs can slow down activity within the course and create a large mail outbox to process. Or student want to see their activity and course completions updated quickly.

===Testing cron and manual trigger===
On a new Moodle install or upgrade, it is a good idea to test the Moodle cron process directly from your browser: ''<nowiki>http://example.com/moodle/admin/cron.php</nowiki>'' (See [[Cron settings]] if this does not work).

Next, you need to set up a way to manage an automatic scheduled process to run the script on a regular basis. This will depend upon the operating system and program you select.

:Note: When the Moodle cron process is called from cron service, 'the command line' trigger creates a temporary admin environment (similar to a login) in order to run and then deletes that environment. You can disable command line running of cron by disabling the appropriate section in the cron.php file.

==Moodle cron process ==
The Moodle cron process basically finds and determines if certain functions need to run. These functions are defined in code associated with specific activities and processes. Usually the function looks for new activity that has occurred since cron was last run. Some of the functions may use a timestamp to determine if they should look for new activity. A few functions are run on a random basis.

===Examples of Moodle cron processes==
Moodle's cron processes include:
*updating reports such as quiz, admin, gradebook
*updating course and activity completion (if enabled in advanced settings)
*updating portfolio
*plagiarism checks
*updates activity modules. It looks through the mod directory for lib.php files that contain the function activity-name_cron and will call it. In a standard install this includes assignment, chat, forum, and SCROM.
*updates blocks. It looks for blocks for their cron methods (object functions) to be run. It then, for each such block, runs the cron method for a new object associated with that block (for more details read admin/cron.php). These files (the lib.php files and the files where the block classes are defined) can contain cleanup functions, email functions or anything that needs to be run on a regular basis.
*create the backups of courses at the time specified in the administration settings.
*updating messaging module or forum email notifications.
*unenroll students - this is done on a random basis about 20% of the time Moodle's cron process is triggered.
*deleting users who have not filled out their profile via the 20% random trigger
*deleting old logs are also checked 20% of the time via the 20% random trigger
*deletes old cached text
*generates new passwords for new users and notifies users
*runs authentication enrolments processes
*updates stats if enabled.
*runs blog cleanups
*updates registrations

The code in lib/cronlib.php shows the places that are being checked when the admin/cron.php is run and the report which is displayed on the screen after it has run. As mentioned elsewhere admin/cli/cron.php is the file which outside cron services run to trigger the Moodle cron process.

==See also==
Using Moodle forum discussions:'''No wiki start'''<nowiki>
*[http://moodle.org/mod/forum/discuss.php?d=41827 Cron - can someone give me a quick confirmation of function?]
*[http://moodle.org/mod/forum/discuss.php?d=97684 Cronjob Question]
*[http://moodle.org/mod/forum/discuss.php?d=97457 Slow cron : avoiding simultaneous cron]
*[http://moodle.org/mod/forum/discuss.php?d=117168 Visibility of cron.php]
*[http://moodle.org/mod/forum/discuss.php?d=139263#p609060 How to log the output of a Scheduled Task on Windows] - this discussion explains a nice trick that can be very useful when you are experiencing problems with your Windows Scheduled Task and you need to log the output of the Scheduled Task to a log file.

[[es:Cron]]
[[fr:Cron]]
[[nl:Cron]]
[[sk:Cron]]
[[pl:Cron]]
[[ja:Cron]]</nowiki>'''No wiki end'''

::'''END OF DRAFT PAGE HERE'''

Talk:Unenrolment

2011-11-19T16:33:55Z

Rcollman: Still not sure if it really deletes all user data

This page should probably also have information for users on what happens to the data for users who are unenrolled, as well as if they are accidentally unenrolled what data is preserved upon re-enrollment. --[[User:Mary Parke|Mary Parke]] 05:04, 18 November 2011 (WST)
:Good point. In my 2.1 servers, I have not unenrolled anyone yet. I just unenrolled Maree Anderson from the demo.moodle Water course. She had grades, they went away when I re-enrolled her. I ran cron.php after I unenrolled her. I looked in course and site admin settings and did not see anything about ways to prevent loss of data. I did not go to the MySQL database and see how good a cleanup job Moodle did on the db. I am uneasy writing anything on the basis of a one time demo.moodle test :) --[[User:chris collman|chris collman]] 00:33, 20 November 2011 (WST)

Talk:Unenrolment

2011-11-19T16:24:42Z

Rcollman: Still a good point

This page should probably also have information for users on what happens to the data for users who are unenrolled, as well as if they are accidentally unenrolled what data is preserved upon re-enrollment. --[[User:Mary Parke|Mary Parke]] 05:04, 18 November 2011 (WST)
:Good point. In my 2.1 servers, I have not unenrolled anyone yet. I just unenrolled Maree Anderson from the demo.moodle Water course. She had grades, they went away when I re-enrolled her. Wonder if there is a setting to prevent this. --[[User:chris collman|chris collman]] 00:24, 20 November 2011 (WST)--[[User:chris collman|chris collman]] 00:18, 20 November 2011 (WST)

Talk:Unenrolment

2011-11-19T16:18:15Z

Rcollman: good point, want o write a section in this page?

This page should probably also have information for users on what happens to the data for users who are unenrolled, as well as if they are accidentally unenrolled what data is preserved upon re-enrollment. --[[User:Mary Parke|Mary Parke]] 05:04, 18 November 2011 (WST)
:Good point. In my 2.1 servers, I have not unenrolled anyone yet. As I recall in pre 2.x, the data never went away. If you re-enrolled someone, they were back in as if they never left. Which was an issue for some sites that wanted to do things like yearly training. --[[User:chris collman|chris collman]] 00:18, 20 November 2011 (WST)

Talk:Cron

2011-11-19T15:57:34Z

Rcollman: Stll needs review by cron "expert:

Comment from Eloy:

"If there is some template to mark one page as "require some love" I'd say https://docs.moodle.org/en/Cron requires it. It talks 99% of the time to use web-browser cron. Only 1 line talks about cli cron." --[[User:Helen Foster|Helen Foster]] 20:44, 9 November 2011 (WST)
:I just noticed this comment. Cron is not one of my special areas of knowledge but obviously use it. Did a quick "Cron CLI" on the web and got lost in how to program a php file to run cron jobs. Saw the note about 2.0 and CLI on this page.

I think Eloy's comment is also saying that this page is too long and could be split up? For example use a navtrail and a Cron template. Proposed pages:
*Cron page - Overview section
*[[Cron with Windows OS]] page - move section.
*[[Cron with MAC OS X]] page - move section
*[[Cron with web hosting services]] page - move section
*[[Cron with UNIX]] page - move section
*[[Cron reports]]
*[[Cron settings]]
Comments? --[[User:chris collman|chris collman]] 23:25, 12 November 2011 (WST)

Notice that I am using the phrase "the Moodle cron process". As I understand it, this process can be triggered via admin/cron.php OR via a cron service at admin/cli/cron.php. Frankly, I am not sure how lib/cronlib.php works with either of these trigeer points but I don't think that is important for the site admin. The old cron page refered to cron.php with the assumption that it was in admin. To avoid confusion for a new user, I decided to call it a Moodle cron process.--[[User:chris collman|chris collman]] 23:57, 19 November 2011 (WST)

==Will create change on this page later==
Not hearing any immediate response to my proposals, I will wait a few days before I change things--[[User:chris collman|chris collman]] 22:58, 17 November 2011 (WST)

::'''DRAFT OF NEW CRON PAGE STARTS HERE''' (will remove later)
Cron is the name of a Unix program that runs predefined tasks on a computer at regular intervals. The cron process in Moodle assists some modules to perform tasks on a scheduled basis. For example, the cron process might tell Moodle to check all discussion forums so it can mail out copies of new posts to people who have subscribed to that forum.

The Moodle cron process can not tell itself to run. It is a best practice to set up a cron service either on the hosting web server, another server or on another computer that will tell the Moodle cron process to run.

*[[Cron reports]] - Examples of reports shown after admin/cron.php was triggered
*[[Cron settings]] - Moodle cron process password and CLI settings
*[[Cron with Windows OS]] - Cron services in Windows
*[[Cron with MAC OS X]]- Cron services in a MAC environment
*[[Cron with web hosting services]]- Cron services in various web hosting examples.
*[[Cron with UNIX]]- Cron services on various UNIX and Linux flavored operating systems.

:Note: Asking a human to use their browser to run the Moodle cron process every five or ten minutes,or when anybody on the site thinks it needs to be run is not a best practice. The outside cron service provides a "heartbeat" so that the Moodle cron process can perform functions at periods defined for each module that needs it.

==Starting cron==
There are a number of way to invoke Moodle cron process. Cron can be started from the address bar in a browser (For example http:demo.moodle.net/admin/cron.php), via a [[Daemon]], or wq1et, curl or some other form of a cron service.

===Cron service location and timing===
Note that the machine providing the cron service '''does not need to be the same machine that is running Moodle'''. For example, if you have a limited web hosting service that does not have a cron service, then you might choose to run cron on another server or on your home computer. All that matters is that the Moodle cron process is run on a regular basis.

The load of the Moodle cron process on the Moodle server is not very high, so 5 minutes is usually reasonable. However if you're worried about it you can reduce the time period to something like 15 minutes or even 30 minutes.
:It's best not to make the time period too long. For example delaying mail-outs can slow down activity within the course and create a large mail outbox to process. Or student want to see their activity and course completions updated quickly.

===Testing cron and manual trigger===
On a new Moodle install or upgrade, it is a good idea to test the Moodle cron process directly from your browser: ''<nowiki>http://example.com/moodle/admin/cron.php</nowiki>'' (See [[Cron settings]] if this does not work).

Next, you need to set up a way to manage an automatic scheduled process to run the script on a regular basis. This will depend upon the operating system and program you select.

:Note: When the Moodle cron process is called from cron service, 'the command line' trigger creates a temporary admin environment (similar to a login) in order to run and then deletes that environment. You can disable command line running of cron by disabling the appropriate section in the cron.php file.

==Moodle cron process ==
The Moodle cron process basically finds and determines if certain functions need to run. These functions are defined in code associated with specific activities and processes. Usually the function looks for new activity that has occurred since cron was last run. Some of the functions may use a timestamp to determine if they should look for new activity. A few functions are run on a random basis.

===Examples of Moodle cron processes==
Moodle's cron processes include:
*updating reports such as quiz, admin, gradebook
*updating course and activity completion (if enabled in advanced settings)
*updating portfolio
*plagiarism checks
*updates activity modules. It looks through the mod directory for lib.php files that contain the function activity-name_cron and will call it. In a standard install this includes assignment, chat, forum, and SCROM.
*updates blocks. It looks for blocks for their cron methods (object functions) to be run. It then, for each such block, runs the cron method for a new object associated with that block (for more details read admin/cron.php). These files (the lib.php files and the files where the block classes are defined) can contain cleanup functions, email functions or anything that needs to be run on a regular basis.
*create the backups of courses at the time specified in the administration settings.
*updating messaging module or forum email notifications.
*unenroll students - this is done on a random basis about 20% of the time Moodle's cron process is triggered.
*deleting users who have not filled out their profile via the 20% random trigger
*deleting old logs are also checked 20% of the time via the 20% random trigger
*deletes old cached text
*generates new passwords for new users and notifies users
*runs authentication enrolments processes
*updates stats if enabled.
*runs blog cleanups
*updates registrations

The code in lib/cronlib.php shows the places that are being checked when the admin/cron.php is run and the report which is displayed on the screen after it has run. As mentioned elsewhere admin/cli/cron.php is the file which outside cron services run to trigger the Moodle cron process.

==See also==
Using Moodle forum discussions:'''No wiki start'''<nowiki>
*[http://moodle.org/mod/forum/discuss.php?d=41827 Cron - can someone give me a quick confirmation of function?]
*[http://moodle.org/mod/forum/discuss.php?d=97684 Cronjob Question]
*[http://moodle.org/mod/forum/discuss.php?d=97457 Slow cron : avoiding simultaneous cron]
*[http://moodle.org/mod/forum/discuss.php?d=117168 Visibility of cron.php]
*[http://moodle.org/mod/forum/discuss.php?d=139263#p609060 How to log the output of a Scheduled Task on Windows] - this discussion explains a nice trick that can be very useful when you are experiencing problems with your Windows Scheduled Task and you need to log the output of the Scheduled Task to a log file.

[[es:Cron]]
[[fr:Cron]]
[[nl:Cron]]
[[sk:Cron]]
[[pl:Cron]]
[[ja:Cron]]</nowiki>'''No wiki end'''

::'''END OF DRAFT PAGE HERE'''

Talk:Cron

2011-11-19T15:49:21Z

Rcollman: /* Starting cron */

Comment from Eloy:

"If there is some template to mark one page as "require some love" I'd say https://docs.moodle.org/en/Cron requires it. It talks 99% of the time to use web-browser cron. Only 1 line talks about cli cron." --[[User:Helen Foster|Helen Foster]] 20:44, 9 November 2011 (WST)
:I just noticed this comment. Cron is not one of my special areas of knowledge but obviously use it. Did a quick "Cron CLI" on the web and got lost in how to program a php file to run cron jobs. Saw the note about 2.0 and CLI on this page.

I think Eloy's comment is also saying that this page is too long and could be split up? For example use a navtrail and a Cron template. Proposed pages:
*Cron page - Overview section
*[[Cron with Windows OS]] page - move section.
*[[Cron with MAC OS X]] page - move section
*[[Cron with web hosting services]] page - move section
*[[Cron with UNIX]] page - move section
*[[Cron reports]]
*[[Cron settings]]
Comments? --[[User:chris collman|chris collman]] 23:25, 12 November 2011 (WST)

==Will create change on this page later==
Not hearing any immediate response to my proposals, I will wait a few days before I change things--[[User:chris collman|chris collman]] 22:58, 17 November 2011 (WST)

Seems excessive to create a Cron settings page but why not, that is consistent with other functions --[[User:chris collman|chris collman]] 22:02, 19 November 2011 (WST)

::'''DRAFT OF NEW CRON PAGE STARTS HERE''' (will remove later)
Cron is the name of a Unix program that runs predefined tasks on a computer at regular intervals. The cron process in Moodle assists some modules to perform tasks on a scheduled basis. For example, the cron process might tell Moodle to check all discussion forums so it can mail out copies of new posts to people who have subscribed to that forum.

The Moodle cron process can not tell itself to run. It is a best practice to set up a cron service either on the hosting web server, another server or on another computer that will tell the Moodle cron process to run.

*[[Cron reports]] - Examples of reports shown after admin/cron.php was triggered
*[[Cron settings]] - Moodle cron process password and CLI settings
*[[Cron with Windows OS]] - Cron services in Windows
*[[Cron with MAC OS X]]- Cron services in a MAC environment
*[[Cron with web hosting services]]- Cron services in various web hosting examples.
*[[Cron with UNIX]]- Cron services on various UNIX and Linux flavored operating systems.

:Note: Asking a human to use their browser to run the Moodle cron process every five or ten minutes,or when anybody on the site thinks it needs to be run is not a best practice. The outside cron service provides a "heartbeat" so that the Moodle cron process can perform functions at periods defined for each module that needs it.

==Starting cron==
There are a number of way to invoke Moodle cron process. Cron can be started from the address bar in a browser (For example http:demo.moodle.net/admin/cron.php), via a [[Daemon]], or wq1et, curl or some other form of a cron service.

===Cron service location and timing===
Note that the machine providing the cron service '''does not need to be the same machine that is running Moodle'''. For example, if you have a limited web hosting service that does not have a cron service, then you might choose to run cron on another server or on your home computer. All that matters is that the Moodle cron process is run on a regular basis.

The load of the Moodle cron process on the Moodle server is not very high, so 5 minutes is usually reasonable. However if you're worried about it you can reduce the time period to something like 15 minutes or even 30 minutes.
:It's best not to make the time period too long. For example delaying mail-outs can slow down activity within the course and create a large mail outbox to process. Or student want to see their activity and course completions updated quickly.

===Testing cron and manual trigger===
On a new Moodle install or upgrade, it is a good idea to test the Moodle cron process directly from your browser: ''<nowiki>http://example.com/moodle/admin/cron.php</nowiki>'' (See [[Cron settings]] if this does not work).

Next, you need to set up a way to manage an automatic scheduled process to run the script on a regular basis. This will depend upon the operating system and program you select.

:Note: When the Moodle cron process is called from cron service, 'the command line' trigger creates a temporary admin environment (similar to a login) in order to run and then deletes that environment. You can disable command line running of cron by disabling the appropriate section in the cron.php file.

==Moodle cron process ==
The Moodle cron process basically finds and determines if certain functions need to run. These functions are defined in code associated with specific activities and processes. Usually the function looks for new activity that has occurred since cron was last run. Some of the functions may use a timestamp to determine if they should look for new activity. A few functions are run on a random basis.

===Examples of Moodle cron processes==
Moodle's cron processes include:
*updating reports such as quiz, admin, gradebook
*updating course and activity completion (if enabled in advanced settings)
*updating portfolio
*plagiarism checks
*updates activity modules. It looks through the mod directory for lib.php files that contain the function activity-name_cron and will call it. In a standard install this includes assignment, chat, forum, and SCROM.
*updates blocks. It looks for blocks for their cron methods (object functions) to be run. It then, for each such block, runs the cron method for a new object associated with that block (for more details read admin/cron.php). These files (the lib.php files and the files where the block classes are defined) can contain cleanup functions, email functions or anything that needs to be run on a regular basis.
*create the backups of courses at the time specified in the administration settings.
*updating messaging module or forum email notifications.
*unenroll students - this is done on a random basis about 20% of the time Moodle's cron process is triggered.
*deleting users who have not filled out their profile via the 20% random trigger
*deleting old logs are also checked 20% of the time via the 20% random trigger
*deletes old cached text
*generates new passwords for new users and notifies users
*runs authentication enrolments processes
*updates stats if enabled.
*runs blog cleanups
*updates registrations

The code in lib/cronlib.php shows the places that are being checked when the admin/cron.php is run and the report which is displayed on the screen after it has run. As mentioned elsewhere admin/cli/cron.php is the file which outside cron services run to trigger the Moodle cron process.

==See also==
Using Moodle forum discussions:'''No wiki start'''<nowiki>
*[http://moodle.org/mod/forum/discuss.php?d=41827 Cron - can someone give me a quick confirmation of function?]
*[http://moodle.org/mod/forum/discuss.php?d=97684 Cronjob Question]
*[http://moodle.org/mod/forum/discuss.php?d=97457 Slow cron : avoiding simultaneous cron]
*[http://moodle.org/mod/forum/discuss.php?d=117168 Visibility of cron.php]
*[http://moodle.org/mod/forum/discuss.php?d=139263#p609060 How to log the output of a Scheduled Task on Windows] - this discussion explains a nice trick that can be very useful when you are experiencing problems with your Windows Scheduled Task and you need to log the output of the Scheduled Task to a log file.

[[es:Cron]]
[[fr:Cron]]
[[nl:Cron]]
[[sk:Cron]]
[[pl:Cron]]
[[ja:Cron]]</nowiki>'''No wiki end'''

::'''END OF DRAFT PAGE HERE'''

Talk:Cron

2011-11-19T15:46:52Z

Rcollman:

Comment from Eloy:

"If there is some template to mark one page as "require some love" I'd say https://docs.moodle.org/en/Cron requires it. It talks 99% of the time to use web-browser cron. Only 1 line talks about cli cron." --[[User:Helen Foster|Helen Foster]] 20:44, 9 November 2011 (WST)
:I just noticed this comment. Cron is not one of my special areas of knowledge but obviously use it. Did a quick "Cron CLI" on the web and got lost in how to program a php file to run cron jobs. Saw the note about 2.0 and CLI on this page.

I think Eloy's comment is also saying that this page is too long and could be split up? For example use a navtrail and a Cron template. Proposed pages:
*Cron page - Overview section
*[[Cron with Windows OS]] page - move section.
*[[Cron with MAC OS X]] page - move section
*[[Cron with web hosting services]] page - move section
*[[Cron with UNIX]] page - move section
*[[Cron reports]]
*[[Cron settings]]
Comments? --[[User:chris collman|chris collman]] 23:25, 12 November 2011 (WST)

==Will create change on this page later==
Not hearing any immediate response to my proposals, I will wait a few days before I change things--[[User:chris collman|chris collman]] 22:58, 17 November 2011 (WST)

Seems excessive to create a Cron settings page but why not, that is consistent with other functions --[[User:chris collman|chris collman]] 22:02, 19 November 2011 (WST)

::'''DRAFT OF NEW CRON PAGE STARTS HERE''' (will remove later)
Cron is the name of a Unix program that runs predefined tasks on a computer at regular intervals. The cron process in Moodle assists some modules to perform tasks on a scheduled basis. For example, the cron process might tell Moodle to check all discussion forums so it can mail out copies of new posts to people who have subscribed to that forum.

The Moodle cron process can not tell itself to run. It is a best practice to set up a cron service either on the hosting web server, another server or on another computer that will tell the Moodle cron process to run.

*[[Cron reports]] - Examples of reports shown after admin/cron.php was triggered
*[[Cron settings]] - Moodle cron process password and CLI settings
*[[Cron with Windows OS]] - Cron services in Windows
*[[Cron with MAC OS X]]- Cron services in a MAC environment
*[[Cron with web hosting services]]- Cron services in various web hosting examples.
*[[Cron with UNIX]]- Cron services on various UNIX and Linux flavored operating systems.

:Note: Asking a human to use their browser to run the Moodle cron process every five or ten minutes,or when anybody on the site thinks it needs to be run is not a best practice. The outside cron service provides a "heartbeat" so that the Moodle cron process can perform functions at periods defined for each module that needs it.

==Starting cron==
There are a number of way to invoke Moodle cron process. Cron can be started from the address bar in a browser (For example http:demo.moodle.net/admin/cron.php), via a [[Daemon]], or wq1et, curl or some other code.

===Cron service location and timing===
Note that the machine providing the cron service '''does not need to be the same machine that is running Moodle'''. For example, if you have a limited web hosting service that does not have a cron service, then you might choose to run cron on another server or on your home computer. All that matters is that the Moodle cron process is run on a regular basis.

The load of the Moodle cron process on the Moodle server is not very high, so 5 minutes is usually reasonable. However if you're worried about it you can reduce the time period to something like 15 minutes or even 30 minutes.
:It's best not to make the time period too long. For example delaying mail-outs can slow down activity within the course and create a large mail outbox to process. Or student want to see their activity and course completions updated quickly.

===Testing cron and manual trigger===
On a new Moodle install or upgrade, it is a good idea to test the Moodle cron process directly from your browser: ''<nowiki>http://example.com/moodle/admin/cron.php</nowiki>'' (See [[Cron settings]] if this does not work).

Next, you need to set up a way to manage an automatic scheduled process to run the script on a regular basis. This will depend upon the operating system and program you select.

:Note: When the Moodle cron process is called from cron service, 'the command line' trigger creates a temporary admin environment (similar to a login) in order to run and then deletes that environment. You can disable command line running of cron by disabling the appropriate section in the cron.php file.

==Moodle cron process ==
The Moodle cron process basically finds and determines if certain functions need to run. These functions are defined in code associated with specific activities and processes. Usually the function looks for new activity that has occurred since cron was last run. Some of the functions may use a timestamp to determine if they should look for new activity. A few functions are run on a random basis.

===Examples of Moodle cron processes==
Moodle's cron processes include:
*updating reports such as quiz, admin, gradebook
*updating course and activity completion (if enabled in advanced settings)
*updating portfolio
*plagiarism checks
*updates activity modules. It looks through the mod directory for lib.php files that contain the function activity-name_cron and will call it. In a standard install this includes assignment, chat, forum, and SCROM.
*updates blocks. It looks for blocks for their cron methods (object functions) to be run. It then, for each such block, runs the cron method for a new object associated with that block (for more details read admin/cron.php). These files (the lib.php files and the files where the block classes are defined) can contain cleanup functions, email functions or anything that needs to be run on a regular basis.
*create the backups of courses at the time specified in the administration settings.
*updating messaging module or forum email notifications.
*unenroll students - this is done on a random basis about 20% of the time Moodle's cron process is triggered.
*deleting users who have not filled out their profile via the 20% random trigger
*deleting old logs are also checked 20% of the time via the 20% random trigger
*deletes old cached text
*generates new passwords for new users and notifies users
*runs authentication enrolments processes
*updates stats if enabled.
*runs blog cleanups
*updates registrations

The code in lib/cronlib.php shows the places that are being checked when the admin/cron.php is run and the report which is displayed on the screen after it has run. As mentioned elsewhere admin/cli/cron.php is the file which outside cron services run to trigger the Moodle cron process.

==See also==
Using Moodle forum discussions:'''No wiki start'''<nowiki>
*[http://moodle.org/mod/forum/discuss.php?d=41827 Cron - can someone give me a quick confirmation of function?]
*[http://moodle.org/mod/forum/discuss.php?d=97684 Cronjob Question]
*[http://moodle.org/mod/forum/discuss.php?d=97457 Slow cron : avoiding simultaneous cron]
*[http://moodle.org/mod/forum/discuss.php?d=117168 Visibility of cron.php]
*[http://moodle.org/mod/forum/discuss.php?d=139263#p609060 How to log the output of a Scheduled Task on Windows] - this discussion explains a nice trick that can be very useful when you are experiencing problems with your Windows Scheduled Task and you need to log the output of the Scheduled Task to a log file.

[[es:Cron]]
[[fr:Cron]]
[[nl:Cron]]
[[sk:Cron]]
[[pl:Cron]]
[[ja:Cron]]</nowiki>'''No wiki end'''

::'''END OF DRAFT PAGE HERE'''

Talk:Cron

2011-11-19T15:35:56Z

Rcollman: /* See also */

Comment from Eloy:

"If there is some template to mark one page as "require some love" I'd say https://docs.moodle.org/en/Cron requires it. It talks 99% of the time to use web-browser cron. Only 1 line talks about cli cron." --[[User:Helen Foster|Helen Foster]] 20:44, 9 November 2011 (WST)
:I just noticed this comment. Cron is not one of my special areas of knowledge but obviously use it. Did a quick "Cron CLI" on the web and got lost in how to program a php file to run cron jobs. Saw the note about 2.0 and CLI on this page.

I think Eloy's comment is also saying that this page is too long and could be split up? For example use a navtrail and a Cron template. Proposed pages:
*Cron page - Overview section
*[[Cron with Windows OS]] page - move section.
*[[Cron with MAC OS X]] page - move section
*[[Cron with web hosting services]] page - move section
*[[Cron with UNIX]] page - move section
*[[Cron reports]]
Comments? --[[User:chris collman|chris collman]] 23:25, 12 November 2011 (WST)

==Will create change on this page later==
Not hearing any immediate response to my proposals, I will wait a few days before I change things--[[User:chris collman|chris collman]] 22:58, 17 November 2011 (WST)

Seems excessive to create a Cron settings page but why not, that is consistent with other functions --[[User:chris collman|chris collman]] 22:02, 19 November 2011 (WST)

::'''DRAFT OF NEW CRON PAGE STARTS HERE''' (will remove later)
Cron is the name of a Unix program that runs predefined tasks on a computer at regular intervals. The cron process in Moodle assists some modules to perform tasks on a scheduled basis. For example, the cron process might tell Moodle to check all discussion forums so it can mail out copies of new posts to people who have subscribed to that forum.

The Moodle cron process can not tell itself to run. It is a best practice to set up a cron service either on the hosting web server, another server or on another computer that will tell the Moodle cron process to run.

:Note: Asking a human to use their browser to run the Moodle cron process every five or ten minutes,or when anybody on the site thinks it needs to be run is not a best practice. The outside cron service provides a "heartbeat" so that the Moodle cron process can perform functions at periods defined for each module that needs it.

==Starting cron==
There are a number of way to invoke Moodle cron process. Cron can be started from the address bar in a browser (For example http:demo.moodle.net/admin/cron.php), via a [[Daemon]], or wq1et, curl or some other code.

===Cron service location and timing===
Note that the machine providing the cron service '''does not need to be the same machine that is running Moodle'''. For example, if you have a limited web hosting service that does not have a cron service, then you might choose to run cron on another server or on your home computer. All that matters is that the Moodle cron process is run on a regular basis.

The load of the Moodle cron process on the Moodle server is not very high, so 5 minutes is usually reasonable. However if you're worried about it you can reduce the time period to something like 15 minutes or even 30 minutes.
:It's best not to make the time period too long. For example delaying mail-outs can slow down activity within the course and create a large mail outbox to process. Or student want to see their activity and course completions updated quickly.

===Testing cron and manual trigger===
On a new Moodle install or upgrade, it is a good idea to test the Moodle cron process directly from your browser: ''<nowiki>http://example.com/moodle/admin/cron.php</nowiki>'' (See [[Cron settings]] if this does not work).

Next, you need to set up a way to manage an automatic scheduled process to run the script on a regular basis. This will depend upon the operating system and program you select.

:Note: When the Moodle cron process is called from cron service, 'the command line' trigger creates a temporary admin environment (similar to a login) in order to run and then deletes that environment. You can disable command line running of cron by disabling the appropriate section in the cron.php file.

==Moodle cron process ==
The Moodle cron process basically finds and determines if certain functions need to run. These functions are defined in code associated with specific activities and processes. Usually the function looks for new activity that has occurred since cron was last run. Some of the functions may use a timestamp to determine if they should look for new activity. A few functions are run on a random basis.

===Examples of Moodle cron processes==
Moodle's cron processes include:
*updating reports such as quiz, admin, gradebook
*updating course and activity completion (if enabled in advanced settings)
*updating portfolio
*plagiarism checks
*updates activity modules. It looks through the mod directory for lib.php files that contain the function activity-name_cron and will call it. In a standard install this includes assignment, chat, forum, and SCROM.
*updates blocks. It looks for blocks for their cron methods (object functions) to be run. It then, for each such block, runs the cron method for a new object associated with that block (for more details read admin/cron.php). These files (the lib.php files and the files where the block classes are defined) can contain cleanup functions, email functions or anything that needs to be run on a regular basis.
*create the backups of courses at the time specified in the administration settings.
*updating messaging module or forum email notifications.
*unenroll students - this is done on a random basis about 20% of the time Moodle's cron process is triggered.
*deleting users who have not filled out their profile via the 20% random trigger
*deleting old logs are also checked 20% of the time via the 20% random trigger
*deletes old cached text
*generates new passwords for new users and notifies users
*runs authentication enrolments processes
*updates stats if enabled.
*runs blog cleanups
*updates registrations

The code in lib/cronlib.php shows the places that are being checked when the admin/cron.php is run and the report which is displayed on the screen after it has run. As mentioned elsewhere admin/cli/cron.php is the file which outside cron services run to trigger the Moodle cron process.

==See also==
Using Moodle forum discussions:'''No wiki start'''<nowiki>
*[http://moodle.org/mod/forum/discuss.php?d=41827 Cron - can someone give me a quick confirmation of function?]
*[http://moodle.org/mod/forum/discuss.php?d=97684 Cronjob Question]
*[http://moodle.org/mod/forum/discuss.php?d=97457 Slow cron : avoiding simultaneous cron]
*[http://moodle.org/mod/forum/discuss.php?d=117168 Visibility of cron.php]
*[http://moodle.org/mod/forum/discuss.php?d=139263#p609060 How to log the output of a Scheduled Task on Windows] - this discussion explains a nice trick that can be very useful when you are experiencing problems with your Windows Scheduled Task and you need to log the output of the Scheduled Task to a log file.

[[es:Cron]]
[[fr:Cron]]
[[nl:Cron]]
[[sk:Cron]]
[[pl:Cron]]
[[ja:Cron]]</nowiki>'''No wiki end'''

::'''END OF DRAFT PAGE HERE'''

Talk:Cron

2011-11-19T15:17:17Z

Rcollman: /* Script overview */

Comment from Eloy:

"If there is some template to mark one page as "require some love" I'd say https://docs.moodle.org/en/Cron requires it. It talks 99% of the time to use web-browser cron. Only 1 line talks about cli cron." --[[User:Helen Foster|Helen Foster]] 20:44, 9 November 2011 (WST)
:I just noticed this comment. Cron is not one of my special areas of knowledge but obviously use it. Did a quick "Cron CLI" on the web and got lost in how to program a php file to run cron jobs. Saw the note about 2.0 and CLI on this page.

I think Eloy's comment is also saying that this page is too long and could be split up? For example use a navtrail and a Cron template. Proposed pages:
*Cron page - Overview section
*[[Cron with Windows OS]] page - move section.
*[[Cron with MAC OS X]] page - move section
*[[Cron with web hosting services]] page - move section
*[[Cron with UNIX]] page - move section
*[[Cron reports]]
Comments? --[[User:chris collman|chris collman]] 23:25, 12 November 2011 (WST)

==Will create change on this page later==
Not hearing any immediate response to my proposals, I will wait a few days before I change things--[[User:chris collman|chris collman]] 22:58, 17 November 2011 (WST)

Seems excessive to create a Cron settings page but why not, that is consistent with other functions --[[User:chris collman|chris collman]] 22:02, 19 November 2011 (WST)

::'''DRAFT OF NEW CRON PAGE STARTS HERE''' (will remove later)
Cron is the name of a Unix program that runs predefined tasks on a computer at regular intervals. The cron process in Moodle assists some modules to perform tasks on a scheduled basis. For example, the cron process might tell Moodle to check all discussion forums so it can mail out copies of new posts to people who have subscribed to that forum.

The Moodle cron process can not tell itself to run. It is a best practice to set up a cron service either on the hosting web server, another server or on another computer that will tell the Moodle cron process to run.

:Note: Asking a human to use their browser to run the Moodle cron process every five or ten minutes,or when anybody on the site thinks it needs to be run is not a best practice. The outside cron service provides a "heartbeat" so that the Moodle cron process can perform functions at periods defined for each module that needs it.

==Starting cron==
There are a number of way to invoke Moodle cron process. Cron can be started from the address bar in a browser (For example http:demo.moodle.net/admin/cron.php), via a [[Daemon]], or wq1et, curl or some other code.

===Cron service location and timing===
Note that the machine providing the cron service '''does not need to be the same machine that is running Moodle'''. For example, if you have a limited web hosting service that does not have a cron service, then you might choose to run cron on another server or on your home computer. All that matters is that the Moodle cron process is run on a regular basis.

The load of the Moodle cron process on the Moodle server is not very high, so 5 minutes is usually reasonable. However if you're worried about it you can reduce the time period to something like 15 minutes or even 30 minutes.
:It's best not to make the time period too long. For example delaying mail-outs can slow down activity within the course and create a large mail outbox to process. Or student want to see their activity and course completions updated quickly.

===Testing cron and manual trigger===
On a new Moodle install or upgrade, it is a good idea to test the Moodle cron process directly from your browser: ''<nowiki>http://example.com/moodle/admin/cron.php</nowiki>'' (See [[Cron settings]] if this does not work).

Next, you need to set up a way to manage an automatic scheduled process to run the script on a regular basis. This will depend upon the operating system and program you select.

:Note: When the Moodle cron process is called from cron service, 'the command line' trigger creates a temporary admin environment (similar to a login) in order to run and then deletes that environment. You can disable command line running of cron by disabling the appropriate section in the cron.php file.

==Moodle cron process ==
The Moodle cron process basically finds and determines if certain functions need to run. These functions are defined in code associated with specific activities and processes. Usually the function looks for new activity that has occurred since cron was last run. Some of the functions may use a timestamp to determine if they should look for new activity. A few functions are run on a random basis.

===Examples of Moodle cron processes==
Moodle's cron processes include:
*updating reports such as quiz, admin, gradebook
*updating course and activity completion (if enabled in advanced settings)
*updating portfolio
*plagiarism checks
*updates activity modules. It looks through the mod directory for lib.php files that contain the function activity-name_cron and will call it. In a standard install this includes assignment, chat, forum, and SCROM.
*updates blocks. It looks for blocks for their cron methods (object functions) to be run. It then, for each such block, runs the cron method for a new object associated with that block (for more details read admin/cron.php). These files (the lib.php files and the files where the block classes are defined) can contain cleanup functions, email functions or anything that needs to be run on a regular basis.
*create the backups of courses at the time specified in the administration settings.
*updating messaging module or forum email notifications.
*unenroll students - this is done on a random basis about 20% of the time Moodle's cron process is triggered.
*deleting users who have not filled out their profile via the 20% random trigger
*deleting old logs are also checked 20% of the time via the 20% random trigger
*deletes old cached text
*generates new passwords for new users and notifies users
*runs authentication enrolments processes
*updates stats if enabled.
*runs blog cleanups
*updates registrations

The code in lib/cronlib.php shows the places that are being checked when the admin/cron.php is run and the report which is displayed on the screen after it has run. As mentioned elsewhere admin/cli/cron.php is the file which outside cron services run to trigger the Moodle cron process.

==See also==
Using Moodle forum discussions:<nowiki>
*[http://moodle.org/mod/forum/discuss.php?d=41827 Cron - can someone give me a quick confirmation of function?]
*[http://moodle.org/mod/forum/discuss.php?d=97684 Cronjob Question]
*[http://moodle.org/mod/forum/discuss.php?d=97457 Slow cron : avoiding simultaneous cron]
*[http://moodle.org/mod/forum/discuss.php?d=117168 Visibility of cron.php]
*[http://moodle.org/mod/forum/discuss.php?d=139263#p609060 How to log the output of a Scheduled Task on Windows] - this discussion explains a nice trick that can be very useful when you are experiencing problems with your Windows Scheduled Task and you need to log the output of the Scheduled Task to a log file.

[[es:Cron]]
[[fr:Cron]]
[[nl:Cron]]
[[sk:Cron]]
[[pl:Cron]]
[[ja:Cron]]</nowiki>

::'''END OF DRAFT PAGE HERE'''

Talk:Cron

2011-11-19T15:12:06Z

Rcollman: /* Testing cron and manual trigger */

Comment from Eloy:

"If there is some template to mark one page as "require some love" I'd say https://docs.moodle.org/en/Cron requires it. It talks 99% of the time to use web-browser cron. Only 1 line talks about cli cron." --[[User:Helen Foster|Helen Foster]] 20:44, 9 November 2011 (WST)
:I just noticed this comment. Cron is not one of my special areas of knowledge but obviously use it. Did a quick "Cron CLI" on the web and got lost in how to program a php file to run cron jobs. Saw the note about 2.0 and CLI on this page.

I think Eloy's comment is also saying that this page is too long and could be split up? For example use a navtrail and a Cron template. Proposed pages:
*Cron page - Overview section
*[[Cron with Windows OS]] page - move section.
*[[Cron with MAC OS X]] page - move section
*[[Cron with web hosting services]] page - move section
*[[Cron with UNIX]] page - move section
*[[Cron reports]]
Comments? --[[User:chris collman|chris collman]] 23:25, 12 November 2011 (WST)

==Will create change on this page later==
Not hearing any immediate response to my proposals, I will wait a few days before I change things--[[User:chris collman|chris collman]] 22:58, 17 November 2011 (WST)

Seems excessive to create a Cron settings page but why not, that is consistent with other functions --[[User:chris collman|chris collman]] 22:02, 19 November 2011 (WST)

::'''DRAFT OF NEW CRON PAGE STARTS HERE''' (will remove later)
Cron is the name of a Unix program that runs predefined tasks on a computer at regular intervals. The cron process in Moodle assists some modules to perform tasks on a scheduled basis. For example, the cron process might tell Moodle to check all discussion forums so it can mail out copies of new posts to people who have subscribed to that forum.

The Moodle cron process can not tell itself to run. It is a best practice to set up a cron service either on the hosting web server, another server or on another computer that will tell the Moodle cron process to run.

:Note: Asking a human to use their browser to run the Moodle cron process every five or ten minutes,or when anybody on the site thinks it needs to be run is not a best practice. The outside cron service provides a "heartbeat" so that the Moodle cron process can perform functions at periods defined for each module that needs it.

==Starting cron==
There are a number of way to invoke Moodle cron process. Cron can be started from the address bar in a browser (For example http:demo.moodle.net/admin/cron.php), via a [[Daemon]], or wq1et, curl or some other code.

===Cron service location and timing===
Note that the machine providing the cron service '''does not need to be the same machine that is running Moodle'''. For example, if you have a limited web hosting service that does not have a cron service, then you might choose to run cron on another server or on your home computer. All that matters is that the Moodle cron process is run on a regular basis.

The load of the Moodle cron process on the Moodle server is not very high, so 5 minutes is usually reasonable. However if you're worried about it you can reduce the time period to something like 15 minutes or even 30 minutes.
:It's best not to make the time period too long. For example delaying mail-outs can slow down activity within the course and create a large mail outbox to process. Or student want to see their activity and course completions updated quickly.

===Testing cron and manual trigger===
On a new Moodle install or upgrade, it is a good idea to test the Moodle cron process directly from your browser: ''<nowiki>http://example.com/moodle/admin/cron.php</nowiki>'' (See [[Cron settings]] if this does not work).

Next, you need to set up a way to manage an automatic scheduled process to run the script on a regular basis. This will depend upon the operating system and program you select.

:Note: When the Moodle cron process is called from cron service, 'the command line' trigger creates a temporary admin environment (similar to a login) in order to run and then deletes that environment. You can disable command line running of cron by disabling the appropriate section in the cron.php file.

===Script overview===
The cron.php script basically finds and determines if certain functions need to run. These functions are defined in code associated with specific activities and processes. Usually the function looks for new activity that has occurred since cron was last run. Some of the functions may use a timestamp to determine if they should look for new activity. A few functions are run on a random basis.

Moodle's cron processes include:
*updating reports such as quiz, admin, gradebook
*updating course and activity completion (if enabled in advanced settings)
*updating portfolio
*plagiarism checks
*updates activity modules. It looks through the mod directory for lib.php files that contain the function activity-name_cron and will call it. In a standard install this includes assignment, chat, forum, and SCROM.
*updates blocks. It looks for blocks for their cron methods (object functions) to be run. It then, for each such block, runs the cron method for a new object associated with that block (for more details read admin/cron.php). These files (the lib.php files and the files where the block classes are defined) can contain cleanup functions, email functions or anything that needs to be run on a regular basis.
*create the backups of courses at the time specified in the administration settings.
*updating messaging module or forum email notifications.
*unenroll students - this is done on a random basis about 20% of the time Moodle's cron process is triggered.
*deleting users who have not filled out their profile via the 20% random trigger
*deleting old logs are also checked 20% of the time via the 20% random trigger
*deletes old cached text
*generates new passwords for new users and notifies users
*runs authentication enrolments processes
*updates stats if enabled.
*runs blog cleanups
*updates registrations

The code in lib/cronlib.php shows the places that are being checked when the admin/cron.php is run and the report which is displayed on the screen after it has run

::'''END OF DRAFT PAGE HERE'''

Talk:Cron

2011-11-19T15:10:54Z

Rcollman: /* Starting cron */

Talk:Cron

2011-11-19T14:55:28Z

Rcollman: /* Will create change on this page later */