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

Simple certificate module: Difference between revisions

From MoodleDocs
(Created page with "{{Activities}} {{Infobox plugin |type = activity |entry = https://moodle.org/plugins/view.php?plugin=mod_simplecertificate |tracker = https://github.com/bozoh/moodle-mod_simplece...")
 
m (→‎Languages with special character: clean up, typos fixed: latin → Latin)
 
(13 intermediate revisions by 3 users not shown)
Line 5: Line 5:
|tracker = https://github.com/bozoh/moodle-mod_simplecertificate/issues
|tracker = https://github.com/bozoh/moodle-mod_simplecertificate/issues
|discussion = https://moodle.org/mod/forum/discuss.php?d=222296
|discussion = https://moodle.org/mod/forum/discuss.php?d=222296
|maintainer = [[User:Carlos_Fonseca|Carlos Alexandre S. da Fonseca]]
|maintainer = [[User:Carlos Alexandre Fonseca|Carlos Alexandre S. da Fonseca]]
}}
}}


==Description==
==Description==
This module is based on certificate module, maintained by [[User:Mark_Nelson|Mark Nelson]], but simpler to use, no needs to change any code to add a new certificate format, and moodle's administrator don't need to upload image files or change language variables. The certificate text are full customisable, using special text marks that will be replaced by variables (like student name, course name, grade, ...).
This module is based on certificate module, maintained by [[User:Mark Nelson|Mark Nelson]], but simpler to use, no need to change any code to add a new certificate format, and Moodle's administrator don't need to upload image files or change language variables. The certificate text are full customizable, using special text marks that will be replaced by variables (like student name, course name, grade, ...).




Line 23: Line 23:
Once you have git installed, simply visit the Moodle mod directory and clone
Once you have git installed, simply visit the Moodle mod directory and clone
git://github.com/bozoh/moodle-mod_simplecertificate.git, remember to
git://github.com/bozoh/moodle-mod_simplecertificate.git, remember to
rename the folder to certificate if you do not specify this in the clone command
rename the folder to certificate if you do not specify this in the clone command.


Eg. Linux command line would be as follow -
E.g. Linux command line would be as follow -


git clone git://github.com/bozoh/moodle-mod_simplecertificate.git simplecertificate
git clone git://github.com/bozoh/moodle-mod_simplecertificate.git simplecertificate


Once cloned, checkout the branch that is specific to your Moodle version.
Once cloned, checkout the branch that is specific to your Moodle version.
eg, MOODLE_22 is for Moodle 2.2, MOODLE_23 is for 2.3, ...
e.g., MOODLE_22 is for Moodle 2.2, MOODLE_23 is for 2.3, ...


Use git pull to update this branch periodically to ensure you have the latest version.
Use git pull to update this branch periodically to ensure you have the latest version.


If you don't want install git you can visit https://github.com/bozoh/moodle-mod_simplecertificate, choose the branch
If you don't want install git you can visit https://github.com/bozoh/moodle-mod_simplecertificate, choose the branch
that matches your Moodle version (eg. MOODLE_22 is for Moodle 2.2, MOODLE_23 is for 2.3) and download the zip,  
that matches your Moodle version (e.g. MOODLE_22 is for Moodle 2.2, MOODLE_23 is for 2.3) and download the zip,  
uncompress this zip and extract the folder. The folder will have a name similar to bozoh-moodle-mod_simplecertificate-c9fbadb,  
uncompress this zip and extract the folder. The folder will have a name similar to bozoh-moodle-mod_simplecertificate-c9fbadb,  
you MUST rename this to simplecertificate. Place this folder in your mod folder in your Moodle directory.
you MUST rename this to simplecertificate. Place this folder in your mod folder in your Moodle directory.


===Using Moodle's plugins databate===
==Using the plugins==
Download the appropriate version of simple certificate module from https://moodle.org/plugins/view.php?plugin=mod_simplecertificate, and uncompress in your moodle mod folder
This plugin is design to be simple to create a certificate, without any PHP knowledge
In this plugins you can create:
*One or Two pages certificate
*Verification code
*QRCode with verification URL
*Multi language support, using Multi Language content filterhttp://docs.moodle.org/26/en/Multi-language_content_filter
*Bulk operations (send certificate via email to the users, ...)
* and more ...


To create a custom certificate, you add a simple certificate activity, in the Certificate Text
you will type you custom certificate text, and you will use some Text marks which will be replace to right values in the certificate creation process.
For example,
Certificate of Achievement
{COURSENAME}
to
{USERNAME}
The texts marks  {COUSENAME} and {USERNAME} will be replaced to course full name and user full name, respectively .
Here a more complete example image:
[[File:Simple_certificate_example_01.png]]
<center><tt>First page editing with a background image</tt></center>
and this will be created:
[[File:Simple_certificate_example_02.jpg]]
''A sample pdf file''
[[File:Simple_certificate_example_01.pdf]]


