MoodleDocs - User contributions [en]

Add fonts for embedding

2016-08-11T11:23:59Z

Davidbalch: Add reference to online font conversion via http://fonts.snm-portal.com/

{{Certificate}}
Additional fonts can be included in Moodle and used by the Certificate module, embedding them in the PDF (when using an "embedded" certificate type).

== Add a font from TTF file ==
Assuming you have a font licensed for converting and embedding...

=== Using an online converter ===
You can upload TTF (or OTF) fonts to http://fonts.snm-portal.com/, and download converted versions.

Fonts created this way seem to handle accented characters better than converting locally.

=== Converting locally ===

Fonts created this way may not handle accented characters correctly; this is probably dependant on the specific software versions. If you encounter this problem, you might want to try using an online converter (above).

1. Copy the .ttf file to /lib/tcpdf/fonts

2. Create a "convertfont.php" file in /lib/tcpdf/fonts (and ensure the web server has permissions to run it), containing:
<code php>
include('../tcpdf.php');
$pdf = new TCPDF_FONTS('P', 'mm', 'A4', true, 'UTF-8', false);
$pdf->addTTFfont('./MyFont.ttf', 'TrueTypeUnicode');
</code>
3. View the file at http://''hostname''/lib/tcpdf/fonts/convertfont.php (it should just show a blank page).

4. Verify that new files have been created in /lib/tcpdf:
* myfont.ctg.z
* myfont.php
* myfont.z

See below for using the font in a certificate.

== Add all TCPDF fonts ==

From /lib/tcpdf/fonts/readme_moodle.txt:

:This directory contains just selected set of original tcpdf fonts in order to keep the standard Moodle distribution lightweight. You may want to manually download tcpdf package and extract its fonts/ directory into your $CFG->dataroot/fonts/. In such case, pdflib.php will use this directory. In the future, we plan to have fonts downloadable in a same way as languages are. (TODO MDL-18663).

== Using a new font ==

Once added, there are two ways to use the new font:
# Go to the Certificate module setting page and set it as the new Serif or Sans-serif font. This will apply to all standard certificates.
# Create a custom certificate type in /mod/certificate/type, and replace the $fontserif and $fontsans variables, as needed.

* Replacing font for the whole file:
<code php>
// $fontsans = get_config('certificate', 'fontsans'); // Comment out old code

$fontsans = 'myfont'; // Add new code.
</code>

* Replacing font for just the student name:
<code php>
//certificate_print_text($pdf, $x, $y + 36, 'C', $fontsans, '', 30, fullname($USER)); // Comment out old code

certificate_print_text($pdf, $x, $y + 36, 'C', 'myfont', '', 30, fullname($USER)); // Add new code.
</code>

[[Category:Certificate]]

Add fonts for embedding

2016-08-11T10:31:02Z

Davidbalch:

{{Certificate}}
Additional fonts can be included in Moodle and used by the Certificate module, embedding them in the PDF (when using an "embedded" certificate type).

== Add a font from TTF file ==
Assuming you have a font licensed for converting and embedding...

1. Copy the .ttf file to /lib/tcpdf/fonts

2. Create a "convertfont.php" file in /lib/tcpdf/fonts (and ensure the web server has permissions to run it), containing:
<code php>
include('../tcpdf.php');
$pdf = new TCPDF_FONTS('P', 'mm', 'A4', true, 'UTF-8', false);
$pdf->addTTFfont('./MyFont.ttf', 'TrueTypeUnicode');
</code>
3. View the file at http://''hostname''/lib/tcpdf/fonts/convertfont.php (it should just show a blank page).

4. Verify that new files have been created in /lib/tcpdf:
* myfont.ctg.z
* myfont.php
* myfont.z

See below for using the font in a certificate.

== Add all TCPDF fonts ==

From /lib/tcpdf/fonts/readme_moodle.txt:

:This directory contains just selected set of original tcpdf fonts in order to keep the standard Moodle distribution lightweight. You may want to manually download tcpdf package and extract its fonts/ directory into your $CFG->dataroot/fonts/. In such case, pdflib.php will use this directory. In the future, we plan to have fonts downloadable in a same way as languages are. (TODO MDL-18663).

== Using a new font ==

Once added, there are two ways to use the new font:
# Go to the Certificate module setting page and set it as the new Serif or Sans-serif font. This will apply to all standard certificates.
# Create a custom certificate type in /mod/certificate/type, and replace the $fontserif and $fontsans variables, as needed.

* Replacing font for the whole file:
<code php>
// $fontsans = get_config('certificate', 'fontsans'); // Comment out old code

$fontsans = 'myfont'; // Add new code.
</code>

* Replacing font for just the student name:
<code php>
//certificate_print_text($pdf, $x, $y + 36, 'C', $fontsans, '', 30, fullname($USER)); // Comment out old code

certificate_print_text($pdf, $x, $y + 36, 'C', 'myfont', '', 30, fullname($USER)); // Add new code.
</code>

[[Category:Certificate]]

Template:Certificate

2016-08-11T10:24:15Z

Davidbalch: Link to page for custom fonts.

<div class="sideblock right" style="width: 12em;">
<div class="header">[[Certificate module|Certificate]]</div>
<div class="content">
* [[Add/edit certificate module|Certificate settings]]
* [[Certificate customizing|Customizing]]
* [[Add fonts for embedding|Adding new fonts]]
* [[Certificate reports]]
* [[Certificate FAQ]]
</div>
</div>

Add fonts for embedding

2016-08-11T10:14:43Z

Davidbalch: Tweak formatting under "Add all TCPDF fonts". Add Category:Certificate

{{Certificate}}
Additional fonts can be included in Moodle and used by the Certificate module, embedding them in the PDF (when using an "embedded" certificate type).

== Add a font from TTF file ==
Assuming you have a font licensed for converting and embedding...

1. Copy the .ttf file to /lib/tcpdf/fonts

2. Create a "convertfont.php" file in /lib/tcpdf/fonts (and ensure the web server has permissions to run it), containing:
<code php>
include('../tcpdf.php');
$pdf = new TCPDF_FONTS('P', 'mm', 'A4', true, 'UTF-8', false);
$pdf->addTTFfont('./MyFont.ttf', 'TrueTypeUnicode');
</code>
3. View the file at http://''hostname''/lib/tcpdf/fonts/convertfont.php

4. Verify that new files have been created in /lib/tcpdf:
* myfont.ctg.z
* myfont.php
* myfont.z

See below for using the font in a certificate.

== Add all TCPDF fonts ==

From /lib/tcpdf/fonts/readme_moodle.txt:

:This directory contains just selected set of original tcpdf fonts in order to keep the standard Moodle distribution lightweight. You may want to manually download tcpdf package and extract its fonts/ directory into your $CFG->dataroot/fonts/. In such case, pdflib.php will use this directory. In the future, we plan to have fonts downloadable in a same way as languages are. (TODO MDL-18663).

== Using a new font ==

Once added, there are two ways to use the new font:
# Go to the Certificate module setting page and set it as the new Serif or Sans-serif font. This will apply to all standard certificates.
# Create a custom certificate type in /mod/certificate/type, and replace the $fontserif and $fontsans variables, as needed.

* Replacing font for the whole file:
<code php>
// $fontsans = get_config('certificate', 'fontsans'); // Comment out old code

$fontsans = 'myfont'; // Add new code.
</code>

* Replacing font for just the student name:
<code php>
//certificate_print_text($pdf, $x, $y + 36, 'C', $fontsans, '', 30, fullname($USER)); // Comment out old code

certificate_print_text($pdf, $x, $y + 36, 'C', 'myfont', '', 30, fullname($USER)); // Add new code.
</code>

[[Category:Certificate]]

Add fonts for embedding

2016-08-11T09:52:51Z

Davidbalch: Initial add.

{{Certificate}}
Additional fonts can be included in Moodle and used by the Certificate module, embedding them in the PDF (when using an "embedded" certificate type).

== Add a font from TTF file ==
Assuming you have a font licensed for converting and embedding...

1. Copy the .ttf file to /lib/tcpdf/fonts

2. Create a "convertfont.php" file in /lib/tcpdf/fonts (and ensure the web server has permissions to run it), containing:
<code php>
include('../tcpdf.php');
$pdf = new TCPDF_FONTS('P', 'mm', 'A4', true, 'UTF-8', false);
$pdf->addTTFfont('./MyFont.ttf', 'TrueTypeUnicode');
</code>
3. View the file at http://''hostname''/lib/tcpdf/fonts/convertfont.php

4. Verify that new files have been created in /lib/tcpdf:
* myfont.ctg.z
* myfont.php
* myfont.z

See below for using the font in a certificate.

== Add all TCPDF fonts ==

From /lib/tcpdf/fonts/readme_moodle.txt:

This directory contains just selected set of original tcpdf fonts in order to keep the standard Moodle distribution lightweight. You may want to manually download tcpdf package and extract its fonts/ directory into your <code php>$CFG->dataroot/fonts/</code>. In such case, pdflib.php will use this directory. In the future, we plan to have fonts downloadable in a same way as languages are. (TODO MDL-18663).

== Using a new font ==

Once added, there are two ways to use the new font:
# Go to the Certificate module setting page and set it as the new Serif or Sans-serif font. This will apply to all standard certificates.
# Create a custom certificate type in /mod/certificate/type, and replace the $fontserif and $fontsans variables, as needed.

* Replacing font for the whole file:
<code php>
// $fontsans = get_config('certificate', 'fontsans'); // Comment out old code

$fontsans = 'myfont'; // Add new code.
</code>

* Replacing font for just the student name:
<code php>
//certificate_print_text($pdf, $x, $y + 36, 'C', $fontsans, '', 30, fullname($USER)); // Comment out old code

certificate_print_text($pdf, $x, $y + 36, 'C', 'myfont', '', 30, fullname($USER)); // Add new code.
</code>

Block layout

2016-03-30T13:25:49Z

Davidbalch: Update reset code for deprecated get_context_instance()

{{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, Tags and Administration 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.

==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''.

'''M2.2 and later:'''
<?php
//moodle 2.2+
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);
$context = context_course::instance($course->id);
blocks_delete_all_for_context($context->id);
blocks_add_default_course_blocks($course);
}
?>

'''M2.0 to M2.2:'''
<?php
//moodle 2.0 - 2.2
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:ブロックレイアウト]]

Creating custom roles

2014-05-27T15:24:46Z

Davidbalch: /* Role archetypes */ Add list of archetypes.

{{Roles}}
==Creating a new role==

To create a custom role:
#Go to ''Administration > Site administration > Users > Permissions > Define roles''.
#Click the "Add a new role" button.
#Select template for the new role or upload a preset
#Give the role a Short name e.g. 'Parent'.The short name is necessary for other plugins in Moodle that may need to refer to the role (e.g. when uploading users from a file or setting enrolments via an enrolment plugin).
#You must provide a full name for all custom roles. If you need to name the role for multiple languages you can use [[Multi language content|multi-lang syntax]] if you wish.
#Give the role a description (optional).
#Select an appropriate role archetype (see below for further information).
#Select the contexts where the role may be assigned e.g. 'User' for Parent role.
#Set permissions as required.
#Scroll to the top or bottom of the page and click the "Create this role" button.

{|
|-
| [[Image:addinganewrole26.png|thumb|Adding a new role and setting context types]]
| [[Image:permissions125.png|thumb|Choose "Allow" where required]]
| [[Image:permissions225.png|thumb|Extra options with "Show advanced" enabled]]
|-
|}

==Role archetypes==

A role archetype

* Is a hard-coded template for a role
* Is used during upgrades when adding defaults for new capabilities - no archetype = no new capabilities during upgrade
* Is used during when resetting a role to determine the defaults - no archetype = reset removes all capabilities

There is no need to set a role archetype for custom roles used for overrides or if the site admin wants to specify new capabilities manually after upgrading.

The archetypes (which relate directly to the built-in roles) are:
* manager
* coursecreator
* editingteacher
* teacher
* guest
* user
* frontpage

==Creating a duplicate role==

To create a duplicate role:
#Go to ''Administration > Site administration > Users > Permissions > Define roles''.
#Click the "Add a new role" button.
#Select existing role as a template
#Give a name and set permissions for your new role; scroll down and click "Create this role".

==New role considerations==

A new role is not automatically listed in course descriptions even if was created by copying a role that is listed, such as Teacher. If you want the new role to appear in the course listing, you must set it explicitly via ''Administration > Site administration > Appearance > Course managers''.

==Testing a new role==
''Administration > Switch role to''
Use the "Switch role to" link to see what another role will see in that context.

Since switching roles confines you to those roles you can assign in a course context, this method is only useful for testing course-scoped capabilities (i.e. it will not be useful for testing permissions that apply outside the course context, like moodle/user:edit).

''Tip:'' You can always create test user and assign the new role to them. Then logout as admin and login as the test user. This is really the best way to test a new role.

==Example custom roles==

*[[Parent role|Parent]] - for providing parents/mentors/tutors with permission to view certain information about their children/mentees/tutees
*[[Demo teacher role|Demo teacher]] - for providing a demonstration teacher account with a password which can't be changed
*[[Forum moderator role|Forum moderator]] - for providing a user with permission in a particular forum to edit or delete forum posts, split discussions and move discussions to other forums
*[[Calendar editor role|Calendar editor]] - for enabling a user to add site or course events to the calendar
*[[Blogger role|Blogger]] - for limiting blogging to specific users only
*[[Quiz user with unlimited time role|Quiz user with unlimited time]] - for allowing a user unlimited time to attempt a quiz which has a time limit set
*[[Question creator role|Question creator]] - for enabling students to create questions for use in quizzes
*[[Question sharer]] - for allowing teachers to share questions between courses
*[[Course requester role]] - for restricting users who can make course requests
*[[Cohort enroller]] - for allowing teachers to enrol category cohorts into their course
*[[Feedback template creator]] - for allowing teachers to save as "Public" a Feedback template.
*[[Grading forms publisher]] for allowing teachers to share Advanced grading forms with others
*[[Grading forms manager]] for allowing teachers to share Advanced grading forms with others and to delete templates others have created.

==See also==

