Difference between revisions of "Certificate module"

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 2.7. Up-to-date documentation for the latest stable version of Moodle may be available here: Certificate module.

(Settings: short list to give feel. More detail in add/edit certificate module)
m (Certificate examples)
 
(35 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Update}}
+
{{Certificate}}
The '''Certificate module''' creates PDF certificates/diplomas for students of the course and is completely customizable. You can add borders, watermarks, seals and even show grade information.  
+
{{Infobox plugin
 +
|type = Activity
 +
|entry = https://moodle.org/plugins/view.php?plugin=mod_certificate
 +
|tracker = http://tracker.moodle.org/browse/CONTRIB-2006
 +
|discussion = https://moodle.org/mod/forum/view.php?id=7163
 +
|maintainer = [[User:Mark Nelson|Mark Nelson]]
 +
|float = right
 +
}}
 +
The '''Certificate module''' creates PDF certificates/diplomas for students in a course and can be customized by the certificate settings menu. You can add borders, watermarks, seals, signatures, outcomes, grades and even add custom text.
 +
 
 +
Certificate should be downloaded from the download Plugins at Moodle.org (see the info box on the page for a link).  You should select the certificate download that matches your Moodle version.
  
 
==Certificate examples==
 
==Certificate examples==
 +
Here are 3 examples. Click on one to enlarge it.  A certificate that uses the standard features found in the install package.  Then 2 others show different possible ways to customize a certificate.
 
<gallery caption="Certificate examples - click on any to enlarge" widths="200px" heights="100px" perrow="6">
 
<gallery caption="Certificate examples - click on any to enlarge" widths="200px" heights="100px" perrow="6">
Image:Certificate 1.gif|Fancy border, signature line, seal, code
+
Image:Certificate 27 plain.png|Shows no options selected, standard title, course name, user name and words.
Image:Certificate199 example lines.png|Lines, signature, seal, watermark, code, grade, outcomes, custom text
+
Image:Certificate 27 manyoptions.png|Shows many text and images selected, signature, seal, watermark, code, grade, teachers name, custom text and border.
Image:Certificate199 example creative.png|New border, new signature, new seal, new watermark, code, outcome
+
Image:Certificate199 example creative.png|Custom border, custom signature, custom seal, custom watermark, code, outcome
 +
Image:Certificate 27 customcode.png |Custom everything, new certificate type, with new text strings, new text and image positions, plus uploadd watermark, seal, signature and border. 
 
</gallery>
 
</gallery>
 
  
 
==Installing==
 
==Installing==
#Download and Unpack the Certificate zip file in a temporary area,
+
#Download and Unpack the Certificate zip file (for example mod_certificate_moodle27_2014041800) for the Moodle version your are using in a temporary area,
#Copy the "certificate" folder to your moodle mod folder located for example at yourhost\moodle\mod . This will include folders backup, db, lang, pix (including subfolders for  borders, seals, signatures and watermarks),  and type (with sub folders for each of 4 default types).
+
#Copy the "certificate" folder to your Moodle mod folder located for example at yourhost\moodle\mod . The certificate folder will include folders backup, db, lang, pix (including subfolders for  borders, seals, signatures and watermarks),  and type (with sub folders for each of 4 default types).
#Note:  It is not necessary to move the lang file into the Moodle lang folder, the certificate lang folder can stay in the mod/certificate folder.
 
 
#Go to your Moodle, and click on the Notifications link in the Site administration. Moodle knows something has been added and it will proceed to install the certificate module.
 
#Go to your Moodle, and click on the Notifications link in the Site administration. Moodle knows something has been added and it will proceed to install the certificate module.
 +
 +
''Note:'' It is not necessary to move the lang file into the Moodle lang folder, the certificate lang folder(s) can stay in the mod/certificate folder.
 +
''Note:'' Advance users upgrading from 1.9.9 or installing Certificate for the first time, might consider editing the files in the pix folder before installing via the notification link. These will be used as the default file.  Site administrators [[Certificate customizing|can upload more images via the interface]] after installing the module.
  
 
See also: [[Installing_contributed_modules_or_plugins]] in MoodleDocs.
 
See also: [[Installing_contributed_modules_or_plugins]] in MoodleDocs.
Line 22: Line 35:
  
 
*General - Certificate name and introduction.  The certificate will use the course name, this is the link name.
 
