MoodleDocs - User contributions [en]

Assignment settings

2021-02-25T01:39:13Z

Abgreeve: /* Submission settings */ Clarification of the attempts reopened setting.

{{Assignment}}
This page explores in more detail the settings for the [[Assignment activity]] once you have added it to your course and also covers the Site administration settings.

Note that if you want to edit an existing assignment, click the Edit link to its right and choose the action you wish to take, eg 'Edit settings'.

==General==
#In the Description, provide instructions for students. Check the box if you want these instructions to display on the course page.
#In Additional files, you can add files which may be of help to the students as they do their assignment, such as example submissions or answer templates.

==Availability==

;Allow submissions from
:This stops students from submitting before the shown date but it doesn't hide the assignment and any included instructions or materials.
;Due date
:Submissions are still allowed after this date but will be marked as late. Disable it by unticking the checkbox. Assignments without a due date will appear on the dashboard with 'No Due Date' displayed.
;Cut-off date
:After this date, students will not be able to submit and the submit button will disappear.
;Remind me to grade by..
:A date needs to be entered here in order for the assignment to display on the teacher's [[Course overview block]] and in the [[Calendar]]. It will display when at least one student has submitted.

==Submission types==

Here you can decide how you wish students to submit their work to you.

Note: If Submission comments are enabled in ''Administration>Plugins>Activity modules>Assignment>Submission plugins'', students will be able to add a note to their teacher on submitting work. If Anonymous submissions are enabled, student comments display in the gradebook as from "Participant 01 etc" to avoid revealing identities.

;Online text
:Students type their responses directly in Moodle using a text editor (such as the [[Atto editor]] which automatically saves text at regular intervals.)

It's possible to set a word limit on an online text assignment. Students get a warning if they try to exceed the word limit. Numbers are counted as words and abbreviations such as ''I'm'' or ''they're'' are counted as single words.