Using Moodle forum discussions:
* [http://moodle.org/mod/forum/discuss.php?d=66782 What happens if a user has multiple roles in a course?]
* [http://moodle.org/mod/forum/discuss.php?d=90140 logged in: what role am I?]
* For more information, Ask questions and get answers on the [http://moodle.org/mod/forum/view.php?id=6826 "Roles and Permissions"] forum.

[[Category:Site administration]]

[[de:Neue Rollen anlegen]]
[[es:Crear roles personalizados]]
[[fr:Création_de_rôles_personnalisés]]

Database templates

2013-11-18T12:37:06Z

Davidbalch: /* Javascript template */ Better JS & YUI approach - ref https://moodle.org/mod/forum/discuss.php?d=243477#p1056563

{{Database}}
Templates for the [[Database activity module]] allow you to control the visual layout of information when listing, viewing or editing database entries. It is a similar to the technique used to ''mail merge'' letters in word processors such as Open Office Writer or Microsoft Word.

== Tag usage ==

The content of each [[Database fields|field]] you create for your database and some special tags (listed below) can be inserted into the output template by the use of tags.

Fields have the format <code><nowiki>[[fieldname]]</nowiki></code>. All other tags have the format <code>##sometag##</code>.

To use the tags in the box on the left of the page, use the HTML viewer, place your cursor in the text area of your target edit and then click on the tag you want to place. Alternatively, you may simply type the appropriate name within the required symbols like <code>##this##</code> or <code><nowiki>[[this]]</nowiki></code>, respectively.

* <code>##edit##</code> creates a clickable icon link that allows you to edit the current entry (only appears if you have the rights to do this)
* <code>##delete##</code> creates a link that lets you delete the current entry (only appears if you have the rights to do this)
* <code>##approve##</code> create a link that lets you approve the current database entry (only appears if you have the rights to do this)
* <code>##more##</code> creates a link to the single view, which may contain more detailed info
* <code>##moreurl##</code> creates just the URL for the above link, useful for creating your own links. You can click on the link icon and type <code>##moreurl##</code> into URL field or in source view type <pre><a href="##moreurl##">[[fieldname]]</a></pre>
* <code>##comments##</code> creates a link to the view/edit comments page, the link text is the current number of comments (only appears if comments are turned on)
* <code>##user##</code> creates a link to the user page of the user who submitted the entry, link text is their name
* <code>##timeadded##</code>
* <code>##timemodified##</code>

== List template ==

This template allows you to control the fields used and their layout when viewing multiple entries at once (e.g. search results). It is possible that this view may simply provide an overview with more detailed information available by clicking on an entry to access the single view of the entry.

See [http://tracker.moodle.org/secure/attachment/23333/moodle_databse_activity_list_formatting.pdf Designing a list view in Moodle database activity] for instructions on how to create a list template table.

The list template can also be used as a way to [[Database export|export your database]] as a CSV file.

== Single template ==
This is used to display a single entry at a time and so has more space for display and can use, for example, larger versions of images or optionally provide more information than shown in the list view.

[[Image:Databasesingletemplate.png]]

== Advanced search template ==

An advanced search template is for creating the interface form used in the advanced search.

== Add template ==

This template creates the interface form used when adding or editing database entries.

== RSS template ==

Lets you control the content of the [[RSS]] feed for database entries.

== CSS template ==

If any of the [[HTML in Moodle|HTML]] in your other templates requires [[CSS]] to provide visual style you can specify it here.

== Javascript template ==

You can use javascript to manipulate the way elements are displayed in either the List, Single or Add templates. Basically you need to enclose the part you want to manipulate in some named html element. The naming is essential as it allows you to identify the element for manipulation.

Let's say, for example, you have a field in your database that stores a person's name and when you display the names in the List View you want to count the times a name matches some criteria and display the result.

Your database will contain a field which we will call "name". In your List template you will be able to display the contents of that field by using the <nowiki>[[name]]</nowiki> construct at the place where you want that information displayed. For example in the ''Repeated entry'' on the list template you will have

<pre>
<table>
<tr>
<td>Name: [[name]]</td>
</tr>
<table>
</pre>

You now need to modify that entry to ensure that the part you want to manipulate is a named element.

<pre>
<table>
<tr>
<td name="named">Name: [[name]]</td>
</tr>
<table>
</pre>

The footer of your list view can then contain another named element to display the result.

<pre>
<div name="result"></div>
</pre>

Your javascript template can now look as follows

<pre>
var cnt = 0;
var re = /foo|Foo/;

function init(){
var namedElements = document.getElementsByName("named");
for (i=0; i < namedElements.length; i++) {
if(re.test(namedElements[i].innerHTML)) cnt++;
}
var namedResult = document.getElementsByName("result");
namedResult[0].innerHTML = cnt;
}

window.onload = init;
</pre>

This will display a table of names as is usual in the list view. Now at the bottom there will also be the count of the names that matched foo or Foo.

Note that window.onload does not handle any dependencies on [https://docs.moodle.org/dev/Javascript_FAQ#What_JavaScript_library_does_Moodle_use.3F YUI] code, so any YUI modules required by your init() code may not be loaded, and your code will fail.

In this case, instead of onload, use:
<pre>
YUI().use('node', 'other', 'dependencies', function(Y) {

// Your code here.

// This function is a closure so the Y object you define in the function definition is yours and nothing else on the page should be able to break it.

});
</pre>

== Reset templates button ==

When you first create a database the templates will be pre-filled with appropriate HTML. If you later add fields then you can press the ''reset templates'' button and it will add HTML for the new fields in a similar fashion. If you have edited any of the templates in the meantime then your changes will be lost. It is recommended that you finalize the database fields before changing the template code.

==See also==
*[[Database presets]]
*[http://video.google.com/videoplay?docid=7026851446099005477 Video demonstrating tag usage]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=55338 Look of the database module]
*[http://moodle.org/mod/forum/discuss.php?d=74243 How can I list database information horizontally instead of vertically?]
*[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=84050 Can't get columns to line up in list view]
*[http://moodle.org/mod/forum/discuss.php?d=86927 Time stamp for database entries?]

[[de:Datenbank-Vorlagen]]
[[fr:Modèles]]
[[ru:Шаблоны]]
[[ja:データベーステンプレート]]

Database templates

2013-11-15T11:26:06Z

Davidbalch: /* Javascript template */

{{Database}}
Templates for the [[Database activity module]] allow you to control the visual layout of information when listing, viewing or editing database entries. It is a similar to the technique used to ''mail merge'' letters in word processors such as Open Office Writer or Microsoft Word.

== Tag usage ==

The content of each [[Database fields|field]] you create for your database and some special tags (listed below) can be inserted into the output template by the use of tags.

Fields have the format <code><nowiki>[[fieldname]]</nowiki></code>. All other tags have the format <code>##sometag##</code>.

To use the tags in the box on the left of the page, use the HTML viewer, place your cursor in the text area of your target edit and then click on the tag you want to place. Alternatively, you may simply type the appropriate name within the required symbols like <code>##this##</code> or <code><nowiki>[[this]]</nowiki></code>, respectively.

* <code>##edit##</code> creates a clickable icon link that allows you to edit the current entry (only appears if you have the rights to do this)
* <code>##delete##</code> creates a link that lets you delete the current entry (only appears if you have the rights to do this)
* <code>##approve##</code> create a link that lets you approve the current database entry (only appears if you have the rights to do this)
* <code>##more##</code> creates a link to the single view, which may contain more detailed info
* <code>##moreurl##</code> creates just the URL for the above link, useful for creating your own links. You can click on the link icon and type <code>##moreurl##</code> into URL field or in source view type <pre><a href="##moreurl##">[[fieldname]]</a></pre>
* <code>##comments##</code> creates a link to the view/edit comments page, the link text is the current number of comments (only appears if comments are turned on)
* <code>##user##</code> creates a link to the user page of the user who submitted the entry, link text is their name
* <code>##timeadded##</code>
* <code>##timemodified##</code>

== List template ==

This template allows you to control the fields used and their layout when viewing multiple entries at once (e.g. search results). It is possible that this view may simply provide an overview with more detailed information available by clicking on an entry to access the single view of the entry.

See [http://tracker.moodle.org/secure/attachment/23333/moodle_databse_activity_list_formatting.pdf Designing a list view in Moodle database activity] for instructions on how to create a list template table.

The list template can also be used as a way to [[Database export|export your database]] as a CSV file.

== Single template ==
This is used to display a single entry at a time and so has more space for display and can use, for example, larger versions of images or optionally provide more information than shown in the list view.

[[Image:Databasesingletemplate.png]]

== Advanced search template ==

An advanced search template is for creating the interface form used in the advanced search.

== Add template ==

This template creates the interface form used when adding or editing database entries.

== RSS template ==

Lets you control the content of the [[RSS]] feed for database entries.

== CSS template ==

If any of the [[HTML in Moodle|HTML]] in your other templates requires [[CSS]] to provide visual style you can specify it here.

== Javascript template ==

You can use javascript to manipulate the way elements are displayed in either the List, Single or Add templates. Basically you need to enclose the part you want to manipulate in some named html element. The naming is essential as it allows you to identify the element for manipulation.

Let's say, for example, you have a field in your database that stores a person's name and when you display the names in the List View you want to count the times a name matches some criteria and display the result.

Your database will contain a field which we will call "name". In your List template you will be able to display the contents of that field by using the <nowiki>[[name]]</nowiki> construct at the place where you want that information displayed. For example in the ''Repeated entry'' on the list template you will have

<pre>
<table>
<tr>
<td>Name: [[name]]</td>
</tr>
<table>
</pre>

You now need to modify that entry to ensure that the part you want to manipulate is a named element.

<pre>
<table>
<tr>
<td name="named">Name: [[name]]</td>
</tr>
<table>
</pre>

The footer of your list view can then contain another named element to display the result.

<pre>
<div name="result"></div>
</pre>

Your javascript template can now look as follows

<pre>
var cnt = 0;
var re = /foo|Foo/;

function init(){
var namedElements = document.getElementsByName("named");
for (i=0; i < namedElements.length; i++) {
if(re.test(namedElements[i].innerHTML)) cnt++;
}
var namedResult = document.getElementsByName("result");
namedResult[0].innerHTML = cnt;
}

window.onload = init;
</pre>

This will display a table of names as is usual in the list view. Now at the bottom there will also be the count of the names that matched foo or Foo.

Note that window.onload does not handle any dependencies on [https://docs.moodle.org/dev/Javascript_FAQ#What_JavaScript_library_does_Moodle_use.3F YUI] code, so any YUI modules required by your init() code may not be loaded, and your code will fail. In this case, use a Y.use() call.

== Reset templates button ==

When you first create a database the templates will be pre-filled with appropriate HTML. If you later add fields then you can press the ''reset templates'' button and it will add HTML for the new fields in a similar fashion. If you have edited any of the templates in the meantime then your changes will be lost. It is recommended that you finalize the database fields before changing the template code.

==See also==
*[[Database presets]]
*[http://video.google.com/videoplay?docid=7026851446099005477 Video demonstrating tag usage]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=55338 Look of the database module]
*[http://moodle.org/mod/forum/discuss.php?d=74243 How can I list database information horizontally instead of vertically?]
*[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=84050 Can't get columns to line up in list view]
*[http://moodle.org/mod/forum/discuss.php?d=86927 Time stamp for database entries?]

[[de:Datenbank-Vorlagen]]
[[fr:Modèles]]
[[ru:Шаблоны]]
[[ja:データベーステンプレート]]

Database templates

2013-11-15T10:31:11Z

Davidbalch: /* Javascript template */

{{Database}}
Templates for the [[Database activity module]] allow you to control the visual layout of information when listing, viewing or editing database entries. It is a similar to the technique used to ''mail merge'' letters in word processors such as Open Office Writer or Microsoft Word.

== Tag usage ==

The content of each [[Database fields|field]] you create for your database and some special tags (listed below) can be inserted into the output template by the use of tags.

Fields have the format <code><nowiki>[[fieldname]]</nowiki></code>. All other tags have the format <code>##sometag##</code>.

To use the tags in the box on the left of the page, use the HTML viewer, place your cursor in the text area of your target edit and then click on the tag you want to place. Alternatively, you may simply type the appropriate name within the required symbols like <code>##this##</code> or <code><nowiki>[[this]]</nowiki></code>, respectively.

* <code>##edit##</code> creates a clickable icon link that allows you to edit the current entry (only appears if you have the rights to do this)
* <code>##delete##</code> creates a link that lets you delete the current entry (only appears if you have the rights to do this)
* <code>##approve##</code> create a link that lets you approve the current database entry (only appears if you have the rights to do this)
* <code>##more##</code> creates a link to the single view, which may contain more detailed info
* <code>##moreurl##</code> creates just the URL for the above link, useful for creating your own links. You can click on the link icon and type <code>##moreurl##</code> into URL field or in source view type <pre><a href="##moreurl##">[[fieldname]]</a></pre>
* <code>##comments##</code> creates a link to the view/edit comments page, the link text is the current number of comments (only appears if comments are turned on)
* <code>##user##</code> creates a link to the user page of the user who submitted the entry, link text is their name
* <code>##timeadded##</code>
* <code>##timemodified##</code>

== List template ==

This template allows you to control the fields used and their layout when viewing multiple entries at once (e.g. search results). It is possible that this view may simply provide an overview with more detailed information available by clicking on an entry to access the single view of the entry.

See [http://tracker.moodle.org/secure/attachment/23333/moodle_databse_activity_list_formatting.pdf Designing a list view in Moodle database activity] for instructions on how to create a list template table.

The list template can also be used as a way to [[Database export|export your database]] as a CSV file.

== Single template ==
This is used to display a single entry at a time and so has more space for display and can use, for example, larger versions of images or optionally provide more information than shown in the list view.

[[Image:Databasesingletemplate.png]]

== Advanced search template ==

An advanced search template is for creating the interface form used in the advanced search.

== Add template ==

This template creates the interface form used when adding or editing database entries.

== RSS template ==

Lets you control the content of the [[RSS]] feed for database entries.

== CSS template ==

If any of the [[HTML in Moodle|HTML]] in your other templates requires [[CSS]] to provide visual style you can specify it here.

== Javascript template ==

You can use javascript to manipulate the way elements are displayed in either the List, Single or Add templates. Basically you need to enclose the part you want to manipulate in some named html element. The naming is essential as it allows you to identify the element for manipulation.

Let's say, for example, you have a field in your database that stores a person's name and when you display the names in the List View you want to count the times a name matches some criteria and display the result.

Your database will contain a field which we will call "name". In your List template you will be able to display the contents of that field by using the <nowiki>[[name]]</nowiki> construct at the place where you want that information displayed. For example in the ''Repeated entry'' on the list template you will have

<pre>
<table>
<tr>
<td>Name: [[name]]</td>
</tr>
<table>
</pre>

You now need to modify that entry to ensure that the part you want to manipulate is a named element.

<pre>
<table>
<tr>
<td name="named">Name: [[name]]</td>
</tr>
<table>
</pre>

The footer of your list view can then contain another named element to display the result.

<pre>
<div name="result"></div>
</pre>

Your javascript template can now look as follows

<pre>
var cnt = 0;
var re = /foo|Foo/;

function init(){
var namedElements = document.getElementsByName("named");
for (i=0; i < namedElements.length; i++) {
if(re.test(namedElements[i].innerHTML)) cnt++;
}
var namedResult = document.getElementsByName("result");
namedResult[0].innerHTML = cnt;
}

window.onload = init;
</pre>

This will display a table of names as is usual in the list view. Now at the bottom there will also be the count of the names that matched foo or Foo.

Note that window.onload does not handle any dependencies on [https://docs.moodle.org/dev/Javascript_FAQ#What_JavaScript_library_does_Moodle_use.3F YUI] code, so any YUI modules required by your init() code may not be loaded, and your code will fail.

== Reset templates button ==

When you first create a database the templates will be pre-filled with appropriate HTML. If you later add fields then you can press the ''reset templates'' button and it will add HTML for the new fields in a similar fashion. If you have edited any of the templates in the meantime then your changes will be lost. It is recommended that you finalize the database fields before changing the template code.

==See also==
*[[Database presets]]
*[http://video.google.com/videoplay?docid=7026851446099005477 Video demonstrating tag usage]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=55338 Look of the database module]
*[http://moodle.org/mod/forum/discuss.php?d=74243 How can I list database information horizontally instead of vertically?]
*[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=84050 Can't get columns to line up in list view]
*[http://moodle.org/mod/forum/discuss.php?d=86927 Time stamp for database entries?]

[[de:Datenbank-Vorlagen]]
[[fr:Modèles]]
[[ru:Шаблоны]]
[[ja:データベーステンプレート]]

Embedding content

2011-08-31T13:38:14Z

Davidbalch:

{{Working with media}}
<p class="note">'''Please refer to [[Page_notes#Embedding content|these notes]] before editing this page.'''</p>
{{Improve}}

== Embedding media files ==
When adding content to a course with a [[Page]] resource, media files can be embedded using [[Multimedia_plugins|multimedia plugins]] to take media file URLs entered in the HTML editor and convert them into relevant player software embedded in the page.

== Embedding uploaded resources ==

When adding a File resource to a course, there are several options for how the file will be displayed to the user: Automatic, Embed, Force download, Open, In pop-up, and disabled by default: In frame, and New window. (See [[mod/file/mod|file mod]] for more details on all of these.)

The options relevant to embedding are Embed and In frame:
=== Embed ===
This uses a HTML <code>object</code> element, or <code>iframe</code> element for older versions of Internet Explorer.

The resource is embedded at a default size 800x600, and automatically resized to fill available space by javascript on page load and resize. Due to the variety of different content that might be embedded (e.g. Flash, PDFs, HTML pages) the resized embed may not maximise use of available screen space, e.g. unused space below the footer.

=== In frame ===
This uses a resizable HTML <code>frameset</code> with an upper <code>frame</code> to show the Moodle heading (with navigation) and the file description, with the file displayed in a <code>frame</code> below.

Disabled by default, In frame is not recommended as frames have been depreciated in recent versions of the HTML standard, due to the problems they create for accessibility.
It can be enabled via ''Site administration > Plugins > Activity modules > File''.

Embedding content

2011-08-31T12:56:56Z

Davidbalch:

{{Working with media}}
<p class="note">'''Please refer to [[Page_notes#Embedding content|these notes]] before editing this page.'''</p>
{{Improve}}

== Embedding media files ==
When adding content to a course with a [[Page]] resource, media files can be embedded using [[Multimedia_plugins|multimedia plugins]] to take media file URLs entered in the HTML editor and convert them into relevant player software embedded in the page.

== Embedding uploaded resources ==

When adding a File resource to a course, there are several options for how the file will be displayed to the user: Automatic, Embed, Force download, Open, In pop-up, and disabled by default: In frame, and New window. (See [[mod/file/mod|file mod]] for more details on all of these.)

The options relevant to embedding are Embed and In frame:
=== Embed ===
This uses a HTML <code>object</code> element, or <code>iframe</code> element for older versions of Internet Explorer. The resource is embedded at a default size 800x600, and automatically resized to fill available space by javascript on page load and resize.

=== In frame ===
This uses a resizable HTML <code>frameset</code> with an upper <code>frame</code> to show the Moodle heading (with navigation) and the file description, with the file displayed in a <code>frame</code> below.

Disabled by default, In frame is not recommended as frames have been depreciated in recent versions of the HTML standard, due to the problems they create for accessibility.
It can be enabled via ''Site administration > Plugins > Activity modules > File''.

Embedding content

2011-08-31T11:37:14Z

Davidbalch: First pass.

{{Working with media}}
<p class="note">'''Please refer to [[Page_notes#Embedding content|these notes]] before editing this page.'''</p>
{{Improve}}

== Embedding media files ==
When adding content to a course with a [[Page]] resource, media files can be embedded using [[Multimedia_plugins|multimedia plugins]] to take media file URLs entered in the HTML editor and convert them into relevant player software embedded in the page.

== Embedding uploaded resources ==

When adding a File resource to a course, there are several options for how the file will be displayed to the user: Automatic, Embed, Force download, Open, In pop-up, and disabled by default: In frame, and New window. (See [[mod/file/mod|file mod]] for more details on all of these.)

The options relevant to embedding are Embed and In frame:
=== Embed ===
This uses a HTML <code>object</code> element, or <code>iframe</code> element for older versions of Internet Explorer.

=== In frame ===
This uses a resizable HTML <code>frameset</code> with an upper <code>frame</code> to show the Moodle heading (with navigation) and the file description, with the file displayed in a <code>frame</code> below.

Disabled by default, In frame is not recommended due to accessibility problems caused by HTML frames.
It can be enabled via ''Site administration > Plugins > Activity modules > File''.

Upload users

2010-09-29T09:15:55Z

Davidbalch: Change "Enrolment field names" layout to make it more comprehensible

Location: ''Administration > Users > Accounts > Upload users''

[[Image:Upload users preview.png|thumb|Upload users preview in Moodle 1.9]]
Firstly, note that it is usually not necessary to import users in bulk - to keep maintenance work down you should first explore forms of authentication that do not require manual maintenance, such as [[External database authentication|connecting to existing external databases]] or letting the [[Internal enrolment|users create their own accounts]]. See [[Manage authentication]] for more information.

If you are sure you want to import multiple user accounts from a text file, then you need to format your text file as follows:

==Upload file format==

* Each line of the file contains one record
* Each record is a series of data separated by commas (or other delimiters)
* The first record of the file is special, and contains a list of fieldnames. This defines the format of the rest of the file.

:'''Required fieldnames''': These fields must be included in the first record, and defined for each user
:<p><code>username, password, firstname, lastname, email</code></p>
:<p>Remember that validity checks for the username, password, and email fields will be performed.Usernames can only contain alphabetical letters in lowercase, numbers, hypen '-', underscore '_', period '.', or at sign '@'. Passwords should meet the requirements specified for the site's [[Site_policies#Password_policy|Password policy]]. Emails should be in the format of a valid email.</p>

:'''Optional fieldnames''': If a value is present for the field in the file, then that value is used; else, the default value for that field is used
:<p><code>institution, department, city, country, lang, auth, ajax, timezone, idnumber, icq, phone1, phone2, address, url, description, mailformat, maildisplay, htmleditor, autosubscribe, emailstop</code></p>

:'''Custom profile field names''': Optional, xxxxx is the real custom user profile field name (i.e. the unique short name)
:<p><code>profile_field_xxxxx</code></p>
:'''Warning:''': If you want to create custom profile fields, you need to follow the standard header in your .csv file to import users. You must create the custom fields BEFORE importing users from list. The "shortname" for your custom field is xxxxx, and the header collumn to all users data in .csv file have standard notation "profile_field_xxxxx".
:'''Example''': If you want to create a custom field "genre" in your Moodle site, you must write a shortname "genre" in the new field, and write "profile_field_genre" in the header of the .csv file.

:'''Special field names''': Used for changing of usernames and deleting of users
:<p><code>deleted, oldusername</code></p>

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

* Commas within the data should be encoded as &#44 - the script will automatically decode these back to commas.
* For Boolean fields, use 0 for false and 1 for true.
* Force password change: Set the password field for desired users to '''changeme'''.
* Turn email off: The parameter '''emailstop''' must be set to 1 if the email address should not work. If you set it to 0 then the email address is switched on. If you want to have all the email addresses active then you do not need the additional parameter in your upload file.
* In order to prevent users from receiving a larger number of emails from courses and forced subscription forums use the '''maildigest''' fieldname. The options for this fieldname are 0 = No digest, 1 = Complete digest and 2 = Digest with just subjects.

Here is an example of a valid import file:

<code>username, password, firstname, lastname, email, lang, idnumber, maildisplay, course1, group1, type1<br />
jonest, verysecret, Tom, Jones, jonest@someplace.edu, en, 3663737, 1, Junk102, Section 1, 1<br />
reznort, somesecret, Trent, Reznor, reznort@someplace.edu, en_us, 6736733, 0, Junk102, Section 3, 3</code>

==Templates==

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

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

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

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

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

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

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

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

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

==Updating existing accounts==

By default Moodle assumes that you will be creating new user accounts, and skips records where the username matches an existing account. However, if you set "Update existing accounts" to '''Yes''', the existing user account will be updated.

When updating existing accounts you can change usernames as well. Set "Allow renames" to '''Yes''' and include in your file a field called <code>oldusername</code>.

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

==Deleting accounts==

If the <code>deleted</code> field is present, users with value 1 for it will be deleted. In this case, all the fields may be omitted, except for <code>username</code>.

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

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

==Encoding==

In Moodle 1.8 the file must be UTF-8. In Moodle 1.9 onwards, the encoding may be selected from a large list, including ISO-8859-1.

==Hints==

===Spreadsheet===

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

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

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

===Country===
The country should be written as a two letter code, in capitals. For example, use BE for Belgium or NL for the Netherlands. Using "be" or "nl" as a country code will result in a database error.
:''Tip:'' If you are having trouble working out the two-letter code for a country, you can consult this Moodle source code file /moodle/lang/en_utf8/countries.php [http://cvs.moodle.org/moodle/lang/en_utf8/countries.php?view=markup&pathrev=MOODLE_19_STABLE or click here for a 1.9 STABLE list].
ISO Website: [http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm]

== See also ==
Moodle Docs:
*[[Flat file]]

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

[[Category:Authentication]]
[[Category:Enrolment]]
[[Category:Groups]]

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

Development:NEWMODULE Documentation

2009-09-22T09:20:56Z

Davidbalch: Changed icon dimensions, as the files are 16x16. Added description of index.php

{{Template:Work in progress}}
{{New_Module}}

This first draft of Moodle Docs page about the creation of a new module is divided into the following sections:

*[[Development:NEWMODULE Tutorial]]
*[[Development:NEWMODULE Reference]]
*[[Development:NEWMODULE FAQ]]
*[[Development:NEWMODULE Adding capabilities]]

----

Daniele, did you know about [[Development:Modules]], which is linked to from [[Developer_documentation#Make_a_new_plugin]]? You may be better off editing that, rather than starting a new page. However don't let me discourage you. That documentation is very limited, and badly needs to be expanded, so it is absolutely brilliant that you want to work on it.--[[User:Tim Hunt|Tim Hunt]] 12:03, 28 March 2008 (CDT)

::Good point Tim! Anyway... I think we can use this as temporary root for Daniele's work and then, simply, move things to their final place. Let's see how this evolves. -- [[User:Eloy Lafuente (stronk7)|Eloy Lafuente (stronk7)]] 12:33, 28 March 2008 (CDT)

----

[http://lyceum.open.ac.uk/temp/creating_moodle_modules.ppt My powerpoint about creating moodle modules] is a bit old (1.8) and maybe not that comprehensible but I use it when I'm trying to explain things to people. It includes a list of all the things you need to have in a module, except the ones I forgot (backuplib iirc is missing). [[User:sam marshall|sam marshall]] 12:52, 28 March 2008 (CDT)

::That's really great, Sam. For sure that presentation will help.Thanks! -- [[User:Eloy Lafuente (stronk7)|Eloy Lafuente (stronk7)]] 13:08, 28 March 2008 (CDT)

Dear Tim, Sam and Eloy, I wrote what was my learning path on these issues. I wrote whatever I found in your powerpoint guide (thanks again, Sam) and whatever I got mainly from Tim, Eloy and Petr. A lot of issues are still obscure to me like: grades, groups, groupings, backup and so forth. Please let me know your opinion to make all together a plan to carry on in the best way. Thanks. -- [[User:Daniele Cordella|Daniele Cordella]] 11:55, 10 September 2009 (UTC)

==Getting started==

To download the newmodule package, please refer to:
:* 1.8: http://download.moodle.org/plugins18/mod/NEWMODULE.zip
:* 1.9: http://download.moodle.org/plugins19/mod/NEWMODULE.zip
:* HEAD: http://download.moodle.org/plugins/mod/NEWMODULE.zip

Although you can download the newmodule package for moodle 1.8, such as 1.9 and head, this tutorial is intended for the newmodule development in Moodle 1.9 ONLY.

Let's start by getting an idea about what you find in the newmodule folder taken from http://download.moodle.org/plugins19/mod/NEWMODULE.zip
<pre>NEWMODULE:
01) db/install.xml
02) db/upgrade.php
03) icon.gif
04) index.php
05) lang/en_utf8/help/newmodule/index.html
06) lang/en_utf8/help/newmodule/mods.html
07) lang/en_utf8/newmodule.php
08) lib.php
09) mod_form.php
10) README.txt
11) version.php
12) view.php
</pre>

The path where you find each file is the correct one. So don't change the path of files and folders in this newmodule package.

Inside the db folder, at the beginning, you can only find install.xml and upgrade.php but sooner you will start to always add the new file "access.php".

01) '''db/install.xml''' is the file to write the xml describing the tables needed by the module. Tables are at least two, one named with the same name of the module, one named "log_display". They follow a strict syntax that you can learn by editing one of the several example you can find inside moodle modules. Ultimately the only thing to take care is the <<previous>> <<next>> connection between tables and fields. This is the mandatory file where you MUST write the structure of the tables your module is going to use. Tha table "log_display" is the tables where you are requested to list all the "actions" that you will add to the logs of your module.

02) '''db/upgrade.php''' is the file that you will write each time you need to change the structure of the tables of your module. To learn how to write this file, please refer to the examples you may find in the file itself.

03) '''icon.gif''', it is a 16px per 16px icon identifying each instance of your module in the frame of a course

04) '''index.php''' is a page to list all instances of the functionality the module provides in a course.

05) '''lang''' is the folder reserved to language packs. A module language pack is a folder named "xx_utf8" containing, in turn, a folder named "help" and a language file named with the same name of the module. xx is the two char long name of the language, i.e. en, de, es, it, fr and so forth.
:Each language file is dedicated to a specific language. The lang folder may contain as much language packs as provided by different translators. The lang/xx_utf8/newmodule/ folder contains all the help files you want to provide to your module. In order to link a help file from inside the code of your module pages try:
:* helpbutton('<<name of your help file saved in lang/xx_utf8/newmodule/>>', get_string('your_string','newmodule'), 'newmodule');
:or, in mod_form.php,
:* $mform->setHelpButton as stated in

08) '''lib.php''' is the pre-filled file with "core" functions needed by each module.
Let me start by remembering the convention to name functions into lib.php and locallib.php.
:See: https://docs.moodle.org/en/Development:Coding_style#Functions_and_Methods
:or
:https://docs.moodle.org/en/Development:Modules

:Mandatory function are, at least:
:*'''function newmodule_add_instance($newmodule)'''
:This function is executed after an editing teacher create an instance of newmodule
:See, lib.php for more details just above the function.

:*'''function newmodule_update_instance($newmodule)'''
:This function is executed after an editing teacher update an instance of newmodule
:See, lib.php for more details just above the function.

:*'''function newmodule_delete_instance($id)'''
:This function is executed after an editing teacher delete an instance of newmodule
:See, lib.php for more details just above the function.

:*'''function newmodule_user_outline()'''
:See, lib.php for more details just above the function.

:*'''function newmodule_user_complete($course, $user, $mod, $newmodule)'''
:See, lib.php for more details just above the function.

:*'''function newmodule_print_recent_activity($course, $isteacher, $timestart)'''
:See, lib.php for more details just above the function.

:*'''function newmodule_cron()'''
:Take care with this function.
:Differently by all the other functions, this function is not called by passing it the $newmodule record. This means that this function, called by moodle core cron has to look for each newmodule instance id before operating.
:Don't worry, even if you have more than a single instance of your module among moodle courses, this function will be executed just one time.

:*'''function newmodule_get_participants($newmoduleid)'''
:See, lib.php for more details just above the function.

:*'''function newmodule_scale_used($newmoduleid, $scaleid)'''
:See, lib.php for more details just above the function.

:*'''function newmodule_scale_used_anywhere($scaleid)'''
:See, lib.php for more details just above the function.

:*'''function newmodule_install()'''
:See, lib.php for more details just above the function.

:*'''function newmodule_uninstall()'''
:See, lib.php for more details just above the function.

:In my honest opinion some more functions should be added. Among these I want to list:

:*'''function newmodule_reset_course_form_definition(&$mform)'''
:*'''function newmodule_reset_course_form_defaults($course)'''
:*'''function newmodule_reset_userdata($data)'''
:These last three functions are responsible for the mewmodule reset process during the more general course reset process. Please, refer to mod/data/lib.php or to mod/feedback/lib.php, for instance, to understand them better.

:Two more functions should be added to lib.php are, in my opinion:
:*'''function newmodule_get_view_actions()'''
:*'''function newmodule_get_post_actions()'''
:They distinguish between "read" and "post" log actions.
:These functions are used by moodle core during log gather.
:The actions you list inside these two functions, must match the ones you listed in the table "log_display" in install.xml

Still about the lib.php file, it is important to read what is stated at the end of lib.php: <pre>//////////////////////////////////////////////////////////////////////////////////////
/// Any other newmodule functions go here. Each of them must have a name that
/// starts with newmodule_
/// Remember (see note in first lines) that, if this section grows, it's HIGHLY
/// recommended to move all functions below to a new "locallib.php" file.</pre>

:One important issue is about the connection between '''lib.php''' and '''locallib.php'''
:Who has to call the other, how and why?
:It has to be locallib.php to call lib.php through: <pre>require_once("$CFG->dirroot/mod/newmodule/lib.php");</pre>
:as first line.

:In this way, if moodle core calls function inside mod/newmodule/lib.php no module specific function will be loaded in memory.
:If it is your newmodule to call a function, it has to require_once('locallib.php'); that, in turn, will require_once('lib.php') so that your module will "see" all its available functions.

09) '''mod_form.php''' is the file describing the form you get at the module instance creation or at the instance editing time.
The syntax is very simple and by reading the file it is simple to change it on your need.
:It uses the syntax you can learn in:
:https://docs.moodle.org/en/Development:lib/formslib.php_Form_Definition

:At date, there is a missing detail by the end of the file.
:You can read:
<pre>//------------------------------------------------------------------------------
// add standard elements, common to all modules
$this->standard_coursemodule_elements();
//------------------------------------------------------------------------------</pre>
:This part is responsible for the common modules section at the end of your newmodule editing instance page. (the section related to groups)
:This code can be customized by changing it as described below:
<pre>//------------------------------------------------------------------------------
// add standard elements, common to all modules
$features = new object();
$features->groups = false;
$features->groupings = false;
$features->groupmembersonly = true;
$this->standard_coursemodule_elements($features);
//------------------------------------------------------------------------------</pre>

One more tip about this file.
:Once you submit the form described by this file, your module executes the function: newmodule_add_instance or newmodule_update_instance both pre-written in lib.php.
:It seems that check boxes in the editing instance form don't work. To test this, please verify the passed parameter $newmodule inside your function newmodule_update_instance through a simple: <pre>print_object($newmodule);</pre>
:You will find that even by selecting or unselecting the check box in the newmodule instance editing form, the corresponding value in the array doesn't change. This is not an error, but at least a lack of code.
:By adding a simple code like: <pre>$checkboxes = array('myfirstcheckboxfield', 'mysecondcheckboxfield', and so fort with all your checkbox field);
foreach ($checkboxes as $checkbox) {
if (empty($newmodule->{$checkbox})) {
$newmodule->{$checkbox} = 0;
}
}
</pre>
:at the beginning of both functions, you will find that all works fine.

10) '''README.txt''' is the file where you are welcome to write what your newmodule does.

11) '''version.php''' is a really very simple file as simple as important.
To understand why it is important, you need to know that there are a bunch of actions that moodle performs for your newmodule ONLY (with only one exception) at the newmodule installation. They are, at least, db tables editing and load of capability. If during the development of your module (that you already installed on your development environment or that you already shared with remote users) you need to change the structure of your newmodule tables or you need to change the capability used by your newmodule, you need to force moodle to edit tables and reload capability. This is done by:
:* adding the proper code in newmodule/db/upgrade.php (to do this, use XMLDB as stated in this same page below)
:* increasing the newmodule version.
:* visiting the notification page of your installation of Moodle.

12) '''view.php''' is the first executed code of your module. By selecting the link of the instance of your module, the code of newmodule/view.php is executed.

== Some very important missing files ==
There are five files that are not present in the newmodule package that 90% of times you will go to add to your newmodule.

1. The first one is locallib.php already described before.

2. The second one is access.php that has to be saved inside newmodule/db/ folder.
:In this file you will add all the capability used by your newmodule and loaded at the installation time or upgrade time. To learn the syntax of the capability, please refer to the same file in other modules or to: https://docs.moodle.org/en/Development:NEWMODULE_Adding_capabilities
3. The third missing file must be added to newmodule/ folder. It is settings.php and describes the form that can be accessed from: Site Administration block -> Modules -> Activities -> <<your newmodule name>>
:This form stores general settings for your newmodule into the site wide $CFG object. Because of this, it is strongly recommended to give to your newmodule general settings with names starting with "newmodule_". This file is useful when there is a setting that doesn't depend from the instance. I.e., if your newmodule simulates a telephone, you will probably save your telephone number in this newmodule setting site wide form instead of typing it each time you add a new instance of your newmodule into a course. In this case, to refer to you telephone number inside your newmodule you will use: $CFG->newmodule_telephonenumber
4. Directly in the newmodule folder, you need to add backuplib.php that is responsible for the backup of each instance of your module and of its log.
:To learn how to code it, start by stealing it from some other module and read it.
5. Again in the newmodule folder, you need to add restorelib.php that is responsible for the restore of each instance your module and of its log.
:To learn how to code it, start by stealing it from some other module and read it.

==Let's start==
To start using a downloaded package, please perform the 7 actions described in https://docs.moodle.org/en/Development:NEWMODULE_Tutorial in How to Begin the Creation of a New Module paragraph.

Then, draw the structure of your tables on a sheet, edit the file db/install.xml according to your project, save, put your renamed newmodule folder in moodle/mod/ and visit the moodle notification page.

To add code to db/upgrade.php never do it manually. I always make use of Site Administration block -> Miscellaneous -> XMLDB editor and I ask it to write the code for me. It never fails.

Please remember: within your module, never use "embedded messages" like:
<pre>echo 'Welcome to this newmodule';</pre>
but make use of get_string or print_string. In this way your module will be multilang with a really small effort.
Use, for instance:
<pre>print_string('welcomemessage','newmodule');</pre>
saving in newmodule/lang/en_utf8/newmodule.php
<pre>$string['welcomemessage'] = 'Welcome to this newmodule';</pre>
==Some code snippets that I find useful==
'''**To check the capability of a user''', try:
<pre>if (newmodule_hascapabilitytodothis()) {
//user is allowed
} else {
// user is not allowed
}</pre>

typing in locallib.php
<pre>function newmodule_hascapabilitytodothis($cm) {
$context = get_context_instance(CONTEXT_MODULE, $cm->id);

return (has_capability('mod/newmodule:candothis', $context));
}</pre>

typing in db/access.php
<pre>$mod_newmodule_capabilities = array(
'mod/newmodule:candothis' => array(
'captype' => 'read',
'contextlevel' => CONTEXT_MODULE,
'legacy' => array(
'teacher' => CAP_ALLOW,
'editingteacher' => CAP_ALLOW,
'admin' => CAP_ALLOW
)
)
)
</pre>

'''To edit the tables in use by your newmodule''', try:
* edit install.xml manually by editing fields and or tables in the xml structure.
* go to Site Administration block -> Miscellaneous -> XMLDB editor and load the tables of your module
* ask to the XMLDB editor the snippets of code you need to add to db/upgrade.php
* copy and paste in db/upgrade.php
* in the line: if ($result && $oldversion < xxxxxxxxxxxx), (replace xxxxxxxxxxxx with the version number you are going to give to your newmodule)
* change (increase) the version number
* visit the Moodle notification page

'''To add a single line to logs from your mewmodule''', try:
<pre>add_to_log($course->id, 'newmodule', '<<action already listed in log_display>>', "view.php?id=$cm->id", "$newmodule->id");</pre>

'''To be sure that remote user will not be able to contact your pages by typing their URL directly in the address bar''', try:

as first line of each of your php script
<pre>defined('NEWMODULE_INCLUDE_TEST') OR die('not allowed');</pre>

typing in lib.php, at the beginning
<pre>define('NEWMODULE_INCLUDE_TEST', 1);</pre>

==Some suggestion I find useful==
'''To include php scripts''', try:
<pre>require_once(myscript.php);</pre>

'''To include php library''', try:
<pre>require_once('locallib.php');</pre>

'''To periodically execute function newmodule_cron()''', try:
<pre>$module->cron = xxxx;</pre>
providing some code in: <pre>function newmodule_cron()</pre>
Your function newmodule_cron() will be executed about each xxxx seconds

'''Do not include config when it is not needed'''
<pre>require_once('config.php')</pre>
is not needed in library scripts

'''Do not use global $cm or $newmodule in your function'''
but use proper function parameters.

So, never use:
<pre>function newmodule_lookatthesky() {
global $cm, $newmodule;

// your stuff
}</pre>
but use:
<pre>function newmodule_lookatthesky($cm, $newmodule) {

// your stuff
}</pre>

==See also==

* [http://dev.moodle.org/course/view.php?id=2 Moodle Developers' Course]
* [[Development:Modules]]
* [[Development:Places to search for lang strings|Where to put language strings for your plugin]]
* [[Development:Installing and upgrading plugin database tables|Defining the database tables for your plugin]]

{{CategoryDeveloper}}
[[Category:Developer|Modules]]

IMS content package

2009-04-20T16:00:53Z

Davidbalch: /* IMS content package repository */ Added notes about deployment size and deploying IMSCPs from a repository.

{{Resources}}
{{Moodle 1.6}}

IMS is a body which helps define technical standards for various things, including e-learning material. The [http://www.imsglobal.org/content/packaging/ IMS Content Packaging specification] makes it possible to store chunks of material in a standard format which can be re-used in different systems, without having to convert the material into new formats.

The IMS content package in Moodle 1.6 enables such content packages to be uploaded and included in Moodle courses. There are various options for displaying content in a pop-up window, with a navigation menu or buttons etc. In addition, the resource type supports an optional repository, enabling content packages to be shared between courses.

==IMS content package repository==

The IMS content package repository enables access to a repository of IMS and SCORM packages within Moodle.

Using the repository will save disk space (and any corresponding backup resources if you copy the filesystem as part of your backup strategy) compared to uploading content packages directly into a course. The repository only needs an unzipped copy of the package, whereas within a course there will be the unzipped copy, plus two zipped copies just taking up space.

===Using the repository===

The repository is disabled by default. It may be enabled as follows:

# Find repository_config.php in ''moodle/mod/resource/type/ims'' and change <code>$CFG->repositoryactivate = false;</code> to <code>$CFG->repositoryactivate = true</code>
# Create a folder named ''ims_repository'' in the webroot or somewhere underneath your webroot.
# Change <code>$CFG->repository = "C:/public/www/html/ims_repository";</code> to point to this folder on your file system
# If your ims_repository is not located directly in your webroot, edit <code>$CFG->repositorywebroot = "/ims_repository";</code> to point to the location of your repository.

Content packages should be extracted to the folder ''ims_repository''.

To use a repository package in a course:
# Create/edit an IMS CP resource.
# Click the "Browse repository" button, opening a window listing the packages in ''ims_repository''. If you can't see your content package, check it's in the right directory and has been unzipped.
# Find your package in the list and click Deploy, and you get a chance to preview the resource. Close the window.
# Click the "Browse repository" button again, and then and Choose the package.
# Save your IMS CP resource.

==See also==

* [http://www.nln.ac.uk/?p=Moodle NLN Materials - Support: Using the NLN Materials in Moodle]

Using Moodle forum discussions:
* [http://moodle.org/mod/forum/discuss.php?d=31011 New resource type: IMS CP]
* [http://moodle.org/mod/forum/discuss.php?d=86101 What is an IMS package?]
* [http://moodle.org/mod/forum/discuss.php?d=48684 Trying to add NLN Materials via IMS CP]

[[Category:Administrator]]
[[Category:Resource]]

[[de:IMS-Paket]]
[[eu:Baliabidea:IMS]]
[[es:Recurso: IMS]]

Development:Filters schema

2007-05-04T08:37:21Z

Davidbalch:

The objective of this page is to document all the ideas and improvements to be implemented in the "Filters" functionality of Moodle.

Every idea will be documented here, including its associated "thoughts" and potential "implementations". Feel free to add/modify everything as you want!

These are the main areas to discuss/analyse/implement:

* [[Course/site filters | Enable/Disable Filters by Course and Site]]
* [[Course/site filter config | Optional Configuration of Filters by Course and Site]]
* [[Multilang filter | Changes in the Caching System to Support the Multilang Filter]]
* [[Enable/Disable Filters by Activities]]
* Allow filtering data before it will save in database? It will do possible exclude some data from text (like TeX formulas) and save in separate table. It will allow change formula by clicking on it and open popup window.
* It'd be great if you could set the text cache lifetime for individual filters. This would be handy for filters that use external resources (e.g., Wikipedia) that sometimes have slow response times. I'd guess that you could use a cache lifetime of a week or more for a Wikipedia filter without causing major usability problems.

==See also==

*[http://moodle.org/bugs/bug.php?op=show&bugid=2400 Bug 2400] - a lot of ideas and request have been written here
http://tracker.moodle.org/browse/MDL-9443 - add support for filtering XHTML resources as well as HTML.
[[Category:Developer]]

Development:Course/site filter config

2007-04-18T10:37:14Z

Davidbalch: Added config idea.

This topic is to define how to add the possibility of "configure" filters both at site and course level.

* The mp3player may be configured at site level to only start downloading when the play button is pressed.
* The filters could configured to apply to classes of files by MIME type and/or file extension.

[[Category:Developer]]