==How to report a bug==
==How to report a bug==
Please, use https://github.com/bozoh/moodle-mod_simplecertificate/issues.
You can report in:
 
Until now a don't have a CONTRIB Issue tracker in moodle tracker


* https://github.com/bozoh/moodle-mod_simplecertificate/issues.


==Text marks==
==Text marks==
The text marks can be found on module helps, just clik in help icon on "Certificate Text option"
In this version other user profile data can be added, like email, first name, country, and the custom profile data too.


{| cellpadding="3" cellspacing="0" border="1"
{| cellpadding="3" cellspacing="0" border="1"
!Text Mark
!Text Mark
!Description
!Description
!Since version
|-
|-
|{USERNAME}
|{USERNAME}
|Full user name
|Full user name
|1.x.x
|-
|-
|{COURSENAME}
|{COURSENAME}
|Full course name (or what is in Alternate course name option)
|Full course name (or what is in Alternate course name option)
|1.x.x
|-
|-
|{GRADE}
|{GRADE}
|Formatted Grade
|Formatted Grade
|1.x.x
|-
|-
|{DATE}
|{DATE}
|Formatted Date
|Formatted Date
|1.x.x
|-
|-
|{OUTCOME}
|{OUTCOME}
|Outcomes
|Outcomes
|1.x.x
|-
|-
|{HOURS}
|{HOURS}
|Defined hours in course
|Defined hours in course
|1.x.x
|-
|-
|{TEACHERS}
|{TEACHERS}
|Teachers List
|Teachers List
|1.x.x
|-
|{IDNUMBER}
|User id number
|2.x.x
|-
|{FIRSTNAME}
|User first name
|2.x.x
|-
|{LASTNAME}
|User last name
|2.x.x
|-
|{EMAIL}
|User e-mail
|2.x.x
|-
|{ICQ}
|User ICQ
|2.x.x
|-
|{SKYPE}
|User Skype
|2.x.x
|-
|{YAHOO}
|User yahoo messenger
|2.x.x
|-
|{AIM}
|User AIM
|2.x.x
|-
|{MSN}
|User MSN
|2.x.x
|-
|{PHONE1}
|User 1° Phone Number
|2.x.x
|-
|{PHONE2}
|User 2° Phone Number
|2.x.x
|-
|{INSTITUTION}
|User institution
|2.x.x
|-
|{DEPARTMENT}
|User department
|2.x.x
|-
|{ADDRESS}
|User address
|2.x.x
|-
|{CITY}
|User city
|2.x.x
|-
|{COUNTRY}
|User country
|2.x.x
|-
|{URL}
|User Home-page
|2.x.x
|-
|{PROFILE_xxxx}
|User custom profile fields
|2.x.x
|-
|{CERTIFICATECODE}
|Unique certificate code text
|2.1.x
|-
|{USERROLENAME}
|User role name in course
|2.2.0
|-
|{TIMESTART}
|User Enrollment start date in course
|2.2.0
|-
|{USERIMAGE}
|User profile image
|2.2.0
|-
|{USERRESULTS}
|User results (grade) in others course activities
|2.2.0
|}
|}


==Feature ideas and requests==
In order to use custom profiles fields you must use "PROFILE_" prefix, for example:
you has created a custom profile with shortname of "birthday,"  so the text mark used on certificate must be {PROFILE_BIRTHDAY}
 
==Languages with special character ==
Some languages have non Latin characters, like Russian or Japanese. In order to work these languages properly, you must use: style="font-family: freeserif;" or something as font style, for example:


<nowiki><span style="font-family: freeserif;">простой сертификат</span></nowiki>


===Enable reCAPTCHA in certificate verification===
<nowiki><span style="font-family: hysmyeongjostdmedium;">かんたん証明書</span></nowiki>
All issued certificate has a QR code on the second page that redirect to a the certificate verification page, will be useful to activate a reCAPTCHA in this page


<nowiki><span style="font-family: kozgopromedium;">かんたん証明書</span></nowiki> (it is better for Japanese characters, but under lib/tcpdf/fonts/ you need kozgopromedium.php which is included in the latest version of TCPDF)


==See also==
==See also==
* [https://moodle.org/mod/forum/discuss.php?d=222296 Discussion forum]
* [https://moodle.org/mod/forum/discuss.php?d=222296 Discussion forum]
* [https://www.youtube.com/watch?v=tmYbpwuN2Ps Basic Usage Video, thanks Matthew Nagy]
* [https://moodle.org/plugins/view.php?plugin=mod_certificate [[User:Mark Nelson|Mark Nelson]] certificate plugin]


* [https://moodle.org/plugins/view.php?plugin=mod_certificate [[User:Mark_Nelson|Mark Nelson]] certificate plugin]
[[es:Módulo certificado simple]]

Latest revision as of 16:00, 9 December 2021

Description

This module is based on certificate module, maintained by Mark Nelson, but simpler to use, no need to change any code to add a new certificate format, and Moodle's administrator don't need to upload image files or change language variables. The certificate text are full customizable, using special text marks that will be replaced by variables (like student name, course name, grade, ...).


Installation

Using git repository

If you do not have git installed, please see the below link. Please note, it is not necessary to set up the SSH Keys. This is only needed if you are going to create a repository of your own on github.com.

Information on installing git - http://help.github.com/set-up-git-redirect/

Once you have git installed, simply visit the Moodle mod directory and clone git://github.com/bozoh/moodle-mod_simplecertificate.git, remember to rename the folder to certificate if you do not specify this in the clone command.

E.g. Linux command line would be as follow -

git clone git://github.com/bozoh/moodle-mod_simplecertificate.git simplecertificate

Once cloned, checkout the branch that is specific to your Moodle version. e.g., MOODLE_22 is for Moodle 2.2, MOODLE_23 is for 2.3, ...

Use git pull to update this branch periodically to ensure you have the latest version.

If you don't want install git you can visit https://github.com/bozoh/moodle-mod_simplecertificate, choose the branch that matches your Moodle version (e.g. MOODLE_22 is for Moodle 2.2, MOODLE_23 is for 2.3) and download the zip, uncompress this zip and extract the folder. The folder will have a name similar to bozoh-moodle-mod_simplecertificate-c9fbadb, you MUST rename this to simplecertificate. Place this folder in your mod folder in your Moodle directory.

Using the plugins

This plugin is design to be simple to create a certificate, without any PHP knowledge In this plugins you can create:

  • One or Two pages certificate
  • Verification code
  • QRCode with verification URL
  • Multi language support, using Multi Language content filterhttp://docs.moodle.org/26/en/Multi-language_content_filter
  • Bulk operations (send certificate via email to the users, ...)
  • and more ...

To create a custom certificate, you add a simple certificate activity, in the Certificate Text you will type you custom certificate text, and you will use some Text marks which will be replace to right values in the certificate creation process.

For example, Certificate of Achievement {COURSENAME}

to

{USERNAME}

The texts marks {COUSENAME} and {USERNAME} will be replaced to course full name and user full name, respectively .

Here a more complete example image:

Simple certificate example 01.png

First page editing with a background image


and this will be created: Simple certificate example 02.jpg


A sample pdf file File:Simple certificate example 01.pdf

How to report a bug

You can report in:

Text marks

In this version other user profile data can be added, like email, first name, country, and the custom profile data too.

Text Mark Description Since version
{USERNAME} Full user name 1.x.x
{COURSENAME} Full course name (or what is in Alternate course name option) 1.x.x
{GRADE} Formatted Grade 1.x.x
{DATE} Formatted Date 1.x.x
{OUTCOME} Outcomes 1.x.x
{HOURS} Defined hours in course 1.x.x
{TEACHERS} Teachers List 1.x.x
{IDNUMBER} User id number 2.x.x
{FIRSTNAME} User first name 2.x.x
{LASTNAME} User last name 2.x.x
{EMAIL} User e-mail 2.x.x
{ICQ} User ICQ 2.x.x
{SKYPE} User Skype 2.x.x
{YAHOO} User yahoo messenger 2.x.x
{AIM} User AIM 2.x.x
{MSN} User MSN 2.x.x
{PHONE1} User 1° Phone Number 2.x.x
{PHONE2} User 2° Phone Number 2.x.x
{INSTITUTION} User institution 2.x.x
{DEPARTMENT} User department 2.x.x
{ADDRESS} User address 2.x.x
{CITY} User city 2.x.x
{COUNTRY} User country 2.x.x
{URL} User Home-page 2.x.x
{PROFILE_xxxx} User custom profile fields 2.x.x
{CERTIFICATECODE} Unique certificate code text 2.1.x
{USERROLENAME} User role name in course 2.2.0
{TIMESTART} User Enrollment start date in course 2.2.0
{USERIMAGE} User profile image 2.2.0
{USERRESULTS} User results (grade) in others course activities 2.2.0

In order to use custom profiles fields you must use "PROFILE_" prefix, for example: you has created a custom profile with shortname of "birthday," so the text mark used on certificate must be {PROFILE_BIRTHDAY}

Languages with special character

Some languages have non Latin characters, like Russian or Japanese. In order to work these languages properly, you must use: style="font-family: freeserif;" or something as font style, for example:

<span style="font-family: freeserif;">простой сертификат</span>

<span style="font-family: hysmyeongjostdmedium;">かんたん証明書</span>

<span style="font-family: kozgopromedium;">かんたん証明書</span> (it is better for Japanese characters, but under lib/tcpdf/fonts/ you need kozgopromedium.php which is included in the latest version of TCPDF)

See also