*General - Certificate name and introduction.  The certificate will use the course name, this is the link name.
*Issue options -Here you can set email options, determine if you want to save and or reissue certificates.
+
*Issue options -Here you can set email options, determine if you want to save and how user views the certificate. You can set minimium time the user must be in the course before issuing the certificate.
*Print text options - determine date,  security code, grade outcomes, credit hours, teachers names, custom text.
+
*Text options - determine date,  security code, grade outcomes, credit hours, teachers names, custom text.
*Design (and image) options - select Type, then determine orientation, and select images for border, lines, watermark, signature, seal or say no to any or all of them.
+
*Design (and image) options - select certificate type/print orientation, select images for border, lines, watermark, signature, seal or say no to any or all of these options.
 
*Common module settings -These are standard Moodle module settings.  See [[Common module settings]]
 
*Common module settings -These are standard Moodle module settings.  See [[Common module settings]]
 
*Locking options - if conditional dependencies has been turned on by the site administrator,  teacher can set standards that must be met before certificate can be issued.
 
*Locking options - if conditional dependencies has been turned on by the site administrator,  teacher can set standards that must be met before certificate can be issued.
  
==Tips & Tricks==
+
==Customizing certificate==
===Certificate icon location===
+
There are several ways to create a custom certificate.  Please see [[Certificate customizing]] for many examples and code hints.  A few quick examples from easiest to more skilled required:
If you are using your own theme you have to put the icon.gif inside a folder called certificate and put in your mod folder imageFor example, if your theme uses custom icons, you must put a certificate folder with the certificate icon.gif in it under your theme/pix/mod folder.
+
*Add your own images via the site administration>Plugins>Activities>Certificate in the appropriate type. Types are boarders, seals, signatures and watermarks.
 +
*Add your images to the appropriate /mod/certificate/pix folder.  This will also make them available under settings. 
 +
*Edit the text strings in the /mod/certificate/lang folder files, or though the customize language tool available to site administrators.
 +
*You may create as many "types" of certificates as you wish. This is more complicated and requires some knowledge of PHP and of course access to the moodle/mod/certificate folder.
  
 +
==Certificate companions==
 +
{{Update}}
 +
Not all these may work with Moodle 2.x. 
  
==Customizing==
 
The certificate code is located in the /mod/certificate folder.  In 1.9 there are sub-folders for db, lang (holds language sub-folders), pix (holds sub-folders for borders, seals, signatures and watermarks) and type (holds 6 standard certificate types, each in their own sub-folder). 
 
 
===Adding images===
 
[[Image:Certificate199 example creative.png|thumb|Creative example]] The easiest way to customize your certificate is to add your own JPG or PNG images. Place these in the appropriate mod/certificate/pix folder on your site.  The added JPG or PNG image will appear in the dropdown list by its file name.
 
 
Make sure your new files are the same size as the standard images. For example, the standard signature file is 150x31 pixels. If the signature file is a different size, you may need to modify the code line.  The same will be true for seals, borders and watermarks.
 
 
In the creative example, a custom border, watermark, signature and seal were added to the right folders.  All were sized and in the same file format as the one supplied with the initial certificate install.
 
 
===Customize format===
 
It is a good idea to create your own custom certificate type, that will appear on a list along with the standard certificates types.  You will know which is your custom certificate type and it will survive when you upgrade.  Here is how:
 
 
1.  Choose the certificate/type folder with the size/orientation you desire, copy and paste it in the certificate/type folder  and give the copied folder a new name.  For example copy the /type/letter_landscape folder and rename it 'mycertificate'.
 
 
2.  Open the certificate/lang/en_utf8/certificate.php file and add the name of your new folder type.  Following the above example, you would add:
 
 
:$string['typemycertificate'] = 'My New Certificate';
 
 
Now, when you add a certificate to a course, your new type should appear on the drop down list as "My New Certificate".
 
 
 
====Modifing image position code example====
 
Lets look at the signature code that is found in the letter_landscape type.
 
 
:print_signature($certificate->printsignature, $orientation, 110, 450, '', '');
 
 
Change it to:
 
:print_signature($certificate->printsignature, $orientation, 100, 435, 150, 75);
 
 
What happens?
 
 
*We moved the image top left corner from the 110 margin position to the left and the 100 position.
 
 
*We raised the image from the 450 line on the page up to the 435 line. 
 
 
*We set the width and height of the image to 150 by 75 pixels.
 
 
 
The default seal code for letter_landscape is below.  We could alter it's position.
 
 
:print_seal($certificate->printseal, $orientation, 590, 425, '', '');
 
 
===Changing Printed Text===
 
 
There are different lang strings in the certificate/lang/en_utf8/certificate.php file for each certificate type, so be sure to change the correct one for the type you are using (or create your own custom type--see above).  For example, if you want to customize the text for the landscape type, you can change these lines in the above mentioned lang file:
 
 
Default:
 
 
:<nowiki>$string['titlelandscape'] = 'CERTIFICATE OF ACHIEVEMENT';</nowiki><br>     
 
:<nowiki>$string['introlandscape'] = 'This is to certify that';</nowiki><br> 
 
:<nowiki>$string['statementlandscape'] = 'has successfully completed the course';</nowiki>
 
 
Customized:
 
 
:$string['statementlandscape'] = 'has successfully passed the final exam';
 
 
===Adding a New Line of Text===
 
 
1. Open the certificate/lang/en_utf8/certificate.php file and add your new lang string giving it a unique name, e.g.:
 
:$string['mynewtext'] = 'This is what I want to print on the certificate';
 
 
2. Open the file for your certificate type, e.g. certificate/type/mycertificate/certificate.php.  At the bottom of the page below '// Add Text' is the code that prints--you guessed it--text on the certificate.  Find the current line below which you would like your new text to be printed.  For example, if you want your text to print below the course name, find the line:
 
 
:<nowiki>cert_printtext(170, 330, 'C', 'Helvetica', '', 20, utf8_decode($classname));</nowiki>
 
 
3. Add a new line below that to print your new text using the name you gave your new lang string like this:
 
 
:<nowiki>cert_printtext(170, 350, 'C', 'Helvetica', '', 20, utf8_decode(get_string('mynewtext', 'certificate')));</nowiki>
 
::note: Make sure you a string to the language file called mynewtext. The above line of code gets that string. 
 
 
4.  You can adjust the placement over from the left by increasing or decreasing the '170' number.
 
You can adjust the placement down on the page by increasing or decreasing the '350' number.
 
Changing 'C' to 'L' or 'R' will print on the left or right side. 
 
For different fonts, see the moodle/lib/fpdf font folder for non-unicode types, and the moodle/lib/tcpdf/fonts folder for unicode types, for available fonts.  (NOTE: for unicode certificates, using more than one font is NOT recommended since the entire font gets embedded in the certificate--increasing the certificate file size.)
 
In the '' after the font name, you can add 'B' for bold, 'I' for italic, or 'U' for underline.
 
Changing the '10' number will change the font size.
 
 
:cert_printtext(170, 350, 'C', 'Times', '', 10, utf8_decode($USER->idnumber));
 
 
5. You can add a hard coded line of text. For example, a signature title block line:
 
:cert_printtext(150, 490, 'L', 'Times', '', 10, utf8_decode('Martin Dougiamas, Lead Developer'));
 
 
===Add your string to the pdf image===
 
You can add your own custom string to the pdf print section.  We wanted to add "These Continuing Credits are from Our University" below the title of the course. We used the landscape certificate type.
 
 
We added the string to the language file. 
 
:<nowiki>$string(ceusfromus) = 'These Continuing Credits are from Our University';</nowiki>
 
 
In the type folder's certificate.php file, in the PDF area near the end of the file, we put the following line:
 
 
:<nowiki>cert_printtext(170, 380, 'C', 'Helvetica', '', 16, utf8_decode
 
      (get_string('ceusfromus', 'certificate')));</nowiki>
 
 
==History of certificate module==
 
The certificate module was originally created by Hugo Salgado, July, 2004, updated by David T. Cannon, July, 2005 and [http://moodle.org/user/view.php?id=3239&course=5 Chardelle Busch] made extensive updates for
 
versions 1.6 through 1.9 based upon community input. 
 
 
==Certificate companions==
 
 
===Certificate Site-wide Report===
 
===Certificate Site-wide Report===
 
As of February 2008, there is a '''Certificate Site-wide Report''' which can be added in Moodle 1.9, as a supplement. This is an add-on to the certificate module--if installed, you will have an option when creating a certificate to send that certificate's info to the report. An optional  block is included that provides a link to the report. Students will see a list of all received certificates. Administrators (or those who have the capability of viewing site reports) will see a link on the Certificate Report page to view/download a report of all students' received certificates.  To install: Place the certificates folder in your root (main) moodle folder and upload to your server.  Place the my_certificates block folder under your moodle/blocks folder, upload to your server and click on the Administration>>Notifications link to install.
 
As of February 2008, there is a '''Certificate Site-wide Report''' which can be added in Moodle 1.9, as a supplement. This is an add-on to the certificate module--if installed, you will have an option when creating a certificate to send that certificate's info to the report. An optional  block is included that provides a link to the report. Students will see a list of all received certificates. Administrators (or those who have the capability of viewing site reports) will see a link on the Certificate Report page to view/download a report of all students' received certificates.  To install: Place the certificates folder in your root (main) moodle folder and upload to your server.  Place the my_certificates block folder under your moodle/blocks folder, upload to your server and click on the Administration>>Notifications link to install.
  
===Certificate Verification Block===
+
===Certificate Verification Block===  
A companion to the Certificate module for Moodle 1.9.  This is a block with a form for entering a given certificate code for verification. The verification page shows the student name, course name, date received and grade (if a grade is printed on the certificate).  The certificate code can be printed on a certificate.
+
A companion to the Certificate module for Moodle 1.9.  This is a block with a form for entering a given certificate code for verification. The verification page shows the student name, course name, date received and grade (if a grade is printed on the certificate).  The certificate code can be printed on a certificate.  
 
+
 
This feature is useful when a Registrar, supervisor or administrator wishes to verify that the printed certificate is valid for that student.  To install: Place the verify_certificate block folder under your moodle/blocks folder, upload to your server and click on the Administration>>Notifications link to install.
 
This feature is useful when a Registrar, supervisor or administrator wishes to verify that the printed certificate is valid for that student.  To install: Place the verify_certificate block folder under your moodle/blocks folder, upload to your server and click on the Administration>>Notifications link to install.
  
==Tips and Tricks==
+
In Certificate for 2.x, the view certificates will show the student name, date received, grade and code.  These are downloadable via several file types.
 
 
*Start with one of the existing certificate types, copy it and modify it.  
 
*Try your customized code on a non production site, such as a local host.
 
*In Administration>>Server set debugging to maximum (to show any coding error messages).
 
*While you can leave a php file open in edit mode, you must save the file before your changes become active.
 
*Make code changes one at a time, test and then backup after each successful change. For example,after adding a new string to the certificate lang file), go to your course page and click on a certificate to see if it appears on the list.
 
*If you broke the code you may get a blank screen for a certificate.   
 
**So it might be a good idea to make a backup of each successful change before starting the next change.  For example, after the 3rd code change, save certificate.php as certificate3.txt.
 
  
 
==See also==
 
==See also==
* [[mod/certificate/mod|Add/Edit Certificate]]
+
* [[Add/edit certificate module]]
 
* [[mod/certificate/view|Viewing a Certificate]]
 
* [[mod/certificate/view|Viewing a Certificate]]
 
+
* [[Certificate customizing]] - many tips and how to make changes to code to customize certificates even more.
 
 
The links below will lead to the current download areas
 
{{Update]]
 
 
 
