MoodleDocs - User contributions [en]

Custom certificate module

2019-12-16T19:47:15Z

Markn:

{{Infobox plugin
|type = Activity
|entry = https://moodle.org/plugins/mod_customcert
|tracker = https://github.com/mdjnelson/moodle-mod_customcert/issues
|discussion = https://moodle.org/mod/forum/view.php?id=7163
|maintainer = [[User:Mark Nelson|Mark Nelson]]
|float = right
}}
==Description==
The [https://moodle.org/plugins/mod_customcert custom certificate module] allows the generation of dynamic PDF certificates with complete customisation via the web browser. It is different from the [https://moodle.org/plugins/mod_certificate certificate module] which requires PHP and FTP access in order to customise its appearance.

==Installation==
There are two installation methods that are available.

Follow one of these, then log into your Moodle site as an administrator and visit the notifications page to complete the install.
===Git===

This requires Git being installed. If you do not have Git installed, please visit the Git website.

Once you have Git installed, simply visit your Moodle mod directory and clone the repository using the following command.

<code>git clone https://github.com/mdjnelson/moodle-mod_customcert.git customcert</code>

Then checkout the branch corresponding to the version of Moodle you are using with the following command. Make sure to replace MOODLE_32_STABLE with the version of Moodle you are using.

<code>git checkout MOODLE_32_STABLE</code><br />
Use <code>git pull</code> to update this repository periodically to ensure you have the most recent updates.
===Download the Zip===

Visit the Moodle plugins website and download the zip corresponding to the version of Moodle you are using. Extract the zip and place the 'customcert' folder in the mod folder in your Moodle directory.

==Site settings==

To visit the site settings log in as a user with appropriate permissions and visit 'Site administration' > 'Plugins' > 'Custom certificate'.

[[File:Custom_certificate_site_settings.png]]

===Show position X and Y===

This will show the X and Y position when editing of an element, allowing the user to accurately specify the location.

This isn't required if you plan on solely using the drag and drop interface for this purpose.

===Manage templates===

This link will take you to a new screen where you will be able to manage templates.

===Upload image===

This link will take you to a new screen where you will be able to upload images. Images uploaded using this method will be available throughout your site to all users who are able to create a custom certificate.

==Managing templates==
Templates allow a person with the appropriate permissions to create a site-wide template that can then be used by users when adding a certificate to a course, saving them from re-creating the same certificate over and over again. To create a template log in as a user who has the appropriate permissions and visit 'Site administration' > 'Plugins' > 'Custom certificate' and click on the link 'Manage templates'.

[[File:Custom_certificate_manage_templates.png]]

Here you will see a list of templates that have already been created. You can choose to edit these templates, delete them or create a new one. We will be creating a new template - start by clicking on 'Create template'.

[[File:Custom_certificate_edit_page.png]]

The name here is what will be displayed to the users when they are creating a certificate in a course and would like to choose a template to load. You can add elements to the template, customise them and rearrange their position. This process is discussed later when we talk about adding a custom certificate to a course and then customising it.

==Adding a custom certificate to a course==

The custom certificate plugin once installed can be added just like any other activity in Moodle. Visit a course, turn editing on and click to add an activity.

[[File:Custom_certificate_add_activity_page.png]]

===Certificate options===

====Allow anyone to verify a certificate====

Each certificate when issued is assigned a unique code. It is possible to have this code displayed on the certificate by adding it as an element. To validate a certificate a person (eg. employer) may want to enter the code displayed on the certificate to confirm that it is indeed authentic. To accomplish this a logged in user requires the capability 'mod/customcert:verifycertificate', however with this setting set to 'Yes' any person with the verification link (including users not logged in) can do this.

====Email students/teachers/others====

These settings enable the emailing of a certificate when a user is able to view it. The certificate may be hidden due to [[https://docs.moodle.org/en/Restrict_access access restrictions]], such as requiring the completion of another activity. A [[https://docs.moodle.org/en/Scheduled_tasks scheduled task]] runs that processes all the certificates that have any of these settings enabled and collects all the users to email that have not been emailed yet and are able to view the certificate and emails them the PDF.

====Required minutes in course====

This is the number of minutes a user is required to be in a course before they are able to view a certificate. This uses the logs in Moodle and hence can not guarantee the result to be 100% accurate.

====Set protection====

This determines what protection we want to set on the PDF.

===Editing a custom certificate===

Once you have added a certificate to your course you can then choose to edit the appearance of it. To do this view the certificate to be taken to the following page.

[[File:Custom_certificate_edit_menu.png]]

Here you can click on the cog on the top right and select 'Edit custom certificate'.

[[File:Custom_certificate_edit_page_with_items.png]]

On the edit page you can see a list of the elements that have already been added to the certificate. You can edit, delete and move these elements. The order of these elements determine when they are rendered on the PDF. So, if you were to add a background image you would want this rendered first.

You can also choose to load a template on this page. If you also have the permissions to manage templates you will also be shown the link to the manage templates page.

===Adding/editing an element===

[[File:Custom_certificate_element_list.png]]

The above is the list of items that come with this plugin. These are [[https://docs.moodle.org/dev/Subplugins sub-plugins]] and are fully customisable allowing the community to generate plugins and share them without having to hack the plugin code.

When editing a custom certificate you can choose to add an element which will take you to the page to edit them.

[[File:Custom_certificate_edit_element.png]]

Each element defines what characteristics you can edit. In the above example we are editing the 'Student name' element. The site setting 'Show position X and Y' has been enabled which is why 'Position X' and 'Position Y' are shown.

===Repositioning elements===

When editing a custom certificate under the list of elements there is a link 'Reposition elements' that will take you to a page where you can drag and drop the elements. While on this page you can also click on the elements to bring up a dialogue that will allow you to edit its properties without having to go back to the edit custom certificate page.

[[File:Custom_certificate_reposition_elements.png]]

==Viewing issued certificates==

To view issued certificates a user with the appropriate permissions can simply click on the certificate and click on the link 'View X issued custom certificates'.

[[File:Custom_certificate_view_issued_certificates.png]]

Once you click on the link you can view the users who have been issued this certificate and also download their version of the certificate.

[[File:Custom_certificate_view_issued_certificates_list.png]]

==Verifying certificates==

Each certificate when issued is assigned a unique code. To validate a certificate a person (eg. employer) may want to enter the code displayed on the certificate to confirm that it is indeed authentic. With the setting 'Allow anyone to verify a certificate' enabled any person with the verification link (including users not logged in) can verify a certificate, however if it is not set, a user with the appropriate permissions ('mod/customcert:verifycertificate') can do this by clicking on the certificate to gain access to the link.

[[File:Custom_certificate_edit_menu.png]]

Here you can click on the cog on the top right and select 'Verify certificate'.

[[File:Custom_certificate_verify_certificate_page.png]]

Here you can enter the code to verify its authenticity.

==My certificates==

It is possible that a user may be in several courses each with their own custom certificate activity. It would be time consuming for the user to visit every course to review their certificate. In order to avoid this there is a page where the user can view all the certificates they have received.

[[File:Custom_certificate_profile_page.png]]

On the user's profile page under 'Miscellaneous' the user can click on 'My certificates' which will take them to a page listing all their certificates with the option of downloading them.

[[File:Custom_certificate_my_certificates_page.png]]

==Helpful links==
See [https://moodle.org/plugins/mod_customcert the plugin page], the [https://github.com/mdjnelson/moodle-mod_customcert/issues tracker page] and the [https://moodle.org/mod/forum/view.php?id=7163 Moodle forum].

[[Add_fonts_for_embedding]] - see this page for details of adding more fonts for use in TCPDF

==Did you find this plugin useful?==
Click on the 'Add to my favourites' link in [https://moodle.org/plugins/mod_customcert the plugin page].

Custom certificate module

2019-12-16T19:46:35Z

Markn:

{{Infobox plugin
|type = Activity
|entry = https://moodle.org/plugins/mod_customcert
|tracker = https://github.com/mdjnelson/moodle-mod_customcert/issues
|discussion = https://moodle.org/mod/forum/view.php?id=7163
|maintainer = [[User:Mark Nelson|Mark Nelson]]
|float = right
}}
==Description==
The [https://moodle.org/plugins/mod_customcert custom certificate module] allows the generation of dynamic PDF certificates with complete customisation via the web browser. It is different from the [https://moodle.org/plugins/mod_certificate certificate module] which requires PHP and FTP access in order to customise its appearance.

==Installation==
There are two installation methods that are available.

Follow one of these, then log into your Moodle site as an administrator and visit the notifications page to complete the install.
===Git===

This requires Git being installed. If you do not have Git installed, please visit the Git website.

Once you have Git installed, simply visit your Moodle mod directory and clone the repository using the following command.

<code>git clone https://github.com/markn86/moodle-mod_customcert.git customcert</code>

Then checkout the branch corresponding to the version of Moodle you are using with the following command. Make sure to replace MOODLE_32_STABLE with the version of Moodle you are using.

<code>git checkout MOODLE_32_STABLE</code><br />
Use <code>git pull</code> to update this repository periodically to ensure you have the most recent updates.
===Download the Zip===

Visit the Moodle plugins website and download the zip corresponding to the version of Moodle you are using. Extract the zip and place the 'customcert' folder in the mod folder in your Moodle directory.

==Site settings==

To visit the site settings log in as a user with appropriate permissions and visit 'Site administration' > 'Plugins' > 'Custom certificate'.

[[File:Custom_certificate_site_settings.png]]

===Show position X and Y===

This will show the X and Y position when editing of an element, allowing the user to accurately specify the location.

This isn't required if you plan on solely using the drag and drop interface for this purpose.

===Manage templates===

This link will take you to a new screen where you will be able to manage templates.

===Upload image===

This link will take you to a new screen where you will be able to upload images. Images uploaded using this method will be available throughout your site to all users who are able to create a custom certificate.

==Managing templates==
Templates allow a person with the appropriate permissions to create a site-wide template that can then be used by users when adding a certificate to a course, saving them from re-creating the same certificate over and over again. To create a template log in as a user who has the appropriate permissions and visit 'Site administration' > 'Plugins' > 'Custom certificate' and click on the link 'Manage templates'.

[[File:Custom_certificate_manage_templates.png]]

Here you will see a list of templates that have already been created. You can choose to edit these templates, delete them or create a new one. We will be creating a new template - start by clicking on 'Create template'.

[[File:Custom_certificate_edit_page.png]]

The name here is what will be displayed to the users when they are creating a certificate in a course and would like to choose a template to load. You can add elements to the template, customise them and rearrange their position. This process is discussed later when we talk about adding a custom certificate to a course and then customising it.

==Adding a custom certificate to a course==

The custom certificate plugin once installed can be added just like any other activity in Moodle. Visit a course, turn editing on and click to add an activity.

[[File:Custom_certificate_add_activity_page.png]]

===Certificate options===

====Allow anyone to verify a certificate====

Each certificate when issued is assigned a unique code. It is possible to have this code displayed on the certificate by adding it as an element. To validate a certificate a person (eg. employer) may want to enter the code displayed on the certificate to confirm that it is indeed authentic. To accomplish this a logged in user requires the capability 'mod/customcert:verifycertificate', however with this setting set to 'Yes' any person with the verification link (including users not logged in) can do this.

====Email students/teachers/others====

These settings enable the emailing of a certificate when a user is able to view it. The certificate may be hidden due to [[https://docs.moodle.org/en/Restrict_access access restrictions]], such as requiring the completion of another activity. A [[https://docs.moodle.org/en/Scheduled_tasks scheduled task]] runs that processes all the certificates that have any of these settings enabled and collects all the users to email that have not been emailed yet and are able to view the certificate and emails them the PDF.

====Required minutes in course====

This is the number of minutes a user is required to be in a course before they are able to view a certificate. This uses the logs in Moodle and hence can not guarantee the result to be 100% accurate.

====Set protection====

This determines what protection we want to set on the PDF.

===Editing a custom certificate===

Once you have added a certificate to your course you can then choose to edit the appearance of it. To do this view the certificate to be taken to the following page.

[[File:Custom_certificate_edit_menu.png]]

Here you can click on the cog on the top right and select 'Edit custom certificate'.

[[File:Custom_certificate_edit_page_with_items.png]]

On the edit page you can see a list of the elements that have already been added to the certificate. You can edit, delete and move these elements. The order of these elements determine when they are rendered on the PDF. So, if you were to add a background image you would want this rendered first.

You can also choose to load a template on this page. If you also have the permissions to manage templates you will also be shown the link to the manage templates page.

===Adding/editing an element===

[[File:Custom_certificate_element_list.png]]

The above is the list of items that come with this plugin. These are [[https://docs.moodle.org/dev/Subplugins sub-plugins]] and are fully customisable allowing the community to generate plugins and share them without having to hack the plugin code.

When editing a custom certificate you can choose to add an element which will take you to the page to edit them.

[[File:Custom_certificate_edit_element.png]]

Each element defines what characteristics you can edit. In the above example we are editing the 'Student name' element. The site setting 'Show position X and Y' has been enabled which is why 'Position X' and 'Position Y' are shown.

===Repositioning elements===

When editing a custom certificate under the list of elements there is a link 'Reposition elements' that will take you to a page where you can drag and drop the elements. While on this page you can also click on the elements to bring up a dialogue that will allow you to edit its properties without having to go back to the edit custom certificate page.

[[File:Custom_certificate_reposition_elements.png]]

==Viewing issued certificates==

To view issued certificates a user with the appropriate permissions can simply click on the certificate and click on the link 'View X issued custom certificates'.

[[File:Custom_certificate_view_issued_certificates.png]]

Once you click on the link you can view the users who have been issued this certificate and also download their version of the certificate.

[[File:Custom_certificate_view_issued_certificates_list.png]]

==Verifying certificates==

Each certificate when issued is assigned a unique code. To validate a certificate a person (eg. employer) may want to enter the code displayed on the certificate to confirm that it is indeed authentic. With the setting 'Allow anyone to verify a certificate' enabled any person with the verification link (including users not logged in) can verify a certificate, however if it is not set, a user with the appropriate permissions ('mod/customcert:verifycertificate') can do this by clicking on the certificate to gain access to the link.

[[File:Custom_certificate_edit_menu.png]]

Here you can click on the cog on the top right and select 'Verify certificate'.

[[File:Custom_certificate_verify_certificate_page.png]]

Here you can enter the code to verify its authenticity.

==My certificates==

It is possible that a user may be in several courses each with their own custom certificate activity. It would be time consuming for the user to visit every course to review their certificate. In order to avoid this there is a page where the user can view all the certificates they have received.

[[File:Custom_certificate_profile_page.png]]

On the user's profile page under 'Miscellaneous' the user can click on 'My certificates' which will take them to a page listing all their certificates with the option of downloading them.

[[File:Custom_certificate_my_certificates_page.png]]

==Helpful links==
See [https://moodle.org/plugins/mod_customcert the plugin page], the [https://github.com/markn86/moodle-mod_customcert/issues tracker page] and the [https://moodle.org/mod/forum/view.php?id=7163 Moodle forum].

[[Add_fonts_for_embedding]] - see this page for details of adding more fonts for use in TCPDF

==Did you find this plugin useful?==
Click on the 'Add to my favourites' link in [https://moodle.org/plugins/mod_customcert the plugin page].

Add fonts for embedding

2018-07-12T03:35:04Z

Markn:

{{Certificate}}
Additional fonts can be included in Moodle and used by the Certificate and Custom certificate module, embedding them in the PDF.

== Before adding custom TCPDF fonts ==

The default location for fonts that are included with TCPDF is lib/tcpdf/fonts/. If PDF_CUSTOM_FONT_PATH exists, this directory will be used instead of lib/tcpdf/fonts/, the default location is $CFG->dataroot.'/fonts/'.

If you are adding custom fonts you need to copy all fonts from lib/tcpdf/fonts/ to your PDF_CUSTOM_FONT_PATH and then add the extra fonts. Alternatively you may download all TCPDF fonts from http://www.tcpdf.org/download.php and extract them to PDF_CUSTOM_FONT_PATH directory.

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).

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

== Using a new font ==

This sections applies to the old mod_certificate plugin, in the mod_customcert plugin the fonts will automatically be listed in the select drop-down.

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]]

[[es:Añadir fonts para incrustar]]

Add fonts for embedding

2018-07-12T03:34:35Z

Markn:

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

== Before adding custom TCPDF fonts ==

The default location for fonts that are included with TCPDF is lib/tcpdf/fonts/. If PDF_CUSTOM_FONT_PATH exists, this directory will be used instead of lib/tcpdf/fonts/, the default location is $CFG->dataroot.'/fonts/'.

If you are adding custom fonts you need to copy all fonts from lib/tcpdf/fonts/ to your PDF_CUSTOM_FONT_PATH and then add the extra fonts. Alternatively you may download all TCPDF fonts from http://www.tcpdf.org/download.php and extract them to PDF_CUSTOM_FONT_PATH directory.

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).

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

== Using a new font ==

This sections applies to the old mod_certificate plugin, in the mod_customcert plugin the fonts will automatically be listed in the select drop-down.

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]]

[[es:Añadir fonts para incrustar]]

Add fonts for embedding

2018-07-12T03:09:48Z

Markn:

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

== Add all TCPDF fonts ==

The default location for fonts that are included with TCPDF is lib/tcpdf/fonts/. If PDF_CUSTOM_FONT_PATH exists, this directory will be used instead of lib/tcpdf/fonts/, the default location is $CFG->dataroot.'/fonts/'.

If you are adding custom fonts you need to copy all fonts from lib/tcpdf/fonts/ to your PDF_CUSTOM_FONT_PATH and then add the extra fonts. Alternatively you may download all TCPDF fonts from http://www.tcpdf.org/download.php and extract them to PDF_CUSTOM_FONT_PATH directory.

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).

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

== Using a new font ==

This sections applies to the old mod_certificate plugin, in the mod_customcert plugin the fonts will automatically be listed in the select drop-down.

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]]

[[es:Añadir fonts para incrustar]]

Add fonts for embedding

2018-07-12T03:07:09Z

Markn: /* Add all TCPDF fonts */

{{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 ==

The default location for fonts that are included with TCPDF is lib/tcpdf/fonts/. If PDF_CUSTOM_FONT_PATH exists, this directory will be used instead of lib/tcpdf/fonts/, the default location is $CFG->dataroot.'/fonts/'.

You should always copy all fonts from lib/tcpdf/fonts/ to your PDF_CUSTOM_FONT_PATH and then add extra fonts. Alternatively you may download all TCPDF fonts from http://www.tcpdf.org/download.php and extract them to PDF_CUSTOM_FONT_PATH directory.

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]]

[[es:Añadir fonts para incrustar]]

Upgrading

2017-11-13T06:09:47Z

Markn: /* Possible issues that may affect you in Moodle {{Version}} */

{{Installing Moodle}}
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''

==Check the requirements==

Check that your server meets all requirements for {{Version}} in ''Administration > Site administration > Server > [[Environment]]''.

See the [{{Release notes}} release notes] in the dev docs for software requirements.

Notes:

* You can only upgrade to Moodle {{Version}} from Moodle 3.0 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/30/en/Upgrading_to_Moodle_3.0 upgrade to 3.0] as a first step.
* The minimum PHP version has increased and is now 7.0.0.
* The PHP extension '''intl''' is now required in Moodle 3.4 (previously it was only recommended).

==Before upgrading==

'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''

Consider setting the [[Upgrade key|upgrade key]] for your site.

== Backup important data ==

There are three areas that should be backed up before any upgrade:
#Moodle software (For example, everything in server/htdocs/moodle)
#Moodle uploaded files (For example, server/moodledata)
#Moodle database (For example, your Postgres or MySQL database dump)

See [[Site backup]] for more specific information.

== Check for plugin updates ==

If you have [[Automatic updates deployment]] enabled, you will be able to update installed plugins automatically during the upgrade. Just make sure you check for available updates (via the button for it) at the Plugins check screen.

If you are updating plugins manually, it is a good moment now to check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a {{Version}} version available for any plugins (including themes) that you have previously installed on your site. If so, download the plugin package. In the next step, you will copy it to the appropriate location in your Moodle code (see [[Installing plugins]]).

The upgrade of the plugin will then happen as part of the Moodle upgrade process.

If an out-of-date plugin causes your upgrade to fail, you can usually delete the plugin code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.

==Put your site into maintenance mode==
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in. Then you should wait for any currently running cron processes to complete before proceeding.

== Install the new Moodle software ==
You can fetch the current version of the software through

wget http://sourceforge.net/projects/moodle/files/Moodle/stable{{Version2}}/moodle-latest-{{Version2}}.tgz

=== Standard install package ===

# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
# Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
# As mentioned above, if you had installed any plugins on your site you should add them to the new code tree (Moodle directory structure) now. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle and that you place the plugin folders in the correct directory (the same directory that they are in in the current installation.)
# Your moodledata folder should be located separately to your Moodle code folder and, as such, should not need anything done to it. Moodle 3.0 will throw a warning if it is located in a web accessible folder and the moodledata should never be located in the Moodle code folder. If you are moving your installation to a new server or new location on your server, then you will need to follow the Migration documents.

====Linux====
mv moodle moodle.backup
tar xvzf moodle-{{Version}}.tgz

Next, copy across your config.php, any custom plugins, and your .htaccess file if you created one ('''check that custom plugins are the correct version for your new Moodle first'''):

cp moodle.backup/config.php moodle
cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme
cp -pr moodle.backup/mod/mymod moodle/mod/mymod

Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. Ideally the files should not be writeable by your server.

chown -R www-data:www-data moodle (Linux debian - change to appropriate user and group for your OS version)
chmod -R 755 moodle

If you use cron, take care that cron.php is executeable and uses the correct php command:
chmod 740 admin/cli/cron.php (some configurations need chmod 750 or chmod 755)
copy the first line from cron.php (if it looks like '#!/usr/local/bin/php' or '#!/usr/local/bin/php5.3', no need to copy '<?php')
if necessary. However, for a simple upgrade, there should be no need to change anything with cron.

=== Using Git ===

You can use Git for updating or upgrading your Moodle. See [[Git for Administrators]] for details.

===Command line upgrade===

On Linux servers, Moodle {{Version}} supports running the [[CLI|upgrade from the command line]], rather than through a web browser. This is likely to be more reliable, particularly for large sites.

== Finishing the upgrade ==

The last step is to trigger the upgrade processes within Moodle.

If you put your site into Maintenance mode earlier; take it out now!

To do this just go to ''Administration > Site administration > Notifications''.

Moodle will automatically detect the new version and perform all the SQL database or file system upgrades that are necessary. If there is anything it can't do itself (very rare) then you will see messages telling you what you need to do.

Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!

Note: If you are running multiple servers then you should purge all caches manually (via ''Administration > Site administration > Development > Purge all caches'') after completing the upgrade on all servers.

===Fatal error: Maximum execution time of 30 seconds exceeded...===

If your server uses a main language other than English, you may encounter a 'Fatal error: Maximum execution time of 30 seconds exceeded' when you try to upgrade it. You can increase max_execution_time = 160 on php.ini to allow the scripts enough time to process the language update. Otherwise, you can switch to English as the default language before doing the upgrade and back to your original language after a succcessful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598.

==After upgrading==

The config.php file from your installation should work fine but if you take a look at config-dist.php that came with Moodle 3.0 there are more/different options available (e.g. database drivers and settings). It's a good idea to map your old config.php settings to a new one based on the 3.0 config-dist.php.

===Cron===

Cron has received a major update (MDL-25499) and now has support for both scheduled and ad hoc tasks.

The benefits of these changes are:
* The schedule for every task can be configured by the admin
* Tasks can run in parallel
* Cron processes use locking to prevent the same task running at the same time by different processes
* Clusters with multiple identical application nodes are supported, you can run cron on all of them

A result of this is that cron can be run much more often, which means (for example) forum posts can be sent out sooner. To take advantage of the new cron system it is now strongly recommended that administrators increase the frequency that cron is run to at least ''once per minute''.

You also may need to modify any automated scripts you have that are parsing the output from cron. It is no longer possible to simply monitor the output of cron for the string "Cron script completed correctly" (if that is what you were doing). An alternative is to monitor the output for the string "task failed:". If you detect that a task is failing, [[Cron#Debugging_Scheduled_Tasks|here]] are some tips for debugging the failure.

Before the upgrade, there may have been a cron task that was failing, which was preventing the rest of cron from being executed. A failure in any single task will no longer prevent the rest of the Moodle cron tasks from executing, so you may uncover previously masked bugs. It is a good idea to closely monitor the output from cron after the upgrade.

===Assignments===

The old assignment (2.2) module has been removed from core and has been replaced by a stub to support transparently remapping URLs and restoring course backups from the old module to the new one.

If you are still using the old assignment (2.2) module, after upgrading to Moodle 3.0 all assignment (2.2) activities will be hidden. You need to run the [[Assignment upgrade tool]] to un-hide the activities.

If you really, really need to keep using the old assignment (2.2) module, you should update the code to Moodle 3.0, and then replace the "mod/assignment" folder with the one from https://github.com/moodlehq/moodle-mod_assignment/releases before completing the upgrade.

==Possible issues that may affect you in Moodle {{Version}}==

* Setting "Use HTTPS for logins" ('loginhttps') was completely removed since it provided false sense of security. If it was enabled before upgrade the whole site will be served via HTTPS protocol. [[HTTPS conversion tool]] is available for administrator to convert links to embedded contents from http to https.
* Minimum supported PHP version was raised to 7.0. You cannot run your Moodle 3.4 site on PHP 5.6 or lower (please refer to [https://docs.moodle.org/dev/Moodle_3.4_release_notes#Server_requirements requirements section] for details).
* The following authentication plugins were removed from core and can be found at the following URLs. If you use them, you must provide them manually during the upgrade (MDL-50925).
** FirstClass (auth_fc) - https://github.com/moodlehq/moodle-auth_fc
** IMAP Mail server (auth_imap) - https://github.com/moodlehq/moodle-auth_imap
** Network News Transfer Protocol (auth_nntp) - https://github.com/moodlehq/moodle-auth_nntp
** Pluggable Authentication Modules (auth_pam) - https://github.com/moodlehq/moodle-auth_pam
** POP3 Mail server (auth_pop3) - https://github.com/moodlehq/moodle-auth_pop3.
* The Messages block has been removed from the standard distribution. The new messages notification is displayed on the top of every page and this block is no longer needed. Block can be [https://github.com/moodlehq/moodle-block_messages manually downloaded] if needed
* Support for custom registration hubs has been completely removed. Registration and course publishing is possible only with https://moodle.net
* Course restore and import operations now will never change user dates and log dates. Only activity dates (due, open/close, etc.) will now change respective of the new course start date.

See the [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]] for the full list of changes in Moodle {{Version}}.

=== Moodle 3.1, 3.2 and 3.3 improvements ===

Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation

* [https://docs.moodle.org/31/en/Upgrading Upgrading to Moodle 3.1]
* [https://docs.moodle.org/32/en/Upgrading Upgrading to Moodle 3.2]
* [https://docs.moodle.org/33/en/Upgrading Upgrading to Moodle 3.3]

==See also==

* [[Installation]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation help forum]
* [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]]

[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[ja:Moodleをアップグレードする]]
[[de:Aktualisierung von Moodle]]

Upgrading

2017-11-13T06:00:36Z

Markn: /* Possible issues that may affect you in Moodle {{Version}} */

{{Installing Moodle}}
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''

==Check the requirements==

Check that your server meets all requirements for {{Version}} in ''Administration > Site administration > Server > [[Environment]]''.

See the [{{Release notes}} release notes] in the dev docs for software requirements.

Notes:

* You can only upgrade to Moodle {{Version}} from Moodle 3.0 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/30/en/Upgrading_to_Moodle_3.0 upgrade to 3.0] as a first step.
* The minimum PHP version has increased and is now 7.0.0.
* The PHP extension '''intl''' is now required in Moodle 3.4 (previously it was only recommended).

==Before upgrading==

'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''

Consider setting the [[Upgrade key|upgrade key]] for your site.

== Backup important data ==

There are three areas that should be backed up before any upgrade:
#Moodle software (For example, everything in server/htdocs/moodle)
#Moodle uploaded files (For example, server/moodledata)
#Moodle database (For example, your Postgres or MySQL database dump)

See [[Site backup]] for more specific information.

== Check for plugin updates ==

If you have [[Automatic updates deployment]] enabled, you will be able to update installed plugins automatically during the upgrade. Just make sure you check for available updates (via the button for it) at the Plugins check screen.

If you are updating plugins manually, it is a good moment now to check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a {{Version}} version available for any plugins (including themes) that you have previously installed on your site. If so, download the plugin package. In the next step, you will copy it to the appropriate location in your Moodle code (see [[Installing plugins]]).

The upgrade of the plugin will then happen as part of the Moodle upgrade process.

If an out-of-date plugin causes your upgrade to fail, you can usually delete the plugin code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.

==Put your site into maintenance mode==
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in. Then you should wait for any currently running cron processes to complete before proceeding.

== Install the new Moodle software ==
You can fetch the current version of the software through

wget http://sourceforge.net/projects/moodle/files/Moodle/stable{{Version2}}/moodle-latest-{{Version2}}.tgz

=== Standard install package ===

# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
# Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
# As mentioned above, if you had installed any plugins on your site you should add them to the new code tree (Moodle directory structure) now. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle and that you place the plugin folders in the correct directory (the same directory that they are in in the current installation.)
# Your moodledata folder should be located separately to your Moodle code folder and, as such, should not need anything done to it. Moodle 3.0 will throw a warning if it is located in a web accessible folder and the moodledata should never be located in the Moodle code folder. If you are moving your installation to a new server or new location on your server, then you will need to follow the Migration documents.

====Linux====
mv moodle moodle.backup
tar xvzf moodle-{{Version}}.tgz

Next, copy across your config.php, any custom plugins, and your .htaccess file if you created one ('''check that custom plugins are the correct version for your new Moodle first'''):

cp moodle.backup/config.php moodle
cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme
cp -pr moodle.backup/mod/mymod moodle/mod/mymod

Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. Ideally the files should not be writeable by your server.

chown -R www-data:www-data moodle (Linux debian - change to appropriate user and group for your OS version)
chmod -R 755 moodle

If you use cron, take care that cron.php is executeable and uses the correct php command:
chmod 740 admin/cli/cron.php (some configurations need chmod 750 or chmod 755)
copy the first line from cron.php (if it looks like '#!/usr/local/bin/php' or '#!/usr/local/bin/php5.3', no need to copy '<?php')
if necessary. However, for a simple upgrade, there should be no need to change anything with cron.

=== Using Git ===

You can use Git for updating or upgrading your Moodle. See [[Git for Administrators]] for details.

===Command line upgrade===

On Linux servers, Moodle {{Version}} supports running the [[CLI|upgrade from the command line]], rather than through a web browser. This is likely to be more reliable, particularly for large sites.

== Finishing the upgrade ==

The last step is to trigger the upgrade processes within Moodle.

If you put your site into Maintenance mode earlier; take it out now!

To do this just go to ''Administration > Site administration > Notifications''.

Moodle will automatically detect the new version and perform all the SQL database or file system upgrades that are necessary. If there is anything it can't do itself (very rare) then you will see messages telling you what you need to do.

Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!

Note: If you are running multiple servers then you should purge all caches manually (via ''Administration > Site administration > Development > Purge all caches'') after completing the upgrade on all servers.

===Fatal error: Maximum execution time of 30 seconds exceeded...===

If your server uses a main language other than English, you may encounter a 'Fatal error: Maximum execution time of 30 seconds exceeded' when you try to upgrade it. You can increase max_execution_time = 160 on php.ini to allow the scripts enough time to process the language update. Otherwise, you can switch to English as the default language before doing the upgrade and back to your original language after a succcessful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598.

==After upgrading==

The config.php file from your installation should work fine but if you take a look at config-dist.php that came with Moodle 3.0 there are more/different options available (e.g. database drivers and settings). It's a good idea to map your old config.php settings to a new one based on the 3.0 config-dist.php.

===Cron===

Cron has received a major update (MDL-25499) and now has support for both scheduled and ad hoc tasks.

The benefits of these changes are:
* The schedule for every task can be configured by the admin
* Tasks can run in parallel
* Cron processes use locking to prevent the same task running at the same time by different processes
* Clusters with multiple identical application nodes are supported, you can run cron on all of them

A result of this is that cron can be run much more often, which means (for example) forum posts can be sent out sooner. To take advantage of the new cron system it is now strongly recommended that administrators increase the frequency that cron is run to at least ''once per minute''.

You also may need to modify any automated scripts you have that are parsing the output from cron. It is no longer possible to simply monitor the output of cron for the string "Cron script completed correctly" (if that is what you were doing). An alternative is to monitor the output for the string "task failed:". If you detect that a task is failing, [[Cron#Debugging_Scheduled_Tasks|here]] are some tips for debugging the failure.

Before the upgrade, there may have been a cron task that was failing, which was preventing the rest of cron from being executed. A failure in any single task will no longer prevent the rest of the Moodle cron tasks from executing, so you may uncover previously masked bugs. It is a good idea to closely monitor the output from cron after the upgrade.

===Assignments===

The old assignment (2.2) module has been removed from core and has been replaced by a stub to support transparently remapping URLs and restoring course backups from the old module to the new one.

If you are still using the old assignment (2.2) module, after upgrading to Moodle 3.0 all assignment (2.2) activities will be hidden. You need to run the [[Assignment upgrade tool]] to un-hide the activities.

If you really, really need to keep using the old assignment (2.2) module, you should update the code to Moodle 3.0, and then replace the "mod/assignment" folder with the one from https://github.com/moodlehq/moodle-mod_assignment/releases before completing the upgrade.

==Possible issues that may affect you in Moodle {{Version}}==

* Setting "Use HTTPS for logins" ('loginhttps') was completely removed since it provided false sense of security. If it was enabled before upgrade the whole site will be served via HTTPS protocol. [[HTTPS conversion tool]] is available for administrator to convert links to embedded contents from http to https.
* Minimum supported PHP version was raised to 7.0. You cannot run your Moodle 3.4 site on PHP 5.6 or lower (please refer to [https://docs.moodle.org/dev/Moodle_3.4_release_notes#Server_requirements requirements section] for details).
* Some authentication methods were removed from the standard distribution (fc, imap, nntp, pam, pop3). If you use them, you must provide them manually during the upgrade (MDL-50925).
* The Messages block has been removed from the standard distribution. The new messages notification is displayed on the top of every page and this block is no longer needed. Block can be [https://github.com/moodlehq/moodle-block_messages manually downloaded] if needed
* Support for custom registration hubs has been completely removed. Registration and course publishing is possible only with https://moodle.net
* Course restore and import operations now will never change user dates and log dates. Only activity dates (due, open/close, etc.) will now change respective of the new course start date.
* The following authentication plugins were removed from core and can be found at the following URLs -
** FirstClass (auth_fc) - https://github.com/moodlehq/moodle-auth_fc
** IMAP Mail server (auth_imap) - https://github.com/moodlehq/moodle-auth_imap
** Network News Transfer Protocol (auth_nntp) - https://github.com/moodlehq/moodle-auth_nntp
** Pluggable Authentication Modules (auth_pam) - https://github.com/moodlehq/moodle-auth_pam
** POP3 Mail server (auth_pop3) - https://github.com/moodlehq/moodle-auth_pop3

See the [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]] for the full list of changes in Moodle {{Version}}.

=== Moodle 3.1, 3.2 and 3.3 improvements ===

Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation

* [https://docs.moodle.org/31/en/Upgrading Upgrading to Moodle 3.1]
* [https://docs.moodle.org/32/en/Upgrading Upgrading to Moodle 3.2]
* [https://docs.moodle.org/33/en/Upgrading Upgrading to Moodle 3.3]

==See also==

* [[Installation]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation help forum]
* [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]]

[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[ja:Moodleをアップグレードする]]
[[de:Aktualisierung von Moodle]]

File:Custom certificate edit page with items.png

2017-08-08T04:30:41Z

Markn: Markn uploaded a new version of File:Custom certificate edit page with items.png

File:Custom certificate edit page.png

2017-08-08T04:30:34Z

Markn: Markn uploaded a new version of File:Custom certificate edit page.png

File:Custom certificate edit page.png

2017-08-08T04:22:48Z

Markn: Markn uploaded a new version of File:Custom certificate edit page.png

Custom certificate module

2017-05-30T02:51:35Z

Markn: /* Helpful links */

{{Infobox plugin
|type = Activity
|entry = https://moodle.org/plugins/mod_customcert
|tracker = https://github.com/markn86/moodle-mod_customcert/issues
|discussion = https://moodle.org/mod/forum/view.php?id=7163
|maintainer = [[User:Mark Nelson|Mark Nelson]]
|float = right
}}
==Description==
The [https://moodle.org/plugins/mod_customcert custom certificate module] allows the generation of dynamic PDF certificates with complete customisation via the web browser. It is different from the [https://moodle.org/plugins/mod_certificate certificate module] which requires PHP and FTP access in order to customise its appearance.

==Installation==
There are two installation methods that are available.

Follow one of these, then log into your Moodle site as an administrator and visit the notifications page to complete the install.
===Git===

This requires Git being installed. If you do not have Git installed, please visit the Git website.

Once you have Git installed, simply visit your Moodle mod directory and clone the repository using the following command.

<code>git clone https://github.com/markn86/moodle-mod_customcert.git customcert</code>

Then checkout the branch corresponding to the version of Moodle you are using with the following command. Make sure to replace MOODLE_32_STABLE with the version of Moodle you are using.

<code>git checkout MOODLE_32_STABLE</code><br />
Use <code>git pull</code> to update this repository periodically to ensure you have the most recent updates.
===Download the Zip===

Visit the Moodle plugins website and download the zip corresponding to the version of Moodle you are using. Extract the zip and place the 'customcert' folder in the mod folder in your Moodle directory.

==Site settings==

To visit the site settings log in as a user with appropriate permissions and visit 'Site administration' > 'Plugins' > 'Custom certificate'.

[[File:Custom_certificate_site_settings.png]]

===Show position X and Y===

This will show the X and Y position when editing of an element, allowing the user to accurately specify the location.

This isn't required if you plan on solely using the drag and drop interface for this purpose.

===Manage templates===

This link will take you to a new screen where you will be able to manage templates.

===Upload image===

This link will take you to a new screen where you will be able to upload images. Images uploaded using this method will be available throughout your site to all users who are able to create a custom certificate.

==Managing templates==
Templates allow a person with the appropriate permissions to create a site-wide template that can then be used by users when adding a certificate to a course, saving them from re-creating the same certificate over and over again. To create a template log in as a user who has the appropriate permissions and visit 'Site administration' > 'Plugins' > 'Custom certificate' and click on the link 'Manage templates'.

[[File:Custom_certificate_manage_templates.png]]

Here you will see a list of templates that have already been created. You can choose to edit these templates, delete them or create a new one. We will be creating a new template - start by clicking on 'Create template'.

[[File:Custom_certificate_edit_page.png]]

The name here is what will be displayed to the users when they are creating a certificate in a course and would like to choose a template to load. You can add elements to the template, customise them and rearrange their position. This process is discussed later when we talk about adding a custom certificate to a course and then customising it.

==Adding a custom certificate to a course==

The custom certificate plugin once installed can be added just like any other activity in Moodle. Visit a course, turn editing on and click to add an activity.

[[File:Custom_certificate_add_activity_page.png]]

===Certificate options===

====Allow anyone to verify a certificate====

Each certificate when issued is assigned a unique code. It is possible to have this code displayed on the certificate by adding it as an element. To validate a certificate a person (eg. employer) may want to enter the code displayed on the certificate to confirm that it is indeed authentic. To accomplish this a logged in user requires the capability 'mod/customcert:verifycertificate', however with this setting set to 'Yes' any person with the verification link (including users not logged in) can do this.

====Email students/teachers/others====

These settings enable the emailing of a certificate when a user is able to view it. The certificate may be hidden due to [[https://docs.moodle.org/en/Restrict_access access restrictions]], such as requiring the completion of another activity. A [[https://docs.moodle.org/en/Scheduled_tasks scheduled task]] runs that processes all the certificates that have any of these settings enabled and collects all the users to email that have not been emailed yet and are able to view the certificate and emails them the PDF.

====Required minutes in course====

This is the number of minutes a user is required to be in a course before they are able to view a certificate. This uses the logs in Moodle and hence can not guarantee the result to be 100% accurate.

====Set protection====

This determines what protection we want to set on the PDF.

===Editing a custom certificate===

Once you have added a certificate to your course you can then choose to edit the appearance of it. To do this view the certificate to be taken to the following page.

[[File:Custom_certificate_edit_menu.png]]

Here you can click on the cog on the top right and select 'Edit custom certificate'.

[[File:Custom_certificate_edit_page_with_items.png]]

On the edit page you can see a list of the elements that have already been added to the certificate. You can edit, delete and move these elements. The order of these elements determine when they are rendered on the PDF. So, if you were to add a background image you would want this rendered first.

You can also choose to load a template on this page. If you also have the permissions to manage templates you will also be shown the link to the manage templates page.

===Adding/editing an element===

[[File:Custom_certificate_element_list.png]]

The above is the list of items that come with this plugin. These are [[https://docs.moodle.org/dev/Subplugins sub-plugins]] and are fully customisable allowing the community to generate plugins and share them without having to hack the plugin code.

When editing a custom certificate you can choose to add an element which will take you to the page to edit them.

[[File:Custom_certificate_edit_element.png]]

Each element defines what characteristics you can edit. In the above example we are editing the 'Student name' element. The site setting 'Show position X and Y' has been enabled which is why 'Position X' and 'Position Y' are shown.

===Repositioning elements===

When editing a custom certificate under the list of elements there is a link 'Reposition elements' that will take you to a page where you can drag and drop the elements. While on this page you can also click on the elements to bring up a dialogue that will allow you to edit its properties without having to go back to the edit custom certificate page.

[[File:Custom_certificate_reposition_elements.png]]

==Viewing issued certificates==

To view issued certificates a user with the appropriate permissions can simply click on the certificate and click on the link 'View X issued custom certificates'.

[[File:Custom_certificate_view_issued_certificates.png]]

Once you click on the link you can view the users who have been issued this certificate and also download their version of the certificate.

[[File:Custom_certificate_view_issued_certificates_list.png]]

==Verifying certificates==

Each certificate when issued is assigned a unique code. To validate a certificate a person (eg. employer) may want to enter the code displayed on the certificate to confirm that it is indeed authentic. With the setting 'Allow anyone to verify a certificate' enabled any person with the verification link (including users not logged in) can verify a certificate, however if it is not set, a user with the appropriate permissions ('mod/customcert:verifycertificate') can do this by clicking on the certificate to gain access to the link.

[[File:Custom_certificate_verify_certificates.png]]

Here you can click on the cog on the top right and select 'Verify certificate'.

[[File:Custom_certificate_verify_certificate_page.png]]

Here you can enter the code to verify its authenticity.

==My certificates==

It is possible that a user may be in several courses each with their own custom certificate activity. It would be time consuming for the user to visit every course to review their certificate. In order to avoid this there is a page where the user can view all the certificates they have received.

[[File:Custom_certificate_profile_page.png]]

On the user's profile page under 'Miscellaneous' the user can click on 'My certificates' which will take them to a page listing all their certificates with the option of downloading them.

[[File:Custom_certificate_my_certificates_page.png]]

==Helpful links==
See [https://moodle.org/plugins/mod_customcert the plugin page], the [https://github.com/markn86/moodle-mod_customcert/issues tracker page] and the [https://moodle.org/mod/forum/view.php?id=7163 Moodle forum].

==Did you find this plugin useful?==
Click on the 'Add to my favourites' link in [https://moodle.org/plugins/mod_customcert the plugin page].

File:Custom certificate my certificates page.png

2017-05-30T02:30:58Z

Markn:

File:Custom certificate profile page.png

2017-05-30T02:30:50Z

Markn:

File:Custom certificate verify certificate page.png

2017-05-30T02:30:43Z

Markn:

File:Custom certificate view issued certificates list.png

2017-05-30T02:30:33Z

Markn:

File:Custom certificate view issued certificates.png

2017-05-30T02:30:27Z

Markn:

File:Custom certificate reposition elements.png

2017-05-30T02:30:25Z

Markn:

File:Custom certificate edit element.png

2017-05-30T02:30:11Z

Markn:

File:Custom certificate element list.png

2017-05-30T02:30:05Z

Markn:

File:Custom certificate edit page with items.png

2017-05-30T02:29:55Z

Markn:

File:Custom certificate edit menu.png

2017-05-30T02:29:45Z

Markn:

File:Custom certificate add activity page.png

2017-05-30T02:29:37Z

Markn:

File:Custom certificate edit page.png

2017-05-30T02:29:29Z

Markn:

File:Custom certificate manage templates.png

2017-05-30T02:29:21Z

Markn:

File:Custom certificate site settings.png

2017-05-30T02:29:14Z

Markn:

Custom certificate module

2017-05-29T10:01:16Z

Markn: Copy from 3.1 page

{{Infobox plugin
|type = Activity
|entry = https://moodle.org/plugins/mod_customcert
|tracker = https://github.com/markn86/moodle-mod_customcert/issues
|discussion = https://moodle.org/mod/forum/view.php?id=7163
|maintainer = [[User:Mark Nelson|Mark Nelson]]
|float = right
}}
==Description==
The [https://moodle.org/plugins/mod_customcert custom certificate module] allows the generation of dynamic PDF certificates with complete customisation via the web browser. It is different from the [https://moodle.org/plugins/mod_certificate certificate module] which requires PHP and FTP access in order to customise its appearance.

==Installation==
There are two installation methods that are available.

Follow one of these, then log into your Moodle site as an administrator and visit the notifications page to complete the install.
===Git===

This requires Git being installed. If you do not have Git installed, please visit the Git website.

Once you have Git installed, simply visit your Moodle mod directory and clone the repository using the following command.

<code>git clone https://github.com/markn86/moodle-mod_customcert.git customcert</code>

Then checkout the branch corresponding to the version of Moodle you are using with the following command. Make sure to replace MOODLE_32_STABLE with the version of Moodle you are using.

<code>git checkout MOODLE_32_STABLE</code><br />
Use <code>git pull</code> to update this repository periodically to ensure you have the most recent updates.
===Download the Zip===

Visit the Moodle plugins website and download the zip corresponding to the version of Moodle you are using. Extract the zip and place the 'customcert' folder in the mod folder in your Moodle directory.

==Site settings==

To visit the site settings log in as a user with appropriate permissions and visit 'Site administration' > 'Plugins' > 'Custom certificate'.

[[File:Custom_certificate_site_settings.png]]

===Show position X and Y===

This will show the X and Y position when editing of an element, allowing the user to accurately specify the location.

This isn't required if you plan on solely using the drag and drop interface for this purpose.

===Manage templates===

This link will take you to a new screen where you will be able to manage templates.

===Upload image===

This link will take you to a new screen where you will be able to upload images. Images uploaded using this method will be available throughout your site to all users who are able to create a custom certificate.

==Managing templates==
Templates allow a person with the appropriate permissions to create a site-wide template that can then be used by users when adding a certificate to a course, saving them from re-creating the same certificate over and over again. To create a template log in as a user who has the appropriate permissions and visit 'Site administration' > 'Plugins' > 'Custom certificate' and click on the link 'Manage templates'.

[[File:Custom_certificate_manage_templates.png]]

Here you will see a list of templates that have already been created. You can choose to edit these templates, delete them or create a new one. We will be creating a new template - start by clicking on 'Create template'.

[[File:Custom_certificate_edit_page.png]]

The name here is what will be displayed to the users when they are creating a certificate in a course and would like to choose a template to load. You can add elements to the template, customise them and rearrange their position. This process is discussed later when we talk about adding a custom certificate to a course and then customising it.

==Adding a custom certificate to a course==

The custom certificate plugin once installed can be added just like any other activity in Moodle. Visit a course, turn editing on and click to add an activity.

[[File:Custom_certificate_add_activity_page.png]]

===Certificate options===

====Allow anyone to verify a certificate====

Each certificate when issued is assigned a unique code. It is possible to have this code displayed on the certificate by adding it as an element. To validate a certificate a person (eg. employer) may want to enter the code displayed on the certificate to confirm that it is indeed authentic. To accomplish this a logged in user requires the capability 'mod/customcert:verifycertificate', however with this setting set to 'Yes' any person with the verification link (including users not logged in) can do this.

====Email students/teachers/others====

These settings enable the emailing of a certificate when a user is able to view it. The certificate may be hidden due to [[https://docs.moodle.org/en/Restrict_access access restrictions]], such as requiring the completion of another activity. A [[https://docs.moodle.org/en/Scheduled_tasks scheduled task]] runs that processes all the certificates that have any of these settings enabled and collects all the users to email that have not been emailed yet and are able to view the certificate and emails them the PDF.

====Required minutes in course====

This is the number of minutes a user is required to be in a course before they are able to view a certificate. This uses the logs in Moodle and hence can not guarantee the result to be 100% accurate.

====Set protection====

This determines what protection we want to set on the PDF.

===Editing a custom certificate===

Once you have added a certificate to your course you can then choose to edit the appearance of it. To do this view the certificate to be taken to the following page.

[[File:Custom_certificate_edit_menu.png]]

Here you can click on the cog on the top right and select 'Edit custom certificate'.

[[File:Custom_certificate_edit_page_with_items.png]]

On the edit page you can see a list of the elements that have already been added to the certificate. You can edit, delete and move these elements. The order of these elements determine when they are rendered on the PDF. So, if you were to add a background image you would want this rendered first.

You can also choose to load a template on this page. If you also have the permissions to manage templates you will also be shown the link to the manage templates page.

===Adding/editing an element===

[[File:Custom_certificate_element_list.png]]

The above is the list of items that come with this plugin. These are [[https://docs.moodle.org/dev/Subplugins sub-plugins]] and are fully customisable allowing the community to generate plugins and share them without having to hack the plugin code.

When editing a custom certificate you can choose to add an element which will take you to the page to edit them.

[[File:Custom_certificate_edit_element.png]]

Each element defines what characteristics you can edit. In the above example we are editing the 'Student name' element. The site setting 'Show position X and Y' has been enabled which is why 'Position X' and 'Position Y' are shown.

===Repositioning elements===

When editing a custom certificate under the list of elements there is a link 'Reposition elements' that will take you to a page where you can drag and drop the elements. While on this page you can also click on the elements to bring up a dialogue that will allow you to edit its properties without having to go back to the edit custom certificate page.

[[File:Custom_certificate_reposition_elements.png]]

==Viewing issued certificates==

To view issued certificates a user with the appropriate permissions can simply click on the certificate and click on the link 'View X issued custom certificates'.

[[File:Custom_certificate_view_issued_certificates.png]]

Once you click on the link you can view the users who have been issued this certificate and also download their version of the certificate.

[[File:Custom_certificate_view_issued_certificates_list.png]]

==Verifying certificates==

Each certificate when issued is assigned a unique code. To validate a certificate a person (eg. employer) may want to enter the code displayed on the certificate to confirm that it is indeed authentic. With the setting 'Allow anyone to verify a certificate' enabled any person with the verification link (including users not logged in) can verify a certificate, however if it is not set, a user with the appropriate permissions ('mod/customcert:verifycertificate') can do this by clicking on the certificate to gain access to the link.

[[File:Custom_certificate_verify_certificates.png]]

Here you can click on the cog on the top right and select 'Verify certificate'.

[[File:Custom_certificate_verify_certificate_page.png]]

Here you can enter the code to verify its authenticity.

==My certificates==

It is possible that a user may be in several courses each with their own custom certificate activity. It would be time consuming for the user to visit every course to review their certificate. In order to avoid this there is a page where the user can view all the certificates they have received.

[[File:Custom_certificate_profile_page.png]]

On the user's profile page under 'Miscellaneous' the user can click on 'My certificates' which will take them to a page listing all their certificates with the option of downloading them.

[[File:Custom_certificate_my_certificates_page.png]]

==Helpful links==
See [https://moodle.org/plugins/mod_customcert the plugin page], the [https://github.com/markn86/moodle-mod_customcert/issues tracker page] and the [https://moodle.org/mod/forum/view.php?id=7163 Moodle forum of this plugin].

==Did you find this plugin useful?==
Click on the 'Add to my favourites' link in [https://moodle.org/plugins/mod_customcert the plugin page].

Calendar settings

2013-11-01T04:40:44Z

Markn:

{{Calendar}}
==Preference settings==
Both the daily detail screen and the monthly detail screen have the Preferences button in the upper right. Here you can set the time format, first day of the week, number of events to show in the calendar block, days to look forward for events and if the filters on this calendar should be saved as the default for all calendars.

==Site administration settings==

The following settings can be changed by a site administrator in ''Administration > Appearance > Calendar'':

===Admins see all===

Whether admins see all calendar events or just those that apply to themselves.

===Time display format===

Whether a 12 or 24 hour format is used. This setting can be overridden by user preferences.

===Start of week===

Default is Sunday.

===Weekend days===

Weekend days are shown in a different colour.

===Days and events to look ahead===

For determining how many events are listed in the [[Upcoming Events block]]. If the Upcoming Events block becomes too long you can reduce the number of days and events to lookahead.

===Calendar export days to look ahead and back===

A custom range of dates, such as a school term or year, may be set as a calendar export option.

===Calendar export salt===

The calendar export salt is a random string of characters used for improving of security of authentication tokens used for exporting of calendars.

==Calendar permissions==

*[[Capabilities/moodle/calendar:manageentries|moodle/calendar:manageentries]]
*[[Capabilities/moodle/calendar:manageownentries|moodle/calendar:manageownentries]]
*[[Capabilities/moodle/calendar:managegroupentries|moodle/calendar:managegroupentries]]

The [[Calendar editor role]] may be used to enable users to add course or site events to the calendar.

[[Category:Site administration]]

[[fr:Calendrier (administrateur)]]
[[ja:カレンダー (管理者)]]
[[de:Kalendereinstellungen]]

==See also==

* [[Core APIs]]
* [[:en:Calendar|Calendar user docs]]
* [[Calendar types]]

Calendar settings

2013-11-01T04:25:47Z

Markn: