Wiki source code of 05 Zertifikate

Last modified by Carina Enke on 23.07.2024

Hide last authors
Carina Enke 896.1 1 [[image:attach:medal.png||data-xwiki-image-style="img-icon"]] In addition to the [[Performance results>>doc:LMS.Benutzerhandbuch OPAL.Lehren.Bewertung.Performance Results.WebHome||shape="rect"]], certificate files can be generated for a course or individual course elements. The user can download these files as a PDF via a link in the performance results section of the course and print them out.
Carina Enke 787.1 2
Carina Enke 896.1 3 You can use various configuration options to influence the design of the certificate and limit the view or print.
Carina Enke 879.1 4
5 {{info}}
Carina Enke 896.1 6 A certificate is issued for a passed course or course element. Instructions on how to configure the passing status can be found on the [[Assessment>>doc:LMS.Benutzerhandbuch OPAL.Lehren.Bewertung.WebHome||shape="rect"]] help page.
Carina Enke 879.1 7
Carina Enke 896.1 8 A certificate is only visible if performance results have been configured for the course. Instructions on how to configure performance results for a course can be found on the [[Performance Results>>doc:LMS.Benutzerhandbuch OPAL.Lehren.Bewertung.Performance Results.WebHome]] help page.
Carina Enke 879.1 9 {{/info}}
10
Moritz Baumgarten 884.1 11 (% class="box infomessage" %)
12 (((
Carina Enke 896.1 13 A [[supplementary Video>>doc:LMS.Benutzerhandbuch OPAL.Erste Schritte.Ergaenzungsvideos.WebHome]] is available for this function.
Carina Enke 787.1 14 )))
Katharina Schönefeld (Admin) 869.1 15
Carina Enke 894.3 16
Carina Enke 896.1 17 == Offer certificates ==
Carina Enke 895.2 18
19
Carina Enke 896.1 20 To generate a certificate automatically and display it to the learner, proceed as follows:
Carina Enke 787.1 21
Carina Enke 896.1 22 1. Open the course editor and navigate to the desired course element. To receive a certificate for the entire course, go to the top course node.
23 1. In the selected element, switch to the **Assessment **tab.
24 1. Activate the **Use certificates **option.
25 \\**//[[image:attach:Kurseditor-Zertifikate verwenden_en.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]//**
Moritz Baumgarten 884.1 26
Carina Enke 896.1 27 1. Choose the desired certificate template from the **Template for certificates **selection list. Apart from the example template, you can also use individually created templates. The latter will appear at the top of the selection list.(% style="color:#0000ff" %)
28 1. If you activate the **Display certificates only for tutors **option,** **the PDF files of the certificates will only be accessible by tutors via the assessment tool. A simple user does not have access to this area and can thus not view, print, or download their certificate.
Moritz Baumgarten 884.1 29
Carina Enke 787.1 30
Carina Enke 896.1 31 {{info}}
32 Please note that the template set in step 4 will be used for the first time for certificates that have been newly acquired after the publication of this change. However, users will also receive a new certificate if they improve on their original result. The template does not affect existing certificates. This also applies to replacing the template. A new template will only be used for a new certificate.
Carina Enke 787.1 33 {{/info}}
34
Moritz Baumgarten 884.1 35
Carina Enke 896.1 36 == Use individual certificate templates ==
Moritz Baumgarten 884.1 37
Carina Enke 787.1 38
Carina Enke 896.1 39 Individual course templates must be saved to the storage folder of the course and linked to the relevant course element. First open the course and switch to the course editor. Then select the Storage folder entry from the Editor tools menu. Choose one of the following options according to your certificate template:
Carina Enke 787.1 40
Carina Enke 896.1 41 * One or more certificate files with **any name**:
Carina Enke 787.1 42
Carina Enke 896.1 43 1. First create a new **folder with the exact title** //certificate_templates //in the course storage folder.
44 1. Copy all HTML templates as well as all images and CSS files referenced in these templates to the //certificate_templates //folder.
45 1. (((
46 Close the storage folder.
Carina Enke 879.1 47
Carina Enke 896.1 48 {{info title="Tip"}}
49 Use the following **example template file** to test the function: (% style="color: rgb(0,0,255);" %)[[attach:certificate_templates.zip]].
50
51 (% style="color: rgb(51,51,51);" %)Upload this file to the storage folder in the course editor and unzip it. Take a look at the examples included in the //certificate_templates// folder and edit them if necessary. All included certificate templates will then be available under the **Use certificates** section in the **Assessment **tab of the course or course element.
Carina Enke 879.1 52 {{/info}}
Carina Enke 787.1 53 )))
Katharina Schönefeld (Admin) 869.1 54
Carina Enke 896.1 55 * A single template with the **mandatory file name **//certificatetemplate.html //(all letters in lowercase):
Carina Enke 787.1 56
Carina Enke 896.1 57 1. Upload the HTML file with this specific file name to the course storage folder or the assigned resource folder of the course.
58 1. All images and CSS files referenced in the template must also be copied to the course storage folder / resource folder.
59 1. Close the storage folder.
Carina Enke 787.1 60
Carina Enke 896.1 61 When configuring the course element in the **Assessment **tab, select exactly this template from the **Template for certificates **list.
Carina Enke 787.1 62
Moritz Baumgarten 884.1 63
Carina Enke 896.1 64 === Placeholder ===
Moritz Baumgarten 884.1 65
Carina Enke 787.1 66
Carina Enke 896.1 67 When creating the certificate template, you can use different placeholders in the HTML file, depending on the configuration of the learning platform. These are then filled in the certificate of the respective user with the corresponding data of the course or user.
Moritz Baumgarten 884.1 68
Carina Enke 896.1 69 You can create and design such a certificate template with the integrated HTML editor e. g. directly in the course storage folder. If you create and upload a certificate template with an external editor, the system will warn you of possible information loss when trying to edit the template with the integrated editor.
Carina Enke 787.1 70
Carina Enke 896.1 71 {{note title="Course element ID"}}
72 For some of the placeholders, you will need the individual course element ID. The IDs can be found in the course editor of the respective course element on the Title and description tab in the form of a number combination in the bottom right corner (e. g. ID: 94862470524389). Just replace the signs indicated in the table (~#~##) with the desired number combination (e.g. %%MARK:94862470524457%%).
Carina Enke 879.1 73 {{/note}}
Carina Enke 787.1 74
Carina Enke 896.1 75 (% class="wrapped" %)
76 |=(((
77 Placeholder
78 )))|=(((
79 Value
80 )))
81 |(((
Carina Enke 879.1 82 %%COURSE_TITLE%%
83 )))|(((
Carina Enke 896.1 84 Title of the course for which the certificate is issued.
Carina Enke 879.1 85 )))
Carina Enke 896.1 86 |(((
87 (% style="color:#172b4d" %)%%COURSENODE_TITLE%%
Carina Enke 879.1 88 )))|(((
Carina Enke 896.1 89 Title of the course element for which the certificate is issued.
Carina Enke 879.1 90 )))
Carina Enke 896.1 91 |(((
Katharina Schönefeld (Admin) 849.1 92 %%CERTIFICATE_DATE%%
Carina Enke 896.1 93
94
95
Carina Enke 841.1 96 )))|(((
Carina Enke 879.1 97 (% class="content-wrapper" %)
98 (((
Carina Enke 896.1 99 The date on which the performance results were achieved. The formatting of the placeholder depends on the language selected by the user. It can be adjusted with the following options:
Carina Enke 879.1 100
Carina Enke 892.2 101
Carina Enke 896.1 102 |=Form|=Placeholder|=Example
Carina Enke 893.2 103 |Standard|%%CERTIFICATE_DATE%%|(((
104 Standard (Systemsprache Deutsch): 23.07.2024,
105
106 Standard (Systemsprache Englisch): Jul 23, 2024
107 )))
108 |LONG DE|%%CERTIFICATE_DATE_LONG:LANG=de%%|23. Juli 2024
109 |SHORT DE|%%CERTIFICATE_DATE_SHORT:LANG=de%%|23.07.24
110 |MEDIUM DE|%%CERTIFICATE_DATE_MEDIUM:LANG=de%%|23.07.2024
111 |FULL DE|%%CERTIFICATE_DATE_FULL:LANG=de%%|Dienstag, 23. Juli 2024
112 |LONG EN|%%CERTIFICATE_DATE_LONG:LANG=en%%|July 23, 2024
113 |SHORT EN|%%CERTIFICATE_DATE_SHORT:LANG=en%%|07/23/24
114 |MEDIUM EN|%%CERTIFICATE_DATE_MEDIUM:LANG=en%%|Jul 23, 2024
115 |FULL EN|%%CERTIFICATE_DATE_FULL:LANG=en%%|Tuesday, July 23, 2024
Carina Enke 787.1 116 )))
Carina Enke 879.1 117 )))
Carina Enke 896.1 118 |(((
119 (% style="color:#172b4d" %)%%GRADE%%
Katharina Schönefeld (Admin) 869.1 120 )))|(((
Carina Enke 896.1 121 Display of grades as text
Katharina Schönefeld (Admin) 869.1 122 )))
Carina Enke 896.1 123 |(((
Carina Enke 879.1 124 %%GRADE:~#~##:LANG=de%%
Katharina Schönefeld (Admin) 849.1 125 )))|(((
Carina Enke 896.1 126 Display of the German grade for the specified course element
Katharina Schönefeld (Admin) 849.1 127 )))
Carina Enke 896.1 128 |(((
Carina Enke 879.1 129 %%GRADE:~#~##:LANG=en%%
130 )))|(((
Carina Enke 896.1 131 Display of the English grade for the specified course element
Carina Enke 879.1 132 )))
Carina Enke 896.1 133 |(((
Carina Enke 787.1 134 %%MARK%%
Katharina Schönefeld (Admin) 849.1 135 )))|(((
Carina Enke 896.1 136 Mark for the entire course
Carina Enke 787.1 137 )))
Carina Enke 896.1 138 |(((
Carina Enke 787.1 139 %%MARK:~#~##%%
140 )))|(((
Carina Enke 896.1 141 Mark for the course element with the ID ~#~## (the course element must be assessable)
Carina Enke 787.1 142 )))
Carina Enke 896.1 143 |(((
Carina Enke 787.1 144 %%ROOT_NODE_SHORT_TITLE%%
Carina Enke 879.1 145 )))|(((
Carina Enke 896.1 146 Short title from the course root node
Carina Enke 787.1 147 )))
Carina Enke 896.1 148 |(((
Carina Enke 787.1 149 %%ROOT_NODE_TITLE%%
Carina Enke 879.1 150 )))|(((
Carina Enke 896.1 151 Title from the course root node
Carina Enke 787.1 152 )))
Carina Enke 896.1 153 |(((
Carina Enke 787.1 154 %%METADATA:moduleduration%%
155 )))|(((
Carina Enke 896.1 156 (% class="TableParagraph" %)
157 Course metadata: Duration of the module
Carina Enke 787.1 158 )))
Carina Enke 896.1 159 |(((
Carina Enke 787.1 160 %%METADATA:moduleects%%
161 )))|(((
Carina Enke 896.1 162 Course metadata: ECTS
Carina Enke 787.1 163 )))
Carina Enke 896.1 164 |(((
Carina Enke 787.1 165 %%METADATA:moduleexam%%
166 )))|(((
Carina Enke 896.1 167 Course metadata: Exams
Carina Enke 787.1 168 )))
Carina Enke 896.1 169 |(((
Carina Enke 787.1 170 %%METADATA:modulelevel%%
171 )))|(((
Carina Enke 896.1 172 Course metadata: Level
Carina Enke 787.1 173 )))
Carina Enke 896.1 174 |(((
Carina Enke 787.1 175 %%METADATA:modulelink%%
176 )))|(((
Carina Enke 896.1 177 Course metadata: Link to the module
Carina Enke 787.1 178 )))
Carina Enke 896.1 179 |(((
Carina Enke 787.1 180 %%METADATA:modulemethods%%
181 )))|(((
Carina Enke 896.1 182 Course metadata: Teaching and learning methods
Carina Enke 787.1 183 )))
Carina Enke 896.1 184 |(((
Carina Enke 787.1 185 %%METADATA:modulename%%
186 )))|(((
Carina Enke 896.1 187 Course metadata: Name of the module
Carina Enke 787.1 188 )))
Carina Enke 896.1 189 |(((
Carina Enke 787.1 190 %%METADATA:modulenumber%%
191 )))|(((
Carina Enke 896.1 192 Course metadata: Module number
Carina Enke 787.1 193 )))
Carina Enke 896.1 194 |(((
Carina Enke 787.1 195 %%METADATA:moduleresponsible%%
196 )))|(((
Carina Enke 896.1 197 Course metadata: Person responsible for further education
Carina Enke 787.1 198 )))
Carina Enke 896.1 199 |(((
Carina Enke 787.1 200 %%METADATA:moduleversion%%
201 )))|(((
Carina Enke 896.1 202 Course metadata: Version
Carina Enke 787.1 203 )))
Carina Enke 896.1 204 |(((
Carina Enke 787.1 205 %%METADATA:moduleworkloadpresence%%
206 )))|(((
Carina Enke 896.1 207 Course metadata: Attendance time
Carina Enke 787.1 208 )))
Carina Enke 896.1 209 |(((
Carina Enke 787.1 210 %%METADATA:moduleworkloadprivate%%
211 )))|(((
Carina Enke 896.1 212 Course metadata: Private study time
Carina Enke 787.1 213 )))
Carina Enke 896.1 214 |(((
Carina Enke 787.1 215 %%METADATA:moduleworkloadtotal%%
216 )))|(((
Carina Enke 896.1 217 Course metadata: Total workload
Carina Enke 787.1 218 )))
Carina Enke 896.1 219 |(((
Carina Enke 787.1 220 %%PASSED%%
221 )))|(((
Carina Enke 896.1 222 Displays "Passed" in the certificate, depending on the configured user language at the time of passing.
Carina Enke 787.1 223 )))
Carina Enke 896.1 224 |(((
Carina Enke 787.1 225 %%PROPERTY:birthDay%%
Carina Enke 879.1 226 )))|(((
227 (% class="content-wrapper" %)
Carina Enke 787.1 228 (((
Carina Enke 896.1 229 (% class="TableParagraph" %)
230 Date of birth with the following options:
Carina Enke 879.1 231
Carina Enke 896.1 232 * Selecting a display style for the date
Carina Enke 879.1 233 * (((
Carina Enke 896.1 234 Defining the language format
Carina Enke 879.1 235
Carina Enke 896.1 236 {{expand title="Display all available format options ..."}}
Carina Enke 879.1 237 {{{Standard: %%PROPERTY:birthDay%%
238 LONG DE: %%PROPERTY:birthDay_LONG:LANG=de%%
239 SHORT DE: %%PROPERTY:birthDay_SHORT:LANG=de%%
240 MEDIUM DE: %%PROPERTY:birthDay_MEDIUM:LANG=de%%
241 FULL DE: %%PROPERTY:birthDay_FULL:LANG=de%%
242 LONG EN: %%PROPERTY:birthDay_LONG:LANG=en%%
243 SHORT EN: %%PROPERTY:birthDay_SHORT:LANG=en%%
244 MEDIUM EN: %%PROPERTY:birthDay_MEDIUM:LANG=en%%
245 FULL EN: %%PROPERTY:birthDay_FULL:LANG=en%%}}}
246 {{/expand}}
Carina Enke 787.1 247 )))
Carina Enke 879.1 248 )))
249 )))
Carina Enke 896.1 250 |(((
Carina Enke 787.1 251 %%PROPERTY:email%%
252 )))|(((
Carina Enke 896.1 253 Email address
Carina Enke 787.1 254 )))
Carina Enke 896.1 255 |(((
Carina Enke 787.1 256 %%PROPERTY:firstName%%
257 )))|(((
Carina Enke 896.1 258 First name
Carina Enke 787.1 259 )))
Carina Enke 896.1 260 |(((
Carina Enke 787.1 261 %%PROPERTY:institutionalName%%
262 )))|(((
263 Institution
264 )))
Carina Enke 896.1 265 |(((
Carina Enke 879.1 266 %%PROPERTY:institutionalUserIdentifier%%
267 )))|(((
Carina Enke 896.1 268 Matriculation number (system-dependent metadata)
Carina Enke 879.1 269 )))
Carina Enke 896.1 270 |(((
Carina Enke 787.1 271 %%PROPERTY:lastName%%
272 )))|(((
Carina Enke 896.1 273 Last name
Carina Enke 787.1 274 )))
Carina Enke 896.1 275 |(((
Carina Enke 787.1 276 %%PROPERTY:orgUnit%%
277 )))|(((
Carina Enke 896.1 278 Organisation unit
Carina Enke 787.1 279 )))
Carina Enke 896.1 280 |(((
Carina Enke 879.1 281 %%SALUTATION:LANG=de%%
282 )))|(((
Carina Enke 896.1 283 Salutation (German)
Carina Enke 879.1 284 )))
Carina Enke 896.1 285 |(((
Carina Enke 879.1 286 %%SALUTATION:LANG=en%%
287 )))|(((
Carina Enke 896.1 288 Salutation (English)
Carina Enke 879.1 289 )))
Carina Enke 896.1 290 |(((
Carina Enke 787.1 291 %%SCORE%%
292 )))|(((
Carina Enke 896.1 293 Score for the entire course
Carina Enke 787.1 294 )))
Carina Enke 896.1 295 |(((
Carina Enke 787.1 296 %%SCORE:~#~##%%
297 )))|(((
Carina Enke 896.1 298 Score for the course element with the ID ~#~## (the course must be assessable)
Carina Enke 787.1 299 )))
Carina Enke 896.1 300 |(((
301 (% style="color:#172b4d" %)%%OUTCOME:[variable name]:~#~##%%
Carina Enke 879.1 302 )))|(((
303 (% class="content-wrapper" %)
304 (((
Carina Enke 896.1 305 Output value of an ONYX test
Carina Enke 879.1 306
Carina Enke 896.1 307 {{expand title="Learn more about how to use this placeholder ..."}}
308 This placeholder can be used for all variables displayed in a test course element on the Test configuration tab>"Output variables of this resource" such as MAXSCORE, PASS_SCORE, SCORE, PASS, as well as for individual test and section variables of the type text or numerical.
Carina Enke 879.1 309
Carina Enke 896.1 310 [[image:attach:Kurseditor - Ausgabevariablen_en.png]]
Carina Enke 879.1 311
Carina Enke 896.1 312 If the certificate should contain output values from another course element, the course element ID must be specified in the placeholder. For example, this is the case if the certificate is created for a structure course element and output values are to be retrieved from a test course element. If the certificate is created directly for the test course element for which the user values should be displayed, %%OUTCOME:[variable name]%% will be sufficient as specification.
Carina Enke 879.1 313 {{/expand}}
314 )))
315 )))
Carina Enke 896.1 316 |(((
317 (% style="letter-spacing:0.0px" %)%%SEMESTER%%
Carina Enke 787.1 318 )))|(((
319 Semester
320 )))
Carina Enke 896.1 321 |(((
Carina Enke 787.1 322 %%USERNAME%%
323 )))|(((
Carina Enke 896.1 324 First and last name of the person receiving the certificate for their performance results.
Carina Enke 787.1 325 )))
326
Carina Enke 896.1 327 === Examples ===
Carina Enke 787.1 328
Carina Enke 879.1 329 {{panel bgColor="#dddddd"}}
Carina Enke 896.1 330 {{expand title="Display HTML example ..."}}
Carina Enke 879.1 331 {{code language="xml"}}
Carina Enke 787.1 332 <body>
333 <div id="center">
334 <!-- header-logo -->
335 <div id="header">
336 <div id="logo"></div>
337 </div>
338
339 <!-- content-part-->
340 <div id="content">
341 <h1>Zertifikat</h1>
342 <h2>%%USERNAME%%</h2>
343 <div>hat am</div>
344 <h3>%%CERTIFICATE_DATE%%</h3>
345 <div>den Kurs</div>
346 <h2>%%COURSE_TITLE%%</h2>
347 <div>erfolgreich absolviert.</div>
348 </div>
349
350 <!-- signature line -->
351 <div id="signature">
352 <h3>Dieses Zertifikat wurde automatisch von der Lernplattform erstellt.</h3>
353 </div>
354 <div class="clearfloat"></div>
355
356 <!-- footer-logo -->
357 <div id="footer">
358 </div>
359
360 </div>
361 </body>
362
363 {{/code}}
Carina Enke 879.1 364 {{/expand}}
365 {{/panel}}
Carina Enke 787.1 366
Carina Enke 879.1 367 {{panel bgColor="#dddddd"}}
Carina Enke 896.1 368 {{expand title="Display CSS example ..."}}
Carina Enke 879.1 369 {{code language="css"}}
Carina Enke 787.1 370 body {font-family: Verdana,Helvetica,Arial,sans-serif; margin: 0; padding: 0;}
371 h1 {color: #888; font-size: 4em; margin-bottom: 80px;}
372 h2 {font-size: 2em; padding-bottom: 0px; margin-top: 40px; margin-bottom: 40px;}
373 h3 {font-size: 1.6em;}
374 .floaterright {float: right;}
375 .clearfloat {clear: both;}
376 #center {margin: 0 auto; width: 900px;}
377 #header {height: 152px;background: url(certificate_header.png) no-repeat #eee; box-shadow: 0 4px 4px -2px #AAAAAA;}
378 #content {height: 900px; margin-top: 100px;}
379 #content div, #signature span {font-size: 1.6em;}
380 #content div, #content h1, #content h2, #content h3 {text-align: center;}
381 #signature {text-align: left; margin-left: 20px;}
382 #signature h3 {font-weight: normal; font-size: 1.3em; margin-bottom: 5px; margin-top: 5px;}
383 #signature span {font-size: 1em;}
384 #footer {margin-top: 35px; height: 50px; background: url(certificate_footer.png) no-repeat #eee;}
385 {{/code}}
Carina Enke 879.1 386 {{/expand}}
387 {{/panel}}