*[https://github.com/PukunuiAustralia/moodle-mod_certificate PukunuiAustralia / moodle-mod_certificate] Version 2.0
 
 
* Moodle.org link [http://promoodle.com Certificate Sitewide Reports]  
 
* Moodle.org link [http://promoodle.com Certificate Validation Block]
 
 
 
  
 
* Using Moodle [http://moodle.org/mod/forum/view.php?id=7163 Certificate module] forum
 
* Using Moodle [http://moodle.org/mod/forum/view.php?id=7163 Certificate module] forum
* [[Activity_Locking]] - a conditional dependency add-in
+
* [[Conditional activities]] - When this site feature is turned on, teachers can set conditions based upon other activities in the course before a certificate will be issued.
 
* [[Development:Certificate Module|Development of the certificate module]]
 
* [[Development:Certificate Module|Development of the certificate module]]
 
* [http://tracker.moodle.org/browse/CONTRIB-334 Patch to enable linking] to [[Face-to-face module|Face-to-Face]] contributed module.
 
* [http://tracker.moodle.org/browse/CONTRIB-334 Patch to enable linking] to [[Face-to-face module|Face-to-Face]] contributed module.
Line 173: Line 76:
 
[[Category:Contributed code]]
 
[[Category:Contributed code]]
  
[[es:Certificate]]
+
[[es:Módulo certificado]]

Latest revision as of 15:00, 21 June 2014

The Certificate module creates PDF certificates/diplomas for students in a course and can be customized by the certificate settings menu. You can add borders, watermarks, seals, signatures, outcomes, grades and even add custom text.

Certificate should be downloaded from the download Plugins at Moodle.org (see the info box on the page for a link). You should select the certificate download that matches your Moodle version.

Certificate examples

Here are 3 examples. Click on one to enlarge it. A certificate that uses the standard features found in the install package. Then 2 others show different possible ways to customize a certificate.

Installing

  1. Download and Unpack the Certificate zip file (for example mod_certificate_moodle27_2014041800) for the Moodle version your are using in a temporary area,
  2. Copy the "certificate" folder to your Moodle mod folder located for example at yourhost\moodle\mod . The certificate folder will include folders backup, db, lang, pix (including subfolders for borders, seals, signatures and watermarks), and type (with sub folders for each of 4 default types).
  3. Go to your Moodle, and click on the Notifications link in the Site administration. Moodle knows something has been added and it will proceed to install the certificate module.

Note: It is not necessary to move the lang file into the Moodle lang folder, the certificate lang folder(s) can stay in the mod/certificate folder. Note: Advance users upgrading from 1.9.9 or installing Certificate for the first time, might consider editing the files in the pix folder before installing via the notification link. These will be used as the default file. Site administrators can upload more images via the interface after installing the module.

See also: Installing_contributed_modules_or_plugins in MoodleDocs.

Settings

This is a short list of settings listed by their group. Please see Add/edit_certificate_module for more detailed information.

  • General - Certificate name and introduction. The certificate will use the course name, this is the link name.
  • Issue options -Here you can set email options, determine if you want to save and how user views the certificate. You can set minimium time the user must be in the course before issuing the certificate.
  • Text options - determine date, security code, grade outcomes, credit hours, teachers names, custom text.
  • Design (and image) options - select certificate type/print orientation, select images for border, lines, watermark, signature, seal or say no to any or all of these options.
  • Common module settings -These are standard Moodle module settings. See Common module settings
  • Locking options - if conditional dependencies has been turned on by the site administrator, teacher can set standards that must be met before certificate can be issued.

Customizing certificate

There are several ways to create a custom certificate. Please see Certificate customizing for many examples and code hints. A few quick examples from easiest to more skilled required:

  • Add your own images via the site administration>Plugins>Activities>Certificate in the appropriate type. Types are boarders, seals, signatures and watermarks.
  • Add your images to the appropriate /mod/certificate/pix folder. This will also make them available under settings.
  • Edit the text strings in the /mod/certificate/lang folder files, or though the customize language tool available to site administrators.
  • You may create as many "types" of certificates as you wish. This is more complicated and requires some knowledge of PHP and of course access to the moodle/mod/certificate folder.

Certificate companions

This page requires updating. Please do so and remove this template when finished.


Not all these may work with Moodle 2.x.

Certificate Site-wide Report

As of February 2008, there is a Certificate Site-wide Report which can be added in Moodle 1.9, as a supplement. This is an add-on to the certificate module--if installed, you will have an option when creating a certificate to send that certificate's info to the report. An optional block is included that provides a link to the report. Students will see a list of all received certificates. Administrators (or those who have the capability of viewing site reports) will see a link on the Certificate Report page to view/download a report of all students' received certificates. To install: Place the certificates folder in your root (main) moodle folder and upload to your server. Place the my_certificates block folder under your moodle/blocks folder, upload to your server and click on the Administration>>Notifications link to install.

Certificate Verification Block

A companion to the Certificate module for Moodle 1.9. This is a block with a form for entering a given certificate code for verification. The verification page shows the student name, course name, date received and grade (if a grade is printed on the certificate). The certificate code can be printed on a certificate.

This feature is useful when a Registrar, supervisor or administrator wishes to verify that the printed certificate is valid for that student. To install: Place the verify_certificate block folder under your moodle/blocks folder, upload to your server and click on the Administration>>Notifications link to install.

In Certificate for 2.x, the view certificates will show the student name, date received, grade and code. These are downloadable via several file types.

See also