;File submissions
:Students can upload one or more files of any type the teacher can open. The teacher can annotate uploaded PDFs, docx and odt files within the browser, and on saving, the annotated file is made available to the student. (Check with your admin that [https://en.wikipedia.org/wiki/Ghostscript Ghostscript] and a [[Document converters| document converter]] are enabled, if you can't annotate uploaded files.) In the screenshot below, a docx file has been uploaded and converted so that the teacher may use the annotation tools to comment directly on the student's assignment.

[[File:assignmentgrading3.png|thumb|500px|center|Annotating uploaded files]]

Comments may be collapsed to make it easier to read the original text:

[[File:collapsedcommentexample.png]]

;Maximum submission size
:The maximum upload size refers to each file a student uploads. It cannot be larger than the limit in the Course settings.
;Accepted file types
:The teacher can specify the types of file the students may upload to the assignment. A file type selector appears upon clicking 'Choose', offering a choice of different file types. (See the video [https://youtu.be/vN1DlHeZkw4 File type selection] for more information.) Leaving the field blank will allow all file types.

If the file types have been restricted, then when students attempt to submit the assignment, they will see a message telling them which files are accepted:
[[File:studentfiletyperestrictions.png|thumb|500px|center|Student view of specified files]]

==Feedback types==
;Feedback comments
:With this enabled, markers can leave comments for each submission (which appear on the assignment grading screen.)

The [[Atto editor]] now allows for recording audio and video when grading, along with the option to upload supporting files such as images.

'''Annotate PDF''' appears if this setting is enabled by the Site administrator in the ''Manage assignment feedback plugins'' section of Site admin and will allow the teacher to annotate using comments, stamps and other features.

;Offline grading worksheet
:This is useful if you wish to download the grading list and edit it in a program such as MS Excel.
{|
|[[File:emptygradebook.png|thumb|The empty gradebook on Moodle]]
|[[File:downloadgradingworksheet.png|thumb|The dropdown to download the list]]
|[[File:excelgrades.png|thumb|Editing the grades offline]]
|}

When the teacher has completed their grading offline, they can then upload the spreadsheet, confirm the changes and the grades and comments will be transferred over into Moodle's gradebook:

{|
|[[File:uploadgradingworksheet.png|thumb|Uploading the grading worksheet]]
|[[File:confirmchanges.png|thumb|Confirming the changes]]
|[[File:fullgradebook.png|thumb|Grades and feedback transferred into Moodle]]
|}

See also [http://www.somerandomthoughts.com/blog/2012/11/19/offline-grading-worksheet-in-moodle-2-4-assignment/ Offline grading worksheet] blog post by Gavin Henrick.

;Feedback files
:This allows markers to upload files with feedback when marking. These files may be the marked up student assignments, documents with comments, a completed marking guide, or spoken audio feedback. It enables the Feedback Files column in the assignment grading screen (accessed from 'View/Grade all submissions'.) To upload feedback files, click on the green tick in the grade column on the grading table and then upload either with drag and drop or using the [[File picker]].

{|
|[[File:feedback files.jpg|thumb|The Feedback files column]]
|[[File:feedback files 2.jpg|thumb|Upload files here]]
|[[File:feedback view for students.jpg|thumb|Student view with comments and file feedback both enabled]]
|}
'''Uploading multiple feedback files''' is also possible:
#Download the students' assignments using the "Download all submissions" link from the same dropdown menu;
#Extract the folder offline and add your comments to the student's submissions. Keep the names the same.
#Select the students' submissions and zip them into a new folder. Important: Don't just edit them inside their original folder and re-zip this; it will not work. The folder name does not matter as long as the feedback files have the same names as before.
#Upload this newly zipped folder.
#You will be presented with a confirmation screen displaying your feedback files. (If you zip files from a Mac, make sure to remove the folder _MACOSX)

{|
|[[File:mutiplefeedbackzip.png|thumb|Choose from the dropdown menu]]
|[[File:multiplezip1.png|thumb|Confirmation screen displaying the feedback files to be uploaded]]
|[[File:multiplezip2.png|thumb|Screen confirming uploaded feedback]]
|}

;Comment inline
:This usefully allows you to comment directly on an 'online text' type submission.

==Submission settings==
;Require students click submit button
:If this is set to 'No' students can make changes to their submission at any time. (If you want to stop them changing work once you are ready to grade, click 'View/Grade all submissions'; locate the student and From the Edit column, click the action icon and select 'Prevent submission changes'.)
:If set to 'Yes', students can upload draft versions of the assignment until such time as they are ready to submit. Clicking the submit button tells the teacher they have finished drafting and want the work to be graded. They can no longer edit it and must ask the teacher to revert to draft status if they need to change it again. To do that, click 'View/Grade all submissions; locate the student and from the Edit column, click the action icon and select 'Revert the submission to draft'.

{|
|[[File:revert to draft.jpg|thumb|Reverting to draft]]
|[[File:prevent submission changes.jpg|thumb|Prevent submission changes]]
|[[File:with selected.jpg|thumb|"With selected" to choose several students.]]
|}

;Require that students accept the Submission statement
:An administrator can define a "Submission statement" (see below) i.e. a statement where students promise the work is their own and which they must agree to before submitting their work. If the administrator has given teachers the option of using a submission statement or not, then it will be available in the assignment settings screen. If the administrator has forced the statement throughout the site, a teacher will not have this option in the settings but a student will see the statement when accessing their assignment.

;Attempts reopened
: Here you can allow the teacher to reopen a students submission attempt. Changing this setting to 'Manually' allows the teacher to go into the grader and in the "Attempt settings" section set "Allow another attempt" to either "yes" or "no". Changing the setting to "Automatically until pass" requires that "Grade to pass" in the Grade section be set. If the student does not receive a passing grade then the submission will automatically be reopened and another attempt can be made.
;Maximum attempts
: Here you can decide how many attempts to allow if students can resubmit. If a student has to keep trying until they get a pass grade, you might decide to limit the attempts even though they have not yet passed - or they might be trying for ever!

==Groups submission settings==
These settings allow students to collaborate on a single assignment, eg. working in the same online area or uploading, editing and reuploading an MS Powerpoint in the common assignment area.

When grading, the teacher may choose to give a common grade and feedback to all students in the group or to give individual grades and feedback to each member.

;Require group to make submission
:Students not in a group can still submit assignments unless this is forced in ''Site administration > Plugins > Assignment > Assignment settings''. Moodle will then display a message ''You're not a member of any group; please contact your teacher'' , and the student will not be able to submit the assignment.
;Require all group members submit
:This setting will only appear if the teacher has ticked the "Require students click submit button" earlier. The assignment will not be classed as "submitted" until all members of the group have made a contribution. When one student has submitted, the other members of the group will be able to see who still has to submit.
;Grouping for student groups
:If a particular grouping is selected here, then the gradebook will display any other groups and non-grouped students in the "default group", while naming the group(s) that are in the chosen grouping. If "none" is selected, then the gradebook will display the names of all groups and put any non-grouped students in the "default group". See this [https://moodle.org/mod/forum/discuss.php?d=216399#p942913 forum post on grouping for student groups] for examples of how this might be used.

==Notifications==
Please note that if you are using group mode then course teachers need to be members of the group in order to receive submission and late submission notifications.

==Grade==
*See [[Grade points]] and [[Advanced grading methods]] for more information on the settings here.
*Setting a passing grade may be connected with [[Activity completion]] and [[Restrict access]] such that a student will not be able to access a follow up activity until they have passed this assignment.
*;Anonymous submissions
:This hides students' names when grading and instead shows randomly generated Participant numbers.

With Anonymous submissions, students cannot see the final grade until all of the students' names have been revealed. Rubrics will also be hidden from students' view until the names are revealed. To reveal student names after you are finished grading, look under ''Assignment settings > Reveal student identities''. Feedback comments will appear whether or not student names are hidden or revealed. Note that this level of anonymity might not suit the privacy requirements of your organisation. See MDL-35390 for more details.

Users with the capability [[Capabilities/mod/assign:viewblinddetails|View student identities when Anonymous submissions are enabled]] (by default managers only) can view student identities and participant numbers.

Users with the capability [[Capabilities/moodle/site:viewanonymousevents|View anonymous events in reports]] (by default managers only) can view student submissions to assignments with Anonymous submissions (in Moodle 3.9 onwards).

*;Marking (grading) workflow
:This lets you keep grades and feedback hidden until you are ready to release them to students. It is also useful if you want to show your progress in grading, or co-ordinate multiple markers/graders.

{|
|[[File:26markingworkflow.png|thumb|Marking workflow state in the individual grading screen]]
|[[File:26quickgradingworkflow.png|thumb|Dropdown to select marking workflow state when quick grading]]
|}
The phases are:

* Not marked (the marker has not yet started)
* In marking (the marker has started but not yet finished)
* Marking completed (the marker has finished but might need to go back for checking/corrections)
* In review (the marking is now with the teacher in charge for quality checking)
* Ready for release (the teacher in charge is satisfied with the marking but wait before giving students access to the marking)
* Released (the student can access the grades/feedback)

;Marking allocation
:Marking allocation can be used if marking workflow is set to Yes. Teachers can then be selected to grade or review submitted work of specific students.

{|
|[[File:26markingworkflowallocatedmarkers.png|thumb|Allocated markers on the grading screen]]
|}

==Other settings==
Depending on what is enabled for your site and course, you may also need to explore [[Common module settings]], [[Restrict access| Restrict access]], [[Activity completion]], [[Tags]] and [[Competencies]]
==Assignment capabilities==

* [[Capabilities/mod/assign:exportownsubmission|Export own submission]]
* [[Capabilities/mod/assign:grade|Grade assignment]]
* [[Capabilities/mod/assign:submit|Submit assignment]]
* [[Capabilities/mod/assign:view|View assignment]]

Role permissions for the activity can be changed from the gear icon Actions menu.

==Site administration settings==
Administrators can access assignment configuration options by expanding ''Administration > Site administration > Plugins > Activity modules > Assignment''.

===Assignment settings===
Here, the administrator can set defaults for certain settings. They may also make certain settings 'Advanced' which means a course teacher has to click the 'Show more' link to see them, or they may 'lock' settings which means a course teacher cannot alter that setting.

If the site contains courses with over 100 participants, the number of assignments listed on the assignment grading page may be limited using the Maximum assignments per page (assign | maxperpage) setting. This removes 'All' from the 'Assignments per page' setting.

;Submission statement
:Here is where the administrator can enter text into a box which will appear when students are about to submit an assignment:

{|
|[[File:newsubmissionstatement.png|thumb|Admin view of Submission statement set up screen - click to enlarge]]
|[[File:submissionstatement1.png|thumb|Student view when about to submit - click to enlarge]]
|}

If it is left as the default "No", then teachers will have the choice within their own assignments to force this or not.

The submission statement may be shown in different languages. See [[Multi-language content filter]] for how to do this.

Note for sites using languages other than English: There is currently a bug affecting the default assignment submission statement - it doesn't display in a user's language (MDL-54731). A workaround is to enter the submission statement in the required language (using the multi-lang filter if multiple languages are are required) in the 'Submission statement' (submissionstatement) field then save changes.

===Submission plugins===
Here the administrator can enable, disable or change the order and default settings for any submission plugins.
;Submission comments
:Note that if submission comments are enabled here AND comments enabled globally in ''Site Administration > Advanced features'') then students will be able to send a message to their teacher when submitting their assignment. If either of those settings is disabled, then the submission comments link will not appear.

===Feedback plugins===
====Manage assignment feedback plugins====
Here the administrator can enable, disable or change the order and default settings for any feedback plugins.
;Annotate PDF
:This is the place to upload stamps for teachers to use when annotating student PDFs.

=====Check Ghostscript=====
You can also check the ghostscript path from here:
{|
|[[File:Selection_116.png|thumb|Ghostscript not installed or incorrectly installed]]
|[[File:Selection_115.png|thumb|Ghostscript correctly installed]]
|}

If the default stamps are deleted by accident, they can be found in mod/assign/feedback/editpdf/pix and re-uploaded.

==See also==
[[de:Aufgabe konfigurieren]]
[[fr:Ajouter/modifier un devoir]]
[[ja:課題を追加/編集する]]
[[es:Configuraciones de tarea]]
[[it:Impostazioni Compito]]

Block layout

2018-12-04T14:10:58Z

Abgreeve: Update explaining that the navigation and administration blocks can not be updated with the defaultblocks settings.

{{Blocks}}
==Default block layout for new courses==

To amend the default block layout for new courses, one or more of the following lines (omitting the forward slashes) from ''config-dist.php'' may be added to ''[[Configuration_file|config.php]]'', amending the block names as required.

// These variables define DEFAULT block variables for new courses
// If this one is set it overrides all others and is the only one used.
// $CFG->defaultblocks_override = 'participants,activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';
//
// These variables define the specific settings for defined course formats.
// They override any settings defined in the formats own config file.
// $CFG->defaultblocks_site = 'site_main_menu,course_list:course_summary,calendar_month';
// $CFG->defaultblocks_social = 'participants,search_forums,calendar_month,calendar_upcoming,social_activities,recent_activity,course_list';
// $CFG->defaultblocks_topics = 'participants,activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';
// $CFG->defaultblocks_weeks = 'participants,activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';
// These blocks are used when no other default setting is found.
// $CFG->defaultblocks = 'participants,activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';</pre>

For example, to set the default block layout for topics format courses to People, and Tags on the left, and Messages, Online users and Recent activity on the right, simply add the following line to your ''config.php'' file:

$CFG->defaultblocks_topics = 'participants,tags:messages,online_users,recent_activity';

Note how the colon is used to separate those blocks appearing on the left, from those appearing on the right.
Additional Note: The Navigation and Administration blocks are not customisable using these settings.

==Resetting the block layout for existing courses==

The block layout for existing courses may be reset by copying the following script into a text file, saving it as ''resetblocks.php'', copying it into the Moodle root directory, then visiting <code><nowiki>http://yourmoodlesite.org/resetblocks.php</nowiki></code>.

'''Warning''': This script may change the layout of your course pages and also remove blocks from those pages if they have not been specified in the config.php line. Check which of your courses has blocks which are not in the config.php line and be prepared to spend time adding blocks to your course pages again. ''Please note that a database backup is recommended before using the script''.

<?php
//moodle 2.x
require_once('config.php');
require_once($CFG->libdir.'/blocklib.php');
$courses = get_courses();//can be feed categoryid to just effect one category
foreach($courses as $course) {
$context = get_context_instance(CONTEXT_COURSE,$course->id);
blocks_delete_all_for_context($context->id);
blocks_add_default_course_blocks($course);
}
?>

[[es:Diseño de bloque]]
[[ja:ブロックレイアウト]]

Lesson settings

2018-03-14T07:47:22Z

Abgreeve: /* Provide option to try a question again - update to try to explain how this setting works. */

{{Lesson}}
=Lesson administration settings=

This page explains the settings involved when first creating a lesson.
To add a lesson to your Moodle course page:
*With the editing turned on, in the section you wish to add your lesson, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu) and choose ''Lesson'' All settings may expanded by clicking the "Expand all" link top right.
*In the '''General''' section, give your lesson a name, a description if needed, and tick the box if you wish that description displayed on the course page.

==Appearance==
===Progress bar===
Choose this to show a bar at the bottom of the page showing how far into the lesson the student has got.
* For lessons containing '''only''' ''Content pages'', once a lesson has been taken to the end, if that same lesson is re-taken, the progress bar will not be "reset", i.e. it will show a 100% progress from page 1!

* For lessons containing ''Question pages'' and set to "Re-take" '''Yes''', the progress bar is always "reset" at 0% upon re-take.

* Note that the Lesson Progress bar only works correctly for lessons with a "straightforward" navigation, such as page 1 -> page 2 -> page n -> end of lesson. It is not guaranteed to work with pages "jumping all over the place".

===Display menu===
Choose this when you want to show a list of the content page titles in the Lesson to the student. Only those pages which have "Display in menu?" checked will display. The menu will not display question pages.
===Show more===
Depending on the what the administrator has specified as 'Advanced', other settings will be displayed by clicking a 'Show more' link:

====Linked media====
[[File:pop-up file link.png|thumb|Link to pop-up]]
If you want to include a link to a media file for students to refer to, upload it here. A 'Click here to view' link will be displayed in a block called 'Linked media' on each page of the lesson.

The width and height of the pop-up window may be set by an admin in ''Site administration > Plugins > Activity modules > Lesson''.

====Display ongoing score====
Choose this to let students see their score as they work through the lesson.

===Minimum grade to display menu===
Choose this if you want the student to go through the lesson once and get a grade before they can (on review) see and navigate through all the different pages.
====Slideshow====

Slideshow height, width and background colour are set for the whole site by an administrator in Site administration > Plugins > Activity modules > Lesson''.

====Maximum Number of Answers====
Here you can set the default number of selection boxes available when you add or edit a question or content page. For instance, if you are only going to use Multiple Choice questions with 3 answers in your lesson, you might select 3. You can change the default here at any time to display more or less question answers or content choices.
:''Note:'' This only impacts the editing screen. Changing from 4 to 2 will not remove or hide any answers previously entered from the student.

====Use default feedback====
Every Moodle site has a standard response (feedback) when a student selects a correct or wrong answer in a lesson. Select "No" if you only what you put as a response for a specific question's answer to display. In this case, when you leave the response to a question blank, the student will not see any comment about their answer. The typical Moodle standard responses are: "That's the correct answer" or "That's the wrong answer".

====Link to next activity====
Choose this to give students a link to another activity when they reach the end of the lesson.

==Availability==

===Available from/Deadline===
Here you can set a start and end date and time for your Lesson.

===Time limit===

This allows you to set a time limit on the lesson which can now be seconds, minutes, hours, days or weeks. Students will see a countdown counter in a block as they work.(Note that this does not work if the lesson is downloaded for offline use via the mobile app.)

[[File:lessontimeremaining.png]]

The timer does not stop them doing the lesson when the time is up, but correct answers are no longer scored.
===Show more===
Depending on the what the administrator has specified as 'Advanced', other settings will be displayed by clicking a 'Show more' link:

====Password protected lesson====
*Change to "Yes" and enter the password if you want students only to access it when they know the password.

====Allow lesson to be attempted offline====

Enabling this setting means the lesson can be downloaded and done offline by a mobile app user.Lessons which are timed may not be attempted offline.

==Flow control==

===Allow Student Review===
This puts a "Review Lesson" button on the last screen of the lesson to encourage the students to navigate through the lesson again. If the lesson contains questions then the review will start from the first question, otherwise the review will start from the first content page.
:Note that the students will not be able to ''change'' their answers, only ''view'' them.

===Provide option to try a question again===
*This displays a button after an incorrectly answered question so that the student can try again (but not get credit for it). If the student clicks to move on to another question then the selected (wrong) answer jump will be followed. By default wrong answer jumps are set to "this page", so it is recommended that you set the wrong answer jump to a different page to avoid confusion with your students.
:''TIP:'' Leave this off if you are using essay questions.

===Maximum Number of Attempts===
*Decide here how many times you want students to be able to attempt each question. When they reach the maximum, they will be taken automatically to the next page.
'''''Note:''''' this setting works in combination with the above setting, or independently.

*When 'provide an option to try again' is set to No, students will be able to retake the question as many times as it is set here, with a score penalty.

*When 'provide an option to try again' is set to Yes, then students will be able to retake the question as many times as it set here without a score penalty. In this case an extra dialogue appears.

Consequently when the relevant jump 'this page' is used in wrong answer while the 'provide an option to try again' is set to No and 'maximum number of attempts' is set to 1, a student that will answer wrongly will be moved into the next page, since he/she has the change to try the question just once.

'''''Tip:''''' Ensure you check lesson using a real student account, as the teacher preview or the 'switch role to student' may not give you the exact picture.

===Show more===
Depending on the what the administrator has specified as 'Advanced', other settings will be displayed by clicking a 'Show more' link:

====Action after a Correct Answer====
Choose here where you want a student to be sent to if they get a question right. See [[Using Lesson]] for more details on this setting. The options are:
**the next part of the Lesson (default setting)
**a random, unexpected page
**a random page which they have not yet answered.
====Number of pages to show====
You only need this if you have set "Action after a correct answer" to show an unseen or unanswered page. Otherwise, all pages will be seen

==Grade==

Set a grade and grade category here, along with a "Grade to pass" which may be connected with [[Activity completion]] and [[Restrict access]] such that a student will not be able to access a follow up activity until they have obtained the required grade in the lesson.

===Practice lesson===

Practice lessons are now saved; this means they will appear in the reports .You must enable the "Retakes allowed" setting if you want students to be able to attempt a practice lesson several times.

'''Note''': If you are upgrading from an earlier version, be aware that all practice lessons will have " Re-takes allowed" set to "Yes" . If you are restoring a practice lesson made before this change, you may need to modify the "Re-takes allowed" setting if needed.

===Custom Scoring===
Use this to give a particular number score (negative or positive) to each answer
===Re-takes allowed===
Choose this if you want your students to be able to do the lesson more than once.
:Note that this setting only applies to lessons containing ''Question pages''. Lessons consisting '''only''' of ''Content pages'' can be re-taken even if 'Re-takes allowed' is set to ''No''.

===Show more===
Depending on the what the administrator has specified as 'Advanced', other settings will be displayed by clicking a 'Show more' link:
====Handling of re-takes====
If you allow your students to re-take the lesson, then decide here if the grade for all lesson attempts is the mean or the maximum.

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

====Minimum Number of Questions====
Set the minimum number of questions that will be used to calculate a student's score. Students will be told how many they have answered and how many more they need to answer.
*If you are using Content pages, then set this to 0.
*If you use this setting, then add some explanatory text at the start of the lesson so the student knows the minimum number of questions they must answer to receive a grade.

==Common module settings==
See [[Common module settings]]

==Access restrictions==
[[Restrict access]] must be turned on in the site settings for this to appear.
(These settings are collapsed by default)

*Grade - limit to overall grade or specific grade on another activity
*Group - limit to specific group
*Groupings - limit to specific groupings
*User profile - limit based upon user profile fields
*Restriction set - nest restrictions

==Activity completion==
[[Activity completion]] must be turned on in the site settings for this to appear.
(These settings are collapsed by default)
*Completion tracking - 3 options
*Required view
*Required grade
*Required end reached
*Required time spent
*Expected completion on

==User and group overrides==

When a lesson has been created, it is possible to overrride certain settings for individuals and groups from Lesson administration. In situations where two group overrides may apply to a single user, the most lenient date is used. For "Available from" dates, this means the earliest possible date is used, for "Deadline" dates, this means that the latest possible date is used. Note also that if there exists a user override for a student, it will always take precedence over any group overrides.

It is possible to override passwords, availability/deadline, time limits and question retries and lesson retakes.

Selecting one of the options, for example 'User' will display a button to click. From the next screen you can choose the user or group to override and the settings you wish to override:

[[File:lessonoverrideuser.png]]

When the override is saved, it is displayed on a screen along with any other overrides previously set:

[[File:lessonoverrideexamples.png]]

==Site administration settings==

*The administrator can change the lesson's default settings and decide which lesson features to display to teachers in courses, and which features are 'Advanced'.
*Features which have the 'Advanced' box ticked only display when teachers click a 'Show more' link.
*This is useful for simplifying the lesson for teachers when it is first set up.
*The lesson settings can be reviewed from ''Site administration > Plugins > Activity modules > Lesson.''

[[de:Lektion konfigurieren]]
[[fr:Ajouter/modifier une leçon]]
[[ja:レッスンの設定]]
[[es:Configuraciones de lección]]

MySQL full unicode support

2017-07-26T01:49:03Z

Abgreeve: sql commands addition

{{Environment}}
==UTF-8==

UTF-8 is a character encoding that most websites use. It encodes each of the 1,112,064 valid code points. To store all of this information, four bytes is required. The most popular values are in the three byte region. MySQL by default only uses a three byte encoding and so values in the four byte range (eg. Asian characters and Emojis) can not be stored. Any attempt to enter a text that contains four byte characters will result in a Moodle database error.

MySQL does provide full four byte UTF-8 support, but it requires certain database settings to be configured. From version 3.3 on Moodle uses full UTF-8 for both MySQL and MariaDB by default. Existing databases will still run with partial support, but it is recommended to move over to full support.

Moodle comes with a Command Line Interface (CLI) script for converting to full UTF-8 for MySQL (and MariaDB). Before Moodle versions 3.1.5 and 3.2.2 this conversion tool would only change the Collation to some variant of 'utf8_bin'. 'utf8_unicode_ci' was the recommended Collation. We now recommend using 'utf8mb4_unicode_ci' which supports four byte characters (utf8_unicode_ci only supports three).

This script will attempt to change the database Collation, Character set, default table settings and column definitions.

To summarise:

* Fresh installs of Moodle 3.1.5 and 3.2.2 onwards will use utf8mb4 by default, if the database server is configured appropriately (see below).
* Sites upgrading to Moodle 3.1.5 or 3.2.2 can use the script to update to utf8mb4. In Moodle 3.3 a warning will show that the database isn't using full UTF-8 support and suggest moving to 'utf8mb4_unicode_ci', but you may choose to keep using 'utf8_*'.

===File format===

To allow for large indexes on columns that are a varchar, a combination of settings needs to be set. The file format for the system needs to be using "Barracuda". This allows for the row format to be set to "Compressed" or "Dynamic". To enable this setting see the upgrade steps listed below.

===File per table===

To enable this setting see the upgrade steps listed below.

===Large prefix===

This in conjunction with the row format being either "Compressed" or "Dynamic" allows for large varchar indexes above 191 characters.
To enable this setting see the upgrade steps listed below.

==Steps to upgrade==

Most important: Please backup your database before making any changes or running the CLI script.

* Change configuration settings for MySQL (exactly the same for MariaDB). This step is optional. You can run the script and it will try and make these changes itself. If errors occur then try manually changing these settings as listed below.
** On Linux based systems you will want to alter my.cnf. This may be located in '/etc/mysql/'.
** Make the following alterations to my.cnf:
<code>
[client]
default-character-set = utf8mb4

[mysqld]
innodb_file_format = Barracuda
innodb_file_per_table = 1
innodb_large_prefix

character-set-server = utf8mb4
collation-server = utf8mb4_unicode_ci
skip-character-set-client-handshake

[mysql]
default-character-set = utf8mb4
</code>
* Restart your MySQL server.
* Run the CLI script to convert to the new Character set and Collation (requires Moodle 3.1.5, 3.2.2 or newer):
<pre>
$ php admin/cli/mysql_collation.php --collation=utf8mb4_unicode_ci
</pre>

'''NOTE: For large sites, this script will be slow. It is recommended to dump and reimport your data according to https://docs.moodle.org/310/en/Converting_your_MySQL_database_to_UTF8#Default_Mysql_character_set'''

* Adjust the $CFG->dboptions Array in your '''config.php''' to make sure that Moodle uses the right Collation when connecting to the MySQL Server:
<pre>
$CFG->dboptions = array(
…
'dbcollation' => 'utf8mb4_unicode_ci',
…
);
</pre>

If you only have access to the database command line (or something like phpmyadmin) you can try the following sql commands:
<code>
SET GLOBAL innodb_file_format = barracuda

SET GLOBAL innodb_file_per_table = 1

SET GLOBAL innodb_large_prefix = 'on'
</code>

* Try adding some Emojis (e.g. 😂💩) to your Moodle site to verify that the upgrade was successful.

[[Category:Environment|UTF-8]]
[[Category:UTF-8]]

[[es:MySQL soporte unicode completo]]
[[fr:Support unicode complet pour MySQL]]
[[de:MySQL Unicode Unterstützung]]

Lesson settings

2017-06-06T06:04:06Z

Abgreeve: /* Allow Student Review - Clarification of student review. */

{{Lesson}}
=Lesson administration settings=

This page explains the settings involved when first creating a lesson.
To add a lesson to your Moodle course page:
*With the editing turned on, in the section you wish to add your lesson, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu) and choose ''Lesson'' All settings may expanded by clicking the "Expand all" link top right.
*In the '''General''' section, give your lesson a name, a description if needed, and tick the box if you wish that description displayed on the course page.

==Appearance==
===Progress bar===
Choose this to show a bar at the bottom of the page showing how far into the lesson the student has got.
* For lessons containing '''only''' ''Content pages'', once a lesson has been taken to the end, if that same lesson is re-taken, the progress bar will not be "reset", i.e. it will show a 100% progress from page 1!

* For lessons containing ''Question pages'' and set to "Re-take" '''Yes''', the progress bar is always "reset" at 0% upon re-take.

* Note that the Lesson Progress bar only works correctly for lessons with a "straightforward" navigation, such as page 1 -> page 2 -> page n -> end of lesson. It is not guaranteed to work with pages "jumping all over the place".

===Display menu===
Choose this when you want to show a list of the content page titles in the Lesson to the student. Only those pages which have "Display in menu?" checked will display. The menu will not display question pages.
===Show more===
Depending on the what the administrator has specified as 'Advanced', other settings will be displayed by clicking a 'Show more' link:

====Linked media====
[[File:pop-up file link.png|thumb|Link to pop-up]]
If you want to include a link to a media file for students to refer to, upload it here. A 'Click here to view' link will be displayed in a block called 'Linked media' on each page of the lesson.

The width and height of the pop-up window may be set by an admin in ''Site administration > Plugins > Activity modules > Lesson''.

====Display ongoing score====
Choose this to let students see their score as they work through the lesson.

===Minimum grade to display menu===
Choose this if you want the student to go through the lesson once and get a grade before they can (on review) see and navigate through all the different pages.
====Slideshow====

Slideshow height, width and background colour are set for the whole site by an administrator in Site administration > Plugins > Activity modules > Lesson''.

====Maximum Number of Answers====
Here you can set the default number of selection boxes available when you add or edit a question or content page. For instance, if you are only going to use Multiple Choice questions with 3 answers in your lesson, you might select 3. You can change the default here at any time to display more or less question answers or content choices.
:''Note:'' This only impacts the editing screen. Changing from 4 to 2 will not remove or hide any answers previously entered from the student.

====Use default feedback====
Every Moodle site has a standard response (feedback) when a student selects a correct or wrong answer in a lesson. Select "No" if you only what you put as a response for a specific question's answer to display. In this case, when you leave the response to a question blank, the student will not see any comment about their answer. The typical Moodle standard responses are: "That's the correct answer" or "That's the wrong answer".

====Link to next activity====
Choose this to give students a link to another activity when they reach the end of the lesson. ''(Note: this can also be achieved using [[Conditional activities]])''

==Availability==

===Available from/Deadline===
Here you can set a start and end date and time for your Lesson.

===Time limit===

This allows you to set a time limit on the lesson which can now be seconds, minutes, hours, days or weeks. Students will see a countdown counter in a block as they work.

[[File:lessontimeremaining.png]]

The timer does not stop them doing the lesson when the time is up, but correct answers are no longer scored.
===Show more===
Depending on the what the administrator has specified as 'Advanced', other settings will be displayed by clicking a 'Show more' link:

====Password protected lesson====
*Change to "Yes" and enter the password if you want students only to access it when they know the password.

==Flow control==

===Allow Student Review===
This puts a "Review Lesson" button on the last screen of the lesson to encourage the students to navigate through the lesson again. If the lesson contains questions then the review will start from the first question, otherwise the review will start from the first content page.
:Note that the students will not be able to ''change'' their answers, only ''view'' them.

===Provide option to try a question again===
*This displays a button after an incorrectly answered question so that the student can try again (but not get credit for it)
:''TIP:'' Leave this off if you are using essay questions.
===Maximum Number of Attempts===
*Decide here how many times you want students to be able to attempt each question. When they reach the maximum, they will be taken automatically to the next page.
'''''Note:''''' this setting works in combination with the above setting, or independently.

*When 'provide an option to try again' is set to No, students will be able to retake the question as many times as it is set here, with a score penalty.

*When 'provide an option to try again' is set to Yes, then students will be able to retake the question as many times as it set here without a score penalty. In this case an extra dialogue appears.

Consequently when the relevant jump 'this page' is used in wrong answer while the 'provide an option to try again' is set to No and 'maximum number of attempts' is set to 1, a student that will answer wrongly will be moved into the next page, since he/she has the change to try the question just once.

'''''Tip:''''' Ensure you check lesson using a real student account, as the teacher preview or the 'switch role to student' may not give you the exact picture.

===Show more===
Depending on the what the administrator has specified as 'Advanced', other settings will be displayed by clicking a 'Show more' link:

====Action after a Correct Answer====
Choose here where you want a student to be sent to if they get a question right. See [[Using Lesson]] for more details on this setting. The options are:
**the next part of the Lesson (default setting)
**a random, unexpected page
**a random page which they have not yet answered.
====Number of pages to show====
You only need this if you have set "Action after a correct answer" to show an unseen or unanswered page. Otherwise, all pages will be seen

==Grade==

Set a grade and grade category here, along with a "Grade to pass" which may be connected with [[Activity completion]] and [[Restrict access]] such that a student will not be able to access a follow up activity until they have obtained the required grade in the lesson.

===Practice lesson===

Practice lessons are now saved; this means they will appear in the reports .You must enable the "Retakes allowed" setting if you want students to be able to attempt a practice lesson several times.

'''Note''': If you are upgrading from an earlier version, be aware that all practice lessons will have " Re-takes allowed" set to "Yes" . If you are restoring a practice lesson made before this change, you may need to modify the "Re-takes allowed" setting if needed.

===Custom Scoring===
Use this to give a particular number score (negative or positive) to each answer
===Re-takes allowed===
Choose this if you want your students to be able to do the lesson more than once.
:Note that this setting only applies to lessons containing ''Question pages''. Lessons consisting '''only''' of ''Content pages'' can be re-taken even if 'Re-takes allowed' is set to ''No''.

===Show more===
Depending on the what the administrator has specified as 'Advanced', other settings will be displayed by clicking a 'Show more' link:
====Handling of re-takes====
If you allow your students to re-take the lesson, then decide here if the grade for all lesson attempts is the mean or the maximum.

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

====Minimum Number of Questions====
Set the minimum number of questions that will be used to calculate a student's score. Students will be told how many they have answered and how many more they need to answer.
*If you are using Content pages, then set this to 0.
*If you use this setting, then add some explanatory text at the start of the lesson so the student knows the minimum number of questions they must answer to receive a grade.

==Common module settings==
See [[Common module settings]]

==Access restrictions==
[[Restrict access]] must be turned on in the site settings for this to appear.
(These settings are collapsed by default)

*Grade - limit to overall grade or specific grade on another activity
*Group - limit to specific group
*Groupings - limit to specific groupings
*User profile - limit based upon user profile fields
*Restriction set - nest restrictions

==Activity completion==
[[Activity completion]] must be turned on in the site settings for this to appear.
(These settings are collapsed by default)
*Completion tracking - 3 options
*Required view
*Required grade
*Required end reached
*Required time spent
*Expected completion on

==User and group overrides==

When a lesson has been created, it is possible to overrride certain settings for individuals and groups from Lesson administration. In situations where two group overrides may apply to a single user, the most lenient date is used. For "Available from" dates, this means the earliest possible date is used, for "Deadline" dates, this means that the latest possible date is used. Note also that if there exists a user override for a student, it will always take precedence over any group overrides.

It is possible to override passwords, availability/deadline, time limits and question retries and lesson retakes.

Selecting one of the options, for example 'User' will display a button to click. From the next screen you can choose the user or group to override and the settings you wish to override:

[[File:lessonoverrideuser.png]]

When the override is saved, it is displayed on a screen along with any other overrides previously set:

[[File:lessonoverrideexamples.png]]

==Site administration settings==

*The administrator can change the lesson's default settings and decide which lesson features to display to teachers in courses, and which features are 'Advanced'.
*Features which have the 'Advanced' box ticked only display when teachers click a 'Show more' link.
*This is useful for simplifying the lesson for teachers when it is first set up.
*The lesson settings can be reviewed from ''Site administration > Plugins > Activity modules > Lesson.''

==See also==
*[http://youtu.be/cUDV0WE5ZYY Moodle 2.x Lesson (part 1)] MoodleBites video on YouTube
*[http://youtu.be/Mfj-8w-Ze0A Moodle 2.x Lesson (part 2)] MoodleBites video on YouTube
*[http://youtu.be/jXjqHtgC9c0 Moodle 2.x Lesson (part 3)] MoodleBites video on YouTube

[[de:Lektion konfigurieren]]
[[fr:Ajouter/modifier une leçon]]
[[ja:レッスンの設定]]
[[es:Configuraciones de lección]]

Installation quick guide

2017-05-08T01:36:55Z

Abgreeve: /* Create a database UTF-8 update */

{{Installing Moodle}}
''This page is intended for administrators who are experienced with installing web server applications and are in a hurry to get up and running. Otherwise please see [[Installing Moodle]]''.

==Basic Requirements==

* You will need a working web server (e.g. [[Apache]]), a database (e.g. [[MySQL]], [[MariaDB]] or [[PostgreSQL]]) and have [[PHP]] configured. See the [{{Release notes}} release notes] in the dev docs for software requirements.
* Moodle requires a number of [[PHP]] extensions. However, Moodle checks early in the installation process and you can fix the problem and re-start the install script if any are missing.
* If you want Moodle to send email (you probably do) you need a working Sendmail (Unix/Linux) on your server or access to an SMTP mail server.

==Getting Moodle==

You have two basic options:
* Download your required version from http://moodle.org/downloads ... OR
* Pull the code from the Git repository (recommended for developers and also makes upgrading very simple):
<pre>
git clone -b MOODLE_{{Version2}}_STABLE git://git.moodle.org/moodle.git
</pre>
...this fetches a complete copy of the Moodle repository and then switches to the {{Version}} Stable branch.

See [[Git_for_Administrators|Git for Administrators ]] for details on using Git to install Moodle code.

Note: Only download Moodle from one of the moodle.org sources. Other versions (e.g. control panel based installers, Linux distribution repositories) cannot be guaranteed to work properly, be upgradable or be supportable.

==Create a database==

* Using your chosen database server, create a new empty database. The default encoding must be UTF8. For example, using MySQL:
<pre>
CREATE DATABASE moodle DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
</pre>
* Create a user/password combination with appropriate permissions for the database. For example (MySQL again):
<pre>
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,CREATE TEMPORARY TABLES,DROP,INDEX,ALTER ON moodle.* TO 'moodleuser'@'localhost' IDENTIFIED BY 'yourpassword';
</pre>

Notes: It is important to GRANT ON moodle.* as the database name including the '.*' and not just the bare database name. Save this password you use for the Moodle user, since you will need it later in the install.

==Create data directory==

* Create an empty directory to hold Moodle files. It '''must not''' be in the area served by the web server and must have permissions so that the web server user can write to it. Typically, either make it owned by the web server user or give it write permissions for 'everyone'.

==Install Moodle code==

* If you downloaded the zip or tgz file earlier, then unzip / untar / move / copy the Moodle code (obtained above) so that it will be served by your web server (e.g. on Debian based Linux, move to /var/www/moodle)
* Check the permissions and make sure that the web server does '''not''' have permissions to write to any of the files in the Moodle code directories (a very common root cause of sites being hacked).
* If you need to, configure your web server to serve the Moodle site with your chosen URL.

==Configure Moodle==

* In the Moodle code directory, find the file ''config-dist.php'' and copy it to a new file called ''config.php'' (but read next step, 'Install Moodle', first).
* Edit config.php with your favourite editor and change the appropriate settings to point to your site, directories and database. ''Note: the Moodle install script will create config.php for you if it does not exist but make sure you (re-)set permissions appropriately afterwards''

==Install Moodle==

* Go to the URL for your moodle site in a browser (installation will complete automatically) or run the command line version at (requires cli version of PHP):
<pre>
/usr/bin/php /path/to/moodle/admin/cli/install.php
</pre>
The CLI creates the config.php for you and will not run if you created one in the previous step.
* After completing the install make sure your file permissions are ok for the Moodle program files (not writeable by web server) and the Moodle data files (writeable by web server).

==Set up cron==

You will need a cron job to run periodically. It is recommended that ''the cron is run every minute'', as required for asynchronous activity deletion when using the [[Recycle bin|recycle bin]]. A typical Unix cron entry will be as follows:
<pre>
* * * * * /usr/bin/php /path/to/moodle/admin/cli/cron.php >/dev/null
</pre>
You do not set up Cron inside Moodle but on your server. Your site '''will not work properly''' unless cron is running regularly. It is very important you do not skip this step.

See [[Cron]] for details.

==Congratulations!==

You are now ready to use your Moodle site.

If you run into problems, check the [[Installation FAQ]] and visit the [http://moodle.org/mod/forum/view.php?id=28 Installation help forum].

[[Category:Quick guide]]

[[ja:インストールクイックスタート]]
[[de:Installation in Kürze]]
[[fr:Installation_rapide]]
[[es:Inicio_Rápido_de_Instalación]]

RedHat Linux installation

2017-05-08T01:25:38Z

Abgreeve: /* Setup MySQL - UTF-8 update */

Note : These instructions apply to RedHat version 8. They have also been found to work for RedHat 9.0 and for Fedora Core 1 and 2. '''Fedora Core 3 requires the php-gd package in addition to php.''' I see no reason why they should not work for later versions. In addition, later distributions of Fedora (after 7) contain a moodle yum package. Installation is as easy as '''yum install moodle'''.

Redhat installation considerations: There are many installation options available when installing Redhat. I assume that you are installing on a server and will have selected a Server type install. There is however no reason why this should not work on a desktop or Workstation installation.

== Make sure you have installed the following packages ==
(You will need to select the option to customize the default set of packages on installation OR bring up the package manager by putting disk 1 back in the drive for an existing system):

* X Windows System (not vital but easier)
* Gnome or KDE desktop environment (as above)
* Server Configuration Tools
* Web Server
** Click "Details" and make sure all PHP modules are ticked (except ODBC and PGSQL, they're not neccesary)
** make sure not to miss the MYSQL-PHP module (not installed by default)
* SQL Database
** Click "Details" and tick MySQL server box
* Also make sure you set up the firewall. You probably only need to enable HTTP (and perhaps FTP and SSH) access to your server machine, unless you know different.

If you want a minimal system, startging with RHEL6 (and clones) there is the possiblity of installing a minimal system.

== Configure hostname and domain name==

Type system-config-network to open the GUI editor. Click on the DNS tab. In the "DNS Search Path" fill in your domain name for example myuniversity.edu. Now ensure the "Hostname" contains the computer name you will use and click activate to make changes

== A word about SELinux ==
Default RedHat Enterprise Linux comes with SELinux set to enforcing. If you are not used to SELinux and setting permissions it's (maybe less secure but) often easier to lower the SELinux level to permissive, see the CentOS [https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Security-Enhanced_Linux/sect-Security-Enhanced_Linux-Working_with_SELinux-Changing_SELinux_Modes.html]

== A word about the PHP packages in RHEL ==
RedHat EL - or 'the upstream vendor' if you are using a clone - will not introduce newer PHP packages unless there is an exception (php53 in EL5.6+). Moodle has quite a some PHP dependencies which cannot be fullfilled solely by installing all RHEL-provided packages.

You have therefore to make a choice:
* Use RH and pay attention your Moodle version supports it + PHP modules from and maintain them on your own
* Install the whole (latest) PHP from source on your own (and maintain it)
* Install PHP packages from a third party repo (but you won't get support from Redhat if you run into problems):
** [rpms.famillecollet.com] Maintains recent MySQL and PHP packages for supported EL version (a EPEL contributor)
** RPMFusion and others also have newer PHP packages

== Download Moodle==
(I will install under /usr/moodle, data in /usr/moodle_data)

* Download your favourite version of Moodle from moodle.org (.zip archive is easiest)
* as Root create folder under /usr and copy zip
** su
** mkdir /usr/moodle
** mkdir /usr/moodle_data
** cp moodle_111.zip /usr/moodle
* If you prefer you can install the GIT version directly for all the latest features. Instead of downloading and copying the zip file..
** cd /usr/moodle
** git clone git://git.moodle.org/moodle.git
* Or if you prefer you can install the CVS version directly for all the latest features. Instead of downloading and copying the zip file..
** cd /usr/moodle
** cvs -d:pserver:anonymous@uk.cvs.moodle.org:/cvsroot/moodle login
** cvs -z3 -d:pserver:anonymous@uk.cvs.moodle.org:/cvsroot/moodle co moodle

== Unpack and set file permission etc ==

* Still as root we unpack moodle and rename to something appropiate (I have multiple moodle installs, hence this setup). I will call this install mymoodle.
** cd /usr/moodle
** unzip moodle_xxx.zip
** mv moodle mymoodle
*** (optional step - I have more than one install under /usr/moodle)
** mkdir /usr/moodle_data/mymoodle
*** (same name as the moodle install above)
** chown -R apache:apache /usr/moodle
*** (! Giving Apache full rights to your Moodle programs is not secure. Check out the forums for recomendations on how to secure a production environment.)
** chown -R apache:apache /usr/moodle_data

== Setup config.php ==

* Still as root copy and edit the config file, you should know the host/domain name for your server
** cd /usr/moodle/mymoodle
** cp config-dist.php config.php
** vi config.php (or whatever your favourite editor is!)
* Your config.php settings should be something like...
** dbtype = "mysqli"
** dbhost = "localhost"
** dbname = "mymoodle"
** dbuser = "moodleuser"
** dbpass = "moodlepass" (<-- better make this something of your own)
** prefix = ""
*** (keep the default 'mdl_' prefix if you plan on sharing the database with other applications)
** wwwroot = "http://myhost.mydomain/mymoodle"
*** (If you only want to try moodle out and will not be accessing it from other machines you can use "http://localhost/mymoodle")
** dirroot = '/usr/moodle/mymoodle'
** dataroot = '/usr/moodle_data/mymoodle'
* Save your changes and exit from the editor

== Setup MySQL ==

* First you need to get the MySQL daemon running, it is not running by default.
** On the Desktop find and launch "Services" (on KDE and Gnome it's under System Settings=>Server Settings=>Services, but you might have to hunt around).
** Tick the box for MySQL and (with it selected) press the Start icon - ensure it starts up
** Choose "Save Changes" from the menu, and exit the program.
* If you haven't yet, as root, change the MySQL root password
** mysqladmin -u root password mysqlpass (<-- should change this to something of your own)
* Next, set up the MySQL database (see http://moodle.org/doc/?file=install.html#Database for more details)
* Launch MySQL as root
** mysql -u root -p
*** (at the password prompt, enter the password from above)
* At the '>' MySQL prompt, enter the following commands (MySQL commands are ended with a ';')
** CREATE DATABASE mymoodle CHARSET 'utf8mb4';
*** (the name 'mymoodle' is the same name as the database from Step 4)
** GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,INDEX,ALTER ON mymoodle.*
*** (as above, 'mymoodle' is from Step 4)
** TO moodleuser@localhost IDENTIFIED BY 'moodlepass';
*** ('moodleuser' and 'moodlepass' are from Step 4)
** flush privileges;
** quit
* (! Consider MySQL security - not covered here. If you run a firewall, you don't have too much to worry about.)

== Setup Apache ==

* Edit the Apache configuration file at /etc/httpd/conf/httpd.conf
* Right at the end of the file add the following lines: (once again 'mymoodle' as from Step 3)
** <Directory "/usr/moodle/mymoodle">
** DirectoryIndex index.php
** AcceptPathInfo on
** AllowOverride None
** Options None
** Order allow,deny
** Allow from all
** </Directory>
** Alias /mymoodle "/usr/moodle/mymoodle"
* Don't insert a space in "allow,deny" (common mistake!)
* You might also want to run through the rest of the config file and make some other (obvious) changes - administrator email and suchlike. Not vital though.
* Run the Services application (same as for Mysql) - tick and start "httpd", then save changes and exit.

== Set up the cron job ==

As root user edit the /etc/crontab file using vi (or another editor) OR you can add a line to the root user's "personal" crontab (don't do both!).

* If you wish to place an entry in your root user's crontab use:
** crontab -e
** Add the following line:
*** */5 * * * * /usr/bin/wget -O /dev/null http://localhost/mymoodle/admin/cron.php
**** (change the URL as appropriate for your site)
---
* If you wish to add an entry in /etc/crontab:
* Open the /etc/crontab file in an editor (vi).
* Add the following line:
** */5 * * * * root /usr/bin/wget -O /dev/null http://localhost/mymoodle/admin/cron.php
*** (change the URL as appropriate for your site)
---
* In either case, don't forget to save the file and exit (in vi that is <Esc>, then ':wq')

== Try your new installation ==

http://myhost.mydomain/mymoodle/admin

or, if you are running the browser on the same machine

http://localhost/mymoodle/admin

[[Category:Administrator]]
[[Category:Installation]]
[[pl:Instalacja_w_RedHat]]

== Reference ==
Please also see these discussion for GD:

MySQL

2017-05-05T02:19:52Z

Abgreeve: /* Installing MySQL - minor UTF-8 update */

{{Installing Moodle}}
MySQL is one of the supported databases that underpins a Moodle installation.

== Installing MySQL ==

* If you are running Linux your preference should be to install using your distributions package manager. This ensures you will get any available updates. However, you can also use apt-get or yum depending on the distribution that you are running.
* There are installers available for most popular operating systems at http://www.mysql.com/downloads/mysql/.
* It is possible and reasonably straightforward to build mysql from source but it is not recommended (the pre-built binaries are supposedly better optimised).
* Make sure you set a password for the 'root' user (see http://dev.mysql.com/doc/refman/5.0/en/default-privileges.html).
* Consider installing and configuring my.cnf (the MySQL settings file) to suit your needs. The default configuration is usually very conservative in respect of memory usage versus performance. Increase the 'max_allowed_packet' setting to at least 4 megabytes. Also make sure that your collation and character set is using full UTF-8 support. Please view [[MySQL_full_unicode_support#Steps_to_upgrade]].
* If you are going to use Master/Slave replication, you must add binlog_format = 'ROW' into your my.cnf within [mysqld]. Otherwise, Moodle will not be able to write to the database.

== Creating Moodle database ==

These are the steps to create an empty Moodle database. Substitute your own database name, user name and password as appropriate.

The instructions assume that the web server and MySQL server are on the same machine. In this case the 'dbhost' is 'localhost'. If they are on different machines substitute the name of the web server for 'localhost' in the following instructions and the 'dbhost' setting will be the name of the database server.
Databases have a "Character set" and a "Collation". For Moodle the Character set should be '''utf8''' and the Collation '''utf8_unicode_ci'''. You may get the option to set these values when you create the database. If you are not given a choice, the default options are probably good. An install on an old server may have the wrong settings.

=== Command line ===

* To create a database using the 'mysql' command line client, first log into MySQL
<pre>
$ mysql -u root -p
Enter password:
</pre>
(Enter the password you previously set - or been given - for the MySQL 'root' user). After some pre-amble this should take you to the ''mysql>'' prompt.
* Create a new database (called 'moodle' - substitute your own name if required). We recommend you use '''utf8mb4_unicode_ci''' for Collation.
<pre>
mysql> CREATE DATABASE moodle DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
</pre>
* Add a user/password with the minimum needed permissions:
<pre>
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,CREATE TEMPORARY TABLES,DROP,INDEX,ALTER ON moodle.* TO moodleuser@localhost IDENTIFIED BY 'yourpassword';
</pre>
...which creates a user called 'moodleuser' with a password 'yourpassword'. Make sure you invent a strong password and resist the temptation to 'GRANT ALL'.

=== phpMyAdmin ===

[http://www.phpmyadmin.net/ phpMyAdmin] is a web based administration tool for MySQL. If this is available you can use it to create a new database. Make sure that you select 'UTF8' as the default character set.

==Which database belongs to which Moodle==
If you have installed several Moodle installations on the same server, there will be several databases in your MySQL server. The names might be quite poor reflections of the content like _mdl1 _mdl2 _mdl3 . So how do I see which database goes with which Moodle installation? You can go in with phpMyAdmin and in the various databases check for the table "mdl_course". There you will easily see the name of that Moodle Installation. In table mdl_config you can see the Moodle version. The main URL for the site is not in the database except where there are absolute links.

== See also ==

* [[MariaDB]]
* [[MySQL full unicode support]]
* [http://www.mysql.com/ The MySQL homepage]
* [http://en.wikipedia.org/wiki/MySQL Wikipedia article about ''MySQL'']
* [http://forums.mysql.com/read.php?24,92131,92131 List of articles on MySQL performance tuning]

[[Category:SQL databases]]

[[ja:MySQL]]
[[de:MySQL]]
[[es:MySQL]]

MySQL

2017-05-05T02:07:52Z

Abgreeve: utf8mb4 update

{{Installing Moodle}}
MySQL is one of the supported databases that underpins a Moodle installation.

== Installing MySQL ==

* If you are running Linux your preference should be to install using your distributions package manager. This ensures you will get any available updates. However, you can also use apt-get or yum depending on the distribution that you are running.
* There are installers available for most popular operating systems at http://www.mysql.com/downloads/mysql/.
* It is possible and reasonably straightforward to build mysql from source but it is not recommended (the pre-built binaries are supposedly better optimised).
* Make sure you set a password for the 'root' user (see http://dev.mysql.com/doc/refman/5.0/en/default-privileges.html).
* Consider installing and configuring my.cnf (the MySQL settings file) to suit your needs. The default configuration is usually very conservative in respect of memory usage versus performance. Increase the 'max_allowed_packet' setting to at least 4 megabytes. Also make sure that your collation is using full UTF-8 support. Please view [[MySQL_full_unicode_support#Steps_to_upgrade]].
* If you are going to use Master/Slave replication, you must add binlog_format = 'ROW' into your my.cnf within [mysqld]. Otherwise, Moodle will not be able to write to the database.

== Creating Moodle database ==

These are the steps to create an empty Moodle database. Substitute your own database name, user name and password as appropriate.

The instructions assume that the web server and MySQL server are on the same machine. In this case the 'dbhost' is 'localhost'. If they are on different machines substitute the name of the web server for 'localhost' in the following instructions and the 'dbhost' setting will be the name of the database server.
Databases have a "Character set" and a "Collation". For Moodle the Character set should be '''utf8''' and the Collation '''utf8_unicode_ci'''. You may get the option to set these values when you create the database. If you are not given a choice, the default options are probably good. An install on an old server may have the wrong settings.

=== Command line ===

* To create a database using the 'mysql' command line client, first log into MySQL
<pre>
$ mysql -u root -p
Enter password:
</pre>
(Enter the password you previously set - or been given - for the MySQL 'root' user). After some pre-amble this should take you to the ''mysql>'' prompt.
* Create a new database (called 'moodle' - substitute your own name if required). We recommend you use '''utf8mb4_unicode_ci''' for Collation.
<pre>
mysql> CREATE DATABASE moodle DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
</pre>
* Add a user/password with the minimum needed permissions:
<pre>
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,CREATE TEMPORARY TABLES,DROP,INDEX,ALTER ON moodle.* TO moodleuser@localhost IDENTIFIED BY 'yourpassword';
</pre>
...which creates a user called 'moodleuser' with a password 'yourpassword'. Make sure you invent a strong password and resist the temptation to 'GRANT ALL'.

=== phpMyAdmin ===

[http://www.phpmyadmin.net/ phpMyAdmin] is a web based administration tool for MySQL. If this is available you can use it to create a new database. Make sure that you select 'UTF8' as the default character set.

==Which database belongs to which Moodle==
If you have installed several Moodle installations on the same server, there will be several databases in your MySQL server. The names might be quite poor reflections of the content like _mdl1 _mdl2 _mdl3 . So how do I see which database goes with which Moodle installation? You can go in with phpMyAdmin and in the various databases check for the table "mdl_course". There you will easily see the name of that Moodle Installation. In table mdl_config you can see the Moodle version. The main URL for the site is not in the database except where there are absolute links.

== See also ==

* [[MariaDB]]
* [[MySQL full unicode support]]
* [http://www.mysql.com/ The MySQL homepage]
* [http://en.wikipedia.org/wiki/MySQL Wikipedia article about ''MySQL'']
* [http://forums.mysql.com/read.php?24,92131,92131 List of articles on MySQL performance tuning]

[[Category:SQL databases]]

[[ja:MySQL]]
[[de:MySQL]]
[[es:MySQL]]

MySQL full unicode support

2017-02-24T06:43:30Z

Abgreeve: /* File Format - minor heading change*/

==MySQL full unicode support==

==UTF-8==

UTF-8 is a character encoding that most websites use. It encodes each of the 1,112,064 valid code points. To store all of this information, four bytes is required. The most popular values are in the three byte region. MySQL by default only uses a three byte encoding and so values in the four byte range can not be stored. Any record that contains a four byte character will not be saved.

MySQL does support full UTF-8 support. It requires certain settings to be configured. From Moodle 3.3 the default will be to use full UTF-8 for MySQL and MariaDB. Existing databases will still run with partial support, but it is recommended to move over to full support.

Moodle does come with a Command Line Interface (CLI) script for converting to full UTF-8 for MySQL (and MariaDB). Before Moodle 3.3 this conversion tool would only change the collation to some variant of 'utf8_bin'. 'utf8_unicode_ci' was the recommended collation. We now recommend 'utf8mb4_unicode_ci'. 'utf8mb4_unicode_ci' supports 4 byte characters (utf8_unicode_ci only supports 3 byte characters) so four byte characters such as Asian characters and emoji should now be fully supported.

This script will attempt to change the database collation, character set, and default table settings.

===File format===

To allow for large indexes on columns that are a varchar, a combination of settings needs to be set. The file format for the system needs to be using "Barracuda". This allows for the row format to be set to "Compressed" or "Dynamic". To enable this setting see the upgrade steps listed below.

===File per table===

To enable this setting see the upgrade steps listed below.

===Large prefix===

This in conjunction with the row format being either "Compressed" or "Dynamic" allows for large varchar indexes above 191 characters.
To enable this setting see the upgrade steps listed below.

==Steps to upgrade==

* Most important. Please backup your database before making any changes or running the CLI script.
* Change configuration settings for MySQL (exactly the same for MariaDB). This step is optional. You can run the script and it will try and make these changes itself. If errors occur then try manually changing these settings as listed below.
** On Linux based systems you will want to alter my.cnf. This may be located in '/etc/mysql/'.
** Make the following alterations to my.cnf:
<code>
[client]
default-character-set = utf8mb4

[mysqld]
innodb_file_format = Barracuda
innodb_file_per_table = 1
innodb_large_prefix

character-set-client-handshake = FALSE
character-set-server = utf8mb4
collation-server = utf8mb4_unicode_ci

[mysql]
default-character-set = utf8mb4
</code>
* Restart your mysql server.
* Run the CLI script to convert to the new character set and collation: '''php admin/cli/mysql_collation --collation=utf8mb4_unicode_ci'''
* The upgrade is now complete.

MySQL full unicode support

2017-02-24T06:40:58Z

Abgreeve: MySQL full UTF-8 support

==MySQL full unicode support==

==UTF-8==

UTF-8 is a character encoding that most websites use. It encodes each of the 1,112,064 valid code points. To store all of this information, four bytes is required. The most popular values are in the three byte region. MySQL by default only uses a three byte encoding and so values in the four byte range can not be stored. Any record that contains a four byte character will not be saved.

MySQL does support full UTF-8 support. It requires certain settings to be configured. From Moodle 3.3 the default will be to use full UTF-8 for MySQL and MariaDB. Existing databases will still run with partial support, but it is recommended to move over to full support.

Moodle does come with a Command Line Interface (CLI) script for converting to full UTF-8 for MySQL (and MariaDB). Before Moodle 3.3 this conversion tool would only change the collation to some variant of 'utf8_bin'. 'utf8_unicode_ci' was the recommended collation. We now recommend 'utf8mb4_unicode_ci'. 'utf8mb4_unicode_ci' supports 4 byte characters (utf8_unicode_ci only supports 3 byte characters) so four byte characters such as Asian characters and emoji should now be fully supported.

This script will attempt to change the database collation, character set, and default table settings.

===File Format===

To allow for large indexes on columns that are a varchar, a combination of settings needs to be set. The file format for the system needs to be using "Barracuda". This allows for the row format to be set to "Compressed" or "Dynamic". To enable this setting see the upgrade steps listed below.

===File per table===

To enable this setting see the upgrade steps listed below.

===Large prefix===

This in conjunction with the row format being either "Compressed" or "Dynamic" allows for large varchar indexes above 191 characters.
To enable this setting see the upgrade steps listed below.

==Steps to upgrade==

* Most important. Please backup your database before making any changes or running the CLI script.
* Change configuration settings for MySQL (exactly the same for MariaDB). This step is optional. You can run the script and it will try and make these changes itself. If errors occur then try manually changing these settings as listed below.
** On Linux based systems you will want to alter my.cnf. This may be located in '/etc/mysql/'.
** Make the following alterations to my.cnf:
<code>
[client]
default-character-set = utf8mb4

[mysqld]
innodb_file_format = Barracuda
innodb_file_per_table = 1
innodb_large_prefix

character-set-client-handshake = FALSE
character-set-server = utf8mb4
collation-server = utf8mb4_unicode_ci

[mysql]
default-character-set = utf8mb4
</code>
* Restart your mysql server.
* Run the CLI script to convert to the new character set and collation: '''php admin/cli/mysql_collation --collation=utf8mb4_unicode_ci'''
* The upgrade is now complete.

Database activity FAQ

2016-12-21T08:55:20Z

Abgreeve: Remove how to make an email address clickable - please do not do, it causes problems with search highlighting.

{{Database}}
==Where can I download additional database presets?==

See the Presets and See also sections in [[Building Database]] for various places with presets for download.

==How can I add to the list of database presets available for users to choose from?==

[[File:databasepresetsnew.png|thumb|Database presets]]

There is one default preset, Image Gallery. It is possible to create your own presets.

When you have created your database that you desire to set as a preset; go to the "Presets" tab of the database and choose "Save as preset". Give the preset a name and the database fields and templates will now be available as a preset for the rest of the site. You will need site admin rights to do this.

Please see the [[Database presets]] for other available presets you can import into your system.

==How can I create a database in which students can only view their own entries?==

Either:
*Set up the database so that entries require approval. If the entries are never approved, then only the student that added a particular entry and the teachers can view it.

Or:
*Set the group mode of the database to "Separate groups" and assign each student to a separate group.

==How can I enable a sort function by clicking on the field headings?==

For sorting, you need to manually create the link in the template around that heading. To find the URL you need, you can do a sort using the menus and then look in the URLs. Take out everything but the d, sort and order parameters. For example,

http://moodle.org/mod/data/view.php?d=13&sort=44&order=ASC

http://moodle.org/mod/data/view.php?d=13&sort=44&order=DESC

==How can I list database information horizontally instead of vertically?==
*[http://moodle.org/mod/forum/discuss.php?d=74243 How can I list database information horizontally instead of vertically? Forum discussion]

==Can't get columns to line up in list view==
*[http://moodle.org/mod/forum/discuss.php?d=84050 Can't get columns to line up in list view forum discussion] including moodle.org presets for download

==How can I make an Encyclopedia database preset?==
*[http://moodle.org/mod/forum/discuss.php?d=87560 Encyclopedia database preset forum discussion] including encyclopedia-style preset for download

==Is there a Time stamp for database entries?==

<nowiki>##timeadded##</nowiki>

==How can I make the title of an entry into a link?==

To make the title of an entry in list view link to the single view, add the following code to the list template:

<nowiki><a href="##moreurl##">[[Title]]</a></nowiki>

==How can I hide a database entry which was previously approved?==

Edit the list and or single template and add the undo approval tag (##disapprove##).

==How can I add a default sort order of entries?==

In the Fields tab, select a default sort field, choose ascending or descending then click the Save button.

==Why is my database so slow to show each page?==

Try to go to "Administration > Miscellaneous > XMLDB editor" and choose "Check Indexes". If you have any missing indexes found; upgrade your Moodle to the latest weekly build of your version; re-run the test; backup your site database and then run the suggested SQL from the test on your site database. This should speed up your database activity load times.

==How can I prevent students from adding entries?==

An override may be used to close/archive a database activity, or have a database in which only teachers can add entries, but students can view the entries.

# Follow the Permissions link in the settings block under Database activity administration
# Remove Student from the capability [[Capabilities/mod/data:writeentry|mod/data:writeentry]] by clicking the 'X' next to it.
# Click the continue button to confirm.

==How can I empty a database / remove records from a database en masse?==
In List view, there is a checkbox next to each entry. Click to select the ones you wish to delete and then click the 'Delete selected' button. Alternatively, click the 'Select all' and 'Delete all' buttons. A warning message will appear asking you to confirm what you wish to delete.

==I get an error message when importing a csv of entries==
One thing to try is to open up the csv file in Excel and save it again as a csv file - with another name - and then try importing it agin. Sometimes this just works :)

==How do I export/import picture fields from a database activity from one course to another?==
You cannot export/import database entries with picture fields using the csv option, you will need to use Moodle's backup and restore functionality. Please note that you will need to backup and restore the database activity with user data in order for the entries to be carried over.

==How can I show recently added entries in a block on the course page?==

# Enable an RSS feed of recently added entries as described in [[Using Database]]
# Add a [[Remote RSS feeds block]] to the course page
# Add the database activity RSS feed to it

==How can I have entries waiting for approval highlighted?==

In Moodle 3.0 onwards, any newly created database activities show entries waiting for approval as highlighted for the teacher and the user who added the entry.

For existing database activities, the highlighting can be added by editing the list and/or single template and resetting it, or adding some inline css:

class="mod-data-default-template ##approvalstatus##"

==Any further questions?==

Please post in the [https://moodle.org/mod/forum/view.php?id=3505 Database forum] on moodle.org

==See also==
Forum discussions:

*[http://moodle.org/mod/forum/discuss.php?d=87005 New preset, please review, and make suggestions!] including FAQ preset for download
*[http://moodle.org/mod/forum/discuss.php?d=88727 Design a Database Preset for Document Sharing] including preset for download
*[http://moodle.org/mod/forum/discuss.php?d=55338 Look of the database module]
*[http://moodle.org/mod/forum/discuss.php?d=61179 For those who want the display of Moodle Site's Modules and plugins]
*[http://moodle.org/mod/forum/discuss.php?d=94854#p457252 Looking for some stellar examples of Moodle courses] including book reviews preset for download
*[https://moodle.org/mod/forum/discuss.php?d=268206 Database 2.7 List and Single View: Possible to view only entered fields?]
*[https://moodle.org/mod/forum/discuss.php?d=324452 Glossary autolink within a database activity]

[[Category:FAQ]]

[[de:Datenbank FAQ]]
[[es:Actividad BasedeDatos FAQ]]

Parent role

2016-12-07T05:27:48Z

Abgreeve: /* Assigning the parent to the student - Added step for clarification */

{{Roles}}
The role of '''Parent''' may be used to provide parents/mentors/tutors with permission to view certain information, such as activity reports, grades, blog entries and forum posts, about their children/mentees/tutees.

===Creating a new role===

#As an administrator, go to ''Administration > Site administration > Users > Permissions > Define roles'' and click the "Add a new role" button.
#For archtype role choose "No role."
#Give the role a short name (such as "Parent", but it can be anything appropriate, such as tutor/mentor)
#Give the role a custom full name (such as "Parent", but it can be anything appropriate, such as tutor/mentor)
#Under Context types where this role may be assigned check the '''user''' context.
#Under the heading of '''Course'''
#Change [[Capabilities/moodle/user:viewdetails|moodle/user:viewdetails]] to ''allow'' - to access the student's profile
#Under the heading of '''Users'''
#Change [[Capabilities/moodle/user:viewdetails|moodle/user:viewalldetails]] to ''allow'' - to view all aspects of the student's profile
#Change any/all of the following capabilities to ''allow''
#*[[Capabilities/moodle/user:readuserblogs|moodle/user:readuserblogs]] - to read the student's blog entries
#*[[Capabilities/moodle/user:readuserposts|moodle/user:readuserposts]] - to read the student's forum posts
#*[[Capabilities/moodle/user:viewuseractivitiesreport|moodle/user:viewuseractivitiesreport]] - to view the student's activity reports and grades
#*[[Capabilities/moodle/user:editprofile|moodle/user:editprofile]] - to edit the student's profile
#Click the "Create this role" button.

{|
| [[File:CustomRole05.png|thumb|Setting up the parent role]]
| [[File:CustomRole06.png|thumb|Assigning capabilities to the parent role]]
| [[File:CustomRole07.png|thumb|Saving changes to the parent role]]
|}

Some permissions may already be set to "Allow", or the permissions granted here may not be the ones required for that Role. This set of Permissions mean that this Role allows anyone assigned to a Parent Role, then linked to the Student Role, to edit the profile or read the blogs of that Student - not everyone's profile or blogs.

==Assigning the parent to the student==

*Access the child's full profile page, via '''Site administration ► Users ► Accounts ► Browse list of users'''
*Click the child's name to view the profile.
*In the Administration section, click Preferences
*In the Roles section, click Assign roles relative to this user
*Choose the role to assign i.e. Parent by clicking on the word.
*Select the parent in the potential users list and use the Add button to add it to the existing users list.

{|
| [[File:Parentroleassignroles.png|thumb|500px|"Assign roles relative to this user"]]
| [[File:choosingparent.png|thumb|500px|Assigning the parent to the student]]
|}

At this point you can return to the "Assign roles in user:" page and you should see that the parent name is now in the "Users with Role" column.

:'''NOTE:'''The same parent may be assigned to several students, siblings or otherwise.

===Adding multiple parents/mentors at once===
If you are interested in assigning several parent roles ''en masse'' there is a contributed plugin (use at your own risk) here CONTRIB-3938 which allows you to configure automatic role assignment between users from a database (ex: mentor/mentee or parent/child). You can also read the discussion at http://moodle.org/mod/forum/discuss.php?d=70539#p345127)

===Adding the Mentees Block===
This block needs to be added so parents can see links to their child's profile.

* On the Front Page, turn editing on.
*Go to the '''Add Blocks''' block and select the [[Mentees block]] and when it appears, click on the Configuration icon.
*Edit the configuration settings to suit the needs of the site. When complete, save the changes and return to the Front Page.

{|
| [[File:addmenteesblock.png|thumb|Accessing the Add Blocks]]
| [[File:configuringmenteesblock.png|thumb|Setting the configuration values]]
|}

===How a parent sees their child's activities===

*Once the mentees block has been added, a parent/mentor sees the link to any children/mentees they are responsible for.
*They click on a name and will be taken to the profile page of that user.
*They then select from "Course profiles" - the name of a course the user is enrolled in.
*Grades may then be viewed by clicking in the Reports section
*Forum posts or similar may also be viewed from the user's profile in the Miscellaneous section.
{|
| [[File:MOParentRole01a.png|thumb|Click the name of a course in the profile]]
| [[File:MOParentRole02.png|thumb|Only '''then''' choose an item, for example grades]]
| [[File:MOParentRole03.png|thumb|The course grades are now visible]]
|}

*To view activity in another course, the parent needs to click back to the user's main profile and then select another course link.

==See also==
*[http://www.youtube.com/watch?v=Gk_TRi_N00o The Parent role in Moodle 2.0 video]
*[[Create_custom_roles|Create a custom role]]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=57812 Create a Parent of a student role]
*[http://moodle.org/mod/forum/discuss.php?d=199269 Parent Role Report: Who belongs to whom?]

*Improving navigation:

One small hack that can make the course list a bit more readable, especially for long course lists, is to change the format to a vertical list:

* Edit the moodle/user/view.php file and look for these lines (around line 302-304 in my 2.3.2 installation):
<code php>. $cfullname . "</a>, ";
} else {
$courselisting .= $cfullname . ", ";
</code>
* and change that to :
<code php>. $cfullname . "</a>,<br />";
} else {
$courselisting .= $cfullname . "<br />";;</code>
* Then save
This will affect the profile view in a course.

* Edit the moodle/user/profile.php file and look for these lines (around line 3332 in my 2.3.2 installation):
<code php> $courselisting .= "<a href=\"{$CFG->wwwroot}/user/view.php?id={$user->id}&course={$mycourse->id}\" $class >" . format_string($mycourse->fullname) . "</a>, ";
</code>
* and change that to :
<code php>$courselisting .= "<a href=\"{$CFG->wwwroot}/user/view.php?id={$user->id}&course={$mycourse->id}\" $class >" . format_string($mycourse->fullname) . "</a>,<br />";</code>
* Then save
This will affect the profile view from the main page.

[[eu:Guraso_rola]]
[[fr:Rôle Parent]]
[[ja:親ロール]]
[[de:Eltern-Rolle]]
[[es:Rol paterno]]

Stash block

2016-09-01T08:01:22Z

Abgreeve: Added Fred as a maintainer because he does a lot of the work on this project.

{{Infobox plugin
|type = Block, Stash
|set = https://moodle.org/plugins/browse.php?list=set&id=79
|entry = https://moodle.org/plugins/block_stash
|tracker = https://github.com/FMCorz/moodle-block_stash/issues
|discussion = https://moodle.org/plugins/block_stash
|maintainer = [[User:Adrian Greeve|Adrian Greeve]], Frédéric Massart
|float = right
}}
=Stash=
[https://moodle.org/plugins/block_stash Stash] is a block that allows a teacher to create and then show items around a course. Students can then go and collect these items which will then appear in their stash block. The stash block is a good way to encourage more interaction with activities and is invaluable for teachers looking to gamify their course.

==Adding an item==
* A teacher can click on the settings link in the stash block.
* This will lead them to a page that lists all the current items.
* Click on the "Add an item" button to add an item.
* Both a name and an image must be supplied.

[[File:block stash add an item.png|400px]]

* Clicking "Save and next" will progress to a location page.

[[File:block stash item location.png|400px]]

==Item location==
The location page contains details about a specific item location. One item has the ability to be located in many different places. Each location determines how many times a student can collect an item from that area.

==The hard part: embedding objects==
Please see [https://www.youtube.com/watch?v=J9fvJmUdUFg this video on YouTube] about what and how to insert.
===Click on the link to the item location===
* Click on the link to the location of the item (red rectangle in the image below) :

[[File:block stash link to the item location.png|400px]]

===Find the Snippet and copy that code===
* A window will pop with appearance dropdown menu, button text, snippet (this is the very important JavaScript code that will do the actual work), and location summary:

[[File:block stash link item location inside Smaug's castle.png|400px]]

* Notice that the 'Snippet' rectangle can be scrolled and resized. You can enlarge it by dragging the triangle in the lower right corner (red circle in the image below):

[[File:block stash snippet enlarged rectangle.png|400px]]

* Now you can select all the content of the Snippet box, which you will later paste into the [[Atto]] editor inside an activity:

[[File:block stash snippet selected for copying.png|500px]]

* Close the window.

=== Now select an activity or resource to harbour the item===
* Let us create a [[Page|page]] named 'The Hobbit, book reading'
* In that page, instruct the students to read the famous Tolkien book:

[[File:block stash required activity (page).png|400px]]

* Let us now create another [[Page|page]] named 'After reading The Hobbit'
* In that page, congratulate your students for having read a long book and... now it is time to insert the item (the ring) that will reward them for their reading activity:

[[File:block stash page where we will embedd the item.png|400px]]

* Notice the very first button (red rectangle) in the Atto toolbar that will expand the toolbar. You must click on that first button:

* Now you must click on the button with the <> symbols to show the HTML code (green rectangle):

[[File:block stash page where we will embedd the item expanded Atto toolbar.png|400px]]

* And finally, you can now paste the snippet code into the page:
[[File:block stash page where we have embedded the item Snippet code.png|400px]]

* You can click on the <> button again and save your page with the embedded item.

=See it in action in your own Moodle server=
The authors of the plugins have crafted a sample course for you to try. It is the best way to see what this plugin has to offer. Please accurately follow these steps:

* Get your hands on a Moodle installation (3.0 or newer preferred)
* Install the three following plugins (without exception):
** The [https://moodle.org/plugins/block_stash block stash plugin] (block_stash)
** The [https://moodle.org/plugins/availability_stash stash availability plugin] (availability_stash)
** The [https://moodle.org/plugins/filter_stash stash snippet filter plugin] (filter_stash)

* Enable the filter "Stash snippets" you just installed through "Site administration > Filters"
* Enable [[Using_restrict_access#Gamification|conditional access]], named enableavailability under "Site administration > Advanced features"
* [[Course restore|Restore]] now [https://moodle.org/pluginfile.php/50/local_plugins/plugin_description/1665/stash-demo.mbz this backup file] as a new course
* Enrol a student in the new course
* Now, login as that student and try the course
* You will see some very easy to follow instructions:
[[File:block stash course just started.png|400px]]

* You need to collect 3 coins, one sword and one crown in order to complete the course:
[[File:block stash 5 object collected.png|200px]]

* When your stash has all the needed items, you will have completed the course!
[[File:block stash course completed.png|400px]]

= Frequently asked questions =
== Why isn't my item working properly? ==
There are a couple of possibilities that your item may not be working properly.

* The code snippet will only work when inserted into an [[Atto]] editor that only a teacher can see. Placing code into a forum post or database entry will not work. Items for these activities should be placed in the description of the activity.
* Using the [[TinyMCE editor]] causes the JavaScript to be saved in an invalid form. Please use the [[Atto]] editor instead.

== How do I restrict access to an activity to rely on an item in the stash? ==
Restricting access to an activity through an item in the stash is possible, but requires the inclusion of [https://moodle.org/plugins/availability_stash the availability_stash plugin].

==Isn't there an easier way to use the Stash?==
Yes. Install and enable the [https://moodle.org/plugins/filter_stash Stash snippet filter] in order to provide shortcodes to place items.

[[Category:Game]]

[[es:blocks/stash]]

Stash block

2016-08-19T08:45:34Z

Abgreeve: /* Why isn't my item working properly? */ TinyMCE problem.

=Stash=
Stash is a block that allows a teacher to create and then show items around a course. Students can then go and collect these items which will then appear in their stash block. The stash block is a good way to encourage more interaction with activities and is invaluable for teachers looking to gamify their course.

==Adding an item==
A teacher can click on the settings link in the stash block. This will lead them to a page that lists all the current items. Click on the "Add an item" button to add an item.
Both a name and an image must be supplied.
Clicking "Save and next" will progress to a location page.
==Item location==
The location page contains details about a specific item location. One item has the ability to be located in many different places. Each location determines how many times a student can collect an item from that area.

= Frequently asked questions =
== Why isn't my item working properly? ==
There are a couple of possibilities that your item may not be working properly.

* The code snippet will only work when inserted into an editor that only a teacher can see. Placing code into a forum post or database entry will not work. Items for these activities should be placed in the description of the activity.
* Using the editor TinyMCE causes the JavaScript to be saved in an invalid form. Please use the atto editor instead.

== How do I restrict access to an activity to rely on an item in the stash? ==
Restricting access to an activity through an item in the stash is possible, but requires the inclusion of the availability_stash plugin.

Gradebook calculation changes

2016-08-04T02:40:27Z

Abgreeve: /* 20160518 - letter grade boundary issue */ - Information about a script for the 57 letter grade problem.

{{Grades}}
<p class="note">Note: The following information only applies if you see a message displayed in the gradebook following a site upgrade, or after restoring a course backup from a different version of Moodle.</p>

Occasionally there are error fixes which can affect gradebook calculations in certain courses. As part of the upgrade process, such courses are identified and a message is displayed in the gradebook informing teachers that error fixes may result in some grades being changed. Details of these changes are provided below. The 8-digit version number is the date of the fix.

It is recommended that the errors are fixed by clicking the button 'Accept grade changes and fix calculation errors'. Until this is done, the message will continue to be displayed in the gradebook (only for teachers; students can't see it). The old gradebook calculations will still be used (ensuring grades remain unchanged), however they are likely to result in more errors if grades are updated in the future.

=== 20150619 - Calculation of extra credit item weights when using natural aggregation ===

Two errors were fixed:
# Overriding the weight of the extra credit item can lead to changes in other items' weights and random final grades
# The automatic weight of an extra credit item was dependent on the overrides of the normal item's weights

The second error was especially noticeable for students with excluded grade items (for example, when they are hidden or empty).

For example, a category has two normal grade items and one extra credit item. If the maximum grades for each item are the same, the weights of the three items will be: 50%, 50% and 50%. However if the weights of the normal items are overridden to be 50% and 50%, then the weight of the extra credit item would become 0%. If the teacher overrode the weight of the first item to 80%, the second item would automatically become 20% (correct) and the extra credit would also become 20% (incorrect).

The correct behaviour (after the fix): If the weight of extra credit item is not overridden, it should be itemmaxgrade / totalmaxgrade , where totalmaxgrade does not include the extra credit item. In the example, the weight of the extra credit item should always be 50%.

See MDL-49257 for further details including screenshots.

=== 20150627 - Calculated grade items ===

Two errors affecting grades were fixed:
# Changing the maxgrade for a category item with a calculation that has existing grades results in grades displayed out of the old maximum grade, not the updated one. This can cause flow on affects for automatic weights with Natural Aggregation.
# Values for grade items with a calculation are always displayed from 0 to 100 regardless of the minimum and maximum grades for the grade item. This can cause flow on affects for automatic weights with Natural Aggregation.

These fixes will impact existing grades by correcting the maximum grade for existing grade items.

See MDL-48239 for further details.

=== 20160518 - letter grade boundary issue ===

Some letter boundaries, when achieved by a student, would not give the student the associated grade.
For example. If the letter grades were updated so that the letter boundary for a C was 57 and a D was 50, a student that received 57 for a grade would get a D instead of a C.
This problem only affects sites that have edited the letter grades, and not all letter boundaries have this problem. The default settings do not produce this error.
This has now been fixed, but the course gradebook will be frozen if the system has detected that the course has been affected by an altered letter grade boundary. There is a possibility that student's letter grades will change after the gradebook freeze has been accepted.
see MDL-45390 for further details.

The upgrade step that freezes the gradebook above for the letter grade boundary is not 100% accurate. The upgrade step was optimised for speed and will freeze any course that has the potential to be a problem. The script may freeze more courses than it needs to. To determine if a course is definitely affected requires a lot of processing. We have created a script that will go through each of the courses and analyse the grades to see if the grade displayed will actually change. Due to the complex nature of the gradebook, this requires checking how the grade will displayed from a teachers perspective as well as the student perspective and is consequently very slow.

If you wish to check your site and see which courses are definitely affected then you can find the script on issue MDL-55066.

'''Important'''
* The script can only be run '''after''' the upgrade has been done. The upgrade step is cautious with the courses it freezes and so the script uses the frozen courses as a base to do its calculations.
* The script is a Command Line Interface (CLI) and is to be run from the command line.
* The script has two settings.
<code php>
php 57script.php
</code>
Running the script with no options will only produce a report of which courses should be frozen and which should not. No alterations to the freeze will be made.
<code php>
php 57script.php --update
</code>
Running the script with the "update" option will unfreeze courses that it deems do not actually require freezing.

Stash block

2016-07-02T04:53:19Z

Abgreeve: /* Stash */ - More detail

=Stash=
Stash is a block that allows a teacher to create and then show items around a course. Students can then go and collect these items which will then appear in their stash block. The stash block is a good way to encourage more interaction with activities and is invaluable for teachers looking to gamify their course.

==Adding an item==
A teacher can click on the settings link in the stash block. This will lead them to a page that lists all the current items. Click on the "Add an item" button to add an item.
Both a name and an image must be supplied.
Clicking "Save and next" will progress to a location page.
==Item location==
The location page contains details about a specific item location. One item has the ability to be located in many different places. Each location determines how many times a student can collect an item from that area.

= Frequently asked questions =
== Why isn't my item working properly? ==
The code snippet will only work when inserted into an editor that only a teacher can see. Placing code into a forum post or database entry will not work. Items for these activities should be placed in the description of the activity.
== How do I restrict access to an activity to rely on an item in the stash? ==
Restricting access to an activity through an item in the stash is possible, but requires the inclusion of the availability_stash plugin.

Stash block

2016-07-02T04:40:46Z

Abgreeve: FAQ

=Stash=
Stash is a block that allows a teacher to create and then show items around a course. Students can then go and collect these items which will then appear in their stash block.

==Adding an item==
A teacher can click on the settings link in the stash block. This will lead them to a page that lists all the current items. Click on the "Add an item" button to add an item.
Both a name and an image must be supplied.
Clicking "Save and next" will progress to a location page.
==Item location==
The location page contains details about a specific item location. One item has the ability to be located in many different places. Each location determines how many times a student can collect an item from that area.
= Frequently asked questions =
== Why isn't my item working properly? ==
The code snippet will only work when inserted into an editor that only a teacher can see. Placing code into a forum post or database entry will not work. Items for these activities should be placed in the description of the activity.
== How do I restrict access to an activity to rely on an item in the stash? ==
Restricting access to an activity through an item in the stash is possible, but requires the inclusion of the availability_stash plugin.

Stash block

2016-06-29T07:52:51Z

Abgreeve: Items and locations

=Stash=
Stash is a block that allows a teacher to create and then show items around a course. Students can then go and collect these items which will then appear in their stash block.

==Adding an item==
A teacher can click on the settings link in the stash block. This will lead them to a page that lists all the current items. Click on the "Add an item" button to add an item.
Both a name and an image must be supplied.
Clicking "Save and next" will progress to a location page.
==Item location==
The location page contains details about a specific item location. One item has the ability to be located in many different places. Each location determines how many times a student can collect an item from that area.

Stash block

2016-06-29T07:35:37Z

Abgreeve: Very basic introduction to the stash

=Stash=
Stash is a block that allows a teacher to create and then show items around a course. Students can then go and collect these items which will then appear in their stash block.

Gradebook calculation changes

2016-06-29T02:17:13Z

Abgreeve: /* 20160518 - letter grade boundary issue */ more alterations

Gradebook calculation changes

2016-06-29T02:13:01Z

Abgreeve: /* 20160518 - letter grade boundary issue */ - small clarification

Gradebook calculation changes

2016-06-29T02:11:52Z

Abgreeve: /* 20160518 - letter grade boundary issue */

Legacy course files

2015-12-14T03:59:17Z

Abgreeve: /* Where are legacy files stored? -Uploading legacy course files */

{{Repositories}}
<p class="note">Note: This page only applies to sites which have been upgraded from Moodle 1.9.</p>
In Moodle 2.0 onwards, files are stored in separate areas, rather than together in the course files area. See [[Course files]] for a detailed explanation. When a site is upgraded from 1.9, the course files area is renamed 'Legacy course files'. By default, this area is not available in new courses.

''It is recommended that teachers make use of the new [[Repositories|repositories]] in Moodle 2.0 for storing course files, rather than saving them in the legacy course files area''.

==Enabling legacy course files areas==

To enable a legacy course files area in a new course

# Enable the legacy course files repository plugin in ''Administration > Site administration > Plugins > Repositories > Common repository settings''.
# Check the legacyfilesinnewcourses box in the Manage repositories common settings (Settings > Site administration > Plugins > Repositories > Common repository settings) then click the 'Save changes' button.
# Set 'Legacy course files' to Yes in the course settings.

A legacy course files link will then appear in the ''Administration > Course administration'' area.

==Repository capabilities==

The capabilities [[Capabilities/repository/coursefiles:view|Use course files repository plugin]] and [[Capabilities/moodle/course:managefiles|Manage files]] are both required for users to access the legacy course files area.

==FAQs==
===Can you find out disk volume of legacy files?===
No. You will need a custom report of some kind. See http://moodle.org/mod/forum/discuss.php?d=201601

===Where are legacy files stored?===
For one explanation, see http://moodle.org/mod/forum/discuss.php?d=164544

If you are looking to add files to the course (such as for testing). Go to 'Administration > Course administration > Legacy course files' in your course (with all the appropriate settings set as mentioned above). You can upload and delete files here.

===Is there a way to delete legacy files en masse?===
Not at the moment. Tracker item: http://tracker.moodle.org/browse/MDL-36008 and discussion: https://moodle.org/mod/forum/discuss.php?d=209353

See also a comment here: https://moodle.org/mod/forum/discuss.php?d=234922#p1020379

===Is there a way to prevent new additions to legacy files?===
Yes. Unchecking [[Managing_repositories#Allow adding to legacy course files|Allow adding to legacy course files]] in ''Site Administration > Plugins > Repositories > Common repository settings'' will prevent users from adding new files and directories to legacy course files, but they will still be able to delete files.

===What happens if you switch legacy files off in a site that has been upgraded and has a lot of legacy files?===
Unsure.

===Can you migrate a course from 1.9 to 2+ and NOT end up with a legacy files repository?===
Yes, you can. If you restore as a Teacher into the course you're currently present in (best if it's empty) and don't override any settings then the Legacy Files will not be added as a Repository.

===What happens to the Legacy files in a course imported from 1.9 to 2.x that is re-imported into another 2.x?===

===In backups, are legacy files included with a course?===
Seems to be the case: http://moodle.org/mod/forum/discuss.php?d=194981

Also check out https://moodle.org/mod/forum/discuss.php?d=251415

===Long term, will there be any problem keeping a large number of Legacy files?===
Possibly if you want to import (as opposed to restore) you may lose legacy files. See
*http://tracker.moodle.org/browse/MDL-25631
*http://tracker.moodle.org/browse/MDL-32598

===What happens if legacy files were previously enabled and then the legacy course files repository is disabled?===

Legacy course files are displayed if they have ever been enabled on the course, but can be disabled at the course level in the course settings. Any new courses created will not have a legacy course files area.

==Also see==
*http://moodle.org/mod/forum/discuss.php?d=172559
*http://moodle.org/mod/forum/discuss.php?d=197746
*https://moodle.org/mod/forum/discuss.php?d=234922

[[ja: レガシーコースファイル]]
[[de:Legacy-Kursdateien]]
[[es:Archivos de curso heredados]]

Legacy course files

2015-12-14T02:42:18Z

Abgreeve: /* Enabling legacy course files areas - clarification of point two */

{{Repositories}}
<p class="note">Note: This page only applies to sites which have been upgraded from Moodle 1.9.</p>
In Moodle 2.0 onwards, files are stored in separate areas, rather than together in the course files area. See [[Course files]] for a detailed explanation. When a site is upgraded from 1.9, the course files area is renamed 'Legacy course files'. By default, this area is not available in new courses.

''It is recommended that teachers make use of the new [[Repositories|repositories]] in Moodle 2.0 for storing course files, rather than saving them in the legacy course files area''.

==Enabling legacy course files areas==

To enable a legacy course files area in a new course

# Enable the legacy course files repository plugin in ''Administration > Site administration > Plugins > Repositories > Common repository settings''.
# Check the legacyfilesinnewcourses box in the Manage repositories common settings (Settings > Site administration > Plugins > Repositories > Common repository settings) then click the 'Save changes' button.
# Set 'Legacy course files' to Yes in the course settings.

A legacy course files link will then appear in the ''Administration > Course administration'' area.

==Repository capabilities==

The capabilities [[Capabilities/repository/coursefiles:view|Use course files repository plugin]] and [[Capabilities/moodle/course:managefiles|Manage files]] are both required for users to access the legacy course files area.

==FAQs==
===Can you find out disk volume of legacy files?===
No. You will need a custom report of some kind. See http://moodle.org/mod/forum/discuss.php?d=201601

===Where are legacy files stored?===
For one explanation, see http://moodle.org/mod/forum/discuss.php?d=164544

===Is there a way to delete legacy files en masse?===
Not at the moment. Tracker item: http://tracker.moodle.org/browse/MDL-36008 and discussion: https://moodle.org/mod/forum/discuss.php?d=209353

See also a comment here: https://moodle.org/mod/forum/discuss.php?d=234922#p1020379

===Is there a way to prevent new additions to legacy files?===
Yes. Unchecking [[Managing_repositories#Allow adding to legacy course files|Allow adding to legacy course files]] in ''Site Administration > Plugins > Repositories > Common repository settings'' will prevent users from adding new files and directories to legacy course files, but they will still be able to delete files.

===What happens if you switch legacy files off in a site that has been upgraded and has a lot of legacy files?===
Unsure.

===Can you migrate a course from 1.9 to 2+ and NOT end up with a legacy files repository?===
Yes, you can. If you restore as a Teacher into the course you're currently present in (best if it's empty) and don't override any settings then the Legacy Files will not be added as a Repository.

===What happens to the Legacy files in a course imported from 1.9 to 2.x that is re-imported into another 2.x?===

===In backups, are legacy files included with a course?===
Seems to be the case: http://moodle.org/mod/forum/discuss.php?d=194981

Also check out https://moodle.org/mod/forum/discuss.php?d=251415

===Long term, will there be any problem keeping a large number of Legacy files?===
Possibly if you want to import (as opposed to restore) you may lose legacy files. See
*http://tracker.moodle.org/browse/MDL-25631
*http://tracker.moodle.org/browse/MDL-32598

===What happens if legacy files were previously enabled and then the legacy course files repository is disabled?===

Legacy course files are displayed if they have ever been enabled on the course, but can be disabled at the course level in the course settings. Any new courses created will not have a legacy course files area.

==Also see==
*http://moodle.org/mod/forum/discuss.php?d=172559
*http://moodle.org/mod/forum/discuss.php?d=197746
*https://moodle.org/mod/forum/discuss.php?d=234922

[[ja: レガシーコースファイル]]
[[de:Legacy-Kursdateien]]
[[es:Archivos de curso heredados]]

User:Adrian Greeve/form comparison

2015-11-26T02:40:00Z

Abgreeve: /* Form library and helper functions */

==Edit form template==
{| class="nicetable"
|+ Form template
|-
!width="50%"|Type A
!width="50%"|Type B
|-
|
| <code xml>
{{!
@template mod_lesson/page_editor

}}

<div class="mod_lesson_page_editor">
<form action="">
<h3>Edit this {{lessonpagetype}} </h3>
{{#title}}
{{>core/form-element-text}}
{{/title}}
<div>Page Content</div>
{{#select}}
{{>core/form-element-select}}
{{/select}}
<div>
<button type="button" id="mod_lesson_editor_save_btn">Save</button>
<button type="button" id="mod_lesson_editor_cancel_btn">Cancel</button>
</div>
</form>
</div>
</code>
|}

==Form data compilation for displaying==
{| class="nicetable"
|+ Form data compilation for display
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
var frm = new form();
frm.addFieldset('general', 'General');
textfield = new text();
textfield.set_name('title');
textfield.set_id('mod_lesson_title_' + pageid);
textfield.set_label('Page Title');
textfield.set_required();
textfield.set_text(lesson.pages[pageid].title);
frm.addElement(textfield);
selectfield = new selectElement();
selectfield.set_name('Jump_1');
selectfield.set_label('Jumps');
selectfield.set_id("mod_lesson_jump_1_" + pageid);
selectfield.set_options(joptions);
frm.addElement(selectfield);
$.when(frm.printForm()).then(function(tempformstuff) {
$('.mod_lesson_pages').append(tempformstuff);
$('#mod_lesson_editor_save_btn').click(function() {
// Could do client side validation here.
if ($("#mod_lesson_title_" + pageid).val() == "") {
var textelement = $("#fitem_mod_lesson_title_" + pageid);
frm.handleError('title', textelement, 'text', 'Title should not be empty');
} else {
lesson.pages[pageid].save_edit_form(frm);
}
});
$('#mod_lesson_editor_cancel_btn').click(function() {
$('.mod_lesson_page_editor').remove();
});
});
</code>
| <code javascript>
var formdata = {
lessonpagetype: lesson.pages[pageid].qtypestring,
pageid: pageid,
title: {
id: "mod_lesson_title_" + pageid,
label: "Page Title",
name: "title",
text: lesson.pages[pageid].title,
required: 1
},
contents: lesson.pages[pageid].contents,
select: {
id: pageid,
label: "Jumps",
name: "Jump_1",
options: formfactory.formatOptions(joptions),
helpButton: "<button type=\"button\">Help is here</button>"

}
};
$.when(templates.render('mod_lesson/page_editor', formdata)).done(function(pageeditor) {
$('.mod_lesson_pages').append(pageeditor);
$('#mod_lesson_editor_save_btn').click(function() {
// Do client side validation.
var titleelement = $("#mod_lesson_title_" + pageid);
if (titleelement.val() == "") {
var errors = {
errors: {
name: "title",
message: "The lesson page title should not be empty"
}
};
formfactory.handleErrors(errors, formdata);
} else {
lesson.pages[pageid].save_edit_form(formdata);
}
});
$('#mod_lesson_editor_cancel_btn').click(function() {
$('.mod_lesson_page_editor').remove();
});
});
</code>
|}

==Saving a form==
{| class="nicetable"
|+ Form saving
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
save_edit_form: function(formobject) {

// Perhaps this could all be included in a save method for the form.
var formdata = formfactory.getFormData();
formdata["lessonid"] = lesson.id;
formdata["pageid"] = this.id;
delete formdata["Jump_1"];

var promises = ajax.call([{
methodname: 'mod_lesson_add_page',
args: formdata
}]);

$.when.apply($.when, promises).then(function(response) {
if (response.warnings.length != "0") {
formobject.handleErrors(response.warnings);
}
});
</code>
| <code javascript>
save_edit_form: function(formobject) {

// Perhaps this could all be included in a save method for the form.
var formdata = formfactory.getFormData();
formdata["lessonid"] = lesson.id;
formdata["pageid"] = this.id;
delete formdata["Jump_1"];

var promises = ajax.call([{
methodname: 'mod_lesson_add_page',
args: formdata
}]);

$.when.apply($.when, promises).then(function(response) {
if (response.warnings.length != "0") {
formfactory.handleErrors(response.warnings, formobject);
}
});
</code>
|}

==New form elements==
{| class="nicetable"
|+ New form elements
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
define(['jquery', 'core/form-element'], function($, formElement) {

var Select = function() {
formElement.call(this);
this.type = 'select';
this.options = '';
this.template = "core/form-element-select";
};

/**
* Format a normal array into an object for a select form element.
*
* @param {array} options An array of options.
* @param {string} selected The selected option. Needs to match the array index.
* @return {object} An options object that can be used with a select form element.
*/
this.formatOptions = function(options, selected) {
var returnoptions = [];
var select = 0;
if (selected !== 'undefined') {
select = selected
}
for (index in options) {
if (index == selected) {
returnoptions.push({
value: index,
text: options[index],
selected: select
});
} else {
returnoptions.push({
value: index,
text: options[index],
});
}
}
return returnoptions;
}

Select.prototype.set_name = function(name) {
formElement.prototype.set_name.call(this, name);
};

Select.prototype.set_id = function(id) {
formElement.prototype.set_id.call(this, id);
};

Select.prototype.set_label = function(label) {
formElement.prototype.set_label.call(this, label);
};

Select.prototype.set_error = function(error) {
formElement.prototype.set_error.call(this, error);
};

Select.prototype.set_required = function() {
formElement.prototype.set_required.call(this);
};

Select.prototype.set_options = function(options, selected) {
this.options = formatOptions(options, selected);
};

Select.prototype.get_name = function() {
return formElement.prototype.get_name.call(this);
};

Select.prototype.show = function() {
return formElement.prototype.show.call(this);
};

return Select;

});
</code>
|
|}

==Template for a select element==
Same for both.
<code xml>
<div id="fitem_{{id}}" class="fitem fitem_select {{#required}}required{{/required}} {{#advanced}}advanced{{/advanced}}" data-field-type="select">
<div class="fitemtitle">
<label {{#hiddenLabel}}class="accesshide"{{/hiddenLabel}} for="{{id}}">
{{label}}
{{#required}}{{>core/form-required}}{{/required}}
{{#advanced}}{{>core/form-advanced}}{{/advanced}}
</label>
{{{helpButton}}}
</div>
<div class="felement fselect {{#error}}error{{/error}}">
{{#error}}
<span class="error" tabindex="0">{{{error}}}</span>
<br/>
{{/error}}
<select name="{{name}}" id="{{id}}" {{#required}}required{{/required}} {{#size}}size="{{size}}"{{/size}}>
{{#options}}
<option value="{{value}}" {{#selected}}selected{{/selected}}>{{text}}</option>
{{/options}}
</select>
</div>
</div>

</code>

==Form library and helper functions==

{| class="nicetable"
|+ Library
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var Form = function() {
this._fieldsets = {};
this.elements = {};
this.formPage = '';

};

// These two methods would actually be using classes for the form.
Form.prototype.add_top = function() {
this.formPage += '<div class="mod_lesson_page_editor"><form action="">';
};

Form.prototype.add_bottom = function() {
this.formPage += '<div><button type="button" id="mod_lesson_editor_save_btn">Save</button>';
this.formPage += '<button type="button" id="mod_lesson_editor_cancel_btn">Cancel</button></div></form></div>';
};

Form.prototype.addFieldset = function(key, title) {
this._fieldsets[key] = title;
};

Form.prototype.handleError = function(errorname, errorelement, elementtype, errormessage) {
var index = elementtype + "-" + errorname;
this.elements[index].set_error(errormessage);
var htmlpromise = templates.render(this.elements[index].template, this.elements[index]);
$.when(htmlpromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
}

Form.prototype.handleErrors = function(errors) {

// Need to loop through all potential errors.

var errorname = errors.errors.name;
var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
Form.prototype.handleError.call(this, errorname, errorelement, elementtype, errors.errors.message);
}

Form.prototype.addElement = function(element) {
var index = element.type + "-" + element.name;
this.elements[index] = element;
};

Form.prototype.showElements = function() {
console.log(this.elements);
};

Form.prototype.printForm = function() {

var allpromises = [];
for (index in this.elements) {
allpromises.push(this.elements[index].show());
}

return $.when.apply($.when, allpromises).then(function() {
Form.prototype.add_top.call(this);
var schema = arguments;
for (index in schema) {
this.formPage += schema[index][0];
}
Form.prototype.add_bottom.call(this);
return this.formPage;
}, function() {
return 'default html';
});
}

return Form;

});
</code>
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var formData;

return {

handleErrors: function(errors, formdata) {
// name attribute of the error.
var errorname = errors.errors.name;
var templatedata;
for (index in formdata) {
if (typeof formdata[index] == "object") {
if (formdata[index].name == errorname) {
formdata[index].error = errors.errors.message;
templatedata = formdata[index];
}
}
}
// for (index in errors.errors) {

// console.log(errors.errors["name"]);
// }

// Need to loop through all potential errors.

var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
// console.log(elementtype);
var template = 'core/form-element-' + elementtype;
var templatepromise = templates.render(template, templatedata);
$.when(templatepromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
},

getFormData: function() {
formData = $('form').serializeArray();
var tempstorage = {};
for (index in formData) {
var name = formData[index].name;
if (name !== 'query') {
tempstorage[name] = formData[index].value;
}
}
return tempstorage;
},

/**
* Format a normal array into an object for a select form element.
*
* @param {array} options An array of options.
* @param {string} selected The selected option. Needs to match the array index.
* @return {object} An options object that can be used with a select form element.
*/
formatOptions: function(options, selected) {
var returnoptions = [];
var select = 0;
if (selected !== 'undefined') {
select = selected
}
for (index in options) {
if (index == selected) {
returnoptions.push({
value: index,
text: options[index],
selected: select
});
} else {
returnoptions.push({
value: index,
text: options[index],
});
}
}
return returnoptions;
}
};
});
</code>
|}

==Simple web service==
<code php>
class mod_lesson_external extends external_api {

public static function add_page_parameters() {
return new external_function_parameters(
array(
'lessonid' => new external_value(PARAM_INT, 'lesson module ID'),
'pageid' => new external_value(PARAM_INT, 'lesson page ID'),
'title' => new external_value(PARAM_TEXT, 'lesson page title', VALUE_OPTIONAL)
)
);
}

public static function add_page($lessonid, $pageid, $title) {
$params = self::validate_parameters(self::add_page_parameters(),
array($lessonid, $pageid, $title));
$errors = array();
if (empty($title)) {
$errors["code"] = "formvalidationfailed";
$errors["message"] = "Validation Failed";
$errors["errors"] = array('code' => 'notitlefound', 'name' => 'title', 'message' => 'Title must not be empty');
return array('status' => false, 'warnings' => $errors);
}
return array('status' => true, 'warnings' => $errors);
}

public static function add_page_returns() {
return new external_single_structure(
array(
'status' => new external_value(PARAM_BOOL, 'status: true if success'),
'warnings' => new external_warnings()
)
);
}
}
</code>

User:Adrian Greeve/form comparison

2015-11-26T01:39:05Z

Abgreeve: Titles

User:Adrian Greeve/form comparison

2015-11-26T01:33:17Z

Abgreeve: New form element

{| class="nicetable"
|+ Form saving
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
save_edit_form: function(formobject) {

// Perhaps this could all be included in a save method for the form.
var formdata = formfactory.getFormData();
formdata["lessonid"] = lesson.id;
formdata["pageid"] = this.id;
delete formdata["Jump_1"];

var promises = ajax.call([{
methodname: 'mod_lesson_add_page',
args: formdata
}]);

$.when.apply($.when, promises).then(function(response) {
if (response.warnings.length != "0") {
formobject.handleErrors(response.warnings);
}
});
</code>
| <code javascript>
save_edit_form: function(formobject) {

// Perhaps this could all be included in a save method for the form.
var formdata = formfactory.getFormData();
formdata["lessonid"] = lesson.id;
formdata["pageid"] = this.id;
delete formdata["Jump_1"];

var promises = ajax.call([{
methodname: 'mod_lesson_add_page',
args: formdata
}]);

$.when.apply($.when, promises).then(function(response) {
if (response.warnings.length != "0") {
formfactory.handleErrors(response.warnings, formobject);
}
});
</code>
|}

{| class="nicetable"
|+ Form data compilation for display
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
var frm = new form();
frm.addFieldset('general', 'General');
textfield = new text();
textfield.set_name('title');
textfield.set_id('mod_lesson_title_' + pageid);
textfield.set_label('Page Title');
textfield.set_required();
textfield.set_text(lesson.pages[pageid].title);
frm.addElement(textfield);
selectfield = new selectElement();
selectfield.set_name('Jump_1');
selectfield.set_label('Jumps');
selectfield.set_id("mod_lesson_jump_1_" + pageid);
selectfield.set_options(joptions);
frm.addElement(selectfield);
$.when(frm.printForm()).then(function(tempformstuff) {
$('.mod_lesson_pages').append(tempformstuff);
$('#mod_lesson_editor_save_btn').click(function() {
// Could do client side validation here.
if ($("#mod_lesson_title_" + pageid).val() == "") {
var textelement = $("#fitem_mod_lesson_title_" + pageid);
frm.handleError('title', textelement, 'text', 'Title should not be empty');
} else {
lesson.pages[pageid].save_edit_form(frm);
}
});
$('#mod_lesson_editor_cancel_btn').click(function() {
$('.mod_lesson_page_editor').remove();
});
});
</code>
| <code javascript>
var formdata = {
lessonpagetype: lesson.pages[pageid].qtypestring,
pageid: pageid,
title: {
id: "mod_lesson_title_" + pageid,
label: "Page Title",
name: "title",
text: lesson.pages[pageid].title,
required: 1
},
contents: lesson.pages[pageid].contents,
select: {
id: pageid,
label: "Jumps",
name: "Jump_1",
options: formfactory.formatOptions(joptions),
helpButton: "<button type=\"button\">Help is here</button>"

}
};
$.when(templates.render('mod_lesson/page_editor', formdata)).done(function(pageeditor) {
$('.mod_lesson_pages').append(pageeditor);
$('#mod_lesson_editor_save_btn').click(function() {
// Do client side validation.
var titleelement = $("#mod_lesson_title_" + pageid);
if (titleelement.val() == "") {
var errors = {
errors: {
name: "title",
message: "The lesson page title should not be empty"
}
};
formfactory.handleErrors(errors, formdata);
} else {
lesson.pages[pageid].save_edit_form(formdata);
}
});
$('#mod_lesson_editor_cancel_btn').click(function() {
$('.mod_lesson_page_editor').remove();
});
});
</code>
|}

{| class="nicetable"
|+ New form elements
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
define(['jquery', 'core/form-element'], function($, formElement) {

var Select = function() {
formElement.call(this);
this.type = 'select';
this.options = '';
this.template = "core/form-element-select";
};

/**
* Format a normal array into an object for a select form element.
*
* @param {array} options An array of options.
* @param {string} selected The selected option. Needs to match the array index.
* @return {object} An options object that can be used with a select form element.
*/
this.formatOptions = function(options, selected) {
var returnoptions = [];
var select = 0;
if (selected !== 'undefined') {
select = selected
}
for (index in options) {
if (index == selected) {
returnoptions.push({
value: index,
text: options[index],
selected: select
});
} else {
returnoptions.push({
value: index,
text: options[index],
});
}
}
return returnoptions;
}

Select.prototype.set_name = function(name) {
formElement.prototype.set_name.call(this, name);
};

Select.prototype.set_id = function(id) {
formElement.prototype.set_id.call(this, id);
};

Select.prototype.set_label = function(label) {
formElement.prototype.set_label.call(this, label);
};

Select.prototype.set_error = function(error) {
formElement.prototype.set_error.call(this, error);
};

Select.prototype.set_required = function() {
formElement.prototype.set_required.call(this);
};

Select.prototype.set_options = function(options, selected) {
this.options = formatOptions(options, selected);
};

Select.prototype.get_name = function() {
return formElement.prototype.get_name.call(this);
};

Select.prototype.show = function() {
return formElement.prototype.show.call(this);
};

return Select;

});
</code>
|
|}

==Template for a select element==
Same for both.
<code xml>
<div id="fitem_{{id}}" class="fitem fitem_select {{#required}}required{{/required}} {{#advanced}}advanced{{/advanced}}" data-field-type="select">
<div class="fitemtitle">
<label {{#hiddenLabel}}class="accesshide"{{/hiddenLabel}} for="{{id}}">
{{label}}
{{#required}}{{>core/form-required}}{{/required}}
{{#advanced}}{{>core/form-advanced}}{{/advanced}}
</label>
{{{helpButton}}}
</div>
<div class="felement fselect {{#error}}error{{/error}}">
{{#error}}
<span class="error" tabindex="0">{{{error}}}</span>
<br/>
{{/error}}
<select name="{{name}}" id="{{id}}" {{#required}}required{{/required}} {{#size}}size="{{size}}"{{/size}}>
{{#options}}
<option value="{{value}}" {{#selected}}selected{{/selected}}>{{text}}</option>
{{/options}}
</select>
</div>
</div>

</code>

{| class="nicetable"
|+ Form template
|-
!width="50%"|Type A
!width="50%"|Type B
|-
|
| <code xml>
{{!
@template mod_lesson/page_editor

}}

<div class="mod_lesson_page_editor">
<form action="">
<h3>Edit this {{lessonpagetype}} </h3>
{{#title}}
{{>core/form-element-text}}
{{/title}}
<div>Page Content</div>
{{#select}}
{{>core/form-element-select}}
{{/select}}
<div>
<button type="button" id="mod_lesson_editor_save_btn">Save</button>
<button type="button" id="mod_lesson_editor_cancel_btn">Cancel</button>
</div>
</form>
</div>
</code>
|}

{| class="nicetable"
|+ Library
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var Form = function() {
this._fieldsets = {};
this.elements = {};
this.formPage = '';

};

// These two methods would actually be using classes for the form.
Form.prototype.add_top = function() {
this.formPage += '<div class="mod_lesson_page_editor"><form action="">';
};

Form.prototype.add_bottom = function() {
this.formPage += '<div><button type="button" id="mod_lesson_editor_save_btn">Save</button>';
this.formPage += '<button type="button" id="mod_lesson_editor_cancel_btn">Cancel</button></div></form></div>';
};

Form.prototype.addFieldset = function(key, title) {
this._fieldsets[key] = title;
};

Form.prototype.handleError = function(errorname, errorelement, elementtype, errormessage) {
var index = elementtype + "-" + errorname;
this.elements[index].set_error(errormessage);
var htmlpromise = templates.render(this.elements[index].template, this.elements[index]);
$.when(htmlpromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
}

Form.prototype.handleErrors = function(errors) {

// Need to loop through all potential errors.

var errorname = errors.errors.name;
var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
Form.prototype.handleError.call(this, errorname, errorelement, elementtype, errors.errors.message);
}

Form.prototype.addElement = function(element) {
var index = element.type + "-" + element.name;
this.elements[index] = element;
};

Form.prototype.showElements = function() {
console.log(this.elements);
};

Form.prototype.printForm = function() {

var allpromises = [];
for (index in this.elements) {
allpromises.push(this.elements[index].show());
}

return $.when.apply($.when, allpromises).then(function() {
Form.prototype.add_top.call(this);
var schema = arguments;
for (index in schema) {
this.formPage += schema[index][0];
}
Form.prototype.add_bottom.call(this);
return this.formPage;
}, function() {
return 'default html';
});
}

return Form;

});
</code>
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var formData;

return {

handleErrors: function(errors, formdata) {
// name attribute of the error.
var errorname = errors.errors.name;
var templatedata;
for (index in formdata) {
if (typeof formdata[index] == "object") {
if (formdata[index].name == errorname) {
formdata[index].error = errors.errors.message;
templatedata = formdata[index];
}
}
}
// for (index in errors.errors) {

// console.log(errors.errors["name"]);
// }

// Need to loop through all potential errors.

var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
// console.log(elementtype);
var template = 'core/form-element-' + elementtype;
var templatepromise = templates.render(template, templatedata);
$.when(templatepromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
},

getFormData: function() {
formData = $('form').serializeArray();
var tempstorage = {};
for (index in formData) {
var name = formData[index].name;
if (name !== 'query') {
tempstorage[name] = formData[index].value;
}
}
return tempstorage;
},

/**
* Format a normal array into an object for a select form element.
*
* @param {array} options An array of options.
* @param {string} selected The selected option. Needs to match the array index.
* @return {object} An options object that can be used with a select form element.
*/
formatOptions: function(options, selected) {
var returnoptions = [];
var select = 0;
if (selected !== 'undefined') {
select = selected
}
for (index in options) {
if (index == selected) {
returnoptions.push({
value: index,
text: options[index],
selected: select
});
} else {
returnoptions.push({
value: index,
text: options[index],
});
}
}
return returnoptions;
}
};
});
</code>
|}

User:Adrian Greeve/form comparison

2015-11-26T01:27:43Z

Abgreeve: Form saving

{| class="nicetable"
|+ Form saving
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
save_edit_form: function(formobject) {

// Perhaps this could all be included in a save method for the form.
var formdata = formfactory.getFormData();
formdata["lessonid"] = lesson.id;
formdata["pageid"] = this.id;
delete formdata["Jump_1"];

var promises = ajax.call([{
methodname: 'mod_lesson_add_page',
args: formdata
}]);

$.when.apply($.when, promises).then(function(response) {
if (response.warnings.length != "0") {
formobject.handleErrors(response.warnings);
}
});
</code>
| <code javascript>
save_edit_form: function(formobject) {

// Perhaps this could all be included in a save method for the form.
var formdata = formfactory.getFormData();
formdata["lessonid"] = lesson.id;
formdata["pageid"] = this.id;
delete formdata["Jump_1"];

var promises = ajax.call([{
methodname: 'mod_lesson_add_page',
args: formdata
}]);

$.when.apply($.when, promises).then(function(response) {
if (response.warnings.length != "0") {
formfactory.handleErrors(response.warnings, formobject);
}
});
</code>
|}

{| class="nicetable"
|+ Form data compilation for display
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
var frm = new form();
frm.addFieldset('general', 'General');
textfield = new text();
textfield.set_name('title');
textfield.set_id('mod_lesson_title_' + pageid);
textfield.set_label('Page Title');
textfield.set_required();
textfield.set_text(lesson.pages[pageid].title);
frm.addElement(textfield);
selectfield = new selectElement();
selectfield.set_name('Jump_1');
selectfield.set_label('Jumps');
selectfield.set_id("mod_lesson_jump_1_" + pageid);
selectfield.set_options(joptions);
frm.addElement(selectfield);
$.when(frm.printForm()).then(function(tempformstuff) {
$('.mod_lesson_pages').append(tempformstuff);
$('#mod_lesson_editor_save_btn').click(function() {
// Could do client side validation here.
if ($("#mod_lesson_title_" + pageid).val() == "") {
var textelement = $("#fitem_mod_lesson_title_" + pageid);
frm.handleError('title', textelement, 'text', 'Title should not be empty');
} else {
lesson.pages[pageid].save_edit_form(frm);
}
});
$('#mod_lesson_editor_cancel_btn').click(function() {
$('.mod_lesson_page_editor').remove();
});
});
</code>
| <code javascript>
var formdata = {
lessonpagetype: lesson.pages[pageid].qtypestring,
pageid: pageid,
title: {
id: "mod_lesson_title_" + pageid,
label: "Page Title",
name: "title",
text: lesson.pages[pageid].title,
required: 1
},
contents: lesson.pages[pageid].contents,
select: {
id: pageid,
label: "Jumps",
name: "Jump_1",
options: formfactory.formatOptions(joptions),
helpButton: "<button type=\"button\">Help is here</button>"

}
};
$.when(templates.render('mod_lesson/page_editor', formdata)).done(function(pageeditor) {
$('.mod_lesson_pages').append(pageeditor);
$('#mod_lesson_editor_save_btn').click(function() {
// Do client side validation.
var titleelement = $("#mod_lesson_title_" + pageid);
if (titleelement.val() == "") {
var errors = {
errors: {
name: "title",
message: "The lesson page title should not be empty"
}
};
formfactory.handleErrors(errors, formdata);
} else {
lesson.pages[pageid].save_edit_form(formdata);
}
});
$('#mod_lesson_editor_cancel_btn').click(function() {
$('.mod_lesson_page_editor').remove();
});
});
</code>
|}

==Template for a select element==
Same for both.
<code xml>
<div id="fitem_{{id}}" class="fitem fitem_select {{#required}}required{{/required}} {{#advanced}}advanced{{/advanced}}" data-field-type="select">
<div class="fitemtitle">
<label {{#hiddenLabel}}class="accesshide"{{/hiddenLabel}} for="{{id}}">
{{label}}
{{#required}}{{>core/form-required}}{{/required}}
{{#advanced}}{{>core/form-advanced}}{{/advanced}}
</label>
{{{helpButton}}}
</div>
<div class="felement fselect {{#error}}error{{/error}}">
{{#error}}
<span class="error" tabindex="0">{{{error}}}</span>
<br/>
{{/error}}
<select name="{{name}}" id="{{id}}" {{#required}}required{{/required}} {{#size}}size="{{size}}"{{/size}}>
{{#options}}
<option value="{{value}}" {{#selected}}selected{{/selected}}>{{text}}</option>
{{/options}}
</select>
</div>
</div>

</code>

{| class="nicetable"
|+ Form template
|-
!width="50%"|Type A
!width="50%"|Type B
|-
|
| <code xml>
{{!
@template mod_lesson/page_editor

}}

<div class="mod_lesson_page_editor">
<form action="">
<h3>Edit this {{lessonpagetype}} </h3>
{{#title}}
{{>core/form-element-text}}
{{/title}}
<div>Page Content</div>
{{#select}}
{{>core/form-element-select}}
{{/select}}
<div>
<button type="button" id="mod_lesson_editor_save_btn">Save</button>
<button type="button" id="mod_lesson_editor_cancel_btn">Cancel</button>
</div>
</form>
</div>
</code>
|}

{| class="nicetable"
|+ Library
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var Form = function() {
this._fieldsets = {};
this.elements = {};
this.formPage = '';

};

// These two methods would actually be using classes for the form.
Form.prototype.add_top = function() {
this.formPage += '<div class="mod_lesson_page_editor"><form action="">';
};

Form.prototype.add_bottom = function() {
this.formPage += '<div><button type="button" id="mod_lesson_editor_save_btn">Save</button>';
this.formPage += '<button type="button" id="mod_lesson_editor_cancel_btn">Cancel</button></div></form></div>';
};

Form.prototype.addFieldset = function(key, title) {
this._fieldsets[key] = title;
};

Form.prototype.handleError = function(errorname, errorelement, elementtype, errormessage) {
var index = elementtype + "-" + errorname;
this.elements[index].set_error(errormessage);
var htmlpromise = templates.render(this.elements[index].template, this.elements[index]);
$.when(htmlpromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
}

Form.prototype.handleErrors = function(errors) {

// Need to loop through all potential errors.

var errorname = errors.errors.name;
var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
Form.prototype.handleError.call(this, errorname, errorelement, elementtype, errors.errors.message);
}

Form.prototype.addElement = function(element) {
var index = element.type + "-" + element.name;
this.elements[index] = element;
};

Form.prototype.showElements = function() {
console.log(this.elements);
};

Form.prototype.printForm = function() {

var allpromises = [];
for (index in this.elements) {
allpromises.push(this.elements[index].show());
}

return $.when.apply($.when, allpromises).then(function() {
Form.prototype.add_top.call(this);
var schema = arguments;
for (index in schema) {
this.formPage += schema[index][0];
}
Form.prototype.add_bottom.call(this);
return this.formPage;
}, function() {
return 'default html';
});
}

return Form;

});
</code>
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var formData;

return {

handleErrors: function(errors, formdata) {
// name attribute of the error.
var errorname = errors.errors.name;
var templatedata;
for (index in formdata) {
if (typeof formdata[index] == "object") {
if (formdata[index].name == errorname) {
formdata[index].error = errors.errors.message;
templatedata = formdata[index];
}
}
}
// for (index in errors.errors) {

// console.log(errors.errors["name"]);
// }

// Need to loop through all potential errors.

var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
// console.log(elementtype);
var template = 'core/form-element-' + elementtype;
var templatepromise = templates.render(template, templatedata);
$.when(templatepromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
},

getFormData: function() {
formData = $('form').serializeArray();
var tempstorage = {};
for (index in formData) {
var name = formData[index].name;
if (name !== 'query') {
tempstorage[name] = formData[index].value;
}
}
return tempstorage;
},

/**
* Format a normal array into an object for a select form element.
*
* @param {array} options An array of options.
* @param {string} selected The selected option. Needs to match the array index.
* @return {object} An options object that can be used with a select form element.
*/
formatOptions: function(options, selected) {
var returnoptions = [];
var select = 0;
if (selected !== 'undefined') {
select = selected
}
for (index in options) {
if (index == selected) {
returnoptions.push({
value: index,
text: options[index],
selected: select
});
} else {
returnoptions.push({
value: index,
text: options[index],
});
}
}
return returnoptions;
}
};
});
</code>
|}

User:Adrian Greeve/form comparison

2015-11-26T01:24:14Z

Abgreeve: form data definition

{| class="nicetable"
|+ Form data compilation for display
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
var frm = new form();
frm.addFieldset('general', 'General');
textfield = new text();
textfield.set_name('title');
textfield.set_id('mod_lesson_title_' + pageid);
textfield.set_label('Page Title');
textfield.set_required();
textfield.set_text(lesson.pages[pageid].title);
frm.addElement(textfield);
selectfield = new selectElement();
selectfield.set_name('Jump_1');
selectfield.set_label('Jumps');
selectfield.set_id("mod_lesson_jump_1_" + pageid);
selectfield.set_options(joptions);
frm.addElement(selectfield);
$.when(frm.printForm()).then(function(tempformstuff) {
$('.mod_lesson_pages').append(tempformstuff);
$('#mod_lesson_editor_save_btn').click(function() {
// Could do client side validation here.
if ($("#mod_lesson_title_" + pageid).val() == "") {
var textelement = $("#fitem_mod_lesson_title_" + pageid);
frm.handleError('title', textelement, 'text', 'Title should not be empty');
} else {
lesson.pages[pageid].save_edit_form(frm);
}
});
$('#mod_lesson_editor_cancel_btn').click(function() {
$('.mod_lesson_page_editor').remove();
});
});
</code>
| <code javascript>
var formdata = {
lessonpagetype: lesson.pages[pageid].qtypestring,
pageid: pageid,
title: {
id: "mod_lesson_title_" + pageid,
label: "Page Title",
name: "title",
text: lesson.pages[pageid].title,
required: 1
},
contents: lesson.pages[pageid].contents,
select: {
id: pageid,
label: "Jumps",
name: "Jump_1",
options: formfactory.formatOptions(joptions),
helpButton: "<button type=\"button\">Help is here</button>"

}
};
$.when(templates.render('mod_lesson/page_editor', formdata)).done(function(pageeditor) {
$('.mod_lesson_pages').append(pageeditor);
$('#mod_lesson_editor_save_btn').click(function() {
// Do client side validation.
var titleelement = $("#mod_lesson_title_" + pageid);
if (titleelement.val() == "") {
var errors = {
errors: {
name: "title",
message: "The lesson page title should not be empty"
}
};
formfactory.handleErrors(errors, formdata);
} else {
lesson.pages[pageid].save_edit_form(formdata);
}
});
$('#mod_lesson_editor_cancel_btn').click(function() {
$('.mod_lesson_page_editor').remove();
});
});
</code>
|}

==Template for a select element==
Same for both.
<code xml>
<div id="fitem_{{id}}" class="fitem fitem_select {{#required}}required{{/required}} {{#advanced}}advanced{{/advanced}}" data-field-type="select">
<div class="fitemtitle">
<label {{#hiddenLabel}}class="accesshide"{{/hiddenLabel}} for="{{id}}">
{{label}}
{{#required}}{{>core/form-required}}{{/required}}
{{#advanced}}{{>core/form-advanced}}{{/advanced}}
</label>
{{{helpButton}}}
</div>
<div class="felement fselect {{#error}}error{{/error}}">
{{#error}}
<span class="error" tabindex="0">{{{error}}}</span>
<br/>
{{/error}}
<select name="{{name}}" id="{{id}}" {{#required}}required{{/required}} {{#size}}size="{{size}}"{{/size}}>
{{#options}}
<option value="{{value}}" {{#selected}}selected{{/selected}}>{{text}}</option>
{{/options}}
</select>
</div>
</div>

</code>

{| class="nicetable"
|+ Form template
|-
!width="50%"|Type A
!width="50%"|Type B
|-
|
| <code xml>
{{!
@template mod_lesson/page_editor

}}

<div class="mod_lesson_page_editor">
<form action="">
<h3>Edit this {{lessonpagetype}} </h3>
{{#title}}
{{>core/form-element-text}}
{{/title}}
<div>Page Content</div>
{{#select}}
{{>core/form-element-select}}
{{/select}}
<div>
<button type="button" id="mod_lesson_editor_save_btn">Save</button>
<button type="button" id="mod_lesson_editor_cancel_btn">Cancel</button>
</div>
</form>
</div>
</code>
|}

{| class="nicetable"
|+ Library
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var Form = function() {
this._fieldsets = {};
this.elements = {};
this.formPage = '';

};

// These two methods would actually be using classes for the form.
Form.prototype.add_top = function() {
this.formPage += '<div class="mod_lesson_page_editor"><form action="">';
};

Form.prototype.add_bottom = function() {
this.formPage += '<div><button type="button" id="mod_lesson_editor_save_btn">Save</button>';
this.formPage += '<button type="button" id="mod_lesson_editor_cancel_btn">Cancel</button></div></form></div>';
};

Form.prototype.addFieldset = function(key, title) {
this._fieldsets[key] = title;
};

Form.prototype.handleError = function(errorname, errorelement, elementtype, errormessage) {
var index = elementtype + "-" + errorname;
this.elements[index].set_error(errormessage);
var htmlpromise = templates.render(this.elements[index].template, this.elements[index]);
$.when(htmlpromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
}

Form.prototype.handleErrors = function(errors) {

// Need to loop through all potential errors.

var errorname = errors.errors.name;
var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
Form.prototype.handleError.call(this, errorname, errorelement, elementtype, errors.errors.message);
}

Form.prototype.addElement = function(element) {
var index = element.type + "-" + element.name;
this.elements[index] = element;
};

Form.prototype.showElements = function() {
console.log(this.elements);
};

Form.prototype.printForm = function() {

var allpromises = [];
for (index in this.elements) {
allpromises.push(this.elements[index].show());
}

return $.when.apply($.when, allpromises).then(function() {
Form.prototype.add_top.call(this);
var schema = arguments;
for (index in schema) {
this.formPage += schema[index][0];
}
Form.prototype.add_bottom.call(this);
return this.formPage;
}, function() {
return 'default html';
});
}

return Form;

});
</code>
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var formData;

return {

handleErrors: function(errors, formdata) {
// name attribute of the error.
var errorname = errors.errors.name;
var templatedata;
for (index in formdata) {
if (typeof formdata[index] == "object") {
if (formdata[index].name == errorname) {
formdata[index].error = errors.errors.message;
templatedata = formdata[index];
}
}
}
// for (index in errors.errors) {

// console.log(errors.errors["name"]);
// }

// Need to loop through all potential errors.

var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
// console.log(elementtype);
var template = 'core/form-element-' + elementtype;
var templatepromise = templates.render(template, templatedata);
$.when(templatepromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
},

getFormData: function() {
formData = $('form').serializeArray();
var tempstorage = {};
for (index in formData) {
var name = formData[index].name;
if (name !== 'query') {
tempstorage[name] = formData[index].value;
}
}
return tempstorage;
},

/**
* Format a normal array into an object for a select form element.
*
* @param {array} options An array of options.
* @param {string} selected The selected option. Needs to match the array index.
* @return {object} An options object that can be used with a select form element.
*/
formatOptions: function(options, selected) {
var returnoptions = [];
var select = 0;
if (selected !== 'undefined') {
select = selected
}
for (index in options) {
if (index == selected) {
returnoptions.push({
value: index,
text: options[index],
selected: select
});
} else {
returnoptions.push({
value: index,
text: options[index],
});
}
}
return returnoptions;
}
};
});
</code>
|}

User:Adrian Greeve/form comparison

2015-11-26T01:17:25Z

Abgreeve: Select template

==Template for a select element==
Same for both.
<code xml>
<div id="fitem_{{id}}" class="fitem fitem_select {{#required}}required{{/required}} {{#advanced}}advanced{{/advanced}}" data-field-type="select">
<div class="fitemtitle">
<label {{#hiddenLabel}}class="accesshide"{{/hiddenLabel}} for="{{id}}">
{{label}}
{{#required}}{{>core/form-required}}{{/required}}
{{#advanced}}{{>core/form-advanced}}{{/advanced}}
</label>
{{{helpButton}}}
</div>
<div class="felement fselect {{#error}}error{{/error}}">
{{#error}}
<span class="error" tabindex="0">{{{error}}}</span>
<br/>
{{/error}}
<select name="{{name}}" id="{{id}}" {{#required}}required{{/required}} {{#size}}size="{{size}}"{{/size}}>
{{#options}}
<option value="{{value}}" {{#selected}}selected{{/selected}}>{{text}}</option>
{{/options}}
</select>
</div>
</div>

</code>

{| class="nicetable"
|+ Form template
|-
!width="50%"|Type A
!width="50%"|Type B
|-
|
| <code xml>
{{!
@template mod_lesson/page_editor

}}

<div class="mod_lesson_page_editor">
<form action="">
<h3>Edit this {{lessonpagetype}} </h3>
{{#title}}
{{>core/form-element-text}}
{{/title}}
<div>Page Content</div>
{{#select}}
{{>core/form-element-select}}
{{/select}}
<div>
<button type="button" id="mod_lesson_editor_save_btn">Save</button>
<button type="button" id="mod_lesson_editor_cancel_btn">Cancel</button>
</div>
</form>
</div>
</code>
|}

{| class="nicetable"
|+ Library
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var Form = function() {
this._fieldsets = {};
this.elements = {};
this.formPage = '';

};

// These two methods would actually be using classes for the form.
Form.prototype.add_top = function() {
this.formPage += '<div class="mod_lesson_page_editor"><form action="">';
};

Form.prototype.add_bottom = function() {
this.formPage += '<div><button type="button" id="mod_lesson_editor_save_btn">Save</button>';
this.formPage += '<button type="button" id="mod_lesson_editor_cancel_btn">Cancel</button></div></form></div>';
};

Form.prototype.addFieldset = function(key, title) {
this._fieldsets[key] = title;
};

Form.prototype.handleError = function(errorname, errorelement, elementtype, errormessage) {
var index = elementtype + "-" + errorname;
this.elements[index].set_error(errormessage);
var htmlpromise = templates.render(this.elements[index].template, this.elements[index]);
$.when(htmlpromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
}

Form.prototype.handleErrors = function(errors) {

// Need to loop through all potential errors.

var errorname = errors.errors.name;
var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
Form.prototype.handleError.call(this, errorname, errorelement, elementtype, errors.errors.message);
}

Form.prototype.addElement = function(element) {
var index = element.type + "-" + element.name;
this.elements[index] = element;
};

Form.prototype.showElements = function() {
console.log(this.elements);
};

Form.prototype.printForm = function() {

var allpromises = [];
for (index in this.elements) {
allpromises.push(this.elements[index].show());
}

return $.when.apply($.when, allpromises).then(function() {
Form.prototype.add_top.call(this);
var schema = arguments;
for (index in schema) {
this.formPage += schema[index][0];
}
Form.prototype.add_bottom.call(this);
return this.formPage;
}, function() {
return 'default html';
});
}

return Form;

});
</code>
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var formData;

return {

handleErrors: function(errors, formdata) {
// name attribute of the error.
var errorname = errors.errors.name;
var templatedata;
for (index in formdata) {
if (typeof formdata[index] == "object") {
if (formdata[index].name == errorname) {
formdata[index].error = errors.errors.message;
templatedata = formdata[index];
}
}
}
// for (index in errors.errors) {

// console.log(errors.errors["name"]);
// }

// Need to loop through all potential errors.

var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
// console.log(elementtype);
var template = 'core/form-element-' + elementtype;
var templatepromise = templates.render(template, templatedata);
$.when(templatepromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
},

getFormData: function() {
formData = $('form').serializeArray();
var tempstorage = {};
for (index in formData) {
var name = formData[index].name;
if (name !== 'query') {
tempstorage[name] = formData[index].value;
}
}
return tempstorage;
},

/**
* Format a normal array into an object for a select form element.
*
* @param {array} options An array of options.
* @param {string} selected The selected option. Needs to match the array index.
* @return {object} An options object that can be used with a select form element.
*/
formatOptions: function(options, selected) {
var returnoptions = [];
var select = 0;
if (selected !== 'undefined') {
select = selected
}
for (index in options) {
if (index == selected) {
returnoptions.push({
value: index,
text: options[index],
selected: select
});
} else {
returnoptions.push({
value: index,
text: options[index],
});
}
}
return returnoptions;
}
};
});
</code>
|}

User:Adrian Greeve/form comparison

2015-11-26T01:14:49Z

Abgreeve: templates

{| class="nicetable"
|+ Form template
|-
!width="50%"|Type A
!width="50%"|Type B
|-
|
| <code xml>
{{!
@template mod_lesson/page_editor

}}

<div class="mod_lesson_page_editor">
<form action="">
<h3>Edit this {{lessonpagetype}} </h3>
{{#title}}
{{>core/form-element-text}}
{{/title}}
<div>Page Content</div>
{{#select}}
{{>core/form-element-select}}
{{/select}}
<div>
<button type="button" id="mod_lesson_editor_save_btn">Save</button>
<button type="button" id="mod_lesson_editor_cancel_btn">Cancel</button>
</div>
</form>
</div>
</code>
|}

{| class="nicetable"
|+ Library
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var Form = function() {
this._fieldsets = {};
this.elements = {};
this.formPage = '';

};

// These two methods would actually be using classes for the form.
Form.prototype.add_top = function() {
this.formPage += '<div class="mod_lesson_page_editor"><form action="">';
};

Form.prototype.add_bottom = function() {
this.formPage += '<div><button type="button" id="mod_lesson_editor_save_btn">Save</button>';
this.formPage += '<button type="button" id="mod_lesson_editor_cancel_btn">Cancel</button></div></form></div>';
};

Form.prototype.addFieldset = function(key, title) {
this._fieldsets[key] = title;
};

Form.prototype.handleError = function(errorname, errorelement, elementtype, errormessage) {
var index = elementtype + "-" + errorname;
this.elements[index].set_error(errormessage);
var htmlpromise = templates.render(this.elements[index].template, this.elements[index]);
$.when(htmlpromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
}

Form.prototype.handleErrors = function(errors) {

// Need to loop through all potential errors.

var errorname = errors.errors.name;
var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
Form.prototype.handleError.call(this, errorname, errorelement, elementtype, errors.errors.message);
}

Form.prototype.addElement = function(element) {
var index = element.type + "-" + element.name;
this.elements[index] = element;
};

Form.prototype.showElements = function() {
console.log(this.elements);
};

Form.prototype.printForm = function() {

var allpromises = [];
for (index in this.elements) {
allpromises.push(this.elements[index].show());
}

return $.when.apply($.when, allpromises).then(function() {
Form.prototype.add_top.call(this);
var schema = arguments;
for (index in schema) {
this.formPage += schema[index][0];
}
Form.prototype.add_bottom.call(this);
return this.formPage;
}, function() {
return 'default html';
});
}

return Form;

});
</code>
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var formData;

return {

handleErrors: function(errors, formdata) {
// name attribute of the error.
var errorname = errors.errors.name;
var templatedata;
for (index in formdata) {
if (typeof formdata[index] == "object") {
if (formdata[index].name == errorname) {
formdata[index].error = errors.errors.message;
templatedata = formdata[index];
}
}
}
// for (index in errors.errors) {

// console.log(errors.errors["name"]);
// }

// Need to loop through all potential errors.

var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
// console.log(elementtype);
var template = 'core/form-element-' + elementtype;
var templatepromise = templates.render(template, templatedata);
$.when(templatepromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
},

getFormData: function() {
formData = $('form').serializeArray();
var tempstorage = {};
for (index in formData) {
var name = formData[index].name;
if (name !== 'query') {
tempstorage[name] = formData[index].value;
}
}
return tempstorage;
},

/**
* Format a normal array into an object for a select form element.
*
* @param {array} options An array of options.
* @param {string} selected The selected option. Needs to match the array index.
* @return {object} An options object that can be used with a select form element.
*/
formatOptions: function(options, selected) {
var returnoptions = [];
var select = 0;
if (selected !== 'undefined') {
select = selected
}
for (index in options) {
if (index == selected) {
returnoptions.push({
value: index,
text: options[index],
selected: select
});
} else {
returnoptions.push({
value: index,
text: options[index],
});
}
}
return returnoptions;
}
};
});
</code>
|}

User:Adrian Greeve/form comparison

2015-11-26T01:10:39Z

Abgreeve: Set width

{| class="nicetable"
|+ Library
|-
!width="50%"|Type A
!width="50%"|Type B
|-
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var Form = function() {
this._fieldsets = {};
this.elements = {};
this.formPage = '';

};

// These two methods would actually be using classes for the form.
Form.prototype.add_top = function() {
this.formPage += '<div class="mod_lesson_page_editor"><form action="">';
};

Form.prototype.add_bottom = function() {
this.formPage += '<div><button type="button" id="mod_lesson_editor_save_btn">Save</button>';
this.formPage += '<button type="button" id="mod_lesson_editor_cancel_btn">Cancel</button></div></form></div>';
};

Form.prototype.addFieldset = function(key, title) {
this._fieldsets[key] = title;
};

Form.prototype.handleError = function(errorname, errorelement, elementtype, errormessage) {
var index = elementtype + "-" + errorname;
this.elements[index].set_error(errormessage);
var htmlpromise = templates.render(this.elements[index].template, this.elements[index]);
$.when(htmlpromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
}

Form.prototype.handleErrors = function(errors) {

// Need to loop through all potential errors.

var errorname = errors.errors.name;
var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
Form.prototype.handleError.call(this, errorname, errorelement, elementtype, errors.errors.message);
}

Form.prototype.addElement = function(element) {
var index = element.type + "-" + element.name;
this.elements[index] = element;
};

Form.prototype.showElements = function() {
console.log(this.elements);
};

Form.prototype.printForm = function() {

var allpromises = [];
for (index in this.elements) {
allpromises.push(this.elements[index].show());
}

return $.when.apply($.when, allpromises).then(function() {
Form.prototype.add_top.call(this);
var schema = arguments;
for (index in schema) {
this.formPage += schema[index][0];
}
Form.prototype.add_bottom.call(this);
return this.formPage;
}, function() {
return 'default html';
});
}

return Form;

});
</code>
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var formData;

return {

handleErrors: function(errors, formdata) {
// name attribute of the error.
var errorname = errors.errors.name;
var templatedata;
for (index in formdata) {
if (typeof formdata[index] == "object") {
if (formdata[index].name == errorname) {
formdata[index].error = errors.errors.message;
templatedata = formdata[index];
}
}
}
// for (index in errors.errors) {

// console.log(errors.errors["name"]);
// }

// Need to loop through all potential errors.

var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
// console.log(elementtype);
var template = 'core/form-element-' + elementtype;
var templatepromise = templates.render(template, templatedata);
$.when(templatepromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
},

getFormData: function() {
formData = $('form').serializeArray();
var tempstorage = {};
for (index in formData) {
var name = formData[index].name;
if (name !== 'query') {
tempstorage[name] = formData[index].value;
}
}
return tempstorage;
},

/**
* Format a normal array into an object for a select form element.
*
* @param {array} options An array of options.
* @param {string} selected The selected option. Needs to match the array index.
* @return {object} An options object that can be used with a select form element.
*/
formatOptions: function(options, selected) {
var returnoptions = [];
var select = 0;
if (selected !== 'undefined') {
select = selected
}
for (index in options) {
if (index == selected) {
returnoptions.push({
value: index,
text: options[index],
selected: select
});
} else {
returnoptions.push({
value: index,
text: options[index],
});
}
}
return returnoptions;
}
};
});
</code>
|}

User:Adrian Greeve/form comparison

2015-11-26T01:08:18Z

Abgreeve: Library for both types

{| class="nicetable"
|+ Library
|-
! Type A
! Type B
|-
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var Form = function() {
this._fieldsets = {};
this.elements = {};
this.formPage = '';

};

// These two methods would actually be using classes for the form.
Form.prototype.add_top = function() {
this.formPage += '<div class="mod_lesson_page_editor"><form action="">';
};

Form.prototype.add_bottom = function() {
this.formPage += '<div><button type="button" id="mod_lesson_editor_save_btn">Save</button>';
this.formPage += '<button type="button" id="mod_lesson_editor_cancel_btn">Cancel</button></div></form></div>';
};

Form.prototype.addFieldset = function(key, title) {
this._fieldsets[key] = title;
};

Form.prototype.handleError = function(errorname, errorelement, elementtype, errormessage) {
var index = elementtype + "-" + errorname;
this.elements[index].set_error(errormessage);
var htmlpromise = templates.render(this.elements[index].template, this.elements[index]);
$.when(htmlpromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
}

Form.prototype.handleErrors = function(errors) {

// Need to loop through all potential errors.

var errorname = errors.errors.name;
var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
Form.prototype.handleError.call(this, errorname, errorelement, elementtype, errors.errors.message);
}

Form.prototype.addElement = function(element) {
var index = element.type + "-" + element.name;
this.elements[index] = element;
};

Form.prototype.showElements = function() {
console.log(this.elements);
};

Form.prototype.printForm = function() {

var allpromises = [];
for (index in this.elements) {
allpromises.push(this.elements[index].show());
}

return $.when.apply($.when, allpromises).then(function() {
Form.prototype.add_top.call(this);
var schema = arguments;
for (index in schema) {
this.formPage += schema[index][0];
}
Form.prototype.add_bottom.call(this);
return this.formPage;
}, function() {
return 'default html';
});
}

return Form;

});
</code>
| <code javascript>
define(['jquery', 'core/templates'], function($, templates) {

var formData;

return {

handleErrors: function(errors, formdata) {
// name attribute of the error.
var errorname = errors.errors.name;
var templatedata;
for (index in formdata) {
if (typeof formdata[index] == "object") {
if (formdata[index].name == errorname) {
formdata[index].error = errors.errors.message;
templatedata = formdata[index];
}
}
}
// for (index in errors.errors) {

// console.log(errors.errors["name"]);
// }

// Need to loop through all potential errors.

var errorelementid = $(":input[name=" + errorname + "]").attr("id");
// console.log(errorelementid);
var errorelement = $("#fitem_" + errorelementid);
// console.log(errorelement);
// Get the form element type.
var elementtype = errorelement.attr("data-field-type");
// console.log(elementtype);
var template = 'core/form-element-' + elementtype;
var templatepromise = templates.render(template, templatedata);
$.when(templatepromise).then(function(newhtml) {
templates.replaceNode(errorelement, newhtml);
});
},

getFormData: function() {
formData = $('form').serializeArray();
var tempstorage = {};
for (index in formData) {
var name = formData[index].name;
if (name !== 'query') {
tempstorage[name] = formData[index].value;
}
}
return tempstorage;
},

/**
* Format a normal array into an object for a select form element.
*
* @param {array} options An array of options.
* @param {string} selected The selected option. Needs to match the array index.
* @return {object} An options object that can be used with a select form element.
*/
formatOptions: function(options, selected) {
var returnoptions = [];
var select = 0;
if (selected !== 'undefined') {
select = selected
}
for (index in options) {
if (index == selected) {
returnoptions.push({
value: index,
text: options[index],
selected: select
});
} else {
returnoptions.push({
value: index,
text: options[index],
});
}
}
return returnoptions;
}
};
});
</code>
|}

Grade import

2015-07-27T06:09:01Z

Abgreeve: /* Importing grades */ - Inclusion of note 3

{{Grades}}
==Importing grades==
Grades may be imported as a CSV or XML file, or by pasting from a spreadsheet.

The import file format is the same as the corresponding export format.

'''Note 1:''' Grade import is equivalent to manual grading in the [[Grader report|grader report]]. Thus, if grades for a particular Moodle activity such as an assignment are imported, they can no longer be edited via the assignment submission page.

'''Note 2:''' To import grades above 100% you need to check the 'unlimitedgrades' and 'gradepointmax' settings in ''Site administration>Administration>Grades>General settings''.

'''Note 3:''' Importing feedback will also overwrite any grades that are linked to that assessment. Please include both feedback and grades for the activity when mapping and importing grades via CSV. If both columns are not included then all grades for that activity will be lost.

[[Image:Csv grade import.png|thumb|CSV grade import]]
To import grades into the gradebook:

# Decide on an import format - CSV or XML file, or paste from spreadsheet (see below) - then [[Grade export|export some grades]] using the corresponding export format.
# Edit the export file as appropriate and save it.
# Tip: If you opened your exported file in Excel, don't add columns there because Moodle will reject the import if there are new columns that didn't exist in the exported file. If you need to add columns, do that in Moodle BEFORE you export your gradebook.
# Select your chosen import format from the gradebook dropdown menu.
# Browse and upload your previously saved file.
# Set options as required.
# Click the "Upload grades" button.
# CSV import only: Preview the grade import and choose the column mapping then click the "Upload grades" button to complete the grade import.
## Tip: By default "Map from" is set to First Name, and "Map to" to userid. Change both dropdowns to: "Email Address" to "useremail", or to "Id Number" to "useridnumber" (assuming that your users have ID number fields filled in in their profiles).
## Tip: Unlike in most email programs, email addresses are case sensitive in grade import files. (This should eventually be fixed as per MDL-29315.)

You need two permissions to import grades: (1) general permission to import grades and (2) permission to import grades in a particular format. For example, to import CSV grades you need moodle/grade:import ("Import grades") = Allow and gradeimport/csv:view ("Import grades from CSV") = Allow

==CSV import==

CSV import is more flexible than XML import, as you may choose the column mapping.

===Grade Mapping===

After selecting your CSV for import you'll be prompted to map user fields and grade items to the new column headers to ensure that there is a match. More than one item can be mapped to the same grade item in your destination course so be mindful of the mapping to ensure that grade data is imported properly, any collisions (i.e. if two or more fields are mapped to the same but duplicate data exists) will cause an error. User grade data for users not yet enrolled to the destination course will be noted (and once enrolled their grade data will display).

===Encoding===

If you are unsure of the encoding of your CSV file, try selecting the second option in the encoding dropdown menu. If you've used Excel to produce the CSV file the second option WINDOWS-xxx encoding is probably the correct one. The grade import preview will tell you if you guessed the encoding correctly.

===Verbose scales===

Scales can be either specified as a raw id - eg. 0, 1, 2, 3, etc. or as a string, eg. "good", "bad", "not very bad". The later format is called "verbose".

===Force import===

This prevents grade overriding during the grade importing in a scenario where more than one teacher exports the course grades and then re-imports them. If a second teacher exports the grades and tries to import them, the following error message will be displayed and the grade importing procedure will be aborted:
<pre>(''Student name'') grades have not been imported because the grades in the import file are older than in the grader report. To proceed with the grade import anyway, use the force import option.</pre>

It will not be possible to import a file that had been exported file longer than a year ago, one with dates in the future. However, in cases where a teacher needs to import the grades regardless, they should use the '''Force import'''. option. This will then import the grades irrespective of the dates.

==Paste from spreadsheet==

Grades may be pasted directly from a spreadsheet such as Excel or Libre Office:

1) Ensure you have the correct column names for your grades (eg the assignment title or manual grade) It might help to download and edit the relevant students and graded information by using the [[Grade export]] feature.

2) For the students you need either their username, their ID or their email address. Add the grades you need and copy the relevant section:
[[File:pastegrades1.png|thumb|center|400px]]
3) In your course, go to ''Grade administration>Import>Paste from spreadsheet'' and paste:
[[File:pastegrades2.png|thumb|center|400px]]
4) In the preview, ensure you match up the identifier you used for the students -so if you used 'username', ensure it maps to 'username'. Do the same for your graded activities:
[[File:pastegrades3.png|thumb|400px|center]]
5) If everything has been correctly mapped (See grade mapping above), you should get a success message and the grades will have been added, displaying in a different colour to show they were imported directly into the gradebook:
{|
| [[File:pastegrades4.png|thumb|400px]]
| [[File:pastegrades5.png|thumb|400px]]
|}

Paste from a spreadsheet requires similar permissions to a csv file import: (1) general permission to import grades and (2) permission to import grades in a particular format i.e. moodle/grade:import ("Import grades") = Allow and gradeimport/direct:view ("Import grades from spreadsheet") = Allow

==XML import==

Before importing an XML file you will need to ensure that all of the students that you want to alter grades for have their ID number field filled out. This is located in the "Optional" section of the user edit profile page.
You will also need to set the ID number of the activity as well. You can find this under "Common module settings" when editing the activity.

The format for the XML should be as follows:
<pre>
<results>
<result>
<assignment>activityidnumber</assignment>
<student>studentidnumber</student>
<score>53.00</score>
</result>
<result>
<assignment>differentactivityidnumber</assignment>
<student>studentidnumber</student>
<score>73.00</score>
</result>
</results>
</pre>

For a working example try exporting the gradebook as an xml file and view the format.

===Remote file URL===

The remote file URL field is for fetching data from a remote server, such as a student information system.

==Grade import capabilities==

* [[Capabilities/gradeimport/csv:view|Import grades from CSV]]
* [[Capabilities/gradeimport/xml:publish|Publish import grades from XML]]
* [[Capabilities/gradeimport/xml:view|Import grades from XML]]

==See also==

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=85944 Gradebook confusion]
*[http://moodle.org/mod/forum/discuss.php?d=92081 Can external software insert data into the gradebook?]

[[ja:評定のインポート]]
[[de:Bewertungen importieren]]
[[es:Importar calificaciones]]
[[fr:Importation des notes]]

Grade import

2015-07-27T06:07:53Z

Abgreeve: /* Grade Mapping */ moving content

{{Grades}}
==Importing grades==
Grades may be imported as a CSV or XML file, or by pasting from a spreadsheet.

The import file format is the same as the corresponding export format.

'''Note 1:''' Grade import is equivalent to manual grading in the [[Grader report|grader report]]. Thus, if grades for a particular Moodle activity such as an assignment are imported, they can no longer be edited via the assignment submission page.

'''Note 2:''' To import grades above 100% you need to check the 'unlimitedgrades' and 'gradepointmax' settings in ''Site administration>Administration>Grades>General settings''.

[[Image:Csv grade import.png|thumb|CSV grade import]]
To import grades into the gradebook:

# Decide on an import format - CSV or XML file, or paste from spreadsheet (see below) - then [[Grade export|export some grades]] using the corresponding export format.
# Edit the export file as appropriate and save it.
# Tip: If you opened your exported file in Excel, don't add columns there because Moodle will reject the import if there are new columns that didn't exist in the exported file. If you need to add columns, do that in Moodle BEFORE you export your gradebook.
# Select your chosen import format from the gradebook dropdown menu.
# Browse and upload your previously saved file.
# Set options as required.
# Click the "Upload grades" button.
# CSV import only: Preview the grade import and choose the column mapping then click the "Upload grades" button to complete the grade import.
## Tip: By default "Map from" is set to First Name, and "Map to" to userid. Change both dropdowns to: "Email Address" to "useremail", or to "Id Number" to "useridnumber" (assuming that your users have ID number fields filled in in their profiles).
## Tip: Unlike in most email programs, email addresses are case sensitive in grade import files. (This should eventually be fixed as per MDL-29315.)

You need two permissions to import grades: (1) general permission to import grades and (2) permission to import grades in a particular format. For example, to import CSV grades you need moodle/grade:import ("Import grades") = Allow and gradeimport/csv:view ("Import grades from CSV") = Allow

==CSV import==

CSV import is more flexible than XML import, as you may choose the column mapping.

===Grade Mapping===

After selecting your CSV for import you'll be prompted to map user fields and grade items to the new column headers to ensure that there is a match. More than one item can be mapped to the same grade item in your destination course so be mindful of the mapping to ensure that grade data is imported properly, any collisions (i.e. if two or more fields are mapped to the same but duplicate data exists) will cause an error. User grade data for users not yet enrolled to the destination course will be noted (and once enrolled their grade data will display).

===Encoding===

If you are unsure of the encoding of your CSV file, try selecting the second option in the encoding dropdown menu. If you've used Excel to produce the CSV file the second option WINDOWS-xxx encoding is probably the correct one. The grade import preview will tell you if you guessed the encoding correctly.

===Verbose scales===

Scales can be either specified as a raw id - eg. 0, 1, 2, 3, etc. or as a string, eg. "good", "bad", "not very bad". The later format is called "verbose".

===Force import===

This prevents grade overriding during the grade importing in a scenario where more than one teacher exports the course grades and then re-imports them. If a second teacher exports the grades and tries to import them, the following error message will be displayed and the grade importing procedure will be aborted:
<pre>(''Student name'') grades have not been imported because the grades in the import file are older than in the grader report. To proceed with the grade import anyway, use the force import option.</pre>

It will not be possible to import a file that had been exported file longer than a year ago, one with dates in the future. However, in cases where a teacher needs to import the grades regardless, they should use the '''Force import'''. option. This will then import the grades irrespective of the dates.

==Paste from spreadsheet==

Grades may be pasted directly from a spreadsheet such as Excel or Libre Office:

1) Ensure you have the correct column names for your grades (eg the assignment title or manual grade) It might help to download and edit the relevant students and graded information by using the [[Grade export]] feature.

2) For the students you need either their username, their ID or their email address. Add the grades you need and copy the relevant section:
[[File:pastegrades1.png|thumb|center|400px]]
3) In your course, go to ''Grade administration>Import>Paste from spreadsheet'' and paste:
[[File:pastegrades2.png|thumb|center|400px]]
4) In the preview, ensure you match up the identifier you used for the students -so if you used 'username', ensure it maps to 'username'. Do the same for your graded activities:
[[File:pastegrades3.png|thumb|400px|center]]
5) If everything has been correctly mapped (See grade mapping above), you should get a success message and the grades will have been added, displaying in a different colour to show they were imported directly into the gradebook:
{|
| [[File:pastegrades4.png|thumb|400px]]
| [[File:pastegrades5.png|thumb|400px]]
|}

Paste from a spreadsheet requires similar permissions to a csv file import: (1) general permission to import grades and (2) permission to import grades in a particular format i.e. moodle/grade:import ("Import grades") = Allow and gradeimport/direct:view ("Import grades from spreadsheet") = Allow

==XML import==

Before importing an XML file you will need to ensure that all of the students that you want to alter grades for have their ID number field filled out. This is located in the "Optional" section of the user edit profile page.
You will also need to set the ID number of the activity as well. You can find this under "Common module settings" when editing the activity.

The format for the XML should be as follows:
<pre>
<results>
<result>
<assignment>activityidnumber</assignment>
<student>studentidnumber</student>
<score>53.00</score>
</result>
<result>
<assignment>differentactivityidnumber</assignment>
<student>studentidnumber</student>
<score>73.00</score>
</result>
</results>
</pre>

For a working example try exporting the gradebook as an xml file and view the format.

===Remote file URL===

The remote file URL field is for fetching data from a remote server, such as a student information system.

==Grade import capabilities==

* [[Capabilities/gradeimport/csv:view|Import grades from CSV]]
* [[Capabilities/gradeimport/xml:publish|Publish import grades from XML]]
* [[Capabilities/gradeimport/xml:view|Import grades from XML]]

==See also==

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=85944 Gradebook confusion]
*[http://moodle.org/mod/forum/discuss.php?d=92081 Can external software insert data into the gradebook?]

[[ja:評定のインポート]]
[[de:Bewertungen importieren]]
[[es:Importar calificaciones]]
[[fr:Importation des notes]]

Grade import

2015-07-27T06:04:23Z

Abgreeve: /* Grade Mapping */ notice for overriding feedback

{{Grades}}
==Importing grades==
Grades may be imported as a CSV or XML file, or by pasting from a spreadsheet.

The import file format is the same as the corresponding export format.

'''Note 1:''' Grade import is equivalent to manual grading in the [[Grader report|grader report]]. Thus, if grades for a particular Moodle activity such as an assignment are imported, they can no longer be edited via the assignment submission page.

'''Note 2:''' To import grades above 100% you need to check the 'unlimitedgrades' and 'gradepointmax' settings in ''Site administration>Administration>Grades>General settings''.

[[Image:Csv grade import.png|thumb|CSV grade import]]
To import grades into the gradebook:

# Decide on an import format - CSV or XML file, or paste from spreadsheet (see below) - then [[Grade export|export some grades]] using the corresponding export format.
# Edit the export file as appropriate and save it.
# Tip: If you opened your exported file in Excel, don't add columns there because Moodle will reject the import if there are new columns that didn't exist in the exported file. If you need to add columns, do that in Moodle BEFORE you export your gradebook.
# Select your chosen import format from the gradebook dropdown menu.
# Browse and upload your previously saved file.
# Set options as required.
# Click the "Upload grades" button.
# CSV import only: Preview the grade import and choose the column mapping then click the "Upload grades" button to complete the grade import.
## Tip: By default "Map from" is set to First Name, and "Map to" to userid. Change both dropdowns to: "Email Address" to "useremail", or to "Id Number" to "useridnumber" (assuming that your users have ID number fields filled in in their profiles).
## Tip: Unlike in most email programs, email addresses are case sensitive in grade import files. (This should eventually be fixed as per MDL-29315.)

You need two permissions to import grades: (1) general permission to import grades and (2) permission to import grades in a particular format. For example, to import CSV grades you need moodle/grade:import ("Import grades") = Allow and gradeimport/csv:view ("Import grades from CSV") = Allow

==CSV import==

CSV import is more flexible than XML import, as you may choose the column mapping.

===Grade Mapping===

After selecting your CSV for import you'll be prompted to map user fields and grade items to the new column headers to ensure that there is a match. More than one item can be mapped to the same grade item in your destination course so be mindful of the mapping to ensure that grade data is imported properly, any collisions (i.e. if two or more fields are mapped to the same but duplicate data exists) will cause an error. User grade data for users not yet enrolled to the destination course will be noted (and once enrolled their grade data will display).

Importing feedback will also overwrite any grades that are linked to that assessment. Please include both feedback and grades for the activity when mapping and importing grades via CSV. If both columns are not included then all grades for that activity will be lost.

===Encoding===

If you are unsure of the encoding of your CSV file, try selecting the second option in the encoding dropdown menu. If you've used Excel to produce the CSV file the second option WINDOWS-xxx encoding is probably the correct one. The grade import preview will tell you if you guessed the encoding correctly.

===Verbose scales===

Scales can be either specified as a raw id - eg. 0, 1, 2, 3, etc. or as a string, eg. "good", "bad", "not very bad". The later format is called "verbose".

===Force import===

This prevents grade overriding during the grade importing in a scenario where more than one teacher exports the course grades and then re-imports them. If a second teacher exports the grades and tries to import them, the following error message will be displayed and the grade importing procedure will be aborted:
<pre>(''Student name'') grades have not been imported because the grades in the import file are older than in the grader report. To proceed with the grade import anyway, use the force import option.</pre>

It will not be possible to import a file that had been exported file longer than a year ago, one with dates in the future. However, in cases where a teacher needs to import the grades regardless, they should use the '''Force import'''. option. This will then import the grades irrespective of the dates.

==Paste from spreadsheet==

Grades may be pasted directly from a spreadsheet such as Excel or Libre Office:

1) Ensure you have the correct column names for your grades (eg the assignment title or manual grade) It might help to download and edit the relevant students and graded information by using the [[Grade export]] feature.

2) For the students you need either their username, their ID or their email address. Add the grades you need and copy the relevant section:
[[File:pastegrades1.png|thumb|center|400px]]
3) In your course, go to ''Grade administration>Import>Paste from spreadsheet'' and paste:
[[File:pastegrades2.png|thumb|center|400px]]
4) In the preview, ensure you match up the identifier you used for the students -so if you used 'username', ensure it maps to 'username'. Do the same for your graded activities:
[[File:pastegrades3.png|thumb|400px|center]]
5) If everything has been correctly mapped (See grade mapping above), you should get a success message and the grades will have been added, displaying in a different colour to show they were imported directly into the gradebook:
{|
| [[File:pastegrades4.png|thumb|400px]]
| [[File:pastegrades5.png|thumb|400px]]
|}

Paste from a spreadsheet requires similar permissions to a csv file import: (1) general permission to import grades and (2) permission to import grades in a particular format i.e. moodle/grade:import ("Import grades") = Allow and gradeimport/direct:view ("Import grades from spreadsheet") = Allow

==XML import==

Before importing an XML file you will need to ensure that all of the students that you want to alter grades for have their ID number field filled out. This is located in the "Optional" section of the user edit profile page.
You will also need to set the ID number of the activity as well. You can find this under "Common module settings" when editing the activity.

The format for the XML should be as follows:
<pre>
<results>
<result>
<assignment>activityidnumber</assignment>
<student>studentidnumber</student>
<score>53.00</score>
</result>
<result>
<assignment>differentactivityidnumber</assignment>
<student>studentidnumber</student>
<score>73.00</score>
</result>
</results>
</pre>

For a working example try exporting the gradebook as an xml file and view the format.

===Remote file URL===

The remote file URL field is for fetching data from a remote server, such as a student information system.

==Grade import capabilities==

* [[Capabilities/gradeimport/csv:view|Import grades from CSV]]
* [[Capabilities/gradeimport/xml:publish|Publish import grades from XML]]
* [[Capabilities/gradeimport/xml:view|Import grades from XML]]

==See also==

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=85944 Gradebook confusion]
*[http://moodle.org/mod/forum/discuss.php?d=92081 Can external software insert data into the gradebook?]

[[ja:評定のインポート]]
[[de:Bewertungen importieren]]
[[es:Importar calificaciones]]
[[fr:Importation des notes]]

User:Adrian Greeve/howto fix gradebook issues

2015-07-20T02:43:37Z

Abgreeve: First edit - main content

==How to fix Grade book issues==

There has been a policy decision that any fixes to the grade book must not result in any changes to grades. Some fixes may result in grades being changed and in these situations we need to freeze the grade book and let the teacher / admin / higher power agree to applying the change.

For future fixes to the grade book we will be putting revision numbers and nested code into the grade book libraries.

===Fixing the issue===

Choose a freeze number that is greater than the current build number but will be less than the next build number (This needs explaining)

When making changes wrap your code in an if statement.

example:
<code php>
$gradebookcalculationsfreeze = get_config('core', 'gradebook_calculations_freeze_' . $courseid);
// Stick with the original code if the grade book is frozen.
if ($gradebookcalculationsfreeze && (int)$gradebookcalculationsfreeze <= {your code freeze number}) {
{original code goes here}
} else {
{new fixed code goes here}
}
</code>
Enter in details about your fix at https://docs.moodle.org/310/en/Gradebook_calculation_changes

===Upgrade code===

Code will be required to determine if the site being upgraded is affected. If so then it should be flagged to be frozen.

example (lib/db/upgrade.php):
<code php>
if ($oldversion < 2015062500.01) {
// MDL-48239. Changed calculated grade items so that the maximum and minimum grade can be set.

// If the changes are accepted and a regrade is done on the gradebook then some grades may change significantly.
// This is here to freeze the gradebook in affected courses.

// This script is included in each major version upgrade process so make sure we don't run it twice.
if (empty($CFG->upgrade_calculatedgradeitemsignored)) {
upgrade_calculated_grade_items();

// To skip running the same script on the upgrade to the next major release.
set_config('upgrade_calculatedgradeitemsignored', 1);
}

// Main savepoint reached.
upgrade_main_savepoint(true, 2015062500.01);
}
</code>
The code for doing this check should be located in lib/db/upgradelib.php so that it can also be run when a course is being restored.

===New installations===

Make sure to not run the upgrade step with the new installation

example (lib/db/install.php:: xmldb_main_install() line 135):
<code php>
'upgrade_calculatedgradeitemsignored' => 1, // New installs should not run this upgrade step.
</code>

===Restoration code===

Code should be generated so that a regrading of the gradebook will fix the problem. Any solution that requires direct alteration of the grades in the database will result in an extremely complex set of restore code.

example (backup/moodle2/restore_stepslib.php):
<code php>
// Calculated grade items need recalculating for backups made between 2.8 release (20141110) and the fix release (20150627).
if (!$gradebookcalculationsfreeze && $backupbuild >= 20141110 && $backupbuild < 20150627) {
require_once($CFG->libdir . '/db/upgradelib.php');
upgrade_calculated_grade_items($this->get_courseid());
}
</code>
===Tests===

Create a behat test to make sure that when the gradebook is frozen that grades are not changed.
Create a behat test to make sure that when the gradebook is not frozen that the issue is solved.

Create unit tests to check functions in the upgradelib.php file.

Gradebook calculation changes

2015-06-26T07:12:58Z

Abgreeve: update to grade build number

Gradebook calculation changes

2015-06-26T03:46:40Z

Abgreeve: 20150620 information

Grade import

2014-11-07T02:53:52Z

Abgreeve: Slight update to paste from spreadsheet section

{{Grades}}Grades may be imported as a CSV or XML file, or (new in 2.8 onwards) by pasting from a spreadsheet.

The import file format is the same as the corresponding export format.

Note: Grade import is equivalent to manual grading in the [[Grader report|grader report]]. Thus, if grades for a particular Moodle activity such as an assignment are imported, they can no longer be edited via the assignment submission page.

==Importing grades==
[[Image:Csv grade import.png|thumb|CSV grade import]]
To import grades into the gradebook:

# Decide on an import format - CSV or XML file, or paste from spreadsheet (see below) - then [[Grade export|export some grades]] using the corresponding export format.
# Edit the export file as appropriate and save it.
# Tip: If you opened your exported file in Excel, don't add columns there because Moodle will reject the import if there are new columns that didn't exist in the exported file. If you need to add columns, do that in Moodle BEFORE you export your gradebook.
# Select your chosen import format from the gradebook dropdown menu.
# Browse and upload your previously saved file.
# Set options as required.
# Click the "Upload grades" button.
# CSV import only: Preview the grade import and choose the column mapping then click the "Upload grades" button to complete the grade import.
## Tip: By default "Map from" is set to First Name, and "Map to" to userid. Change both dropdowns to: "Email Address" to "useremail", or to "Id Number" to "useridnumber" (assuming that your users have ID number fields filled in in their profiles).
## Tip: Unlike in most email programs, email addresses are case sensitive in grade import files. (This should eventually be fixed as per MDL-29315.)

You need two permissions to import grades: (1) general permission to import grades and (2) permission to import grades in a particular format. For example, to import CSV grades you need

moodle/grade:import ("Import grades") = Allow
gradeimport/csv:view ("Import grades from CSV") = Allow

==CSV import==

CSV import is more flexible than XML import, as you may choose the column mapping.

===Grade Mapping===

When Importing to Moodle 2.x or higher, after selecting your CSV for import you'll be prompted to map user fields and grade items to the new column headers to ensure that there is a match. More than one item can be mapped to the same grade item in your destination course so be mindful of the mapping to ensure that grade data is imported properly, any collisions (i.e. if two or more fields are mapped to the same but duplicate data exists) will cause an error. User grade data for users not yet enrolled to the destination course will be noted (and once enrolled their grade data will display).

===Encoding===

If you are unsure of the encoding of your CSV file, try selecting the second option in the encoding dropdown menu. If you've used Excel to produce the CSV file the second option WINDOWS-xxx encoding is probably the correct one. The grade import preview will tell you if you guessed the encoding correctly.

===Verbose scales===

Scales can be either specified as a raw id - eg. 0, 1, 2, 3, etc. or as a string, eg. "good", "bad", "not very bad". The later format is called "verbose".

==Paste from spreadsheet==

{{New features}}
Grades may be pasted directly from a spreadsheet such as Excel or Libre Office:

1) Ensure you have the correct column names for your grades (eg the assignment title or manual grade) It might help to download and edit the relevant students and graded information by using the [[Grade export]] feature.

2) For the students you need either their username, their ID or their email address. Add the grades you need and copy the relevant section:
[[File:pastegrades1.png|thumb|center|400px]]
3) In your course, go to ''Grade administration>Import>Paste from spreadsheet'' and paste:
[[File:pastegrades2.png|thumb|center|400px]]
4) In the preview, ensure you match up the identifier you used for the students -so if you used 'username', ensure it maps to 'username'. Do the same for your graded activities:
[[File:pastegrades3.png|thumb|400px|center]]
5) If everything has been correctly mapped (See grade mapping above), you should get a success message and the grades will have been added, displaying in a different colour to show they were imported directly into the gradebook:
{|
| [[File:pastegrades4.png|thumb|400px]]
| [[File:pastegrades5.png|thumb|400px]]
|}

Paste from a spreadsheet requires similar permissions to a csv file import: (1) general permission to import grades and (2) permission to import grades in a particular format.

moodle/grade:import ("Import grades") = Allow
gradeimport/direct:view ("Import grades from spreadsheet") = Allow

==XML import==

Before importing an XML file you will need to ensure that all of the students that you want to alter grades for have their ID number field filled out. This is located in the "Optional" section of the user edit profile page.
You will also need to set the ID number of the activity as well. You can find this under "Common module settings" when editing the activity.

The format for the XML should be as follows:
<pre>
<results>
<result>
<assignment>activityidnumber</assignment>
<student>studentidnumber</student>
<score>53.00</score>
</result>
<result>
<assignment>differentactivityidnumber</assignment>
<student>studentidnumber</student>
<score>73.00</score>
</result>
</results>
</pre>

For a working example try exporting the gradebook as an xml file and view the format.

===Remote file URL===

The remote file URL field is for fetching data from a remote server, such as a student information system.

==Grade import capabilities==

* [[Capabilities/gradeimport/csv:view|Import grades from CSV]]
* [[Capabilities/gradeimport/xml:publish|Publish import grades from XML]]
* [[Capabilities/gradeimport/xml:view|Import grades from XML]]

==See also==

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=85944 Gradebook confusion]
*[http://moodle.org/mod/forum/discuss.php?d=92081 Can external software insert data into the gradebook?]

[[ja:評定のインポート]]
[[de:Bewertungen importieren]]
[[es:Importar calificaciones]]
[[fr:Importation des notes]]

Event list report

2014-04-11T06:17:17Z

Abgreeve: Placeholder for Event list report.

Event list report
I created a plugin for reporting all of the events in a list. It's awesome. You should totally go and check it out.

Grade import

2014-04-11T02:21:50Z

Abgreeve: /* XML import */

{{Grades}}Grades may be imported as a CSV or XML file.

The import file format is the same as the corresponding export format.

Note: Grade import is equivalent to manual grading in the [[Grader report|grader report]]. Thus, if grades for a particular Moodle activity such as an assignment are imported, they can no longer be edited via the assignment submission page.

==Importing grades==
[[Image:Csv grade import.png|thumb|CSV grade import]]
To import grades into the gradebook:

# Decide on an import format - CSV or XML file (see below) - then [[Grade export|export some grades]] using the corresponding export format.
# Edit the export file as appropriate and save it.
# Tip: If you opened your exported file in Excel, don't add columns there because Moodle will reject the import if there are new columns that didn't exist in the exported file. If you need to add columns, do that in Moodle BEFORE you export your gradebook.
# Select your chosen import format from the gradebook dropdown menu.
# Browse and upload your previously saved file.
# Set options as required.
# Click the "Upload grades" button.
# CSV import only: Preview the grade import and choose the column mapping then click the "Upload grades" button to complete the grade import.
## Tip: By default "Map from" is set to First Name, and "Map to" to userid. Change both dropdowns to: "Email Address" to "useremail", or to "Id Number" to "useridnumber" (assuming that your users have ID number fields filled in in their profiles).
## Tip: Unlike in most email programs, email addresses are case sensitive in grade import files. (This should eventually be fixed as per MDL-29315.)

You need two permissions to import grades: (1) general permission to import grades and (2) permission to import grades in a particular format. For example, to import CSV grades you need

moodle/grade:import ("Import grades") = Allow
gradeimport/csv:view ("Import grades from CSV") = Allow

==XML import==

Before importing an XML file you will need to ensure that all of the students that you want to alter grades for have their ID number field filled out. This is located in the "Optional" section of the user edit profile page.
You will also need to set the ID number of the activity as well. You can find this under "Common module settings" when editing the activity.

The format for the XML should be as follows:
<pre>
<results>
<result>
<assignment>activityidnumber</assignment>
<student>studentidnumber</student>
<score>53.00</score>
</result>
<result>
<assignment>differentactivityidnumber</assignment>
<student>studentidnumber</student>
<score>73.00</score>
</result>
</results>
</pre>

For a working example try exporting the gradebook as an xml file and view the format.

===Remote file URL===

The remote file URL field is for fetching data from a remote server, such as a student information system.

==CSV import==

CSV import is more flexible than XML import, as you may choose the column mapping.

===Grade Mapping===

When Importing to Moodle 2.x or higher, after selecting your CSV for import you'll be prompted to map user fields and grade items to the new column headers to ensure that there is a match. More than one item can be mapped to the same grade item in your destination course so be mindful of the mapping to ensure that grade data is imported properly, any collisions (i.e. if two or more fields are mapped to the same but duplicate data exists) will cause an error. User grade data for users not yet enrolled to the destination course will be noted (and once enrolled their grade data will display).

===Encoding===

If you are unsure of the encoding of your CSV file, try selecting the second option in the encoding dropdown menu. If you've used Excel to produce the CSV file the second option WINDOWS-xxx encoding is probably the correct one. The grade import preview will tell you if you guessed the encoding correctly.

===Verbose scales===

Scales can be either specified as a raw id - eg. 0, 1, 2, 3, etc. or as a string, eg. "good", "bad", "not very bad". The later format is called "verbose".

==Grade import capabilities==

* [[Capabilities/gradeimport/csv:view|Import grades from CSV]]
* [[Capabilities/gradeimport/xml:publish|Publish import grades from XML]]
* [[Capabilities/gradeimport/xml:view|Import grades from XML]]

==See also==

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=85944 Gradebook confusion]
*[http://moodle.org/mod/forum/discuss.php?d=92081 Can external software insert data into the gradebook?]

[[ja:評定のインポート]]
[[de:Bewertungen importieren]]
[[fr:Importation des notes]]

Grade import

2014-04-11T02:21:07Z

Abgreeve: /* XML import - expanded detail and example */

{{Grades}}Grades may be imported as a CSV or XML file.

The import file format is the same as the corresponding export format.

Note: Grade import is equivalent to manual grading in the [[Grader report|grader report]]. Thus, if grades for a particular Moodle activity such as an assignment are imported, they can no longer be edited via the assignment submission page.

==Importing grades==
[[Image:Csv grade import.png|thumb|CSV grade import]]
To import grades into the gradebook:

# Decide on an import format - CSV or XML file (see below) - then [[Grade export|export some grades]] using the corresponding export format.
# Edit the export file as appropriate and save it.
# Tip: If you opened your exported file in Excel, don't add columns there because Moodle will reject the import if there are new columns that didn't exist in the exported file. If you need to add columns, do that in Moodle BEFORE you export your gradebook.
# Select your chosen import format from the gradebook dropdown menu.
# Browse and upload your previously saved file.
# Set options as required.
# Click the "Upload grades" button.
# CSV import only: Preview the grade import and choose the column mapping then click the "Upload grades" button to complete the grade import.
## Tip: By default "Map from" is set to First Name, and "Map to" to userid. Change both dropdowns to: "Email Address" to "useremail", or to "Id Number" to "useridnumber" (assuming that your users have ID number fields filled in in their profiles).
## Tip: Unlike in most email programs, email addresses are case sensitive in grade import files. (This should eventually be fixed as per MDL-29315.)

You need two permissions to import grades: (1) general permission to import grades and (2) permission to import grades in a particular format. For example, to import CSV grades you need

moodle/grade:import ("Import grades") = Allow
gradeimport/csv:view ("Import grades from CSV") = Allow

==XML import==

Before importing an XML file you will need to ensure that all of the students that you want to alter grades for have their ID number field filled out. This is located in the "Optional" section of the user edit profile page.
You will also need to set the ID number of the activity as well. You can find this under "Common module settings" when editing the activity.

The format for the XML should be as follows:
<pre>
<results>
<result>
<assignment>activityidnumber</assignment>
<student>studentidnumber</student>
<score>53.00</score</score>
</result>
<result>
<assignment>differentactivityidnumber</assignment>
<student>studentidnumber</student>
<score>73.00</score</score>
</result>
</results>
</pre>

For a working example try exporting the gradebook as an xml file and view the format.

===Remote file URL===

The remote file URL field is for fetching data from a remote server, such as a student information system.

==CSV import==

CSV import is more flexible than XML import, as you may choose the column mapping.

===Grade Mapping===

When Importing to Moodle 2.x or higher, after selecting your CSV for import you'll be prompted to map user fields and grade items to the new column headers to ensure that there is a match. More than one item can be mapped to the same grade item in your destination course so be mindful of the mapping to ensure that grade data is imported properly, any collisions (i.e. if two or more fields are mapped to the same but duplicate data exists) will cause an error. User grade data for users not yet enrolled to the destination course will be noted (and once enrolled their grade data will display).

===Encoding===

If you are unsure of the encoding of your CSV file, try selecting the second option in the encoding dropdown menu. If you've used Excel to produce the CSV file the second option WINDOWS-xxx encoding is probably the correct one. The grade import preview will tell you if you guessed the encoding correctly.

===Verbose scales===

Scales can be either specified as a raw id - eg. 0, 1, 2, 3, etc. or as a string, eg. "good", "bad", "not very bad". The later format is called "verbose".

==Grade import capabilities==

* [[Capabilities/gradeimport/csv:view|Import grades from CSV]]
* [[Capabilities/gradeimport/xml:publish|Publish import grades from XML]]
* [[Capabilities/gradeimport/xml:view|Import grades from XML]]

==See also==

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=85944 Gradebook confusion]
*[http://moodle.org/mod/forum/discuss.php?d=92081 Can external software insert data into the gradebook?]

[[ja:評定のインポート]]
[[de:Bewertungen importieren]]
[[fr:Importation des notes]]

Additional name fields

2013-11-06T07:43:00Z

Abgreeve: /* Updating the user's profile */

{{New features}}

Moodle 2.6 now has four additional name fields. These fields allow for further detail to be displayed about the user. The additional name fields are:
* First name - phonetic
* Surname - phonetic
* Middle name
* Alternate name

[[File:26names.png]]

==Display==

The display of the user's full name is determined by the capability *Add capability here*

[[File:participants-after.png]]

==Configuration==

Configuration of the additional name fields is done in the following Administration page [Administration ► Site administration ► Users ► Permissions ► User policies].
The setting to change is "Full name format" (fullnamedisplay).
This setting uses the following placeholders:
* firstname
* lastname
* firstnamephonetic
* lastnamephonetic
* middlename
* alternatename
* language (used on its own to force the use of the language pack)
By default it has the place-holder "language" and it will use the local language pack to determine how user names are displayed. (location: /lang/en/moodle.php - fullnamedisplay)

To enable the additional name fields, just enter in the placeholders into the text box. The order that you enter in the names will be the order that they are displayed around Moodle.

===Example 1===
{| class="wikitable"
!First name
!Surname
!Middle name
!Surname - phonetic
!First name - phonetic
|-
|John
|Doe
|James
|Dough
|Jon
|}

'''Full name format setting'''

<blockquote>firstname middlename lastname</blockquote>

will display:

<blockquote>John James Doe</blockquote>

Other characters can be included in the setting such as commas and parenthesis.

===Example 2===

'''Full name format setting'''

<blockquote>lastname firstname (lastnamephonetic firstnamephonetic)</blockquote>

will display:

<blockquote>Doe John (Dough Jon)</blockquote>

==Updating the user's profile==
Any additional names that are included in the "Full name format" setting will be displayed directly under the text boxes for first name and surname. All other name fields that are not being used are located under the section "Additional names" further down the page.

==Upgrade from previous versions==

When upgrading to 2.6, the "Full name format" (fullnamedisplay) setting found in [Administration ► Site administration ► Security ► Site policies] will automatically be changed over. All of the additional name fields will be blank.

Additional name fields

2013-11-06T07:35:47Z

Abgreeve: /* Example 1 */

{{New features}}

Moodle 2.6 now has four additional name fields. These fields allow for further detail to be displayed about the user. The additional name fields are:
* First name - phonetic
* Surname - phonetic
* Middle name
* Alternate name

[[File:26names.png]]

==Display==

The display of the user's full name is determined by the capability *Add capability here*

[[File:participants-after.png]]

==Configuration==

Configuration of the additional name fields is done in the following Administration page [Administration ► Site administration ► Users ► Permissions ► User policies].
The setting to change is "Full name format" (fullnamedisplay).
This setting uses the following placeholders:
* firstname
* lastname
* firstnamephonetic
* lastnamephonetic
* middlename
* alternatename
* language (used on its own to force the use of the language pack)
By default it has the place-holder "language" and it will use the local language pack to determine how user names are displayed. (location: /lang/en/moodle.php - fullnamedisplay)

To enable the additional name fields, just enter in the placeholders into the text box. The order that you enter in the names will be the order that they are displayed around Moodle.

===Example 1===
{| class="wikitable"
!First name
!Surname
!Middle name
!Surname - phonetic
!First name - phonetic
|-
|John
|Doe
|James
|Dough
|Jon
|}

'''Full name format setting'''

<blockquote>firstname middlename lastname</blockquote>

will display:

<blockquote>John James Doe</blockquote>

Other characters can be included in the setting such as commas and parenthesis.

===Example 2===

'''Full name format setting'''

<blockquote>lastname firstname (lastnamephonetic firstnamephonetic)</blockquote>

will display:

<blockquote>Doe John (Dough Jon)</blockquote>

==Updating the user's profile==

==Upgrade from previous versions==

When upgrading to 2.6, the "Full name format" (fullnamedisplay) setting found in [Administration ► Site administration ► Security ► Site policies] will automatically be changed over. All of the additional name fields will be blank.

Additional name fields

2013-11-06T07:32:00Z

Abgreeve: setting mistake

{{New features}}

Moodle 2.6 now has four additional name fields. These fields allow for further detail to be displayed about the user. The additional name fields are:
* First name - phonetic
* Surname - phonetic
* Middle name
* Alternate name

[[File:26names.png]]

==Display==

The display of the user's full name is determined by the capability *Add capability here*

[[File:participants-after.png]]

==Configuration==

Configuration of the additional name fields is done in the following Administration page [Administration ► Site administration ► Users ► Permissions ► User policies].
The setting to change is "Full name format" (fullnamedisplay).
This setting uses the following placeholders:
* firstname
* lastname
* firstnamephonetic
* lastnamephonetic
* middlename
* alternatename
* language (used on its own to force the use of the language pack)
By default it has the place-holder "language" and it will use the local language pack to determine how user names are displayed. (location: /lang/en/moodle.php - fullnamedisplay)

To enable the additional name fields, just enter in the placeholders into the text box. The order that you enter in the names will be the order that they are displayed around Moodle.

===Example 1===
{| class="wikitable"
!First name
!Surname
!Middle name
!Surname - phonetic
!First name - phonetic
|-
|John
|Doe
|James
|Jon
|Dough
|}

'''Full name format setting'''

<blockquote>firstname middlename lastname</blockquote>

will display:

<blockquote>John James Doe</blockquote>

Other characters can be included in the setting such as commas and parenthesis.

===Example 2===

'''Full name format setting'''

<blockquote>lastname firstname (lastnamephonetic firstnamephonetic)</blockquote>

will display:

<blockquote>Doe John (Dough Jon)</blockquote>

==Updating the user's profile==

==Upgrade from previous versions==

When upgrading to 2.6, the "Full name format" (fullnamedisplay) setting found in [Administration ► Site administration ► Security ► Site policies] will automatically be changed over. All of the additional name fields will be blank.

Additional name fields

2013-11-06T03:19:42Z

Abgreeve: Participants page example

{{New features}}

Moodle 2.6 now has four additional name fields. These fields allow for further detail to be displayed about the user. The additional name fields are:
* First name - phonetic
* Surname - phonetic
* Middle name
* Alternate name

[[File:26names.png]]

==Display==

The display of the user's full name is determined by the capability *Add capability here*

[[File:participants-after.png]]

==Configuration==

Configuration of the additional name fields is done in the following Administration page [Administration ► Site administration ► Users ► Permissions ► User policies].
The setting to change is "Full name format" (fullnamedisplay).
This setting uses the following placeholders:
* firstname
* lastname
* firstnamephonetic
* lastnamephonetic
* middlename
* alternatename
* language (used on its own to force the use of the language pack)
By default it has the place-holder "language" and it will use the local language pack to determine how user names are displayed. (location: /lang/en/moodle.php - fullnamedisplay)

To enable the additional name fields, just enter in the placeholders into the text box. The order that you enter in the names will be the order that they are displayed around Moodle.

===Example 1===
{| class="wikitable"
!First name
!Surname
!Middle name
!Surname - phonetic
!First name - phonetic
|-
|John
|Doe
|James
|Jon
|Jay-ms
|}

'''Full name format setting'''

<blockquote>firstname middlename lastname</blockquote>

will display:

<blockquote>John James Doe</blockquote>

Other characters can be included in the setting such as commas and parenthesis.

===Example 2===

'''Full name format setting'''

<blockquote>lastname firstname (lastnamephonetic firstnamephonetic)</blockquote>

will display:

<blockquote>James John (Jay-ms Jon)</blockquote>

==Updating the user's profile==

==Upgrade from previous versions==

When upgrading to 2.6, the "Full name format" (fullnamedisplay) setting found in [Administration ► Site administration ► Security ► Site policies] will automatically be changed over. All of the additional name fields will be blank.

File:participants-after.png

2013-11-06T03:15:27Z

Abgreeve:

Additional name fields

2013-11-06T03:07:20Z

Abgreeve: Addition of a few categories and a bit of detail

{{New features}}

Moodle 2.6 now has four additional name fields. These fields allow for further detail to be displayed about the user. The additional name fields are:
* First name - phonetic
* Surname - phonetic
* Middle name
* Alternate name

[[File:26names.png]]

==Display==

The display of the user's full name is determined by the capability *Add capability here*

==Configuration==

Configuration of the additional name fields is done in the following Administration page [Administration ► Site administration ► Users ► Permissions ► User policies].
The setting to change is "Full name format" (fullnamedisplay).
This setting uses the following placeholders:
* firstname
* lastname
* firstnamephonetic
* lastnamephonetic
* middlename
* alternatename
* language (used on its own to force the use of the language pack)
By default it has the place-holder "language" and it will use the local language pack to determine how user names are displayed. (location: /lang/en/moodle.php - fullnamedisplay)

To enable the additional name fields, just enter in the placeholders into the text box. The order that you enter in the names will be the order that they are displayed around Moodle.

===Example 1===
{| class="wikitable"
!First name
!Surname
!Middle name
!Surname - phonetic
!First name - phonetic
|-
|John
|Doe
|James
|Jon
|Jay-ms
|}

'''Full name format setting'''

<blockquote>firstname middlename lastname</blockquote>

will display:

<blockquote>John James Doe</blockquote>

Other characters can be included in the setting such as commas and parenthesis.

===Example 2===

'''Full name format setting'''

<blockquote>lastname firstname (lastnamephonetic firstnamephonetic)</blockquote>

will display:

<blockquote>James John (Jay-ms Jon)</blockquote>

==Updating the user's profile==

==Upgrade from previous versions==

When upgrading to 2.6, the "Full name format" (fullnamedisplay) setting found in [Administration ► Site administration ► Security ► Site policies] will automatically be changed over. All of the additional name fields will be blank.