MoodleDocs - User contributions [en]

Adaptable theme

2020-11-16T14:31:50Z

Rcollman: /* Screenshots */ used better file name

{{Themes}}
{{Infobox plugin
|type = Theme
|entry = https://moodle.org/plugins/theme_adaptable
|tracker = https://bitbucket.org/covuni/moodle-theme_adaptable/issues
|discussion = [https://moodle.org/mod/forum/view.php?id=46 Themes Forum]
|maintainer = [[User:Jez H|Jez H]]
|float = right
}}
This is a [[:Category:Contributed_code|contributed (third party)]] highly customisable two column theme designed to work in a range of different situations. It is based on the popular [https://moodle.org/plugins/theme_bcu BCU theme]. '''Adaptable has all the features of BCU''' along with many new features.

==Features==
'''Layout Builders!''' You can now define a custom layout in the admin settings for:

* Block Regions (drag and drop)
* Marketing Blocks
* Footer Blocks
* Fully Customisable:
** Fonts
** Colors
** Block styles (including icons)
** Buttons (including radius)
* Choice of two [https://en.wikipedia.org/wiki/JQuery JQuery] sliders on [[My home|home page]] with customisable colors
* News / Announcements Ticker on [[My home|home]] / [[Dashboard]]
* Multiple [[Front page]] course styles
* Extensive custom menus (can be targeted to different users based on custom profile field)
* "My Courses" list can be organised to put older courses in sub menu item
* Dismissible Bootstrap Alerts
** Display sitewide notices using different Bootstrap styles
** Allow users to dismiss alerts once read (persistent between page loads / login)
** Allow re-use of alerts (display again even if user has dismissed) buy updating a "key" field
* Additional layout settings for width, slider width, padding of various elements
* Social icons or Search box in header (admin can choose between the two)
* Support for [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (thanks to Chris Kenniburg for help on this)
* Mobile settings (greater control of how the theme looks on mobile devices)
* Option to add login form in header on front page
* [https://en.wikipedia.org/wiki/Favicon Favicon] uploader
* Background image uploader

In addition, many fields (menus, news items, alerts and help links) can be targeted using custom profile fields, thus it is possible to present different users with different navigation items and notices.

It is also possible for individual users to customise where they want top menu navigation to appear (disable, [[My home|home pages]] only, sitewide) using custom profile fields.

==Demo Video==

[https://youtu.be/7bSDmp_gYqw YouTube video]

==Demo site==
[http://3-bits.com/demo/adaptable/ http://3-bits.com/demo/adaptable/]

==Screenshots==
<gallery mode=packed heights=300px style="text-align:left">
File: adaptable_layout.png|Adaptable theme layout
File:adaptable-select.png|Adaptable select
File:adaptable-front-page.png|adaptable-front-page
File:adaptable-alerts.PNG|adaptable-alerts
File:reduced_adaptable-colors.png|reduced_adaptable-colors
File:adaptable-fonts.png|adaptable-fonts
File:block-region-builder.png|block-region-builder
File:block-region-front-page.png|block-region-front-page
File:adaptable-mobile-social-on.PNG|adaptable-mobile-social-on
</gallery>

==Download==
From the [https://moodle.org/plugins/theme_adaptable Moodle plugins database].

==Installation==
There are several ways to install the Adaptable theme.
* Review [[Installing_plugins#Installing_a_plugin]] Plugin installation section
* Make sure the Adaptable theme is compatible with your Moodle version
* After installing the Adaptable theme, [[Installing_a_new_theme|change the site theme]] on one or more devices to the Adaptable theme

==Configuration==
Adaptable has a lot of settings and may seem daunting at first, our advice is to simply install with the default settings and play with it afterwards.

With a little time you should be able to setup an attractive Moodle site with a high degree of individuality without knowing any CSS.

You can work on configuring the theme without it being live on your site by putting ''theme=adaptable'' or ''theme=clean'' into the URL. See [[Allow theme change by URL]].

==Theme settings that will be linked to by 'Moodle Docs for this page'==

===Colours===
You can select the colours that you would like to use throughout the theme. Use [https://en.wikipedia.org/wiki/Web_colors Hexadecimal color notation] or any other standard notation. As an alternate option you can use transparent and inherited as a value

===Fonts===
You can select the [https://en.wikipedia.org/wiki/Google_Fonts Google Fonts] that you would like to use throughout the theme. Select the subset needed (latin is always included) and enter the right font weight or the font will not displayed.

===Buttons===
Alter the appearance of buttons used in this theme. Configure as needed.

===Header===
* Customize the header of this theme.
* Upload your [https://en.wikipedia.org/wiki/Favicon favicon], logo, set login form in header, adjust titles in header.
* You can set font size and styles for titles in the "fonts" settings page.

===Header Menus===
* Tools Menus (in navbar) and Top Menus (upper header) can be restricted based on custom profile fields (optional).
* To add a restriction enter the name of the profile field and expected value.
* Menu Structure follows the common Moodle format:
Moodle community|https://moodle.org
-Moodle free support|https://moodle.org/support
-Moodle development|https://moodle.org/development
--Moodle Docs|http://docs.moodle.org
--German Moodle Docs|http://docs.moodle.org/de
Moodle.com|http://moodle.com/

* General settings for Top Menu visibility
** These settings allow you to control where menus appear and optionally allow users to customise their settings

===Header User===
Allows you to control all of the elements that appear in the user navigation dropdown.

===Header Social===
* You can disable the sitewide search box and enable social icons / links in its place.
* To setup icons enter a de-limited list into the "Social Icon List" field below.
* This should be in the format:
url|title|icon

** For example:
http://localhost/moodle/course/search.php|Search Moodle|fa-search
http://facebook.com/|Facebook|fa-facebook-square
http://twitter.com/|Twitter|fa-twitter-square
http://instagram.com|Instagram|fa-instagram

* For reference you can find the full [http://fortawesome.github.io/Font-Awesome/icons/ list of Font Awesome Icons Here]

===Header Navbar===
... customize as needed ...

===Header Tools Menu===
... customize as needed ...

===Block Settings===
... customize as needed ...

===Block Region Builder===
* You can build your own layout for block regions on the [[Front page]].
* To add content these regions you will need to [[Turn editing on]] on the [[Front page]] of Moodle.
* Then you can begin to drag/drop blocks into the regions you create!

===Course Sections===
... customize as needed ...

===Marketing Blocks===
* There are two full width info boxes witht differing styles you can use.
* In addition to this there is a layout builder, allowing you to decide how many blocks you need and define your own layout.
* Please see the README file that comes with this theme.

===Front page Courses===
Configure the way that the course boxes are rendered on the [[Front page]].

===Frontpage Ticker===
* Here you can set a news ticker to run across the [[Front page]] of your Moodle site.
* It is intended as a less intrusive alternative to the slider, taking up very little space.
* To setup your ticker, simply entere a bulleted list and include any hyperlinks you need to in that text.
* Note: you must not put ul tags around our list, only li. Moodles [[Text editor]] tends to add ul tags.
* If your ticker does not load properly, switch to [[HTML]] view and ensure you have only li tags:

<code php>
<li>News item one.....</li>
<li>News item two.....</li>
</code>

===Frontpage Slider===
* Upload the images, add the links and description for the carousel on the [[Front page]].
* Sample [[HTML]] for Slider Captions:

<code php>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Please favorite our theme!</a>
</code>

===Alert Box===
* Enter and customize a text to be displayed in the top of the site as an alert.
* It is possible to set more than one alert to target different user types.
* You also have the option of showing alerts sitewide or on [[My home|homepages]] only.

===Layout===
Set the default layout that users see.

===Footer===
Set the content that should appear in the footer

===Mobile Settings===
Control how your site looks on mobile devices

===Social Wall===
Customise the appearance of the [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (if in use on your site)

===Custom CSS & JS===
Here you can find various settings to add your own [[CSS]] and [https://en.wikipedia.org/wiki/JavaScript JavaScript] code to the theme.

===Analytics===
You can setup multiple codes for [https://en.wikipedia.org/wiki/Google_Analytics Google Analytics] and targed them to user profile fields.

==Migration from BCU to Adaptable==

Advice on migrating from BCU to Adaptable can be found [https://moodle.org/mod/forum/discuss.php?d=326470 here]

==[[HTML]] code for settings and block areas==

Here you will find some code samples to help you to customize the Info Box and the Marketing Blocks

You can insert any [[HTML]] tag to customize the [[Front page]] blocks. Use a <nowiki> <div> </nowiki> as a main container and add the
height to keep the same value in all the blocks.

The Font Awesome icons set is available in http://fortawesome.github.io/Font-Awesome/icons/.
You can insert any of them and following the examples in http://fortawesome.github.io/Font-Awesome/examples/

===Front Page Slider Styles===

There are two possible slider styles each with different markup required:

====Original BCU Slider Markup====

<code css>
<div class="span9">

<h4>Information</h4>

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
</div>

<div class="span3">

<a href="#" class="submit">2013/14 Courses <i class="fa-chevron-right fa"></i></a>

</div>
</code>
====Coventry Style Slider Markup====

<code css>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Check out our custom theme pricing!</a>
</div>
</code>

===Frontpage Marketing Block HTML structure Coventry===

<code css>
<div><img src="http://somewebsite.com/2.jpg" class="marketimage"></div>
<h4><a href="#">International Courses</a></h4>
<p>Some text below the link....</p>
</code>

===Front page Info Block===

There are two Info blocks in the frontpage located above and below the Marketing Blocks. See pix/layout.png

===Simple box with solid background and using a default heading===
<code css>
<div style="text-align:center; background: #f0f0f0;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>

===Simple box with solid background colour, default heading h3 and white text colour===
<code css>
<div style="text-align:center; background: #009688; color: #ffffff;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>

===Front Page Secondary Info Block Example===

You can apply additional styles to the secondary info block:

<code css>
<div class="span2 personpic">
<div id="person" class="spn5">
<img src="/urltoanimage.jpg" alt="person">
</div>
</div>

<div class="span10">
<h4>School of Jewelry</h4>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
<a href="#" class="submit">Learn more... <i class="fa-chevron-right fa"></i></a>
</div>
</code>

===Frontpage Marketing Block HTML===

You can add up to 12 Marketing Blocks in the [[Front page]].
The blocks are located automatically in rows, with a maximum of 4 blocks per row.
The full width is divided equally between the blocks.

===Simple Block with white background and Font Awesome icon. Using the default text colour and h3 heading===
<code css>
<div style="text-align:center; background: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-font fa-5x"></i>
<h3 style="color: #333333;">TITLE</h3>
<div style="text-align:center;">Add your text here</div>
</div>
</code>

===Block with solid background colour, white text colour and Font Awesome icon===
<code css>
<div style="text-align:center; background: #4b4b4b; color: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-th fa-5x"></i>
<h3 style="color: #ffffff;">TITLE</h3>
<div style="text-align:center; padding: 5px;">Add your text here</div>
</div>
</code>

===Block with solid background, white text colour and text aligned vertically (useful for blocks 100% wide)===
<code css>
<div style="background: #c2185b; height: 120px;">
<h1 style="line-height: 120px; color: #ffffff; text-align: center; "><b>moodle 3.0 ready !!!</b></h1>
</div>
</code>

===Footer Blocks===

Contact information
<code css>
<i class="fa fa-building"></i> High St. 100<br>
<span style="margin-left: 20px;">123456 City</span><br><br>
<i class="fa fa-phone"></i> +12 (3)456 78 90<br>
<i class="fa fa-envelope"></i> info@mail.com<br>
<i class="fa fa-globe"></i> www.example.com
</code>

List with Chevron
<code css>
<ul class="block-list white">
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Accessibility</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Feedback</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Feedback</span></a></li>
</ul>
</nowiki>
</code>

==Credits==

* Adaptable is a fork of [https://moodle.org/plugins/theme_bcu BCU theme] and owes its existence to all those credited on that theme
* Adaptable development was driven by [https://3-bits.com/en/ 3Bits E-Learning Solutions] and [https://en.wikipedia.org/wiki/Coventry_University Coventry University]
* Persistence of Bootstrap Alerts provided by [https://moodle.org/user/profile.php?id=14534 Justin Hunt] in between mowing lawns and brokering cease fires (see his [http://poodll.com/services/ Moodle Services page])
* Ideas on [https://moodle.org/plugins/format_socialwall Social Wall] support provided by [https://moodle.org/user/profile.php?id=26675 Chris Kenniburg]
* Help with renderers and other tricky stuff provided by [https://moodle.org/user/profile.php?id=713800 Mary Evans] and [https://moodle.org/user/profile.php?id=442195 Gareth J BarnardH]
* Additional support provided by [http://www.newschoollearning.com/?from=@ New School Learning]

==Support==

Please post your questions in the [https://moodle.org/mod/forum/view.php?id=46 Themes Forum].

'''We do not provide direct support'''

==See also==
The authors documentation page at [https://bitbucket.org/covuni/moodle-theme_adaptable https://bitbucket.org/covuni/moodle-theme_adaptable]

[[es:Tema Adaptable]]

File:adaptable layout.png

2020-11-16T14:29:43Z

Rcollman: from moodle>theme>adaptable>pix

from moodle>theme>adaptable>pix

Adaptable theme

2020-11-16T14:26:06Z

Rcollman: /* Screenshots */ Added layout image

{{Themes}}
{{Infobox plugin
|type = Theme
|entry = https://moodle.org/plugins/theme_adaptable
|tracker = https://bitbucket.org/covuni/moodle-theme_adaptable/issues
|discussion = [https://moodle.org/mod/forum/view.php?id=46 Themes Forum]
|maintainer = [[User:Jez H|Jez H]]
|float = right
}}
This is a [[:Category:Contributed_code|contributed (third party)]] highly customisable two column theme designed to work in a range of different situations. It is based on the popular [https://moodle.org/plugins/theme_bcu BCU theme]. '''Adaptable has all the features of BCU''' along with many new features.

==Features==
'''Layout Builders!''' You can now define a custom layout in the admin settings for:

* Block Regions (drag and drop)
* Marketing Blocks
* Footer Blocks
* Fully Customisable:
** Fonts
** Colors
** Block styles (including icons)
** Buttons (including radius)
* Choice of two [https://en.wikipedia.org/wiki/JQuery JQuery] sliders on [[My home|home page]] with customisable colors
* News / Announcements Ticker on [[My home|home]] / [[Dashboard]]
* Multiple [[Front page]] course styles
* Extensive custom menus (can be targeted to different users based on custom profile field)
* "My Courses" list can be organised to put older courses in sub menu item
* Dismissible Bootstrap Alerts
** Display sitewide notices using different Bootstrap styles
** Allow users to dismiss alerts once read (persistent between page loads / login)
** Allow re-use of alerts (display again even if user has dismissed) buy updating a "key" field
* Additional layout settings for width, slider width, padding of various elements
* Social icons or Search box in header (admin can choose between the two)
* Support for [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (thanks to Chris Kenniburg for help on this)
* Mobile settings (greater control of how the theme looks on mobile devices)
* Option to add login form in header on front page
* [https://en.wikipedia.org/wiki/Favicon Favicon] uploader
* Background image uploader

In addition, many fields (menus, news items, alerts and help links) can be targeted using custom profile fields, thus it is possible to present different users with different navigation items and notices.

It is also possible for individual users to customise where they want top menu navigation to appear (disable, [[My home|home pages]] only, sitewide) using custom profile fields.

==Demo Video==

[https://youtu.be/7bSDmp_gYqw YouTube video]

==Demo site==
[http://3-bits.com/demo/adaptable/ http://3-bits.com/demo/adaptable/]

==Screenshots==
<gallery mode=packed heights=300px style="text-align:left">
File:Moodle adaptable_layout,png|Adaptable theme layout
File:adaptable-select.png|Adaptable select
File:adaptable-front-page.png|adaptable-front-page
File:adaptable-alerts.PNG|adaptable-alerts
File:reduced_adaptable-colors.png|reduced_adaptable-colors
File:adaptable-fonts.png|adaptable-fonts
File:block-region-builder.png|block-region-builder
File:block-region-front-page.png|block-region-front-page
File:adaptable-mobile-social-on.PNG|adaptable-mobile-social-on
</gallery>

==Download==
From the [https://moodle.org/plugins/theme_adaptable Moodle plugins database].

==Installation==
There are several ways to install the Adaptable theme.
* Review [[Installing_plugins#Installing_a_plugin]] Plugin installation section
* Make sure the Adaptable theme is compatible with your Moodle version
* After installing the Adaptable theme, [[Installing_a_new_theme|change the site theme]] on one or more devices to the Adaptable theme

==Configuration==
Adaptable has a lot of settings and may seem daunting at first, our advice is to simply install with the default settings and play with it afterwards.

With a little time you should be able to setup an attractive Moodle site with a high degree of individuality without knowing any CSS.

You can work on configuring the theme without it being live on your site by putting ''theme=adaptable'' or ''theme=clean'' into the URL. See [[Allow theme change by URL]].

==Theme settings that will be linked to by 'Moodle Docs for this page'==

===Colours===
You can select the colours that you would like to use throughout the theme. Use [https://en.wikipedia.org/wiki/Web_colors Hexadecimal color notation] or any other standard notation. As an alternate option you can use transparent and inherited as a value

===Fonts===
You can select the [https://en.wikipedia.org/wiki/Google_Fonts Google Fonts] that you would like to use throughout the theme. Select the subset needed (latin is always included) and enter the right font weight or the font will not displayed.

===Buttons===
Alter the appearance of buttons used in this theme. Configure as needed.

===Header===
* Customize the header of this theme.
* Upload your [https://en.wikipedia.org/wiki/Favicon favicon], logo, set login form in header, adjust titles in header.
* You can set font size and styles for titles in the "fonts" settings page.

===Header Menus===
* Tools Menus (in navbar) and Top Menus (upper header) can be restricted based on custom profile fields (optional).
* To add a restriction enter the name of the profile field and expected value.
* Menu Structure follows the common Moodle format:
Moodle community|https://moodle.org
-Moodle free support|https://moodle.org/support
-Moodle development|https://moodle.org/development
--Moodle Docs|http://docs.moodle.org
--German Moodle Docs|http://docs.moodle.org/de
Moodle.com|http://moodle.com/

* General settings for Top Menu visibility
** These settings allow you to control where menus appear and optionally allow users to customise their settings

===Header User===
Allows you to control all of the elements that appear in the user navigation dropdown.

===Header Social===
* You can disable the sitewide search box and enable social icons / links in its place.
* To setup icons enter a de-limited list into the "Social Icon List" field below.
* This should be in the format:
url|title|icon

** For example:
http://localhost/moodle/course/search.php|Search Moodle|fa-search
http://facebook.com/|Facebook|fa-facebook-square
http://twitter.com/|Twitter|fa-twitter-square
http://instagram.com|Instagram|fa-instagram

* For reference you can find the full [http://fortawesome.github.io/Font-Awesome/icons/ list of Font Awesome Icons Here]

===Header Navbar===
... customize as needed ...

===Header Tools Menu===
... customize as needed ...

===Block Settings===
... customize as needed ...

===Block Region Builder===
* You can build your own layout for block regions on the [[Front page]].
* To add content these regions you will need to [[Turn editing on]] on the [[Front page]] of Moodle.
* Then you can begin to drag/drop blocks into the regions you create!

===Course Sections===
... customize as needed ...

===Marketing Blocks===
* There are two full width info boxes witht differing styles you can use.
* In addition to this there is a layout builder, allowing you to decide how many blocks you need and define your own layout.
* Please see the README file that comes with this theme.

===Front page Courses===
Configure the way that the course boxes are rendered on the [[Front page]].

===Frontpage Ticker===
* Here you can set a news ticker to run across the [[Front page]] of your Moodle site.
* It is intended as a less intrusive alternative to the slider, taking up very little space.
* To setup your ticker, simply entere a bulleted list and include any hyperlinks you need to in that text.
* Note: you must not put ul tags around our list, only li. Moodles [[Text editor]] tends to add ul tags.
* If your ticker does not load properly, switch to [[HTML]] view and ensure you have only li tags:

<code php>
<li>News item one.....</li>
<li>News item two.....</li>
</code>

===Frontpage Slider===
* Upload the images, add the links and description for the carousel on the [[Front page]].
* Sample [[HTML]] for Slider Captions:

<code php>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Please favorite our theme!</a>
</code>

===Alert Box===
* Enter and customize a text to be displayed in the top of the site as an alert.
* It is possible to set more than one alert to target different user types.
* You also have the option of showing alerts sitewide or on [[My home|homepages]] only.

===Layout===
Set the default layout that users see.

===Footer===
Set the content that should appear in the footer

===Mobile Settings===
Control how your site looks on mobile devices

===Social Wall===
Customise the appearance of the [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (if in use on your site)

===Custom CSS & JS===
Here you can find various settings to add your own [[CSS]] and [https://en.wikipedia.org/wiki/JavaScript JavaScript] code to the theme.

===Analytics===
You can setup multiple codes for [https://en.wikipedia.org/wiki/Google_Analytics Google Analytics] and targed them to user profile fields.

==Migration from BCU to Adaptable==

Advice on migrating from BCU to Adaptable can be found [https://moodle.org/mod/forum/discuss.php?d=326470 here]

==[[HTML]] code for settings and block areas==

Here you will find some code samples to help you to customize the Info Box and the Marketing Blocks

You can insert any [[HTML]] tag to customize the [[Front page]] blocks. Use a <nowiki> <div> </nowiki> as a main container and add the
height to keep the same value in all the blocks.

The Font Awesome icons set is available in http://fortawesome.github.io/Font-Awesome/icons/.
You can insert any of them and following the examples in http://fortawesome.github.io/Font-Awesome/examples/

===Front Page Slider Styles===

There are two possible slider styles each with different markup required:

====Original BCU Slider Markup====

<code css>
<div class="span9">

<h4>Information</h4>

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
</div>

<div class="span3">

<a href="#" class="submit">2013/14 Courses <i class="fa-chevron-right fa"></i></a>

</div>
</code>
====Coventry Style Slider Markup====

<code css>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Check out our custom theme pricing!</a>
</div>
</code>

===Frontpage Marketing Block HTML structure Coventry===

<code css>
<div><img src="http://somewebsite.com/2.jpg" class="marketimage"></div>
<h4><a href="#">International Courses</a></h4>
<p>Some text below the link....</p>
</code>

===Front page Info Block===

There are two Info blocks in the frontpage located above and below the Marketing Blocks. See pix/layout.png

===Simple box with solid background and using a default heading===
<code css>
<div style="text-align:center; background: #f0f0f0;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>

===Simple box with solid background colour, default heading h3 and white text colour===
<code css>
<div style="text-align:center; background: #009688; color: #ffffff;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>

===Front Page Secondary Info Block Example===

You can apply additional styles to the secondary info block:

<code css>
<div class="span2 personpic">
<div id="person" class="spn5">
<img src="/urltoanimage.jpg" alt="person">
</div>
</div>

<div class="span10">
<h4>School of Jewelry</h4>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
<a href="#" class="submit">Learn more... <i class="fa-chevron-right fa"></i></a>
</div>
</code>

===Frontpage Marketing Block HTML===

You can add up to 12 Marketing Blocks in the [[Front page]].
The blocks are located automatically in rows, with a maximum of 4 blocks per row.
The full width is divided equally between the blocks.

===Simple Block with white background and Font Awesome icon. Using the default text colour and h3 heading===
<code css>
<div style="text-align:center; background: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-font fa-5x"></i>
<h3 style="color: #333333;">TITLE</h3>
<div style="text-align:center;">Add your text here</div>
</div>
</code>

===Block with solid background colour, white text colour and Font Awesome icon===
<code css>
<div style="text-align:center; background: #4b4b4b; color: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-th fa-5x"></i>
<h3 style="color: #ffffff;">TITLE</h3>
<div style="text-align:center; padding: 5px;">Add your text here</div>
</div>
</code>

===Block with solid background, white text colour and text aligned vertically (useful for blocks 100% wide)===
<code css>
<div style="background: #c2185b; height: 120px;">
<h1 style="line-height: 120px; color: #ffffff; text-align: center; "><b>moodle 3.0 ready !!!</b></h1>
</div>
</code>

===Footer Blocks===

Contact information
<code css>
<i class="fa fa-building"></i> High St. 100<br>
<span style="margin-left: 20px;">123456 City</span><br><br>
<i class="fa fa-phone"></i> +12 (3)456 78 90<br>
<i class="fa fa-envelope"></i> info@mail.com<br>
<i class="fa fa-globe"></i> www.example.com
</code>

List with Chevron
<code css>
<ul class="block-list white">
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Accessibility</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Feedback</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Feedback</span></a></li>
</ul>
</nowiki>
</code>

==Credits==

* Adaptable is a fork of [https://moodle.org/plugins/theme_bcu BCU theme] and owes its existence to all those credited on that theme
* Adaptable development was driven by [https://3-bits.com/en/ 3Bits E-Learning Solutions] and [https://en.wikipedia.org/wiki/Coventry_University Coventry University]
* Persistence of Bootstrap Alerts provided by [https://moodle.org/user/profile.php?id=14534 Justin Hunt] in between mowing lawns and brokering cease fires (see his [http://poodll.com/services/ Moodle Services page])
* Ideas on [https://moodle.org/plugins/format_socialwall Social Wall] support provided by [https://moodle.org/user/profile.php?id=26675 Chris Kenniburg]
* Help with renderers and other tricky stuff provided by [https://moodle.org/user/profile.php?id=713800 Mary Evans] and [https://moodle.org/user/profile.php?id=442195 Gareth J BarnardH]
* Additional support provided by [http://www.newschoollearning.com/?from=@ New School Learning]

==Support==

Please post your questions in the [https://moodle.org/mod/forum/view.php?id=46 Themes Forum].

'''We do not provide direct support'''

==See also==
The authors documentation page at [https://bitbucket.org/covuni/moodle-theme_adaptable https://bitbucket.org/covuni/moodle-theme_adaptable]

[[es:Tema Adaptable]]

User:Chris collman

2020-11-13T18:52:12Z

Rcollman:

[[https://moodle.org/user/profile.php?id=105471 Click here]] for my Moodle profile. I have been editing Moodle Docs off and on since 2006.

Best Chris (aka rcollman)

User:Chris collman

2020-11-13T18:47:16Z

Rcollman: another tweak

[[https://moodle.org/user/profile.php?id=105471 Click here]] for my Moodle profile. I have been around.

Best Chris (aka rcollman)

User:Chris collman

2020-11-13T18:46:18Z

Rcollman: cut down and put link to moodle profile

[[https://moodle.org/user/profile.php?id=105471]] for my Moodle profile. I have been around.
Best Chris (aka rcollman)

Adaptable theme

2020-11-13T18:36:26Z

Rcollman: changed discussion link from thread to forum

{{Themes}}
{{Infobox plugin
|type = Theme
|entry = https://moodle.org/plugins/theme_adaptable
|tracker = https://bitbucket.org/covuni/moodle-theme_adaptable/issues
|discussion = [https://moodle.org/mod/forum/view.php?id=46 Themes Forum]
|maintainer = [[User:Jez H|Jez H]]
|float = right
}}
This is a [[:Category:Contributed_code|contributed (third party)]] highly customisable two column theme designed to work in a range of different situations. It is based on the popular [https://moodle.org/plugins/theme_bcu BCU theme]. '''Adaptable has all the features of BCU''' along with many new features.

==Features==
'''Layout Builders!''' You can now define a custom layout in the admin settings for:

* Block Regions (drag and drop)
* Marketing Blocks
* Footer Blocks
* Fully Customisable:
** Fonts
** Colors
** Block styles (including icons)
** Buttons (including radius)
* Choice of two [https://en.wikipedia.org/wiki/JQuery JQuery] sliders on [[My home|home page]] with customisable colors
* News / Announcements Ticker on [[My home|home]] / [[Dashboard]]
* Multiple [[Front page]] course styles
* Extensive custom menus (can be targeted to different users based on custom profile field)
* "My Courses" list can be organised to put older courses in sub menu item
* Dismissible Bootstrap Alerts
** Display sitewide notices using different Bootstrap styles
** Allow users to dismiss alerts once read (persistent between page loads / login)
** Allow re-use of alerts (display again even if user has dismissed) buy updating a "key" field
* Additional layout settings for width, slider width, padding of various elements
* Social icons or Search box in header (admin can choose between the two)
* Support for [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (thanks to Chris Kenniburg for help on this)
* Mobile settings (greater control of how the theme looks on mobile devices)
* Option to add login form in header on front page
* [https://en.wikipedia.org/wiki/Favicon Favicon] uploader
* Background image uploader

In addition, many fields (menus, news items, alerts and help links) can be targeted using custom profile fields, thus it is possible to present different users with different navigation items and notices.

It is also possible for individual users to customise where they want top menu navigation to appear (disable, [[My home|home pages]] only, sitewide) using custom profile fields.

==Demo Video==

[https://youtu.be/7bSDmp_gYqw YouTube video]

==Demo site==
[http://3-bits.com/demo/adaptable/ http://3-bits.com/demo/adaptable/]

==Screenshots==
<gallery mode=packed heights=300px style="text-align:left">
File:adaptable-select.png|Adaptable select
File:adaptable-front-page.png|adaptable-front-page
File:adaptable-alerts.PNG|adaptable-alerts
File:reduced_adaptable-colors.png|reduced_adaptable-colors
File:adaptable-fonts.png|adaptable-fonts
File:block-region-builder.png|block-region-builder
File:block-region-front-page.png|block-region-front-page
File:adaptable-mobile-social-on.PNG|adaptable-mobile-social-on
</gallery>

==Download==
From the [https://moodle.org/plugins/theme_adaptable Moodle plugins database].

==Installation==
There are several ways to install the Adaptable theme.
* Review [[Installing_plugins#Installing_a_plugin]] Plugin installation section
* Make sure the Adaptable theme is compatible with your Moodle version
* After installing the Adaptable theme, [[Installing_a_new_theme|change the site theme]] on one or more devices to the Adaptable theme

==Configuration==
Adaptable has a lot of settings and may seem daunting at first, our advice is to simply install with the default settings and play with it afterwards.

With a little time you should be able to setup an attractive Moodle site with a high degree of individuality without knowing any CSS.

You can work on configuring the theme without it being live on your site by putting ''theme=adaptable'' or ''theme=clean'' into the URL. See [[Allow theme change by URL]].

==Theme settings that will be linked to by 'Moodle Docs for this page'==

===Colours===
You can select the colours that you would like to use throughout the theme. Use [https://en.wikipedia.org/wiki/Web_colors Hexadecimal color notation] or any other standard notation. As an alternate option you can use transparent and inherited as a value

===Fonts===
You can select the [https://en.wikipedia.org/wiki/Google_Fonts Google Fonts] that you would like to use throughout the theme. Select the subset needed (latin is always included) and enter the right font weight or the font will not displayed.

===Buttons===
Alter the appearance of buttons used in this theme. Configure as needed.

===Header===
* Customize the header of this theme.
* Upload your [https://en.wikipedia.org/wiki/Favicon favicon], logo, set login form in header, adjust titles in header.
* You can set font size and styles for titles in the "fonts" settings page.

===Header Menus===
* Tools Menus (in navbar) and Top Menus (upper header) can be restricted based on custom profile fields (optional).
* To add a restriction enter the name of the profile field and expected value.
* Menu Structure follows the common Moodle format:
Moodle community|https://moodle.org
-Moodle free support|https://moodle.org/support
-Moodle development|https://moodle.org/development
--Moodle Docs|http://docs.moodle.org
--German Moodle Docs|http://docs.moodle.org/de
Moodle.com|http://moodle.com/

* General settings for Top Menu visibility
** These settings allow you to control where menus appear and optionally allow users to customise their settings

===Header User===
Allows you to control all of the elements that appear in the user navigation dropdown.

===Header Social===
* You can disable the sitewide search box and enable social icons / links in its place.
* To setup icons enter a de-limited list into the "Social Icon List" field below.
* This should be in the format:
url|title|icon

** For example:
http://localhost/moodle/course/search.php|Search Moodle|fa-search
http://facebook.com/|Facebook|fa-facebook-square
http://twitter.com/|Twitter|fa-twitter-square
http://instagram.com|Instagram|fa-instagram

* For reference you can find the full [http://fortawesome.github.io/Font-Awesome/icons/ list of Font Awesome Icons Here]

===Header Navbar===
... customize as needed ...

===Header Tools Menu===
... customize as needed ...

===Block Settings===
... customize as needed ...

===Block Region Builder===
* You can build your own layout for block regions on the [[Front page]].
* To add content these regions you will need to [[Turn editing on]] on the [[Front page]] of Moodle.
* Then you can begin to drag/drop blocks into the regions you create!

===Course Sections===
... customize as needed ...

===Marketing Blocks===
* There are two full width info boxes witht differing styles you can use.
* In addition to this there is a layout builder, allowing you to decide how many blocks you need and define your own layout.
* Please see the README file that comes with this theme.

===Front page Courses===
Configure the way that the course boxes are rendered on the [[Front page]].

===Frontpage Ticker===
* Here you can set a news ticker to run across the [[Front page]] of your Moodle site.
* It is intended as a less intrusive alternative to the slider, taking up very little space.
* To setup your ticker, simply entere a bulleted list and include any hyperlinks you need to in that text.
* Note: you must not put ul tags around our list, only li. Moodles [[Text editor]] tends to add ul tags.
* If your ticker does not load properly, switch to [[HTML]] view and ensure you have only li tags:

<code php>
<li>News item one.....</li>
<li>News item two.....</li>
</code>

===Frontpage Slider===
* Upload the images, add the links and description for the carousel on the [[Front page]].
* Sample [[HTML]] for Slider Captions:

<code php>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Please favorite our theme!</a>
</code>

===Alert Box===
* Enter and customize a text to be displayed in the top of the site as an alert.
* It is possible to set more than one alert to target different user types.
* You also have the option of showing alerts sitewide or on [[My home|homepages]] only.

===Layout===
Set the default layout that users see.

===Footer===
Set the content that should appear in the footer

===Mobile Settings===
Control how your site looks on mobile devices

===Social Wall===
Customise the appearance of the [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (if in use on your site)

===Custom CSS & JS===
Here you can find various settings to add your own [[CSS]] and [https://en.wikipedia.org/wiki/JavaScript JavaScript] code to the theme.

===Analytics===
You can setup multiple codes for [https://en.wikipedia.org/wiki/Google_Analytics Google Analytics] and targed them to user profile fields.

==Migration from BCU to Adaptable==

Advice on migrating from BCU to Adaptable can be found [https://moodle.org/mod/forum/discuss.php?d=326470 here]

==[[HTML]] code for settings and block areas==

Here you will find some code samples to help you to customize the Info Box and the Marketing Blocks

You can insert any [[HTML]] tag to customize the [[Front page]] blocks. Use a <nowiki> <div> </nowiki> as a main container and add the
height to keep the same value in all the blocks.

The Font Awesome icons set is available in http://fortawesome.github.io/Font-Awesome/icons/.
You can insert any of them and following the examples in http://fortawesome.github.io/Font-Awesome/examples/

===Front Page Slider Styles===

There are two possible slider styles each with different markup required:

====Original BCU Slider Markup====

<code css>
<div class="span9">

<h4>Information</h4>

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
</div>

<div class="span3">

<a href="#" class="submit">2013/14 Courses <i class="fa-chevron-right fa"></i></a>

</div>
</code>
====Coventry Style Slider Markup====

<code css>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Check out our custom theme pricing!</a>
</div>
</code>

===Frontpage Marketing Block HTML structure Coventry===

<code css>
<div><img src="http://somewebsite.com/2.jpg" class="marketimage"></div>
<h4><a href="#">International Courses</a></h4>
<p>Some text below the link....</p>
</code>

===Front page Info Block===

There are two Info blocks in the frontpage located above and below the Marketing Blocks. See pix/layout.png

===Simple box with solid background and using a default heading===
<code css>
<div style="text-align:center; background: #f0f0f0;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>

===Simple box with solid background colour, default heading h3 and white text colour===
<code css>
<div style="text-align:center; background: #009688; color: #ffffff;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>

===Front Page Secondary Info Block Example===

You can apply additional styles to the secondary info block:

<code css>
<div class="span2 personpic">
<div id="person" class="spn5">
<img src="/urltoanimage.jpg" alt="person">
</div>
</div>

<div class="span10">
<h4>School of Jewelry</h4>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
<a href="#" class="submit">Learn more... <i class="fa-chevron-right fa"></i></a>
</div>
</code>

===Frontpage Marketing Block HTML===

You can add up to 12 Marketing Blocks in the [[Front page]].
The blocks are located automatically in rows, with a maximum of 4 blocks per row.
The full width is divided equally between the blocks.

===Simple Block with white background and Font Awesome icon. Using the default text colour and h3 heading===
<code css>
<div style="text-align:center; background: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-font fa-5x"></i>
<h3 style="color: #333333;">TITLE</h3>
<div style="text-align:center;">Add your text here</div>
</div>
</code>

===Block with solid background colour, white text colour and Font Awesome icon===
<code css>
<div style="text-align:center; background: #4b4b4b; color: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-th fa-5x"></i>
<h3 style="color: #ffffff;">TITLE</h3>
<div style="text-align:center; padding: 5px;">Add your text here</div>
</div>
</code>

===Block with solid background, white text colour and text aligned vertically (useful for blocks 100% wide)===
<code css>
<div style="background: #c2185b; height: 120px;">
<h1 style="line-height: 120px; color: #ffffff; text-align: center; "><b>moodle 3.0 ready !!!</b></h1>
</div>
</code>

===Footer Blocks===

Contact information
<code css>
<i class="fa fa-building"></i> High St. 100<br>
<span style="margin-left: 20px;">123456 City</span><br><br>
<i class="fa fa-phone"></i> +12 (3)456 78 90<br>
<i class="fa fa-envelope"></i> info@mail.com<br>
<i class="fa fa-globe"></i> www.example.com
</code>

List with Chevron
<code css>
<ul class="block-list white">
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Accessibility</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Feedback</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Feedback</span></a></li>
</ul>
</nowiki>
</code>

==Credits==

* Adaptable is a fork of [https://moodle.org/plugins/theme_bcu BCU theme] and owes its existence to all those credited on that theme
* Adaptable development was driven by [https://3-bits.com/en/ 3Bits E-Learning Solutions] and [https://en.wikipedia.org/wiki/Coventry_University Coventry University]
* Persistence of Bootstrap Alerts provided by [https://moodle.org/user/profile.php?id=14534 Justin Hunt] in between mowing lawns and brokering cease fires (see his [http://poodll.com/services/ Moodle Services page])
* Ideas on [https://moodle.org/plugins/format_socialwall Social Wall] support provided by [https://moodle.org/user/profile.php?id=26675 Chris Kenniburg]
* Help with renderers and other tricky stuff provided by [https://moodle.org/user/profile.php?id=713800 Mary Evans] and [https://moodle.org/user/profile.php?id=442195 Gareth J BarnardH]
* Additional support provided by [http://www.newschoollearning.com/?from=@ New School Learning]

==Support==

Please post your questions in the [https://moodle.org/mod/forum/view.php?id=46 Themes Forum].

'''We do not provide direct support'''

==See also==
The authors documentation page at [https://bitbucket.org/covuni/moodle-theme_adaptable https://bitbucket.org/covuni/moodle-theme_adaptable]

[[es:Tema Adaptable]]

Adaptable theme

2020-11-13T18:29:42Z

Rcollman: /* Screenshots */tweaked

{{Themes}}
{{Infobox plugin
|type = Theme
|entry = https://moodle.org/plugins/theme_adaptable
|tracker = https://bitbucket.org/covuni/moodle-theme_adaptable/issues
|discussion = https://moodle.org/mod/forum/discuss.php?d=326234
|maintainer = [[User:Jez H|Jez H]]
|float = right
}}
This is a [[:Category:Contributed_code|contributed (third party)]] highly customisable two column theme designed to work in a range of different situations. It is based on the popular [https://moodle.org/plugins/theme_bcu BCU theme]. '''Adaptable has all the features of BCU''' along with many new features.

==Features==
'''Layout Builders!''' You can now define a custom layout in the admin settings for:

* Block Regions (drag and drop)
* Marketing Blocks
* Footer Blocks
* Fully Customisable:
** Fonts
** Colors
** Block styles (including icons)
** Buttons (including radius)
* Choice of two [https://en.wikipedia.org/wiki/JQuery JQuery] sliders on [[My home|home page]] with customisable colors
* News / Announcements Ticker on [[My home|home]] / [[Dashboard]]
* Multiple [[Front page]] course styles
* Extensive custom menus (can be targeted to different users based on custom profile field)
* "My Courses" list can be organised to put older courses in sub menu item
* Dismissible Bootstrap Alerts
** Display sitewide notices using different Bootstrap styles
** Allow users to dismiss alerts once read (persistent between page loads / login)
** Allow re-use of alerts (display again even if user has dismissed) buy updating a "key" field
* Additional layout settings for width, slider width, padding of various elements
* Social icons or Search box in header (admin can choose between the two)
* Support for [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (thanks to Chris Kenniburg for help on this)
* Mobile settings (greater control of how the theme looks on mobile devices)
* Option to add login form in header on front page
* [https://en.wikipedia.org/wiki/Favicon Favicon] uploader
* Background image uploader

In addition, many fields (menus, news items, alerts and help links) can be targeted using custom profile fields, thus it is possible to present different users with different navigation items and notices.

It is also possible for individual users to customise where they want top menu navigation to appear (disable, [[My home|home pages]] only, sitewide) using custom profile fields.

==Demo Video==

[https://youtu.be/7bSDmp_gYqw YouTube video]

==Demo site==
[http://3-bits.com/demo/adaptable/ http://3-bits.com/demo/adaptable/]

==Screenshots==
<gallery mode=packed heights=300px style="text-align:left">
File:adaptable-select.png|Adaptable select
File:adaptable-front-page.png|adaptable-front-page
File:adaptable-alerts.PNG|adaptable-alerts
File:reduced_adaptable-colors.png|reduced_adaptable-colors
File:adaptable-fonts.png|adaptable-fonts
File:block-region-builder.png|block-region-builder
File:block-region-front-page.png|block-region-front-page
File:adaptable-mobile-social-on.PNG|adaptable-mobile-social-on
</gallery>

==Download==
From the [https://moodle.org/plugins/theme_adaptable Moodle plugins database].

==Installation==
There are several ways to install the Adaptable theme.
* Review [[Installing_plugins#Installing_a_plugin]] Plugin installation section
* Make sure the Adaptable theme is compatible with your Moodle version
* After installing the Adaptable theme, [[Installing_a_new_theme|change the site theme]] on one or more devices to the Adaptable theme

==Configuration==
Adaptable has a lot of settings and may seem daunting at first, our advice is to simply install with the default settings and play with it afterwards.

With a little time you should be able to setup an attractive Moodle site with a high degree of individuality without knowing any CSS.

You can work on configuring the theme without it being live on your site by putting ''theme=adaptable'' or ''theme=clean'' into the URL. See [[Allow theme change by URL]].

==Theme settings that will be linked to by 'Moodle Docs for this page'==

===Colours===
You can select the colours that you would like to use throughout the theme. Use [https://en.wikipedia.org/wiki/Web_colors Hexadecimal color notation] or any other standard notation. As an alternate option you can use transparent and inherited as a value

===Fonts===
You can select the [https://en.wikipedia.org/wiki/Google_Fonts Google Fonts] that you would like to use throughout the theme. Select the subset needed (latin is always included) and enter the right font weight or the font will not displayed.

===Buttons===
Alter the appearance of buttons used in this theme. Configure as needed.

===Header===
* Customize the header of this theme.
* Upload your [https://en.wikipedia.org/wiki/Favicon favicon], logo, set login form in header, adjust titles in header.
* You can set font size and styles for titles in the "fonts" settings page.

===Header Menus===
* Tools Menus (in navbar) and Top Menus (upper header) can be restricted based on custom profile fields (optional).
* To add a restriction enter the name of the profile field and expected value.
* Menu Structure follows the common Moodle format:
Moodle community|https://moodle.org
-Moodle free support|https://moodle.org/support
-Moodle development|https://moodle.org/development
--Moodle Docs|http://docs.moodle.org
--German Moodle Docs|http://docs.moodle.org/de
Moodle.com|http://moodle.com/

* General settings for Top Menu visibility
** These settings allow you to control where menus appear and optionally allow users to customise their settings

===Header User===
Allows you to control all of the elements that appear in the user navigation dropdown.

===Header Social===
* You can disable the sitewide search box and enable social icons / links in its place.
* To setup icons enter a de-limited list into the "Social Icon List" field below.
* This should be in the format:
url|title|icon

** For example:
http://localhost/moodle/course/search.php|Search Moodle|fa-search
http://facebook.com/|Facebook|fa-facebook-square
http://twitter.com/|Twitter|fa-twitter-square
http://instagram.com|Instagram|fa-instagram

* For reference you can find the full [http://fortawesome.github.io/Font-Awesome/icons/ list of Font Awesome Icons Here]

===Header Navbar===
... customize as needed ...

===Header Tools Menu===
... customize as needed ...

===Block Settings===
... customize as needed ...

===Block Region Builder===
* You can build your own layout for block regions on the [[Front page]].
* To add content these regions you will need to [[Turn editing on]] on the [[Front page]] of Moodle.
* Then you can begin to drag/drop blocks into the regions you create!

===Course Sections===
... customize as needed ...

===Marketing Blocks===
* There are two full width info boxes witht differing styles you can use.
* In addition to this there is a layout builder, allowing you to decide how many blocks you need and define your own layout.
* Please see the README file that comes with this theme.

===Front page Courses===
Configure the way that the course boxes are rendered on the [[Front page]].

===Frontpage Ticker===
* Here you can set a news ticker to run across the [[Front page]] of your Moodle site.
* It is intended as a less intrusive alternative to the slider, taking up very little space.
* To setup your ticker, simply entere a bulleted list and include any hyperlinks you need to in that text.
* Note: you must not put ul tags around our list, only li. Moodles [[Text editor]] tends to add ul tags.
* If your ticker does not load properly, switch to [[HTML]] view and ensure you have only li tags:

<code php>
<li>News item one.....</li>
<li>News item two.....</li>
</code>

===Frontpage Slider===
* Upload the images, add the links and description for the carousel on the [[Front page]].
* Sample [[HTML]] for Slider Captions:

<code php>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Please favorite our theme!</a>
</code>

===Alert Box===
* Enter and customize a text to be displayed in the top of the site as an alert.
* It is possible to set more than one alert to target different user types.
* You also have the option of showing alerts sitewide or on [[My home|homepages]] only.

===Layout===
Set the default layout that users see.

===Footer===
Set the content that should appear in the footer

===Mobile Settings===
Control how your site looks on mobile devices

===Social Wall===
Customise the appearance of the [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (if in use on your site)

===Custom CSS & JS===
Here you can find various settings to add your own [[CSS]] and [https://en.wikipedia.org/wiki/JavaScript JavaScript] code to the theme.

===Analytics===
You can setup multiple codes for [https://en.wikipedia.org/wiki/Google_Analytics Google Analytics] and targed them to user profile fields.

==Migration from BCU to Adaptable==

Advice on migrating from BCU to Adaptable can be found [https://moodle.org/mod/forum/discuss.php?d=326470 here]

==[[HTML]] code for settings and block areas==

Here you will find some code samples to help you to customize the Info Box and the Marketing Blocks

You can insert any [[HTML]] tag to customize the [[Front page]] blocks. Use a <nowiki> <div> </nowiki> as a main container and add the
height to keep the same value in all the blocks.

The Font Awesome icons set is available in http://fortawesome.github.io/Font-Awesome/icons/.
You can insert any of them and following the examples in http://fortawesome.github.io/Font-Awesome/examples/

===Front Page Slider Styles===

There are two possible slider styles each with different markup required:

====Original BCU Slider Markup====

<code css>
<div class="span9">

<h4>Information</h4>

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
</div>

<div class="span3">

<a href="#" class="submit">2013/14 Courses <i class="fa-chevron-right fa"></i></a>

</div>
</code>
====Coventry Style Slider Markup====

<code css>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Check out our custom theme pricing!</a>
</div>
</code>

===Frontpage Marketing Block HTML structure Coventry===

<code css>
<div><img src="http://somewebsite.com/2.jpg" class="marketimage"></div>
<h4><a href="#">International Courses</a></h4>
<p>Some text below the link....</p>
</code>

===Front page Info Block===

There are two Info blocks in the frontpage located above and below the Marketing Blocks. See pix/layout.png

===Simple box with solid background and using a default heading===
<code css>
<div style="text-align:center; background: #f0f0f0;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>

===Simple box with solid background colour, default heading h3 and white text colour===
<code css>
<div style="text-align:center; background: #009688; color: #ffffff;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>

===Front Page Secondary Info Block Example===

You can apply additional styles to the secondary info block:

<code css>
<div class="span2 personpic">
<div id="person" class="spn5">
<img src="/urltoanimage.jpg" alt="person">
</div>
</div>

<div class="span10">
<h4>School of Jewelry</h4>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
<a href="#" class="submit">Learn more... <i class="fa-chevron-right fa"></i></a>
</div>
</code>

===Frontpage Marketing Block HTML===

You can add up to 12 Marketing Blocks in the [[Front page]].
The blocks are located automatically in rows, with a maximum of 4 blocks per row.
The full width is divided equally between the blocks.

===Simple Block with white background and Font Awesome icon. Using the default text colour and h3 heading===
<code css>
<div style="text-align:center; background: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-font fa-5x"></i>
<h3 style="color: #333333;">TITLE</h3>
<div style="text-align:center;">Add your text here</div>
</div>
</code>

===Block with solid background colour, white text colour and Font Awesome icon===
<code css>
<div style="text-align:center; background: #4b4b4b; color: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-th fa-5x"></i>
<h3 style="color: #ffffff;">TITLE</h3>
<div style="text-align:center; padding: 5px;">Add your text here</div>
</div>
</code>

===Block with solid background, white text colour and text aligned vertically (useful for blocks 100% wide)===
<code css>
<div style="background: #c2185b; height: 120px;">
<h1 style="line-height: 120px; color: #ffffff; text-align: center; "><b>moodle 3.0 ready !!!</b></h1>
</div>
</code>

===Footer Blocks===

Contact information
<code css>
<i class="fa fa-building"></i> High St. 100<br>
<span style="margin-left: 20px;">123456 City</span><br><br>
<i class="fa fa-phone"></i> +12 (3)456 78 90<br>
<i class="fa fa-envelope"></i> info@mail.com<br>
<i class="fa fa-globe"></i> www.example.com
</code>

List with Chevron
<code css>
<ul class="block-list white">
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Accessibility</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Feedback</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Feedback</span></a></li>
</ul>
</nowiki>
</code>

==Credits==

* Adaptable is a fork of [https://moodle.org/plugins/theme_bcu BCU theme] and owes its existence to all those credited on that theme
* Adaptable development was driven by [https://3-bits.com/en/ 3Bits E-Learning Solutions] and [https://en.wikipedia.org/wiki/Coventry_University Coventry University]
* Persistence of Bootstrap Alerts provided by [https://moodle.org/user/profile.php?id=14534 Justin Hunt] in between mowing lawns and brokering cease fires (see his [http://poodll.com/services/ Moodle Services page])
* Ideas on [https://moodle.org/plugins/format_socialwall Social Wall] support provided by [https://moodle.org/user/profile.php?id=26675 Chris Kenniburg]
* Help with renderers and other tricky stuff provided by [https://moodle.org/user/profile.php?id=713800 Mary Evans] and [https://moodle.org/user/profile.php?id=442195 Gareth J BarnardH]
* Additional support provided by [http://www.newschoollearning.com/?from=@ New School Learning]

==Support==

Please post your questions in the [https://moodle.org/mod/forum/view.php?id=46 Themes Forum].

'''We do not provide direct support'''

==See also==
The authors documentation page at [https://bitbucket.org/covuni/moodle-theme_adaptable https://bitbucket.org/covuni/moodle-theme_adaptable]

[[es:Tema Adaptable]]

Adaptable theme

2020-11-13T18:23:32Z

Rcollman: /* Screenshots */ put in gallery mode -looks like it will work

{{Themes}}
{{Infobox plugin
|type = Theme
|entry = https://moodle.org/plugins/theme_adaptable
|tracker = https://bitbucket.org/covuni/moodle-theme_adaptable/issues
|discussion = https://moodle.org/mod/forum/discuss.php?d=326234
|maintainer = [[User:Jez H|Jez H]]
|float = right
}}
This is a [[:Category:Contributed_code|contributed (third party)]] highly customisable two column theme designed to work in a range of different situations. It is based on the popular [https://moodle.org/plugins/theme_bcu BCU theme]. '''Adaptable has all the features of BCU''' along with many new features.

==Features==
'''Layout Builders!''' You can now define a custom layout in the admin settings for:

* Block Regions (drag and drop)
* Marketing Blocks
* Footer Blocks
* Fully Customisable:
** Fonts
** Colors
** Block styles (including icons)
** Buttons (including radius)
* Choice of two [https://en.wikipedia.org/wiki/JQuery JQuery] sliders on [[My home|home page]] with customisable colors
* News / Announcements Ticker on [[My home|home]] / [[Dashboard]]
* Multiple [[Front page]] course styles
* Extensive custom menus (can be targeted to different users based on custom profile field)
* "My Courses" list can be organised to put older courses in sub menu item
* Dismissible Bootstrap Alerts
** Display sitewide notices using different Bootstrap styles
** Allow users to dismiss alerts once read (persistent between page loads / login)
** Allow re-use of alerts (display again even if user has dismissed) buy updating a "key" field
* Additional layout settings for width, slider width, padding of various elements
* Social icons or Search box in header (admin can choose between the two)
* Support for [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (thanks to Chris Kenniburg for help on this)
* Mobile settings (greater control of how the theme looks on mobile devices)
* Option to add login form in header on front page
* [https://en.wikipedia.org/wiki/Favicon Favicon] uploader
* Background image uploader

In addition, many fields (menus, news items, alerts and help links) can be targeted using custom profile fields, thus it is possible to present different users with different navigation items and notices.

It is also possible for individual users to customise where they want top menu navigation to appear (disable, [[My home|home pages]] only, sitewide) using custom profile fields.

==Demo Video==

[https://youtu.be/7bSDmp_gYqw YouTube video]

==Demo site==
[http://3-bits.com/demo/adaptable/ http://3-bits.com/demo/adaptable/]

==Screenshots==
<gallery>
File:adaptable-select.png|thumb|Adaptable select
File:adaptable-front-page.png|thumb|adaptable-front-page
File:adaptable-alerts.PNG|thumb|adaptable-alerts
File:reduced_adaptable-colors.png|thumb|reduced_adaptable-colors
</gallery>
<gallery>
File:adaptable-fonts.png|thumb|adaptable-fonts
File:block-region-builder.png|thumb|block-region-builder
File:block-region-front-page.png|thumb|block-region-front-page
File:Image:adaptable-mobile-social-on.PNG|thumb|adaptable-mobile-social-on
</gallery>

==Download==
From the [https://moodle.org/plugins/theme_adaptable Moodle plugins database].

==Installation==
There are several ways to install the Adaptable theme.
* Review [[Installing_plugins#Installing_a_plugin]] Plugin installation section
* Make sure the Adaptable theme is compatible with your Moodle version
* After installing the Adaptable theme, [[Installing_a_new_theme|change the site theme]] on one or more devices to the Adaptable theme

==Configuration==
Adaptable has a lot of settings and may seem daunting at first, our advice is to simply install with the default settings and play with it afterwards.

With a little time you should be able to setup an attractive Moodle site with a high degree of individuality without knowing any CSS.

You can work on configuring the theme without it being live on your site by putting ''theme=adaptable'' or ''theme=clean'' into the URL. See [[Allow theme change by URL]].

==Theme settings that will be linked to by 'Moodle Docs for this page'==

===Colours===
You can select the colours that you would like to use throughout the theme. Use [https://en.wikipedia.org/wiki/Web_colors Hexadecimal color notation] or any other standard notation. As an alternate option you can use transparent and inherited as a value

===Fonts===
You can select the [https://en.wikipedia.org/wiki/Google_Fonts Google Fonts] that you would like to use throughout the theme. Select the subset needed (latin is always included) and enter the right font weight or the font will not displayed.

===Buttons===
Alter the appearance of buttons used in this theme. Configure as needed.

===Header===
* Customize the header of this theme.
* Upload your [https://en.wikipedia.org/wiki/Favicon favicon], logo, set login form in header, adjust titles in header.
* You can set font size and styles for titles in the "fonts" settings page.

===Header Menus===
* Tools Menus (in navbar) and Top Menus (upper header) can be restricted based on custom profile fields (optional).
* To add a restriction enter the name of the profile field and expected value.
* Menu Structure follows the common Moodle format:
Moodle community|https://moodle.org
-Moodle free support|https://moodle.org/support
-Moodle development|https://moodle.org/development
--Moodle Docs|http://docs.moodle.org
--German Moodle Docs|http://docs.moodle.org/de
Moodle.com|http://moodle.com/

* General settings for Top Menu visibility
** These settings allow you to control where menus appear and optionally allow users to customise their settings

===Header User===
Allows you to control all of the elements that appear in the user navigation dropdown.

===Header Social===
* You can disable the sitewide search box and enable social icons / links in its place.
* To setup icons enter a de-limited list into the "Social Icon List" field below.
* This should be in the format:
url|title|icon

** For example:
http://localhost/moodle/course/search.php|Search Moodle|fa-search
http://facebook.com/|Facebook|fa-facebook-square
http://twitter.com/|Twitter|fa-twitter-square
http://instagram.com|Instagram|fa-instagram

* For reference you can find the full [http://fortawesome.github.io/Font-Awesome/icons/ list of Font Awesome Icons Here]

===Header Navbar===
... customize as needed ...

===Header Tools Menu===
... customize as needed ...

===Block Settings===
... customize as needed ...

===Block Region Builder===
* You can build your own layout for block regions on the [[Front page]].
* To add content these regions you will need to [[Turn editing on]] on the [[Front page]] of Moodle.
* Then you can begin to drag/drop blocks into the regions you create!

===Course Sections===
... customize as needed ...

===Marketing Blocks===
* There are two full width info boxes witht differing styles you can use.
* In addition to this there is a layout builder, allowing you to decide how many blocks you need and define your own layout.
* Please see the README file that comes with this theme.

===Front page Courses===
Configure the way that the course boxes are rendered on the [[Front page]].

===Frontpage Ticker===
* Here you can set a news ticker to run across the [[Front page]] of your Moodle site.
* It is intended as a less intrusive alternative to the slider, taking up very little space.
* To setup your ticker, simply entere a bulleted list and include any hyperlinks you need to in that text.
* Note: you must not put ul tags around our list, only li. Moodles [[Text editor]] tends to add ul tags.
* If your ticker does not load properly, switch to [[HTML]] view and ensure you have only li tags:

<code php>
<li>News item one.....</li>
<li>News item two.....</li>
</code>

===Frontpage Slider===
* Upload the images, add the links and description for the carousel on the [[Front page]].
* Sample [[HTML]] for Slider Captions:

<code php>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Please favorite our theme!</a>
</code>

===Alert Box===
* Enter and customize a text to be displayed in the top of the site as an alert.
* It is possible to set more than one alert to target different user types.
* You also have the option of showing alerts sitewide or on [[My home|homepages]] only.

===Layout===
Set the default layout that users see.

===Footer===
Set the content that should appear in the footer

===Mobile Settings===
Control how your site looks on mobile devices

===Social Wall===
Customise the appearance of the [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (if in use on your site)

===Custom CSS & JS===
Here you can find various settings to add your own [[CSS]] and [https://en.wikipedia.org/wiki/JavaScript JavaScript] code to the theme.

===Analytics===
You can setup multiple codes for [https://en.wikipedia.org/wiki/Google_Analytics Google Analytics] and targed them to user profile fields.

==Migration from BCU to Adaptable==

Advice on migrating from BCU to Adaptable can be found [https://moodle.org/mod/forum/discuss.php?d=326470 here]

==[[HTML]] code for settings and block areas==

Here you will find some code samples to help you to customize the Info Box and the Marketing Blocks

You can insert any [[HTML]] tag to customize the [[Front page]] blocks. Use a <nowiki> <div> </nowiki> as a main container and add the
height to keep the same value in all the blocks.

The Font Awesome icons set is available in http://fortawesome.github.io/Font-Awesome/icons/.
You can insert any of them and following the examples in http://fortawesome.github.io/Font-Awesome/examples/

===Front Page Slider Styles===

There are two possible slider styles each with different markup required:

====Original BCU Slider Markup====

<code css>
<div class="span9">

<h4>Information</h4>

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
</div>

<div class="span3">

<a href="#" class="submit">2013/14 Courses <i class="fa-chevron-right fa"></i></a>

</div>
</code>
====Coventry Style Slider Markup====

<code css>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Check out our custom theme pricing!</a>
</div>
</code>

===Frontpage Marketing Block HTML structure Coventry===

<code css>
<div><img src="http://somewebsite.com/2.jpg" class="marketimage"></div>
<h4><a href="#">International Courses</a></h4>
<p>Some text below the link....</p>
</code>

===Front page Info Block===

There are two Info blocks in the frontpage located above and below the Marketing Blocks. See pix/layout.png

===Simple box with solid background and using a default heading===
<code css>
<div style="text-align:center; background: #f0f0f0;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>

===Simple box with solid background colour, default heading h3 and white text colour===
<code css>
<div style="text-align:center; background: #009688; color: #ffffff;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>

===Front Page Secondary Info Block Example===

You can apply additional styles to the secondary info block:

<code css>
<div class="span2 personpic">
<div id="person" class="spn5">
<img src="/urltoanimage.jpg" alt="person">
</div>
</div>

<div class="span10">
<h4>School of Jewelry</h4>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
<a href="#" class="submit">Learn more... <i class="fa-chevron-right fa"></i></a>
</div>
</code>

===Frontpage Marketing Block HTML===

You can add up to 12 Marketing Blocks in the [[Front page]].
The blocks are located automatically in rows, with a maximum of 4 blocks per row.
The full width is divided equally between the blocks.

===Simple Block with white background and Font Awesome icon. Using the default text colour and h3 heading===
<code css>
<div style="text-align:center; background: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-font fa-5x"></i>
<h3 style="color: #333333;">TITLE</h3>
<div style="text-align:center;">Add your text here</div>
</div>
</code>

===Block with solid background colour, white text colour and Font Awesome icon===
<code css>
<div style="text-align:center; background: #4b4b4b; color: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-th fa-5x"></i>
<h3 style="color: #ffffff;">TITLE</h3>
<div style="text-align:center; padding: 5px;">Add your text here</div>
</div>
</code>

===Block with solid background, white text colour and text aligned vertically (useful for blocks 100% wide)===
<code css>
<div style="background: #c2185b; height: 120px;">
<h1 style="line-height: 120px; color: #ffffff; text-align: center; "><b>moodle 3.0 ready !!!</b></h1>
</div>
</code>

===Footer Blocks===

Contact information
<code css>
<i class="fa fa-building"></i> High St. 100<br>
<span style="margin-left: 20px;">123456 City</span><br><br>
<i class="fa fa-phone"></i> +12 (3)456 78 90<br>
<i class="fa fa-envelope"></i> info@mail.com<br>
<i class="fa fa-globe"></i> www.example.com
</code>

List with Chevron
<code css>
<ul class="block-list white">
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Accessibility</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Feedback</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Feedback</span></a></li>
</ul>
</nowiki>
</code>

==Credits==

* Adaptable is a fork of [https://moodle.org/plugins/theme_bcu BCU theme] and owes its existence to all those credited on that theme
* Adaptable development was driven by [https://3-bits.com/en/ 3Bits E-Learning Solutions] and [https://en.wikipedia.org/wiki/Coventry_University Coventry University]
* Persistence of Bootstrap Alerts provided by [https://moodle.org/user/profile.php?id=14534 Justin Hunt] in between mowing lawns and brokering cease fires (see his [http://poodll.com/services/ Moodle Services page])
* Ideas on [https://moodle.org/plugins/format_socialwall Social Wall] support provided by [https://moodle.org/user/profile.php?id=26675 Chris Kenniburg]
* Help with renderers and other tricky stuff provided by [https://moodle.org/user/profile.php?id=713800 Mary Evans] and [https://moodle.org/user/profile.php?id=442195 Gareth J BarnardH]
* Additional support provided by [http://www.newschoollearning.com/?from=@ New School Learning]

==Support==

Please post your questions in the [https://moodle.org/mod/forum/view.php?id=46 Themes Forum].

'''We do not provide direct support'''

==See also==
The authors documentation page at [https://bitbucket.org/covuni/moodle-theme_adaptable https://bitbucket.org/covuni/moodle-theme_adaptable]

[[es:Tema Adaptable]]

Installing a new theme

2020-11-13T16:43:05Z

Rcollman: add section for changing theme images to make it easier to edit

{{Themes}}
{{Update}}
Setting up a new theme in Moodle is a two step process. First someone has to install the theme in the Moodle site. Second, the theme must be selected for use.

==Installing the plugin==
Any new theme is a plugin. Please see [[Installing plugins]] for details about the three different ways of installing a theme.

==Changing the theme==
You may select the theme which will be used on three different types of devices that will use your site: a computer with monitor(s), a mobile phone and a tablet. Some themes will can be additionally modified for a specific device.

# Log in as admin and go to ''Administration > Site administration > Appearance > Themes > Theme Selector''
# Click on the "Change theme" button on the right of the current theme being used for the device
# Scroll down to find the theme you wish to use
# Click the "Use theme" button next to that theme
# Moodle will tell you it has been saved as the default theme
# Check your Moodle site
Notes:
* You may have to refresh your browser to see the new theme
* The Moodle server should automatically clear its theme cache
** Some older versions of Moodle will required you to click on the "Clear theme caches" button as a last step
* It is a best practice to check how the theme looks by using
**the three different types of devices and
**different browsers on those each of those devices

===Changing theme images===
{|
| [[Image:Theme change theme button 3-9.JPG|thumb|Click the Change theme button v 3.9]]
| [[Image:Theme use theme button 3-9.JPG|thumb|Click Use theme button on the theme you want]]
| [[Image:Theme device types 3-9.JPG|thumb|Example, no themes selected for some types]]
|}

==See also==

[[de:Ein_neues_Design_installieren]]
[[es:Instalando un tema nuevo]]
[[fr:Installation d'un thème]]

Adaptable theme

2020-11-13T14:32:44Z

Rcollman: /* Installation */ relink to instruction pages. Old instructions for earlier version of Moodle

{{Themes}}
{{Infobox plugin
|type = Theme
|entry = https://moodle.org/plugins/theme_adaptable
|tracker = https://bitbucket.org/covuni/moodle-theme_adaptable/issues
|discussion = https://moodle.org/mod/forum/discuss.php?d=326234
|maintainer = [[User:Jez H|Jez H]]
|float = right
}}
This is a [[:Category:Contributed_code|contributed (third party)]] highly customisable two column theme designed to work in a range of different situations. It is based on the popular [https://moodle.org/plugins/theme_bcu BCU theme]. '''Adaptable has all the features of BCU''' along with many new features.

==Features==
'''Layout Builders!''' You can now define a custom layout in the admin settings for:

* Block Regions (drag and drop)
* Marketing Blocks
* Footer Blocks
* Fully Customisable:
** Fonts
** Colors
** Block styles (including icons)
** Buttons (including radius)
* Choice of two [https://en.wikipedia.org/wiki/JQuery JQuery] sliders on [[My home|home page]] with customisable colors
* News / Announcements Ticker on [[My home|home]] / [[Dashboard]]
* Multiple [[Front page]] course styles
* Extensive custom menus (can be targeted to different users based on custom profile field)
* "My Courses" list can be organised to put older courses in sub menu item
* Dismissible Bootstrap Alerts
** Display sitewide notices using different Bootstrap styles
** Allow users to dismiss alerts once read (persistent between page loads / login)
** Allow re-use of alerts (display again even if user has dismissed) buy updating a "key" field
* Additional layout settings for width, slider width, padding of various elements
* Social icons or Search box in header (admin can choose between the two)
* Support for [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (thanks to Chris Kenniburg for help on this)
* Mobile settings (greater control of how the theme looks on mobile devices)
* Option to add login form in header on front page
* [https://en.wikipedia.org/wiki/Favicon Favicon] uploader
* Background image uploader

In addition, many fields (menus, news items, alerts and help links) can be targeted using custom profile fields, thus it is possible to present different users with different navigation items and notices.

It is also possible for individual users to customise where they want top menu navigation to appear (disable, [[My home|home pages]] only, sitewide) using custom profile fields.

==Demo Video==

[https://youtu.be/7bSDmp_gYqw YouTube video]

==Demo site==
[http://3-bits.com/demo/adaptable/ http://3-bits.com/demo/adaptable/]

==Screenshots==
[[File:adaptable-select.png|200px]]
[[File:adaptable-front-page.png|200px]]
[[File:adaptable-alerts.PNG|200px]]
[[File:reduced_adaptable-colors.png|200px]]
[[File:adaptable-fonts.png|200px]]
[[File:block-region-builder.png|200px]]
[[File:block-region-front-page.png|200px]]
[[File:adaptable-mobile-social-on.PNG|200px]]

==Download==
From the [https://moodle.org/plugins/theme_adaptable Moodle plugins database].

==Installation==
There are several ways to install the Adaptable theme.
* Review [[Installing_plugins#Installing_a_plugin]] Plugin installation section
* Make sure the Adaptable theme is compatible with your Moodle version
* After installing the Adaptable theme, [[Installing_a_new_theme|change the site theme]] on one or more devices to the Adaptable theme

==Configuration==
Adaptable has a lot of settings and may seem daunting at first, our advice is to simply install with the default settings and play with it afterwards.

With a little time you should be able to setup an attractive Moodle site with a high degree of individuality without knowing any CSS.

You can work on configuring the theme without it being live on your site by putting ''theme=adaptable'' or ''theme=clean'' into the URL. See [[Allow theme change by URL]].

==Theme settings that will be linked to by 'Moodle Docs for this page'==

===Colours===
You can select the colours that you would like to use throughout the theme. Use [https://en.wikipedia.org/wiki/Web_colors Hexadecimal color notation] or any other standard notation. As an alternate option you can use transparent and inherited as a value

===Fonts===
You can select the [https://en.wikipedia.org/wiki/Google_Fonts Google Fonts] that you would like to use throughout the theme. Select the subset needed (latin is always included) and enter the right font weight or the font will not displayed.

===Buttons===
Alter the appearance of buttons used in this theme. Configure as needed.

===Header===
* Customize the header of this theme.
* Upload your [https://en.wikipedia.org/wiki/Favicon favicon], logo, set login form in header, adjust titles in header.
* You can set font size and styles for titles in the "fonts" settings page.

===Header Menus===
* Tools Menus (in navbar) and Top Menus (upper header) can be restricted based on custom profile fields (optional).
* To add a restriction enter the name of the profile field and expected value.
* Menu Structure follows the common Moodle format:
Moodle community|https://moodle.org
-Moodle free support|https://moodle.org/support
-Moodle development|https://moodle.org/development
--Moodle Docs|http://docs.moodle.org
--German Moodle Docs|http://docs.moodle.org/de
Moodle.com|http://moodle.com/

* General settings for Top Menu visibility
** These settings allow you to control where menus appear and optionally allow users to customise their settings

===Header User===
Allows you to control all of the elements that appear in the user navigation dropdown.

===Header Social===
* You can disable the sitewide search box and enable social icons / links in its place.
* To setup icons enter a de-limited list into the "Social Icon List" field below.
* This should be in the format:
url|title|icon

** For example:
http://localhost/moodle/course/search.php|Search Moodle|fa-search
http://facebook.com/|Facebook|fa-facebook-square
http://twitter.com/|Twitter|fa-twitter-square
http://instagram.com|Instagram|fa-instagram

* For reference you can find the full [http://fortawesome.github.io/Font-Awesome/icons/ list of Font Awesome Icons Here]

===Header Navbar===
... customize as needed ...

===Header Tools Menu===
... customize as needed ...

===Block Settings===
... customize as needed ...

===Block Region Builder===
* You can build your own layout for block regions on the [[Front page]].
* To add content these regions you will need to [[Turn editing on]] on the [[Front page]] of Moodle.
* Then you can begin to drag/drop blocks into the regions you create!

===Course Sections===
... customize as needed ...

===Marketing Blocks===
* There are two full width info boxes witht differing styles you can use.
* In addition to this there is a layout builder, allowing you to decide how many blocks you need and define your own layout.
* Please see the README file that comes with this theme.

===Front page Courses===
Configure the way that the course boxes are rendered on the [[Front page]].

===Frontpage Ticker===
* Here you can set a news ticker to run across the [[Front page]] of your Moodle site.
* It is intended as a less intrusive alternative to the slider, taking up very little space.
* To setup your ticker, simply entere a bulleted list and include any hyperlinks you need to in that text.
* Note: you must not put ul tags around our list, only li. Moodles [[Text editor]] tends to add ul tags.
* If your ticker does not load properly, switch to [[HTML]] view and ensure you have only li tags:

<code php>
<li>News item one.....</li>
<li>News item two.....</li>
</code>

===Frontpage Slider===
* Upload the images, add the links and description for the carousel on the [[Front page]].
* Sample [[HTML]] for Slider Captions:

<code php>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Please favorite our theme!</a>
</code>

===Alert Box===
* Enter and customize a text to be displayed in the top of the site as an alert.
* It is possible to set more than one alert to target different user types.
* You also have the option of showing alerts sitewide or on [[My home|homepages]] only.

===Layout===
Set the default layout that users see.

===Footer===
Set the content that should appear in the footer

===Mobile Settings===
Control how your site looks on mobile devices

===Social Wall===
Customise the appearance of the [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (if in use on your site)

===Custom CSS & JS===
Here you can find various settings to add your own [[CSS]] and [https://en.wikipedia.org/wiki/JavaScript JavaScript] code to the theme.

===Analytics===
You can setup multiple codes for [https://en.wikipedia.org/wiki/Google_Analytics Google Analytics] and targed them to user profile fields.

==Migration from BCU to Adaptable==

Advice on migrating from BCU to Adaptable can be found [https://moodle.org/mod/forum/discuss.php?d=326470 here]

==[[HTML]] code for settings and block areas==

Here you will find some code samples to help you to customize the Info Box and the Marketing Blocks

You can insert any [[HTML]] tag to customize the [[Front page]] blocks. Use a <nowiki> <div> </nowiki> as a main container and add the
height to keep the same value in all the blocks.

The Font Awesome icons set is available in http://fortawesome.github.io/Font-Awesome/icons/.
You can insert any of them and following the examples in http://fortawesome.github.io/Font-Awesome/examples/

===Front Page Slider Styles===

There are two possible slider styles each with different markup required:

====Original BCU Slider Markup====

<code css>
<div class="span9">

<h4>Information</h4>

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
</div>

<div class="span3">

<a href="#" class="submit">2013/14 Courses <i class="fa-chevron-right fa"></i></a>

</div>
</code>
====Coventry Style Slider Markup====

<code css>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Check out our custom theme pricing!</a>
</div>
</code>

===Frontpage Marketing Block HTML structure Coventry===

<code css>
<div><img src="http://somewebsite.com/2.jpg" class="marketimage"></div>
<h4><a href="#">International Courses</a></h4>
<p>Some text below the link....</p>
</code>

===Front page Info Block===

There are two Info blocks in the frontpage located above and below the Marketing Blocks. See pix/layout.png

===Simple box with solid background and using a default heading===
<code css>
<div style="text-align:center; background: #f0f0f0;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>

===Simple box with solid background colour, default heading h3 and white text colour===
<code css>
<div style="text-align:center; background: #009688; color: #ffffff;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>

===Front Page Secondary Info Block Example===

You can apply additional styles to the secondary info block:

<code css>
<div class="span2 personpic">
<div id="person" class="spn5">
<img src="/urltoanimage.jpg" alt="person">
</div>
</div>

<div class="span10">
<h4>School of Jewelry</h4>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
<a href="#" class="submit">Learn more... <i class="fa-chevron-right fa"></i></a>
</div>
</code>

===Frontpage Marketing Block HTML===

You can add up to 12 Marketing Blocks in the [[Front page]].
The blocks are located automatically in rows, with a maximum of 4 blocks per row.
The full width is divided equally between the blocks.

===Simple Block with white background and Font Awesome icon. Using the default text colour and h3 heading===
<code css>
<div style="text-align:center; background: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-font fa-5x"></i>
<h3 style="color: #333333;">TITLE</h3>
<div style="text-align:center;">Add your text here</div>
</div>
</code>

===Block with solid background colour, white text colour and Font Awesome icon===
<code css>
<div style="text-align:center; background: #4b4b4b; color: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-th fa-5x"></i>
<h3 style="color: #ffffff;">TITLE</h3>
<div style="text-align:center; padding: 5px;">Add your text here</div>
</div>
</code>

===Block with solid background, white text colour and text aligned vertically (useful for blocks 100% wide)===
<code css>
<div style="background: #c2185b; height: 120px;">
<h1 style="line-height: 120px; color: #ffffff; text-align: center; "><b>moodle 3.0 ready !!!</b></h1>
</div>
</code>

===Footer Blocks===

Contact information
<code css>
<i class="fa fa-building"></i> High St. 100<br>
<span style="margin-left: 20px;">123456 City</span><br><br>
<i class="fa fa-phone"></i> +12 (3)456 78 90<br>
<i class="fa fa-envelope"></i> info@mail.com<br>
<i class="fa fa-globe"></i> www.example.com
</code>

List with Chevron
<code css>
<ul class="block-list white">
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Accessibility</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Feedback</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Feedback</span></a></li>
</ul>
</nowiki>
</code>

==Credits==

* Adaptable is a fork of [https://moodle.org/plugins/theme_bcu BCU theme] and owes its existence to all those credited on that theme
* Adaptable development was driven by [https://3-bits.com/en/ 3Bits E-Learning Solutions] and [https://en.wikipedia.org/wiki/Coventry_University Coventry University]
* Persistence of Bootstrap Alerts provided by [https://moodle.org/user/profile.php?id=14534 Justin Hunt] in between mowing lawns and brokering cease fires (see his [http://poodll.com/services/ Moodle Services page])
* Ideas on [https://moodle.org/plugins/format_socialwall Social Wall] support provided by [https://moodle.org/user/profile.php?id=26675 Chris Kenniburg]
* Help with renderers and other tricky stuff provided by [https://moodle.org/user/profile.php?id=713800 Mary Evans] and [https://moodle.org/user/profile.php?id=442195 Gareth J BarnardH]
* Additional support provided by [http://www.newschoollearning.com/?from=@ New School Learning]

==Support==

Please post your questions in the [https://moodle.org/mod/forum/view.php?id=46 Themes Forum].

'''We do not provide direct support'''

==See also==
The authors documentation page at [https://bitbucket.org/covuni/moodle-theme_adaptable https://bitbucket.org/covuni/moodle-theme_adaptable]

[[es:Tema Adaptable]]

File:Theme device types 3-9.JPG

2020-11-13T14:15:13Z

Rcollman: from moodle sandbox. Did not load first time in docs?

from moodle sandbox. Did not load first time in docs?

File:Theme use theme button 3-9.JPG

2020-11-13T14:12:45Z

Rcollman: from moodle sandbox

from moodle sandbox

File:Theme change theme button 3-9.JPG

2020-11-13T14:11:59Z

Rcollman: from moodle sandbox

from moodle sandbox

File:Theme different devises 3-9.JPG

2020-11-13T14:11:15Z

Rcollman: from moodle sandbox

from moodle sandbox

Installing a new theme

2020-11-13T14:09:46Z

Rcollman: Changed image links to 3.9, will add files in a few minutes

{{Themes}}
{{Update}}
Setting up a new theme in Moodle is a two step process. First someone has to install the theme in the Moodle site. Second, the theme must be selected for use.

==Installing the plugin==
Any new theme is a plugin. Please see [[Installing plugins]] for details about the three different ways of installing a theme.

==Changing the theme==
You may select the theme which will be used on three different types of devices that will use your site: a computer with monitor(s), a mobile phone and a tablet. Some themes will can be additionally modified for a specific device.

# Log in as admin and go to ''Administration > Site administration > Appearance > Themes > Theme Selector''
# Click on the "Change theme" button on the right of the current theme being used for the device
# Scroll down to find the theme you wish to use
# Click the "Use theme" button next to that theme
# Moodle will tell you it has been saved as the default theme
# Check your Moodle site
Notes:
* You may have to refresh your browser to see the new theme
* The Moodle server should automatically clear its theme cache
** Some older versions of Moodle will required you to click on the "Clear theme caches" button as a last step
* It is a best practice to check how the theme looks by using
**the three different types of devices and
**different browsers on those each of those devices

{|
| [[Image:Theme change theme button 3-9.JPG|thumb|Click the Change theme button v 3.9]]
| [[Image:Theme use theme button 3-9.JPG|thumb|Click Use theme button on the theme you want]]
| [[Image:Theme device types 3-9.JPG|thumb|Example, no themes selected for some types]]
|}

==See also==

[[de:Ein_neues_Design_installieren]]
[[es:Instalando un tema nuevo]]
[[fr:Installation d'un thème]]

Installing a new theme

2020-11-13T13:21:13Z

Rcollman: These steps worked for me on my localhost 3.9.2 Moodle. Biggest change is the apparent automatic clear theme caches

{{Themes}}
{{Update}}
Setting up a new theme in Moodle is a two step process. First someone has to install the theme in the Moodle site. Second, the theme must be selected for use.

==Installing the plugin==
Any new theme is a plugin. Please see [[Installing plugins]] for details about the three different ways of installing a theme.

==Changing the theme==
You may select the theme which will be used on three different types of devices that will use your site: a computer with monitor(s), a mobile phone and a tablet. Some themes will can be additionally modified for a specific device.

# Log in as admin and go to ''Administration > Site administration > Appearance > Themes > Theme Selector''
# Click on the "Change theme" button on the right of the current theme being used for the device
# Scroll down to find the theme you wish to use
# Click the "Use theme" button next to that theme
# Moodle will tell you it has been saved as the default theme
# Check your Moodle site
Notes:
* You may have to refresh your browser to see the new theme
* The Moodle server should automatically clear its theme cache
** Some older versions of Moodle will required you to click on the "Clear theme caches" button as a last step
* It is a best practice to check how the theme looks by using
**the three different types of devices and
**different browsers on those each of those devices

{|
| [[Image:instheme07.png|thumb|Open the Appearance > Theme selector page]]
| [[Image:instheme09.png|thumb|Click the Select theme button]]
| [[Image:instheme10.png|thumb|Click the Use theme button]]
| [[Image:instheme11.png|thumb|Checking if the theme is the one selected]]
|}

==See also==

[[de:Ein_neues_Design_installieren]]
[[es:Instalando un tema nuevo]]
[[fr:Installation d'un thème]]

Adaptable theme

2020-11-13T12:01:20Z

Rcollman: /* Support */ removed link to forum thread and set it for Themes Forum

{{Themes}}
{{Infobox plugin
|type = Theme
|entry = https://moodle.org/plugins/theme_adaptable
|tracker = https://bitbucket.org/covuni/moodle-theme_adaptable/issues
|discussion = https://moodle.org/mod/forum/discuss.php?d=326234
|maintainer = [[User:Jez H|Jez H]]
|float = right
}}
This is a [[:Category:Contributed_code|contributed (third party)]] highly customisable two column theme designed to work in a range of different situations. It is based on the popular [https://moodle.org/plugins/theme_bcu BCU theme]. '''Adaptable has all the features of BCU''' along with many new features.

==Features==
'''Layout Builders!''' You can now define a custom layout in the admin settings for:

* Block Regions (drag and drop)
* Marketing Blocks
* Footer Blocks
* Fully Customisable:
** Fonts
** Colors
** Block styles (including icons)
** Buttons (including radius)
* Choice of two [https://en.wikipedia.org/wiki/JQuery JQuery] sliders on [[My home|home page]] with customisable colors
* News / Announcements Ticker on [[My home|home]] / [[Dashboard]]
* Multiple [[Front page]] course styles
* Extensive custom menus (can be targeted to different users based on custom profile field)
* "My Courses" list can be organised to put older courses in sub menu item
* Dismissible Bootstrap Alerts
** Display sitewide notices using different Bootstrap styles
** Allow users to dismiss alerts once read (persistent between page loads / login)
** Allow re-use of alerts (display again even if user has dismissed) buy updating a "key" field
* Additional layout settings for width, slider width, padding of various elements
* Social icons or Search box in header (admin can choose between the two)
* Support for [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (thanks to Chris Kenniburg for help on this)
* Mobile settings (greater control of how the theme looks on mobile devices)
* Option to add login form in header on front page
* [https://en.wikipedia.org/wiki/Favicon Favicon] uploader
* Background image uploader

In addition, many fields (menus, news items, alerts and help links) can be targeted using custom profile fields, thus it is possible to present different users with different navigation items and notices.

It is also possible for individual users to customise where they want top menu navigation to appear (disable, [[My home|home pages]] only, sitewide) using custom profile fields.

==Demo Video==

[https://youtu.be/7bSDmp_gYqw YouTube video]

==Demo site==
[http://3-bits.com/demo/adaptable/ http://3-bits.com/demo/adaptable/]

==Screenshots==
[[File:adaptable-select.png|200px]]
[[File:adaptable-front-page.png|200px]]
[[File:adaptable-alerts.PNG|200px]]
[[File:reduced_adaptable-colors.png|200px]]
[[File:adaptable-fonts.png|200px]]
[[File:block-region-builder.png|200px]]
[[File:block-region-front-page.png|200px]]
[[File:adaptable-mobile-social-on.PNG|200px]]

==Download==
From the [https://moodle.org/plugins/theme_adaptable Moodle plugins database].

==Installation==
* Make sure you have all the required versions.
* Download and unpack the module.
* Place the folder ("adaptable") in the "theme" subdirectory.
* Visit http://yoursite.com/admin to finish the installation

==Configuration==
Adaptable has a lot of settings and may seem daunting at first, our advice is to simply install with the default settings and play with it afterwards.

With a little time you should be able to setup an attractive Moodle site with a high degree of individuality without knowing any CSS.

You can work on configuring the theme without it being live on your site by putting ''theme=adaptable'' or ''theme=clean'' into the URL. See [[Allow theme change by URL]].

==Theme settings that will be linked to by 'Moodle Docs for this page'==

===Colours===
You can select the colours that you would like to use throughout the theme. Use [https://en.wikipedia.org/wiki/Web_colors Hexadecimal color notation] or any other standard notation. As an alternate option you can use transparent and inherited as a value

===Fonts===
You can select the [https://en.wikipedia.org/wiki/Google_Fonts Google Fonts] that you would like to use throughout the theme. Select the subset needed (latin is always included) and enter the right font weight or the font will not displayed.

===Buttons===
Alter the appearance of buttons used in this theme. Configure as needed.

===Header===
* Customize the header of this theme.
* Upload your [https://en.wikipedia.org/wiki/Favicon favicon], logo, set login form in header, adjust titles in header.
* You can set font size and styles for titles in the "fonts" settings page.

===Header Menus===
* Tools Menus (in navbar) and Top Menus (upper header) can be restricted based on custom profile fields (optional).
* To add a restriction enter the name of the profile field and expected value.
* Menu Structure follows the common Moodle format:
Moodle community|https://moodle.org
-Moodle free support|https://moodle.org/support
-Moodle development|https://moodle.org/development
--Moodle Docs|http://docs.moodle.org
--German Moodle Docs|http://docs.moodle.org/de
Moodle.com|http://moodle.com/

* General settings for Top Menu visibility
** These settings allow you to control where menus appear and optionally allow users to customise their settings

===Header User===
Allows you to control all of the elements that appear in the user navigation dropdown.

===Header Social===
* You can disable the sitewide search box and enable social icons / links in its place.
* To setup icons enter a de-limited list into the "Social Icon List" field below.
* This should be in the format:
url|title|icon

** For example:
http://localhost/moodle/course/search.php|Search Moodle|fa-search
http://facebook.com/|Facebook|fa-facebook-square
http://twitter.com/|Twitter|fa-twitter-square
http://instagram.com|Instagram|fa-instagram

* For reference you can find the full [http://fortawesome.github.io/Font-Awesome/icons/ list of Font Awesome Icons Here]

===Header Navbar===
... customize as needed ...

===Header Tools Menu===
... customize as needed ...

===Block Settings===
... customize as needed ...

===Block Region Builder===
* You can build your own layout for block regions on the [[Front page]].
* To add content these regions you will need to [[Turn editing on]] on the [[Front page]] of Moodle.
* Then you can begin to drag/drop blocks into the regions you create!

===Course Sections===
... customize as needed ...

===Marketing Blocks===
* There are two full width info boxes witht differing styles you can use.
* In addition to this there is a layout builder, allowing you to decide how many blocks you need and define your own layout.
* Please see the README file that comes with this theme.

===Front page Courses===
Configure the way that the course boxes are rendered on the [[Front page]].

===Frontpage Ticker===
* Here you can set a news ticker to run across the [[Front page]] of your Moodle site.
* It is intended as a less intrusive alternative to the slider, taking up very little space.
* To setup your ticker, simply entere a bulleted list and include any hyperlinks you need to in that text.
* Note: you must not put ul tags around our list, only li. Moodles [[Text editor]] tends to add ul tags.
* If your ticker does not load properly, switch to [[HTML]] view and ensure you have only li tags:

<code php>
<li>News item one.....</li>
<li>News item two.....</li>
</code>

===Frontpage Slider===
* Upload the images, add the links and description for the carousel on the [[Front page]].
* Sample [[HTML]] for Slider Captions:

<code php>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Please favorite our theme!</a>
</code>

===Alert Box===
* Enter and customize a text to be displayed in the top of the site as an alert.
* It is possible to set more than one alert to target different user types.
* You also have the option of showing alerts sitewide or on [[My home|homepages]] only.

===Layout===
Set the default layout that users see.

===Footer===
Set the content that should appear in the footer

===Mobile Settings===
Control how your site looks on mobile devices

===Social Wall===
Customise the appearance of the [https://moodle.org/plugins/format_socialwall Social Wall Course Format] (if in use on your site)

===Custom CSS & JS===
Here you can find various settings to add your own [[CSS]] and [https://en.wikipedia.org/wiki/JavaScript JavaScript] code to the theme.

===Analytics===
You can setup multiple codes for [https://en.wikipedia.org/wiki/Google_Analytics Google Analytics] and targed them to user profile fields.

==Migration from BCU to Adaptable==

Advice on migrating from BCU to Adaptable can be found [https://moodle.org/mod/forum/discuss.php?d=326470 here]

==[[HTML]] code for settings and block areas==

Here you will find some code samples to help you to customize the Info Box and the Marketing Blocks

You can insert any [[HTML]] tag to customize the [[Front page]] blocks. Use a <nowiki> <div> </nowiki> as a main container and add the
height to keep the same value in all the blocks.

The Font Awesome icons set is available in http://fortawesome.github.io/Font-Awesome/icons/.
You can insert any of them and following the examples in http://fortawesome.github.io/Font-Awesome/examples/

===Front Page Slider Styles===

There are two possible slider styles each with different markup required:

====Original BCU Slider Markup====

<code css>
<div class="span9">

<h4>Information</h4>

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
</div>

<div class="span3">

<a href="#" class="submit">2013/14 Courses <i class="fa-chevron-right fa"></i></a>

</div>
</code>
====Coventry Style Slider Markup====

<code css>
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Check out our custom theme pricing!</a>
</div>
</code>

===Frontpage Marketing Block HTML structure Coventry===

<code css>
<div><img src="http://somewebsite.com/2.jpg" class="marketimage"></div>
<h4><a href="#">International Courses</a></h4>
<p>Some text below the link....</p>
</code>

===Front page Info Block===

There are two Info blocks in the frontpage located above and below the Marketing Blocks. See pix/layout.png

===Simple box with solid background and using a default heading===
<code css>
<div style="text-align:center; background: #f0f0f0;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>

===Simple box with solid background colour, default heading h3 and white text colour===
<code css>
<div style="text-align:center; background: #009688; color: #ffffff;">
<h3 style="text-align: center;">Add your text here</h3>
</div>
</code>

===Front Page Secondary Info Block Example===

You can apply additional styles to the secondary info block:

<code css>
<div class="span2 personpic">
<div id="person" class="spn5">
<img src="/urltoanimage.jpg" alt="person">
</div>
</div>

<div class="span10">
<h4>School of Jewelry</h4>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
<a href="#" class="submit">Learn more... <i class="fa-chevron-right fa"></i></a>
</div>
</code>

===Frontpage Marketing Block HTML===

You can add up to 12 Marketing Blocks in the [[Front page]].
The blocks are located automatically in rows, with a maximum of 4 blocks per row.
The full width is divided equally between the blocks.

===Simple Block with white background and Font Awesome icon. Using the default text colour and h3 heading===
<code css>
<div style="text-align:center; background: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-font fa-5x"></i>
<h3 style="color: #333333;">TITLE</h3>
<div style="text-align:center;">Add your text here</div>
</div>
</code>

===Block with solid background colour, white text colour and Font Awesome icon===
<code css>
<div style="text-align:center; background: #4b4b4b; color: #ffffff; height: 240px; padding: 7px;">
<i class="fa fa-th fa-5x"></i>
<h3 style="color: #ffffff;">TITLE</h3>
<div style="text-align:center; padding: 5px;">Add your text here</div>
</div>
</code>

===Block with solid background, white text colour and text aligned vertically (useful for blocks 100% wide)===
<code css>
<div style="background: #c2185b; height: 120px;">
<h1 style="line-height: 120px; color: #ffffff; text-align: center; "><b>moodle 3.0 ready !!!</b></h1>
</div>
</code>

===Footer Blocks===

Contact information
<code css>
<i class="fa fa-building"></i> High St. 100<br>
<span style="margin-left: 20px;">123456 City</span><br><br>
<i class="fa fa-phone"></i> +12 (3)456 78 90<br>
<i class="fa fa-envelope"></i> info@mail.com<br>
<i class="fa fa-globe"></i> www.example.com
</code>

List with Chevron
<code css>
<ul class="block-list white">
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Accessibility</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Feedback</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Help</span></a></li>
<li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Feedback</span></a></li>
</ul>
</nowiki>
</code>

==Credits==

* Adaptable is a fork of [https://moodle.org/plugins/theme_bcu BCU theme] and owes its existence to all those credited on that theme
* Adaptable development was driven by [https://3-bits.com/en/ 3Bits E-Learning Solutions] and [https://en.wikipedia.org/wiki/Coventry_University Coventry University]
* Persistence of Bootstrap Alerts provided by [https://moodle.org/user/profile.php?id=14534 Justin Hunt] in between mowing lawns and brokering cease fires (see his [http://poodll.com/services/ Moodle Services page])
* Ideas on [https://moodle.org/plugins/format_socialwall Social Wall] support provided by [https://moodle.org/user/profile.php?id=26675 Chris Kenniburg]
* Help with renderers and other tricky stuff provided by [https://moodle.org/user/profile.php?id=713800 Mary Evans] and [https://moodle.org/user/profile.php?id=442195 Gareth J BarnardH]
* Additional support provided by [http://www.newschoollearning.com/?from=@ New School Learning]

==Support==

Please post your questions in the [https://moodle.org/mod/forum/view.php?id=46 Themes Forum].

'''We do not provide direct support'''

==See also==
The authors documentation page at [https://bitbucket.org/covuni/moodle-theme_adaptable https://bitbucket.org/covuni/moodle-theme_adaptable]

[[es:Tema Adaptable]]

Certificate module

2020-11-05T11:59:14Z

Rcollman: /* See also */ oops

{{Certificate}}
{{Infobox plugin
|type = Activity
|entry = https://moodle.org/plugins/mod_customcert
|tracker = https://github.com/markn86/moodle-mod_customcert/issues
|discussion = https://moodle.org/plugins/mod_customcert
|maintainer = [[User:Mark Nelson|Mark Nelson]]
|float = right
}}
The '''Certificate module''' creates PDF certificates/diplomas for students in a course. You can add borders, watermarks, seals, signatures, outcomes, grades, add custom text to a certificate via the settings menu.

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. Two examples show certificates made with the settings menu. The two other examples show a few possible ways to customize a certificate.
<gallery caption="Certificate examples - click on any to enlarge" widths="200px" heights="100px" perrow="6">
Image:Certificate 27 plain.png|Shows no options selected, standard title, course name, user name and words.
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|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>

==Installing==
#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 . 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).
#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.

==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>Settings>Upload images >Type. Types are borders, seals, signatures and watermarks.
*Alternatively, 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 access to the moodle/mod/certificate folder.

==See also==
* [[Add/edit certificate module]]
* [[mod/certificate/view|Viewing a Certificate]]
* [[Certificate customizing]] - many tips and how to make changes to code to customize certificates even more.
* [https://moodle.org/mod/forum/discuss.php?d=279569&parent=1201200 Adding new fonts to certificate] to support non-English languages
* Using Moodle [http://moodle.org/mod/forum/view.php?id=7163 Certificate module] forum
* [[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]]
* [http://tracker.moodle.org/browse/CONTRIB-334 Patch to enable linking] to [[Face-to-face module|Face-to-Face]] contributed module.
* [[Assignment_FAQ#What_is_a_good_procedure_to_issue_a_certificate_based_on_a_face-to-face_final_test.3F| What is a good procedure to issue a certificate based on a face-to-face final test]]
* [[Custom_certificate_module]] - This is a different certificate plugin.

[[Category:Certificate]]
[[Category:Contributed code]]

[[es:Módulo certificado]]

Certificate customizing

2020-11-05T11:58:09Z

Rcollman: /* See also */ ooops, is not part of standard install, just standard on my moodle

{{Certificate}}
A [[Certificate module|certificate]] can be customized beyond the standard downloaded install by the site administrator. In general:

#This can be done by uploading additional image types through the site administration menu. Or by uploading images into one of the certificate/pix folders.
#The displayed text can be changed by customizing the language in site administration. Or directly editing the /certificate/lang file.
#The location of certificate images and text can be change by creating/editing a certificate type's code.

==Certificate examples==
<gallery caption="Certificate examples - click on any to enlarge" widths="200px" heights="100px" perrow="6">
Image:Certificate 27 plain.png|Shows no options selected, standard title, course name, user name and words.
Image:Certificate 1.gif|Fancy border, signature line, seal, code
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 lines.png|Lines, signature, seal, watermark, code, grade, outcomes, custom text
.
Image:Certificate199 example creative.png|Uploaded border, signature, watermark and seal
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>

==Customizing==
The certificate code is located in the /mod/certificate folder. There are sub-folders for backup, db, lang (holds language sub-folders), type (holds standard certificate types, each in their own sub-folder) and pix. The pix folder holds the sub-folders for the default borders, seals, signatures and watermarks. These will be used at the time of installation and become the default standard choices, after that they will not be used.

===Adding images===
[[Image:Certificate199 example creative.png|thumb|Creative customized example]] The easiest way to customize your certificate is for the site administrator to add your own JPG or PNG images for borders, seals, signatures and watermarks to the default images found at the time of installation. The system administrator should go to the site administration block, Plugins>Activities>Certificate>Upload images.

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.The sample seals are 80x80 pixels in size, sample borders are 800x604 or 1024x831 pixels and sample watermarks are 386x468 or 380x380 pixels.

In the creative example, a custom border, watermark, signature and seal were uploaded. All were sized and in the same file format as the one supplied with the initial certificate install.

===Customize format===
[[Image:Certificate_27_customcode.png|thumb|New type with new strings, new positions]] You will need to be able to edit your Moodle code to create a custom 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 one of the certificate/type folders, copy and paste it in the certificate/type folder. Give the copied folder a new name. For example copy the /type/letter_non_embedded folder and rename it 'mycertificate'.

2. Open the certificate/lang/en/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 will appear on the drop down list as "My New Certificate".

:''Tip:'' You should add the proper string as shown in step 2 above or you may receive an error message and it will appear as if the code is broken. And remember if you update your certificate module that this file may be erased with a new version.
: ''Tip:'' The sections below give examples of how to change text and image position in a certificate type file. It also covers how to create a new text string in the certificate lang file.

===Modifying text and text position code examples===
Changing the location of text is done by using code to set the x,y position on the page. The "x" is the distance from the left margin and the "y" is the distance from the top. All the certificate type code files start off with defining x,y points for various strings or images.

Here are some examples which set the position in the same place:
:certificate_print_text($pdf, 28, 183, 'C', 'Times', 'B', 20, get_string('certifymoodle', 'certificate')); //This fixes the start of the text at 28,183.

:certificate_print_text($pdf, $x, $y + 55, 'C', 'Times', 'I', 20, get_string('certifymoodle', 'certificate')); // This uses the x string (which is $x= 28) and adds 55 to the y string (which was $y=128).

:certificate_print_text($pdf, $certx, $certy, 'C', 'Times', ' ', 20, get_string('certifymoodle', 'certificate')); //This uses new string definitions that were added to top of the in both Landscape and Portraits sections.

In the above examples we centered the text, used the Times font, used bold, italic and none and kept the font size to 20.

We also created a new text string called certifymoodle. In the /certifcate/lang/en/certificate.php file we copied the $string['certify'] = 'This is to certify that'; string line, pasted it underneath the original and changed it to read $string['certifymoodle'] = 'This is to say that'; See the section below for more examples of changing text.
:''Tip:'' Text not changing? You might want to go to the site administration language settings and turn off cache. Remember this will slow loading times for all users, so turn it back on as soon as you are done.

====Modifying image position code example====

We will change the signature position that is found in the type/letter_non_embedded/certificate.php file when we generate a pdf in landscape mode. There are at least 2 ways to change the code. Say we want to move it to the left to the 100 position from 130 and up to the 435 line from the 440 line.
*Near the top of the file, you should notice there are a set of variables for "Landscape" which are followed by another set for "Portrait". We can overrule some of the landscape and portrait codes the $sigx and $sigy position variables, so they read $sigx = 100 and $sigy = 435 .
**Alternatively, we can overrule some of the landscape and portrait codes, in this case the signature block. In the "// Add images and lines" section we see the code that actually prints in the position by using the landscape and portrait variables:
:print_signature($pdf, $certificate, $sigx, $sigy, '', '');
By changing the variables to fix numbers it will not matter if the teacher selects landscape or portrait mode for this custom type. For example:
:print_signature($pdf, $certificate, 100, 435, '', '');

If others have not added a standard signature line, you might want to fix it to a certain size. For example, you want the image to print 150px by 75px.

:print_signature($pdf, $certificate, $sigx, $sigy, '150', '75');

This should give you a good idea about how to change the position of other images.

====Adjusting transparency of an image====
It is possible to put in a strong image as a watermark and adjust the transparency setting when the PDF is created. Look for the SetAlpha code in front of a print element. For example infront of the "print_watermark.." line, you will see $pdf_SetAlpha(0.1); It is currently set to .1, the .3 in our example is less transparent.

:''Tip:'' In older version of certificate, the watermark image itself was dimmed before it was placed in the folder. If you had a custom watermark, this is the way it was done. You can change the SetAlpha in the code to 1 and it should appear as it did in previous version of certificate.

===Changing printed text===
There are two ways to change the language strings. A best practice is to customize your language pack via site administration. You will find the certificate.php in the mod group. If you use the method below, when you update all your certificate files, then your changes will not be saved.

You can edit the language file found in the certificate folder, such as certificate/lang/en/certificate.php if you are not worried about losing you changes. Lets say you want to change the words at the top of all certificates on your site.

Find the default strings:
:$string['title'] = 'CERTIFICATE OF ACHIEVEMENT';
:$string['intro'] = 'This is to certify that';
:$string['statement'] = 'has completed the course';

Change them to read (for example):
:$string['title'] = 'DIP0LOMA';
:$string['intro'] = 'I am proud to state that';
:$string['statement'] = 'has successfully passed the final exam';

===Adding a New Line of Text===
You have created a couple of custom certificate types. In these certificates you want some new words to appear. There are basically 2 choices, you can have it look up a new string, or hard code the words in the certificate type instead of looking for a string.

*Add new string method.
**Open the certificate/lang/en/certificate.php file and add your new string giving it a unique name.
:$string['mynewtext'] = 'This is what I want to print on the certificate';

**Open the file for your certificate type and change the string reference. For example, go to certificate/type/mycertificate/certificate.php. Near the end of the file find "// Add Text". This is the area 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:

:cert_printtext($pdf, $x, $y, 'C', 'Helvetica', '', 30, get_string('title', 'certificate'));

3. Add a new line below that to print your new text using the name you gave your new lang string like this:
:cert_printtext($pdf, $x, $y+25, 'C', 'Helvetica', 'B', 10, get_string('mynewtext', 'certificate'));

Quick review. We want the string mynewtext to start on the $x position from the left, on the $y+25 line, and the line should be center aligned (C, L, R or ' '), in Helvetica type, in bold, with a font size of 10.

5. You can add a hard coded line of text. For example, add signature title block line under the signature image:
:cert_printtext($pdf, $sigx, $sigy+30,'', 'Helvetica', 'B', 10, 'Martin Dougiamas, Lead Developer');

===Adding a second page===
Add another page to a certificate by placing this code on the last empty line.

$pdf->AddPage();

Then add the code you want to create the second page.

For example, place the $pdf->Addpage();, then copy the //Text section from the first page to the second page. The second page will not have watermark or borders when a certificate is created.

==Nov 2011 changes==
[https://github.com/PukunuiAustralia/moodle-mod_certificate PukunuiAustralia / moodle-mod_certificate] version 2011110107 is the basis for these comments. There maybe earlier versions which are different.
*Standard types of certificates. There are 4 standard certificate types based upon paper size and if the fonts are embedded or non-embedded in the pdf documents. The orientation of landscape or portrait is located within each of these types. This is different from the 1.9.x versions.
*The code for printing strings has changed. While similar to the pre 2.0, be careful.

==Tips & Tricks==
*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.
*Certificate icon location-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 image. For 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.
*Consider editing you language pack rather than the /certificate/lang/en/certificate.php file. You can do this through the Settings > Site administration >Language > Language customization menu. Look for mod/certificate.php. Then when you update your certificate and it's language,it will keep your changes for the standard strings.
*You can use a graphics program to edit the empty center space in a 'border' image to create a certificate 'background' that contains larger images, more images and multiple signature lines - without having to edit code. This is useful if a series of courses are all going to need the same basic certificate layout - just select the correct 'border image' under Design options and be done.
*Use a topic section heading as the certificate title. See [http://moodle.org/mod/forum/discuss.php?d=193170#p842551 in the certificate forum] for a code tweak.
*Your image is stretching? Add some white space to either side of your canvas. For example add white space to create the same width/height ratio as defined by the wmarkw and wmarkh code variables.

==See also==
* [[mod/certificate/mod|Add/Edit Certificate]]
* [[mod/certificate/view|Viewing a Certificate]]
* [[Custom_certificate_module]] - Link to another certificate plugin
[[es:Personalizar certificado]]

Certificate customizing

2020-11-05T11:54:02Z

Rcollman: /* See also */ deleted dead git hub link and added link to certificate that comes with std install

{{Certificate}}
A [[Certificate module|certificate]] can be customized beyond the standard downloaded install by the site administrator. In general:

#This can be done by uploading additional image types through the site administration menu. Or by uploading images into one of the certificate/pix folders.
#The displayed text can be changed by customizing the language in site administration. Or directly editing the /certificate/lang file.
#The location of certificate images and text can be change by creating/editing a certificate type's code.

==Certificate examples==
<gallery caption="Certificate examples - click on any to enlarge" widths="200px" heights="100px" perrow="6">
Image:Certificate 27 plain.png|Shows no options selected, standard title, course name, user name and words.
Image:Certificate 1.gif|Fancy border, signature line, seal, code
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 lines.png|Lines, signature, seal, watermark, code, grade, outcomes, custom text
.
Image:Certificate199 example creative.png|Uploaded border, signature, watermark and seal
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>

==Customizing==
The certificate code is located in the /mod/certificate folder. There are sub-folders for backup, db, lang (holds language sub-folders), type (holds standard certificate types, each in their own sub-folder) and pix. The pix folder holds the sub-folders for the default borders, seals, signatures and watermarks. These will be used at the time of installation and become the default standard choices, after that they will not be used.

===Adding images===
[[Image:Certificate199 example creative.png|thumb|Creative customized example]] The easiest way to customize your certificate is for the site administrator to add your own JPG or PNG images for borders, seals, signatures and watermarks to the default images found at the time of installation. The system administrator should go to the site administration block, Plugins>Activities>Certificate>Upload images.

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.The sample seals are 80x80 pixels in size, sample borders are 800x604 or 1024x831 pixels and sample watermarks are 386x468 or 380x380 pixels.

In the creative example, a custom border, watermark, signature and seal were uploaded. All were sized and in the same file format as the one supplied with the initial certificate install.

===Customize format===
[[Image:Certificate_27_customcode.png|thumb|New type with new strings, new positions]] You will need to be able to edit your Moodle code to create a custom 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 one of the certificate/type folders, copy and paste it in the certificate/type folder. Give the copied folder a new name. For example copy the /type/letter_non_embedded folder and rename it 'mycertificate'.

2. Open the certificate/lang/en/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 will appear on the drop down list as "My New Certificate".

:''Tip:'' You should add the proper string as shown in step 2 above or you may receive an error message and it will appear as if the code is broken. And remember if you update your certificate module that this file may be erased with a new version.
: ''Tip:'' The sections below give examples of how to change text and image position in a certificate type file. It also covers how to create a new text string in the certificate lang file.

===Modifying text and text position code examples===
Changing the location of text is done by using code to set the x,y position on the page. The "x" is the distance from the left margin and the "y" is the distance from the top. All the certificate type code files start off with defining x,y points for various strings or images.

Here are some examples which set the position in the same place:
:certificate_print_text($pdf, 28, 183, 'C', 'Times', 'B', 20, get_string('certifymoodle', 'certificate')); //This fixes the start of the text at 28,183.

:certificate_print_text($pdf, $x, $y + 55, 'C', 'Times', 'I', 20, get_string('certifymoodle', 'certificate')); // This uses the x string (which is $x= 28) and adds 55 to the y string (which was $y=128).

:certificate_print_text($pdf, $certx, $certy, 'C', 'Times', ' ', 20, get_string('certifymoodle', 'certificate')); //This uses new string definitions that were added to top of the in both Landscape and Portraits sections.

In the above examples we centered the text, used the Times font, used bold, italic and none and kept the font size to 20.

We also created a new text string called certifymoodle. In the /certifcate/lang/en/certificate.php file we copied the $string['certify'] = 'This is to certify that'; string line, pasted it underneath the original and changed it to read $string['certifymoodle'] = 'This is to say that'; See the section below for more examples of changing text.
:''Tip:'' Text not changing? You might want to go to the site administration language settings and turn off cache. Remember this will slow loading times for all users, so turn it back on as soon as you are done.

====Modifying image position code example====

We will change the signature position that is found in the type/letter_non_embedded/certificate.php file when we generate a pdf in landscape mode. There are at least 2 ways to change the code. Say we want to move it to the left to the 100 position from 130 and up to the 435 line from the 440 line.
*Near the top of the file, you should notice there are a set of variables for "Landscape" which are followed by another set for "Portrait". We can overrule some of the landscape and portrait codes the $sigx and $sigy position variables, so they read $sigx = 100 and $sigy = 435 .
**Alternatively, we can overrule some of the landscape and portrait codes, in this case the signature block. In the "// Add images and lines" section we see the code that actually prints in the position by using the landscape and portrait variables:
:print_signature($pdf, $certificate, $sigx, $sigy, '', '');
By changing the variables to fix numbers it will not matter if the teacher selects landscape or portrait mode for this custom type. For example:
:print_signature($pdf, $certificate, 100, 435, '', '');

If others have not added a standard signature line, you might want to fix it to a certain size. For example, you want the image to print 150px by 75px.

:print_signature($pdf, $certificate, $sigx, $sigy, '150', '75');

This should give you a good idea about how to change the position of other images.

====Adjusting transparency of an image====
It is possible to put in a strong image as a watermark and adjust the transparency setting when the PDF is created. Look for the SetAlpha code in front of a print element. For example infront of the "print_watermark.." line, you will see $pdf_SetAlpha(0.1); It is currently set to .1, the .3 in our example is less transparent.

:''Tip:'' In older version of certificate, the watermark image itself was dimmed before it was placed in the folder. If you had a custom watermark, this is the way it was done. You can change the SetAlpha in the code to 1 and it should appear as it did in previous version of certificate.

===Changing printed text===
There are two ways to change the language strings. A best practice is to customize your language pack via site administration. You will find the certificate.php in the mod group. If you use the method below, when you update all your certificate files, then your changes will not be saved.

You can edit the language file found in the certificate folder, such as certificate/lang/en/certificate.php if you are not worried about losing you changes. Lets say you want to change the words at the top of all certificates on your site.

Find the default strings:
:$string['title'] = 'CERTIFICATE OF ACHIEVEMENT';
:$string['intro'] = 'This is to certify that';
:$string['statement'] = 'has completed the course';

Change them to read (for example):
:$string['title'] = 'DIP0LOMA';
:$string['intro'] = 'I am proud to state that';
:$string['statement'] = 'has successfully passed the final exam';

===Adding a New Line of Text===
You have created a couple of custom certificate types. In these certificates you want some new words to appear. There are basically 2 choices, you can have it look up a new string, or hard code the words in the certificate type instead of looking for a string.

*Add new string method.
**Open the certificate/lang/en/certificate.php file and add your new string giving it a unique name.
:$string['mynewtext'] = 'This is what I want to print on the certificate';

**Open the file for your certificate type and change the string reference. For example, go to certificate/type/mycertificate/certificate.php. Near the end of the file find "// Add Text". This is the area 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:

:cert_printtext($pdf, $x, $y, 'C', 'Helvetica', '', 30, get_string('title', 'certificate'));

3. Add a new line below that to print your new text using the name you gave your new lang string like this:
:cert_printtext($pdf, $x, $y+25, 'C', 'Helvetica', 'B', 10, get_string('mynewtext', 'certificate'));

Quick review. We want the string mynewtext to start on the $x position from the left, on the $y+25 line, and the line should be center aligned (C, L, R or ' '), in Helvetica type, in bold, with a font size of 10.

5. You can add a hard coded line of text. For example, add signature title block line under the signature image:
:cert_printtext($pdf, $sigx, $sigy+30,'', 'Helvetica', 'B', 10, 'Martin Dougiamas, Lead Developer');

===Adding a second page===
Add another page to a certificate by placing this code on the last empty line.

$pdf->AddPage();

Then add the code you want to create the second page.

For example, place the $pdf->Addpage();, then copy the //Text section from the first page to the second page. The second page will not have watermark or borders when a certificate is created.

==Nov 2011 changes==
[https://github.com/PukunuiAustralia/moodle-mod_certificate PukunuiAustralia / moodle-mod_certificate] version 2011110107 is the basis for these comments. There maybe earlier versions which are different.
*Standard types of certificates. There are 4 standard certificate types based upon paper size and if the fonts are embedded or non-embedded in the pdf documents. The orientation of landscape or portrait is located within each of these types. This is different from the 1.9.x versions.
*The code for printing strings has changed. While similar to the pre 2.0, be careful.

==Tips & Tricks==
*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.
*Certificate icon location-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 image. For 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.
*Consider editing you language pack rather than the /certificate/lang/en/certificate.php file. You can do this through the Settings > Site administration >Language > Language customization menu. Look for mod/certificate.php. Then when you update your certificate and it's language,it will keep your changes for the standard strings.
*You can use a graphics program to edit the empty center space in a 'border' image to create a certificate 'background' that contains larger images, more images and multiple signature lines - without having to edit code. This is useful if a series of courses are all going to need the same basic certificate layout - just select the correct 'border image' under Design options and be done.
*Use a topic section heading as the certificate title. See [http://moodle.org/mod/forum/discuss.php?d=193170#p842551 in the certificate forum] for a code tweak.
*Your image is stretching? Add some white space to either side of your canvas. For example add white space to create the same width/height ratio as defined by the wmarkw and wmarkh code variables.

==See also==
* [[mod/certificate/mod|Add/Edit Certificate]]
* [[mod/certificate/view|Viewing a Certificate]]
* [[Custom_certificate_module]] - Link to certificate that comes with a standard Moodle install.

[[es:Personalizar certificado]]

Certificate module

2020-11-05T11:50:42Z

Rcollman: /* See also */ Direct to the custom certificate, part of Moodle core

{{Certificate}}
{{Infobox plugin
|type = Activity
|entry = https://moodle.org/plugins/mod_customcert
|tracker = https://github.com/markn86/moodle-mod_customcert/issues
|discussion = https://moodle.org/plugins/mod_customcert
|maintainer = [[User:Mark Nelson|Mark Nelson]]
|float = right
}}
The '''Certificate module''' creates PDF certificates/diplomas for students in a course. You can add borders, watermarks, seals, signatures, outcomes, grades, add custom text to a certificate via the settings menu.

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. Two examples show certificates made with the settings menu. The two other examples show a few possible ways to customize a certificate.
<gallery caption="Certificate examples - click on any to enlarge" widths="200px" heights="100px" perrow="6">
Image:Certificate 27 plain.png|Shows no options selected, standard title, course name, user name and words.
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|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>

==Installing==
#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 . 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).
#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.

==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>Settings>Upload images >Type. Types are borders, seals, signatures and watermarks.
*Alternatively, 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 access to the moodle/mod/certificate folder.

==See also==
* [[Add/edit certificate module]]
* [[mod/certificate/view|Viewing a Certificate]]
* [[Certificate customizing]] - many tips and how to make changes to code to customize certificates even more.
* [https://moodle.org/mod/forum/discuss.php?d=279569&parent=1201200 Adding new fonts to certificate] to support non-English languages
* Using Moodle [http://moodle.org/mod/forum/view.php?id=7163 Certificate module] forum
* [[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]]
* [http://tracker.moodle.org/browse/CONTRIB-334 Patch to enable linking] to [[Face-to-face module|Face-to-Face]] contributed module.
* [[Assignment_FAQ#What_is_a_good_procedure_to_issue_a_certificate_based_on_a_face-to-face_final_test.3F| What is a good procedure to issue a certificate based on a face-to-face final test]]
* [[Custom_certificate_module]] - This comes with a standard Moodle install.

[[Category:Certificate]]
[[Category:Contributed code]]

[[es:Módulo certificado]]

Add/edit certificate module

2016-09-14T11:10:14Z

Rcollman: /* Save Certificates */ Selecting yes prevents additional certificates from being issued

{{Certificate}}
To create a new Certificate select Certificate from the Activities list when viewing a course, with editing turn on. You can customise your Certificate using the following settings:

== General Settings ==
''Settings > Certificate administration > Edit settings''

===Certificate Name===
The Certificate Name will appear on the course home page and will typically tell the users the purpose or type of Certificate being issued. It is possible to have many different certificates in one course.

===Introduction===
This text will be displayed to users when they open the Certificate activity. An introduction should be descriptive and tell the user the purpose or requirements of the certificate.

==Issue Options==

===Email Teachers===

If the Email Teachers option is set to Yes then all users with a Teacher/Trainer role within the course will receive an autogenerated email whenever a student receives a Certificate.

===Email Others===
If there are users within a course that do not have Teacher/Trainer access rights but should be notified when a user receives a Certificate you can enter thier email address in this field. When entering multiple addresses, they should be separated with a comma.

===Delivery===

The Delivery option allows you to choose how students view/receive their Certificate. There are three options:

;Open in Browser
:Opens the Certificate in a new browser window.

;Force Download
:Opens the browser file download window. (Note: Internet Explorer does not currently support the open option from the download window. The save option must be chosen first.)

;Email Certificate
:Choosing this option sends the Certificate to the student as an email attachment (PDF).

===Save Certificates===
The Save Certificate option keeps a copy of the certificate for both the student and the teacher to download and/or review. With "yes" selected, students can click on their certificate link and only make a duplicate copy of the original certificate. Teachers can see a list of all students certificates via the View Issued Certificates report. By selecting "no", a new certificate will be created every time a student views it and no copy will be saved by the system.

==Text Options==

===Print Date===
There are three options. Do not print, print the date the Certificate was issued to the user, or print the course end date.

===Date Format===
The options for a date format are: "January 1, 2000", "January 1st, 2000", "1 January 2000", "January 2000" and "User's language Date Format".

===Print Code===

A unique 10-digit code of random letters and numbers can be printed on the Certificate that is specific to a user and the certificate. This number can then be verified by comparing it to the code number displayed in the teacher View Issued Certificates report.

===Print Grade===

You can choose to print either the total course grade, or the grade of a selected course activity of a user on the Certificate. The grade items are listed in the dropdown menu in the order in which they appear in the Gradebook.

Please note: Once a user has received their Certificate, their grade on the Certificate will not change even if their course grade changes.

===Grade Format===

There are three available formats if you choose to print a grade on the Certificate:

;Percentage Grade
:Prints the grade as a percentage.

;Points Grade
:Prints the point value of the grade.

;Letter Grade
:Prints the percentage grade as a letter.

===Print Outcome===

You can choose any course Outcome name and result on the Certificate. For example 'Assignment Outcome: Proficient'

===Print Credit Hours===
You may enter a number in this field. For example, if you entered 5, then the certificate would show "Credit Hours: 5". By editing the language, it might say "CEUs: 5" or "Days of Participation: 5".

===Print Teacher Name(s)===

If you wish to include the course Teacher name on the Certificate, select Yes under Print Teacher Name(s) and ensure the required staff have been assigned Teacher/Trainer roles at the Certificate Module level.

===Custom Text===
Additional text may be added to the Certificate via the Custom Text field. By default, this text is placed in the lower left of the Certificate.
You can use the text box to enter html, insert links and insert an image,

The following html tags are available:

:<nowiki> < br > and < p ></nowiki>
:<nowiki> < b >, < i > and < u ></nowiki>
:<nowiki> < img > (src and width (or height) are mandatory)</nowiki>
:<nowiki>< a > (href is mandatory)</nowiki>
:<nowiki> < font > possible attributes are - colour: hex colour code and face: arial, times, courier, helvetica, symbol
</nowiki>

==Design Options==
All of the design options can be customized. This includes changing positions of the images or text, adding or changing images.

===Certificate Type===
The certificate type determines what and where things (if selected) will be printed. The Certificate activity comes with 2 paper sizes, with 2 font options
*A4 embedded (fonts)
*A4 non-embedded
*Letter embedded
*Letter non-embedded

If you created any custom certificate types, they will appear on this pulldown menu.

===Orientation===
Select either landscape or portrait. The code for each of these page orientations are located in each of the certificate types.

===Border Image===
Select the border image that you want around the Certificate edges or select No border. By default there are two different border images each in 4 different colors.

===Border Lines===
Instead of, or in addition to a Border Image you can select for a simple three line Border Line around the edge of the Certificate. By default there the line colours are "no" (none), black, blue, brown and green.

===Watermark Image===
A Watermark file can be placed in the background of a Certificate. A Watermark could be a specific logo, seal, crest etc. By default two Watermark Images are included, a sample school crest and a Fleur de lis .

===Signature Image===
This option allows you to print a digital signature or print a line for a written signature on the Certificate.

===Seal or Logo Image===
This option allows you to select a seal or logo to print on the Certificate from a repository of options. By default five seal images and an example logo image are available.

==Common Module Settings==
These may vary according to advanced options and site settings.

===Visible===
If you choose Show, then students in the course will be able to see this Certificate activity and attempt to generate a Certificate. If you choose Hide, then only users with teacher or administrative permissions in the course or Certificate activity will be able to see it.

===ID number===
Reference number used by gradebook and grade calculations. Typically this is left blank.

===Group mode===
A Certificate activity can have the following three Group options:
*No groups - The issue of the Certificate will not consider groups
*Separate groups - Each group can only see their own Certificate activity but others are invisible
*Visible groups - Each group can see their own Certificate as well as see the Certificate activity of other groups.

===Grouping===

==Restrict access==
This feature has to be enabled on the site level under ''Site administration > advanced settings > Enable conditional access''. See [[Conditional activities]] for more information.
===Allow access dates===
*Allow access from
*Allow access until

===Grade condition===
Select the unit or the Course total option.
Choose the minimum required percentage and the max (leave blank if it 100%) grade

:You can set the "lock" on several activities. However best practice is to daisy chain the activities by their conditions. Thus if you had a series of 10 grade conditional activities, each one would be dependent upon the one immediately preceding it. In this example, certificate would set the condition on the 10th activity.

==Activity completion ==
This feature has to be enabled on the site level under "advanced settings". Please see [[Activity completion]] for more information about the features below.
*Completion tracking
*Require view
*Expect completed

==Examples of certificates==

<gallery caption="Both these examples are in blue. Other border colors are black, brown and green. Click on image to enlarge" widths="200px" heights="100px" perrow="3">
Image:Certificate 1.gif|Standard certificate - few options turned on.
Image:Certificate199 example.png|Standard certificate - many options turned on.
</gallery>

==See also==
[[Certificate module]]

[[Category:Certificate]]

[[es:Añadir/editar certificado]]

Certificate customizing

2016-03-19T18:02:52Z

Rcollman: /* Tips & Tricks */ correct image stretching.

{{Certificate}}
A [[Certificate module|certificate]] can be customized beyond the standard downloaded install by the site administrator. In general:

#This can be done by uploading additional image types through the site administration menu. Or by uploading images into one of the certificate/pix folders.
#The displayed text can be changed by customizing the language in site administration. Or directly editing the /certificate/lang file.
#The location of certificate images and text can be change by creating/editing a certificate type's code.

==Certificate examples==
<gallery caption="Certificate examples - click on any to enlarge" widths="200px" heights="100px" perrow="6">
Image:Certificate 27 plain.png|Shows no options selected, standard title, course name, user name and words.
Image:Certificate 1.gif|Fancy border, signature line, seal, code
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 lines.png|Lines, signature, seal, watermark, code, grade, outcomes, custom text
.
Image:Certificate199 example creative.png|Uploaded border, signature, watermark and seal
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>

==Customizing==
The certificate code is located in the /mod/certificate folder. There are sub-folders for backup, db, lang (holds language sub-folders), type (holds standard certificate types, each in their own sub-folder) and pix. The pix folder holds the sub-folders for the default borders, seals, signatures and watermarks. These will be used at the time of installation and become the default standard choices, after that they will not be used.

===Adding images===
[[Image:Certificate199 example creative.png|thumb|Creative customized example]] The easiest way to customize your certificate is for the site administrator to add your own JPG or PNG images for borders, seals, signatures and watermarks to the default images found at the time of installation. The system administrator should go to the site administration block, Plugins>Activities>Certificate>Upload images.

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.The sample seals are 80x80 pixels in size, sample borders are 800x604 or 1024x831 pixels and sample watermarks are 386x468 or 380x380 pixels.

In the creative example, a custom border, watermark, signature and seal were uploaded. All were sized and in the same file format as the one supplied with the initial certificate install.

===Customize format===
[[Image:Certificate_27_customcode.png|thumb|New type with new strings, new positions]] You will need to be able to edit your Moodle code to create a custom 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 one of the certificate/type folders, copy and paste it in the certificate/type folder. Give the copied folder a new name. For example copy the /type/letter_non_embedded folder and rename it 'mycertificate'.

2. Open the certificate/lang/en/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 will appear on the drop down list as "My New Certificate".

:''Tip:'' You should add the proper string as shown in step 2 above or you may receive an error message and it will appear as if the code is broken. And remember if you update your certificate module that this file may be erased with a new version.
: ''Tip:'' The sections below give examples of how to change text and image position in a certificate type file. It also covers how to create a new text string in the certificate lang file.

===Modifying text and text position code examples===
Changing the location of text is done by using code to set the x,y position on the page. The "x" is the distance from the left margin and the "y" is the distance from the top. All the certificate type code files start off with defining x,y points for various strings or images.

Here are some examples which set the position in the same place:
:certificate_print_text($pdf, 28, 183, 'C', 'Times', 'B', 20, get_string('certifymoodle', 'certificate')); //This fixes the start of the text at 28,183.

:certificate_print_text($pdf, $x, $y + 55, 'C', 'Times', 'I', 20, get_string('certifymoodle', 'certificate')); // This uses the x string (which is $x= 28) and adds 55 to the y string (which was $y=128).

:certificate_print_text($pdf, $certx, $certy, 'C', 'Times', ' ', 20, get_string('certifymoodle', 'certificate')); //This uses new string definitions that were added to top of the in both Landscape and Portraits sections.

In the above examples we centered the text, used the Times font, used bold, italic and none and kept the font size to 20.

We also created a new text string called certifymoodle. In the /certifcate/lang/en/certificate.php file we copied the $string['certify'] = 'This is to certify that'; string line, pasted it underneath the original and changed it to read $string['certifymoodle'] = 'This is to say that'; See the section below for more examples of changing text.
:''Tip:'' Text not changing? You might want to go to the site administration language settings and turn off cache. Remember this will slow loading times for all users, so turn it back on as soon as you are done.

====Modifying image position code example====

We will change the signature position that is found in the type/letter_non_embedded/certificate.php file when we generate a pdf in landscape mode. There are at least 2 ways to change the code. Say we want to move it to the left to the 100 position from 130 and up to the 435 line from the 440 line.
*Near the top of the file, you should notice there are a set of variables for "Landscape" which are followed by another set for "Portrait". We can overrule some of the landscape and portrait codes the $sigx and $sigy position variables, so they read $sigx = 100 and $sigy = 435 .
**Alternatively, we can overrule some of the landscape and portrait codes, in this case the signature block. In the "// Add images and lines" section we see the code that actually prints in the position by using the landscape and portrait variables:
:print_signature($pdf, $certificate, $sigx, $sigy, '', '');
By changing the variables to fix numbers it will not matter if the teacher selects landscape or portrait mode for this custom type. For example:
:print_signature($pdf, $certificate, 100, 435, '', '');

If others have not added a standard signature line, you might want to fix it to a certain size. For example, you want the image to print 150px by 75px.

:print_signature($pdf, $certificate, $sigx, $sigy, '150', '75');

This should give you a good idea about how to change the position of other images.

====Adjusting transparency of an image====
It is possible to put in a strong image as a watermark and adjust the transparency setting when the PDF is created. Look for the SetAlpha code in front of a print element. For example infront of the "print_watermark.." line, you will see $pdf_SetAlpha(0.1); It is currently set to .1, the .3 in our example is less transparent.

:''Tip:'' In older version of certificate, the watermark image itself was dimmed before it was placed in the folder. If you had a custom watermark, this is the way it was done. You can change the SetAlpha in the code to 1 and it should appear as it did in previous version of certificate.

===Changing printed text===
There are two ways to change the language strings. A best practice is to customize your language pack via site administration. You will find the certificate.php in the mod group. If you use the method below, when you update all your certificate files, then your changes will not be saved.

You can edit the language file found in the certificate folder, such as certificate/lang/en/certificate.php if you are not worried about losing you changes. Lets say you want to change the words at the top of all certificates on your site.

Find the default strings:
:$string['title'] = 'CERTIFICATE OF ACHIEVEMENT';
:$string['intro'] = 'This is to certify that';
:$string['statement'] = 'has completed the course';

Change them to read (for example):
:$string['title'] = 'DIP0LOMA';
:$string['intro'] = 'I am proud to state that';
:$string['statement'] = 'has successfully passed the final exam';

===Adding a New Line of Text===
You have created a couple of custom certificate types. In these certificates you want some new words to appear. There are basically 2 choices, you can have it look up a new string, or hard code the words in the certificate type instead of looking for a string.

*Add new string method.
**Open the certificate/lang/en/certificate.php file and add your new string giving it a unique name.
:$string['mynewtext'] = 'This is what I want to print on the certificate';

**Open the file for your certificate type and change the string reference. For example, go to certificate/type/mycertificate/certificate.php. Near the end of the file find "// Add Text". This is the area 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:

:cert_printtext($pdf, $x, $y, 'C', 'Helvetica', '', 30, get_string('title', 'certificate'));

3. Add a new line below that to print your new text using the name you gave your new lang string like this:
:cert_printtext($pdf, $x, $y+25, 'C', 'Helvetica', 'B', 10, get_string('mynewtext', 'certificate'));

Quick review. We want the string mynewtext to start on the $x position from the left, on the $y+25 line, and the line should be center aligned (C, L, R or ' '), in Helvetica type, in bold, with a font size of 10.

5. You can add a hard coded line of text. For example, add signature title block line under the signature image:
:cert_printtext($pdf, $sigx, $sigy+30,'', 'Helvetica', 'B', 10, 'Martin Dougiamas, Lead Developer');

===Adding a second page===
Add another page to a certificate by placing this code on the last empty line.

$pdf->AddPage();

Then add the code you want to create the second page.

For example, place the $pdf->Addpage();, then copy the //Text section from the first page to the second page. The second page will not have watermark or borders when a certificate is created.

==Nov 2011 changes==
[https://github.com/PukunuiAustralia/moodle-mod_certificate PukunuiAustralia / moodle-mod_certificate] version 2011110107 is the basis for these comments. There maybe earlier versions which are different.
*Standard types of certificates. There are 4 standard certificate types based upon paper size and if the fonts are embedded or non-embedded in the pdf documents. The orientation of landscape or portrait is located within each of these types. This is different from the 1.9.x versions.
*The code for printing strings has changed. While similar to the pre 2.0, be careful.

==Tips & Tricks==
*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.
*Certificate icon location-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 image. For 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.
*Consider editing you language pack rather than the /certificate/lang/en/certificate.php file. You can do this through the Settings > Site administration >Language > Language customization menu. Look for mod/certificate.php. Then when you update your certificate and it's language,it will keep your changes for the standard strings.
*You can use a graphics program to edit the empty center space in a 'border' image to create a certificate 'background' that contains larger images, more images and multiple signature lines - without having to edit code. This is useful if a series of courses are all going to need the same basic certificate layout - just select the correct 'border image' under Design options and be done.
*Use a topic section heading as the certificate title. See [http://moodle.org/mod/forum/discuss.php?d=193170#p842551 in the certificate forum] for a code tweak.
*Your image is stretching? Add some white space to either side of your canvas. For example add white space to create the same width/height ratio as defined by the wmarkw and wmarkh code variables.

==See also==
* [[mod/certificate/mod|Add/Edit Certificate]]
* [[mod/certificate/view|Viewing a Certificate]]
* Moodle 2.x and later versions of certificate can be found at [https://github.com/PukunuiAustralia/moodle-mod_certificate PukunuiAustralia / moodle-mod_certificate].

[[es:Personalizar certificado]]

Questionnaire module

2016-01-11T21:41:15Z

Rcollman: /* Types of reports */ add information about Reports and Export

{{Questionnaire}}

The Moodle '''Questionnaire module''' is a survey-like type of activity. It is a contributed module which can be downloaded from the [http://moodle.org/plugins/view.php?plugin=mod_questionnaire Moodle Plugins Directory]. It allows teachers to create a wide range of questions to get student feedback e.g. on a course or activities. The goals of the Questionnaire module are quite different from those of the Moodle '''Lesson''' or '''Quiz''' modules. With Questionnaire you do not test or assess the student, you ''gather data''.

==Summary of features==
Please look at the [[Adding/editing a questionnaire]] and [[Editing Questionnaire questions|Adding Questions]] pages for more information.

===Types of questions===
*Check Boxes
*Date Box
*Dropdown choices
*Essay box - HTML editor possible, set width and height of box
*Numeric - can set length and number of decimal places
*Radio buttons - have labels you determine for each question
*Scale - can customize in many ways
*Text box
*Yes/no
You can also place:
*Page breaks
*Labels - might be used to give an overview of next set of questions

===Types of reports===
*Responses can be viewed by everyone or select group
===Export text file===
Responses can be exported as a Tab separated text file.
*Each column contains a field for: Submitted on (date time), Institution, Department, Course, ID (user ID), Full name, Username, and each question.
*The settings allow two check boxes to show the user choice code and to show the use choice text.

==See also==
* The Questionnaire plugin can be downloaded from the [http://moodle.org/plugins/view.php?plugin=mod_questionnaire Moodle Plugins Directory].
*Discussions: please create or find a discussion topic in the [http://moodle.org/mod/forum/view.php?f=469 Questionnaire Forum]
*[http://en.wikipedia.org/wiki/Statistical_survey Statistical_survey] From Wikipedia, the free encyclopedia.

[[Category:Contributed code]]

[[es:Módulo cuestionario]]
[[fr:Questionnaire]]

Quiz submission email notification

2015-12-29T20:28:54Z

Rcollman: /* Allow notification messages to teachers */ add how to for just a specific teacher in a specific quiz rather than all teachers in the course

{{Quiz}}
It is possible for a message to be sent out to confirm that the student submitted the quiz.

There are two types of notification:
#A confirmation to the student that their attempt has finished successfully
#A notification to the teacher(s) that someone has submitted an attempt. Messages are never sent for preview attempts.

Note that although the capabilities are "emailnotifysubmission/emailconfirmsubmission" the notifications do NOT have to be via email. The notifications come via Moodle's messaging system. Admins can set the defaults from ''Administration > Site administration > Plugins > Message outputs > Default message outputs'' to enable/disable email/pop up notification.
{|
| [[File:quizsubmissionnotificationdefault.png|thumb|Quiz submission notification default settings]]
|}

See [[Messaging settings]] for more details. (Notification messages in Moodle quiz are disabled by default.)

==Allow Quiz notification messages to teachers==

To do this for an individual quiz, go to:
''Administration > Quiz administration > Permissions''

This may also be done on the site level by the administrator in ''Administration > Site administration > Users > Permissions > Define roles > Teacher''

#In the Capability column under ''Activity: Quiz'' find the capability ''mod/quiz:emailnotifysubmission''
#Click on the +
#On the next screen, select Teacher and click "Allow"

{|
| [[File:teacherno.png|thumb|1. Click the + to add a role ]]
| [[File:teacheradd.png|thumb|2. Select Teacher and click "Allow"]]
| [[File:teacheryes.png|thumb|3. Teachers will now receive messages]]
|}
===Messages in a specific quiz to specific teacher(s)===
The system administrator will need to create a new role, and allow the the capability ''mod/quiz:emailnotifysubmission'' for that role. Do not give the capability to the teacher's role on the system or course level. The new role is similar to a teacher's role and should be available on the activity level.

In the course, go to the quiz and the quiz administration>locally assigned roles, assign the user(s) that should get emails/messages for a submitted quiz to the new role.

==Allow confirmation messages to students==
To do this for an individual quiz, go to:
''Administration > Quiz administration > Permissions''

This may also be done on the site level by the administrator in ''Administration > Site administration > Users > Permissions > Define roles > Student''

#In the Capability column under ''Activity: Quiz'' find the capability ''mod/quiz:emailconfirmsubmission''
#Click on the +
#On the next screen, select Student and click "Allow"

{|
| [[File:studentno.png|thumb|1. Click the + to add a role ]]
| [[File:studentadd.png|thumb|2. Select Student and click "Allow"]]
| [[File:studentyes.png|thumb|3. Students will now receive messages]]
|}

==Notes==
:Note that if the quiz is set to separate groups, then teachers will only get a notification if either
* the student is in the same group as the teacher, or
* the teacher has moodle/site:accessallgroups.

==How to configure the text of the messages==
''Administration > Site administration > Language > Language customization''

This can only be done by a user that has permission to alter the language files. To reconfigure the way the email reads, you will need to understand string variables and how they work as part of another string. While not complicated, this will require attention to detail. This section assumes you also have read [[Language customization]].

The subject and body of the emails are defined in the quiz.php language file that are in the "mod" group. The strings to edit are 'emailconfirmsubject', 'emailconfirmbody', 'emailnotifysubject' and 'emailnotifybody'. The $a string passed in when these language strings are loaded contains all the following information:

===The emailconfirmbody string===
<nowiki> Dear {$a->username}, Thank you for submitting your answers to '{$a->quizname}' in course '{$a->coursename}' at {$a->submissiontime}. This message confirms that we have safely received your answers. You can access this quiz at {$a->quizurl}.</nowiki>

===The emailnotifybody string===
<nowiki>Dear {$a->username}, {$a->studentname} has completed the quiz '{$a->quizname}' ({$a->quizurl}) in course '{$a->coursename}' You can review this attempt at {$a->quizreviewurl}.</nowiki>

=== The emailnotifysmall===
<nowiki>{$a->studentname} has completed {$a->quizname}</nowiki>

===The emailnotifysubject string===
<nowiki>Quiz submission confirmation: {$a->quizname}</nowiki>

===Potential strings to use in an email===
;$a->coursename
:The name of the course
;$a->courseshortname
:The shortname of the course
;$a->quizname
:The name of the quiz
;$a->quizreporturl
:The URL of the results overview for this quiz (.../mod/quiz/report.php?q=''quizid'')
;$a->quizreportlink
:The URL of the results overview URL and quiz name as a HTML link
;$a->quizreviewurl
:The URL of the review page for this attempt (.../mod/quiz/review.php?attempt=''attemptid'')
;$a->quizreviewlink
:The attempt review URL and quiz name as a HTML link
;$a->quizurl
:The URL of the main page of the quiz (.../mod/quiz/view.php?q=''quizid'')
;$a->quizlink
:The URL of the quiz and the quiz name as a HTML link
;$a->attemptsubmissiontime
:The time the attempt was submitted, formatted using userdate().
;$a->timetaken
:How long the quiz attempt lasted.
;$a->studentname
:The name of the person who submitted the quiz.
;$a->studentidnumber
:The idnumber of the person who submitted the quiz.
;$a->studentusername
:The username of the person who submitted the quiz.
;$a->username
:The name of the user the email is being sent to.
;$a->useridnumber
:The idnumber of the user the email is being sent to.
;$a->userusername
:The username of the user the email is being sent to.

[[ja:解答送信の通知メール]]
[[de:E-Mail-Benachrichtigung bei Testabgabe]]

Cohorts FAQ

2015-12-10T01:03:11Z

Rcollman: /* What is the difference between a cohort and a group? */ Expand upon example, put cohort first, group second.

{{Grouping users}}

==What is the difference between a cohort and a group?==

A cohort exists for enrolment purposes. A group exists only within a course.

Cohorts are a batch(group) of users created by admin which can then be brought in "en masse" to one or more courses. So if "Class 10B" is created as a cohort by admin, then it can be selected in those courses where enrolment via cohort has been enabled. (For more information on creating and using cohorts, see: [[Cohorts]].) Once members of a cohort have been added to a course, the individuals can be added to a group, either by using the "auto create groups" feature or by adding the members to a group.

For example, You might have students in French section 10B and German section 10A, which you want to enrol in "Principles of Language Learning" and "Principles of Linguistics " courses. You also want each section have their own teacher in each course and be unaware of the other section. You might create cohorts for the French and German sections. You would then [[Cohort sync|enrol the two cohorts in the two courses]]. Next you would create two groups in both courses and assign individual students to the appropriate group. Note the individual students will appear in a list of students because they are members of the cohort you assigned them to.

Read more in [[Groups FAQ]]

==Can I synch cohorts with LDAP groups?==
This is not currently available as standard. However, the tracker issue for this (MDL-25011) offers a patch which works on versions up to and including 2.3. It has not yet been tested on 2.4.

==Where can I practise with some ready made cohorts?==
#Log into the [http://school.demo.moodle.net Mount Orange School demo site] with username: ''manager'' and password: ''moodle''
#You can access system cohorts from the Administration block > Site Administration > Users > Accounts > Accounts

==I want to enrol a cohort of students in all courses in a category==
This is not currently possible to add a cohort to a course category and automatically enrol members in every courses at once in that course category. Please see MDL-36951 for the reasoning behind this.
*You can create a special role which will allow the user to self enroll in a course. For example, all courses in the French course category are set to manual enrolment. Then assign a cohort in the context of the French course category the special role. Only special role students (all of the same cohort) can self enrol, the others will have to be manually enrolled.
*You can add add a cohort without any members to a new or existing course, then add members later. This is done on a course by course basis.

[[Category:FAQ]]

[[es:Cohortes FAQ]]

Cohorts FAQ

2015-12-09T23:57:41Z

Rcollman: /* I want to enrol a cohort of students in all courses in a category */

{{Grouping users}}

==What is the difference between a cohort and a group?==

A group exists only within a course. You might have a class 10B for example which you want to enroll in course 1 and course 2. The group would need to be created in both courses and its members enrolled separately in both courses. Cohorts are groups of users created by admin which can then be brought in "en masse" to courses. So if class 10B is created as a cohort by admin, then it can be selected in those courses where enrolment via cohort has been enabled. (For more information on creating and using cohorts, see here: Cohorts) Once members of a cohort have been added to a course, they can be included in a group, either by using the "auto create groups" feature or by adding the members to an empty or pre-created group.

Read more in [[Groups FAQ]]

==Can I synch cohorts with LDAP groups?==
This is not currently available as standard. However, the tracker issue for this (MDL-25011) offers a patch which works on versions up to and including 2.3. It has not yet been tested on 2.4.

==Where can I practise with some ready made cohorts?==
#Log into the [http://school.demo.moodle.net Mount Orange School demo site] with username: ''manager'' and password: ''moodle''
#You can access system cohorts from the Administration block > Site Administration > Users > Accounts > Accounts

==I want to enrol a cohort of students in all courses in a category==
This is not currently possible to add a cohort to a course category and automatically enrol members in every courses at once in that course category. Please see MDL-36951 for the reasoning behind this.
*You can create a special role which will allow the user to self enroll in a course. For example, all courses in the French course category are set to manual enrolment. Then assign a cohort in the context of the French course category the special role. Only special role students (all of the same cohort) can self enrol, the others will have to be manually enrolled.
*You can add add a cohort without any members to a new or existing course, then add members later. This is done on a course by course basis.

[[Category:FAQ]]

[[es:Cohortes FAQ]]

Cohorts FAQ

2015-12-09T23:57:13Z

Rcollman: /* I want to enrol a cohort of students into a category */ spell out the question in detail. Provide alternatives

{{Grouping users}}

==What is the difference between a cohort and a group?==

A group exists only within a course. You might have a class 10B for example which you want to enroll in course 1 and course 2. The group would need to be created in both courses and its members enrolled separately in both courses. Cohorts are groups of users created by admin which can then be brought in "en masse" to courses. So if class 10B is created as a cohort by admin, then it can be selected in those courses where enrolment via cohort has been enabled. (For more information on creating and using cohorts, see here: Cohorts) Once members of a cohort have been added to a course, they can be included in a group, either by using the "auto create groups" feature or by adding the members to an empty or pre-created group.

Read more in [[Groups FAQ]]

==Can I synch cohorts with LDAP groups?==
This is not currently available as standard. However, the tracker issue for this (MDL-25011) offers a patch which works on versions up to and including 2.3. It has not yet been tested on 2.4.

==Where can I practise with some ready made cohorts?==
#Log into the [http://school.demo.moodle.net Mount Orange School demo site] with username: ''manager'' and password: ''moodle''
#You can access system cohorts from the Administration block > Site Administration > Users > Accounts > Accounts

==I want to enrol a cohort of students in all courses in a category==
This is not currently possible to add a cohort to a course category and automatically enrol members every courses at once in that course category. Please see MDL-36951 for the reasoning behind this.
*You can create a special role which will allow the user to self enroll in a course. For example, all courses in the French course category are set to manual enrolment. Then assign a cohort in the context of the French course category the special role. Only special role students (all of the same cohort) can self enrol, the others will have to be manually enrolled.
*You can add add a cohort without any members to a new or existing course, then add members later. This is done on a course by course basis.

[[Category:FAQ]]

[[es:Cohortes FAQ]]

Cohorts

2015-12-09T23:33:52Z

Rcollman: /* See also */

{{Grouping users}}
Cohorts are site-wide or course category-wide groups. Cohorts enable all of it's current members to be enrolled or unenrolled in a course via [[Cohort sync]]. Users can be added or removed from a cohort which immediately impacts their course status.

==Creating a cohort==

Cohorts can be created by site administrators and other users with appropriate permissions.

* Access ''Administration > Site administration > Users > Accounts > Cohorts''
[[File:Createcohort1.png|thumb|center|400px]]
* Click the Add button
*'''NOTE''' In the dropdown you can choose between making your cohort available throughout the site "system" or in a named course category.
*Cohorts are visible to teachers by default but unchecking the 'Visible' link will mean they are not available for teachers to use in their courses.
*Complete the details and save the changes.
* Follow the assign link opposite the cohort name in the list of available cohorts.
[[File:cohortscreen.png|thumb|center|600px]]
* Select potential users from the list then click the Add button.

To synchronise cohort members with course participants, the [[Cohort sync]] enrolment plugin should be enabled in ''Administration > Site administration > Plugins > Enrolments > Manage enrol plugins''.

==Creating cohorts in bulk==

#Cohorts can be created with a csv file upload to the system or to a named category from ''Site administration>Users>Accounts>Cohorts>Upload cohorts''. More detailed information can be found on the [[Upload_cohorts|Upload cohorts]] page.
#Category managers can upload csv files to create cohorts from the Cohorts link in the Administration block of their category.
#An example file is below. The 'Students 2014-15' cohort will be created in the system and the 'History' cohort will be created in the (already existing) Humanities category:

[[File:cohortupload.png|center|thumb|600px]]

==Adding users to a cohort in bulk==

#Access ''Administration > Site administration > Users > Accounts > Bulk user actions''
#Find users by setting an appropriate filter
#Add users from the available list to the selected list
#Choose 'Add to cohort' with selected users

==Uploading users to a cohort==

An administrator can [[Upload users|upload users]] via CSV file to existing cohorts as follows:
#Access ''Administration > Site administration > Users > Accounts > Upload users''
#Upload a text file with the following format:

username,password,firstname,lastname,email,cohort1
tomjones,Pass1234*,Tom,Jones,tomjones@example.com,year3
marysmith,Pass1234*,Mary,Smith,marysmith@example.com,year4

where year3 and year4 are the '''cohort ids''' of existing cohorts (i.e. ''not their names'').

''Note: If the users already exist on the system, then you only need their username with the chosen cohort in your csv file.''

It is also possible to create the cohort at the same time as the users are uploaded to the system.
username,password, firstname,lastname,email,cohort1
jackbrown,Pass5678,Jack,Brown,jbrown@example.com,London Contingent
In the above example, the cohort named London Contingent will be created upon upload of the csv file.

==Searching cohorts==
When a site has a large number of cohorts, keywords may be entered into the Search Cohorts box to search for or filter the available
cohorts.

An All Cohorts screen accessed from ''Site administration>Users>Accounts>Cohorts'' allows an administrator to view and search through system and category cohorts.

[[File:AllCohortsscreen.png|thumb|center|600px]]

==Managing category cohorts==

Cohorts which have been created for a category rather than the system can be located by selecting the appropriate category and then clicking the ''Cohorts'' link in ''Administration>Category (name)>Cohorts''

==Cohort capabilities==

*[[Capabilities/moodle/cohort:assign|Add and remove cohort members]]
*[[Capabilities/moodle/cohort:manage|Create, delete and move cohorts]]
*[[Capabilities/enrol/cohort:config|Configure cohort instances]]
*[[Capabilities/moodle/cohort:view|View site-wide cohorts]]

==See also==

*[[Cohort sync]] enrolment method
*[[cohort/upload|Upload cohorts]] bulk file uploads
*[http://youtu.be/FQ6RjeU3ybQ?list=PLxcO_MFWQBDdJmqW4tD5qXJ6pPXWTP7GL Cohorts 2.8 screencast] from Moodle HQ
*MDL-34189 Make category cohorts visible site-wide for site administrators
*[http://www.somerandomthoughts.com/blog/2011/11/22/using-cohorts-with-moodle-2-2/ Using cohorts with Moodle 2.2] blog entry by Gavin Henrick

[[Category:Site administration]]

[[fr:Cohortes]]
[[de:Globale Gruppen]]
[[es:Cohortes]]
[[ja:コーホート]]

Cohorts

2015-12-09T23:31:49Z

Rcollman:

{{Grouping users}}
Cohorts are site-wide or course category-wide groups. Cohorts enable all of it's current members to be enrolled or unenrolled in a course via [[Cohort sync]]. Users can be added or removed from a cohort which immediately impacts their course status.

==Creating a cohort==

Cohorts can be created by site administrators and other users with appropriate permissions.

* Access ''Administration > Site administration > Users > Accounts > Cohorts''
[[File:Createcohort1.png|thumb|center|400px]]
* Click the Add button
*'''NOTE''' In the dropdown you can choose between making your cohort available throughout the site "system" or in a named course category.
*Cohorts are visible to teachers by default but unchecking the 'Visible' link will mean they are not available for teachers to use in their courses.
*Complete the details and save the changes.
* Follow the assign link opposite the cohort name in the list of available cohorts.
[[File:cohortscreen.png|thumb|center|600px]]
* Select potential users from the list then click the Add button.

To synchronise cohort members with course participants, the [[Cohort sync]] enrolment plugin should be enabled in ''Administration > Site administration > Plugins > Enrolments > Manage enrol plugins''.

==Creating cohorts in bulk==

#Cohorts can be created with a csv file upload to the system or to a named category from ''Site administration>Users>Accounts>Cohorts>Upload cohorts''. More detailed information can be found on the [[Upload_cohorts|Upload cohorts]] page.
#Category managers can upload csv files to create cohorts from the Cohorts link in the Administration block of their category.
#An example file is below. The 'Students 2014-15' cohort will be created in the system and the 'History' cohort will be created in the (already existing) Humanities category:

[[File:cohortupload.png|center|thumb|600px]]

==Adding users to a cohort in bulk==

#Access ''Administration > Site administration > Users > Accounts > Bulk user actions''
#Find users by setting an appropriate filter
#Add users from the available list to the selected list
#Choose 'Add to cohort' with selected users

==Uploading users to a cohort==

An administrator can [[Upload users|upload users]] via CSV file to existing cohorts as follows:
#Access ''Administration > Site administration > Users > Accounts > Upload users''
#Upload a text file with the following format:

username,password,firstname,lastname,email,cohort1
tomjones,Pass1234*,Tom,Jones,tomjones@example.com,year3
marysmith,Pass1234*,Mary,Smith,marysmith@example.com,year4

where year3 and year4 are the '''cohort ids''' of existing cohorts (i.e. ''not their names'').

''Note: If the users already exist on the system, then you only need their username with the chosen cohort in your csv file.''

It is also possible to create the cohort at the same time as the users are uploaded to the system.
username,password, firstname,lastname,email,cohort1
jackbrown,Pass5678,Jack,Brown,jbrown@example.com,London Contingent
In the above example, the cohort named London Contingent will be created upon upload of the csv file.

==Searching cohorts==
When a site has a large number of cohorts, keywords may be entered into the Search Cohorts box to search for or filter the available
cohorts.

An All Cohorts screen accessed from ''Site administration>Users>Accounts>Cohorts'' allows an administrator to view and search through system and category cohorts.

[[File:AllCohortsscreen.png|thumb|center|600px]]

==Managing category cohorts==

Cohorts which have been created for a category rather than the system can be located by selecting the appropriate category and then clicking the ''Cohorts'' link in ''Administration>Category (name)>Cohorts''

==Cohort capabilities==

*[[Capabilities/moodle/cohort:assign|Add and remove cohort members]]
*[[Capabilities/moodle/cohort:manage|Create, delete and move cohorts]]
*[[Capabilities/enrol/cohort:config|Configure cohort instances]]
*[[Capabilities/moodle/cohort:view|View site-wide cohorts]]

==See also==

*[[Cohort sync]] enrolment method
*[[cohort/upload|Upload cohorts]]
*[http://youtu.be/FQ6RjeU3ybQ?list=PLxcO_MFWQBDdJmqW4tD5qXJ6pPXWTP7GL Cohorts 2.8 screencast] from Moodle HQ
*MDL-34189 Make category cohorts visible site-wide for site administrators
*[http://www.somerandomthoughts.com/blog/2011/11/22/using-cohorts-with-moodle-2-2/ Using cohorts with Moodle 2.2] blog entry by Gavin Henrick

[[Category:Site administration]]

[[fr:Cohortes]]
[[de:Globale Gruppen]]
[[es:Cohortes]]
[[ja:コーホート]]

Cohort sync

2015-12-09T19:16:11Z

Rcollman: rewrote the introduction

{{Enrolment}}
Cohorts enable all members of a cohort to be enrolled in a course in one action, either manually via the cohort sync process and then synchronised automatically by adding or removing members of the cohort.

'''Note:''' Teachers can add cohorts to courses by default but a manager or admin can hide certain cohorts from teachers by unchecking the 'Visible' box in the Cohort settings or by clicking the 'eye' icon on the Cohorts screen.

==Enrolling a cohort in a course==

In order to actually enrol users from a Cohort into courses the ''Cohort-Sync'' Enrollment plugin needs to be added to the enrollment methods for the course. The Administrator will first need to enable the ''Cohort-Sync'' enrolment plugin site wide (''Administration > Site administration > Plugins > Enrolments'')

===Adding a whole cohort===
Available cohorts may be selected from ''Course administration>Enrolment methods'' and then selecting from the dropdown the 'Cohortsync' method

[[File:enrolmentmethods29.png|thumb|center|300px]]

Enrolling cohorts this way means that if members are added or removed from the cohort they are added or removed in the course too - ie, enrolment is synchronised.

{|
|[[File:cohort29.png|thumb|center|500px]]
|}

If several cohorts need to be added to the course, a button "Add method and create another" allows the teacher or course manager to quickly repeat the process without having to return to the main screen and start again.

[[File:cohortcreatenewgroup.png]]

When synchronising a cohort it is also possible to automatically add all cohort members to the group. A new group can also be created when adding the cohort.

===Capabilities===
The required capabilities for setting up a cohort sync are:
* moodle/course:enrolconfig in the course context
* enrol/cohort:config in the course context
* moodle/cohort:view in the course context
Default "Teacher" (editingteacher) role has all these capabilities.

===Adding cohort members===

Cohort members may be enrolled from ''Course administration > Enrolled users'' and clicking the 'Enrol users' button, and then 'Browse cohorts'

[[File:newcohortenrol.png|thumb|center|400px]]

Enrolling cohorts this way means that members may be removed individually from the course, ie, there is no cohort synchronisation.

The required capabilities for manually enrolling cohort members are:
* enrol/manual:enrol in course context
* moodle/course:enrolreview in course context
Default "Teacher" (editingteacher) role has all these capabilities.

==Enrolling a cohort in a category==

This is not supported by Moodle at the moment.

See MDL-36951 regarding enrolling system cohorts at category level

See [[Category enrolments]] where it is recommended that cohort sync be used in preference to category enrolments.

==See also==

* [[Cohorts]] for information on how to create a cohort
* [https://moodle.org/plugins/view.php?plugin=enrol_groupsync Enrolment: Cohort members to group] plugin for users already enrolled via different method

[[de:Einschreibung über globale Gruppen]]
[[es:Sincronización de cohorte]]
[[ja:コーホート同期]]

Cohorts

2015-12-09T19:13:58Z

Rcollman: Edited intro. Newbies might not know which categories we are talking about.

{{Grouping users}}
Cohorts are site-wide or course category-wide groups. Cohorts enable all members of a cohort to be enrolled or unenrolled in a course via [[Cohort sync]]. Users can be added or removed from a cohort which immediately impacts their course status.

==Creating a cohort==

Cohorts can be created by site administrators and other users with appropriate permissions.

* Access ''Administration > Site administration > Users > Accounts > Cohorts''
[[File:Createcohort1.png|thumb|center|400px]]
* Click the Add button
*'''NOTE''' In the dropdown you can choose between making your cohort available throughout the site "system" or in a named course category.
*Cohorts are visible to teachers by default but unchecking the 'Visible' link will mean they are not available for teachers to use in their courses.
*Complete the details and save the changes.
* Follow the assign link opposite the cohort name in the list of available cohorts.
[[File:cohortscreen.png|thumb|center|600px]]
* Select potential users from the list then click the Add button.

To synchronise cohort members with course participants, the [[Cohort sync]] enrolment plugin should be enabled in ''Administration > Site administration > Plugins > Enrolments > Manage enrol plugins''.

==Creating cohorts in bulk==

#Cohorts can be created with a csv file upload to the system or to a named category from ''Site administration>Users>Accounts>Cohorts>Upload cohorts''. More detailed information can be found on the [[Upload_cohorts|Upload cohorts]] page.
#Category managers can upload csv files to create cohorts from the Cohorts link in the Administration block of their category.
#An example file is below. The 'Students 2014-15' cohort will be created in the system and the 'History' cohort will be created in the (already existing) Humanities category:

[[File:cohortupload.png|center|thumb|600px]]

==Adding users to a cohort in bulk==

#Access ''Administration > Site administration > Users > Accounts > Bulk user actions''
#Find users by setting an appropriate filter
#Add users from the available list to the selected list
#Choose 'Add to cohort' with selected users

==Uploading users to a cohort==

An administrator can [[Upload users|upload users]] via CSV file to existing cohorts as follows:
#Access ''Administration > Site administration > Users > Accounts > Upload users''
#Upload a text file with the following format:

username,password,firstname,lastname,email,cohort1
tomjones,Pass1234*,Tom,Jones,tomjones@example.com,year3
marysmith,Pass1234*,Mary,Smith,marysmith@example.com,year4

where year3 and year4 are the '''cohort ids''' of existing cohorts (i.e. ''not their names'').

''Note: If the users already exist on the system, then you only need their username with the chosen cohort in your csv file.''

It is also possible to create the cohort at the same time as the users are uploaded to the system.
username,password, firstname,lastname,email,cohort1
jackbrown,Pass5678,Jack,Brown,jbrown@example.com,London Contingent
In the above example, the cohort named London Contingent will be created upon upload of the csv file.

==Searching cohorts==
When a site has a large number of cohorts, keywords may be entered into the Search Cohorts box to search for or filter the available
cohorts.

An All Cohorts screen accessed from ''Site administration>Users>Accounts>Cohorts'' allows an administrator to view and search through system and category cohorts.

[[File:AllCohortsscreen.png|thumb|center|600px]]

==Managing category cohorts==

Cohorts which have been created for a category rather than the system can be located by selecting the appropriate category and then clicking the ''Cohorts'' link in ''Administration>Category (name)>Cohorts''

==Cohort capabilities==

*[[Capabilities/moodle/cohort:assign|Add and remove cohort members]]
*[[Capabilities/moodle/cohort:manage|Create, delete and move cohorts]]
*[[Capabilities/enrol/cohort:config|Configure cohort instances]]
*[[Capabilities/moodle/cohort:view|View site-wide cohorts]]

==See also==

*[[Cohort sync]] enrolment method
*[[cohort/upload|Upload cohorts]]
*[http://youtu.be/FQ6RjeU3ybQ?list=PLxcO_MFWQBDdJmqW4tD5qXJ6pPXWTP7GL Cohorts 2.8 screencast] from Moodle HQ
*MDL-34189 Make category cohorts visible site-wide for site administrators
*[http://www.somerandomthoughts.com/blog/2011/11/22/using-cohorts-with-moodle-2-2/ Using cohorts with Moodle 2.2] blog entry by Gavin Henrick

[[Category:Site administration]]

[[fr:Cohortes]]
[[de:Globale Gruppen]]
[[es:Cohortes]]
[[ja:コーホート]]

Question categories

2015-12-09T16:32:29Z

Rcollman: /* Moving Categories */ create sub headings to cover two ways to move

{{Template:Managing questions}}
A question category can contain individual questions or other question categories. They can be found by using the [[Question bank]] or when [[Building Quiz|building a quiz]].

==What are question categories?==

[[Image:question-categories.png|thumb|300px|Question category as a folder]]
You can imagine a question category as a folder on your desktop computer. Then, questions are stored in these categories in a similar way as your files are stored in a file system.

Each category must have a name and you can include a short description of the category. You can create a ''category hierarchy''. For example, you can specify a parent category for each category or the 'Top' as the parent, when a category has no parent.

:''Tip:'' Creating question categories and sub categories is a good practice. It is better than keeping all your questions in one big list in the quiz module. The hierarchy feature enables you to separate categories into sub categories and sub categories into sub sub categories etc. indefinitely. Categories and sub categories, etc., are very powerful when combined with random questions that can select either from one category or from a category or any of its sub categories.

==Question Sharing==

You can share questions in several different [[Context|contexts]]. Sharing categories in the 'System' context or 'Course' context has a similar effect to publishing the category so others can see them or hiding a question category from specific users. See the [[Question contexts]] page for more information.

By default a course teacher cannot see or use any Question context above the course level.

:'''''Note:''''' "Core System" and "System" refer to the same thing when we are describing or showing screen shots of question categories. "System" is the current term you will see in 2.x releases of Moodle.

==Category Set Up and Management==

* Open the question bank. Either :
** Click on the Questions link in the 'Administration' block click on the 'Questions' link.
** Or open the [[Editing a quiz]] page - when logged in as a teacher or someone with appropriate permissions open a quiz and then click on the 'Edit' tab.
* Click on the 'Categories' tab.
* Below the list of current categories you will see a form to add a new category.
* Choose the 'parent' category in which your new category will be placed. See image of 'Parent' selector image to right. [[image:QuestionParentCategorySelector.jpg|right|thumb|346px|Question category selector]]
** Placing your category in another category makes it a sub-category of the parent.
** Choosing 'Top' means that your category is a top level category, not a sub category. When more than one sharing context is available you can place your category as a top level category in any of the contexts.
** Notice you can choose to make your category a 'top level' category in any context (see [[Question contexts]]) that is available to you. Or you can choose to add your category as a sub category of another category in the same context as the
* Type the name of your new question category in the text box.
* Add an optional meaningful description in the category info area.
* Click the 'Add Category' button. Your new question category will appear in the list of current categories.

===Deleting Categories===

Categories can also be created or deleted at will. However, if you try to delete a category containing questions, then you will be asked to specify another category to move them to. You cannot delete or move the last category in any context, there must always be one category in a context.

===Moving categories===
You can also arrange the categories in a hierarchy so that they are easier to manage.

====Reassign top category to move categories====
Use the question bank>categories link to change the parent category. This will change the order.

====Using arrow icons to move categories====

* The up/down arrow icons lets you change the order in which category 'peers' are displayed.
* The up / down icons are also used to move a '''top-level''' category between contexts. If you move a category to be the first or last category in a context and then press the arrow key again then it will be moved to the next context.
* The right arrow icon allows you to move a category to be a child category of the category listed immediately above it.
* The left arrow icon allows you to move a category up one category level (to be a peer of it's parent category).

''See the tool tip that appears when you place the mouse pointer above these icons if you're not sure what action an icon will perform.'' You cannot move the last category in any context, there must always be at least one category left in all contexts.

==See also==
*[[Question contexts]]
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=47540 I can see other teacher's categories] forum discussion

[[de:Fragenkategorien]]
[[es:Categorías de preguntas]]
[[fr:Catégories de questions]]
[[ru:Категории вопросов]]

Lesson settings

2015-12-08T16:03:10Z

Rcollman: /* Minimum Number of Questions */

{{Lesson}}
=Lesson administration settings=

This page explains the settings involved when first creating a lesson.
To add a lesson to your Moodle course page:
*With the editing turned on, in the section you wish to add your lesson, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu) and choose ''Lesson'' All settings may expanded by clicking the "Expand all" link top right.

==General==
{|
|[[File:lessonintro.png|thumb|500px|General settings expanded by default]]
|}

===Name===
Whatever you type here will form the link learners click on to view the lesson so it is helpful to give it a name that suggests its purpose.

===Description===

Add a description of your lesson here.

===Display description on the course page===
If this box is ticked, the description will appear on the course page just below the name of the lesson.

==Appearance==
(These settings are collapsed by default)
{|
|[[File:lessonappearance.png|thumb|404px|Appearance settings expanded]]
|}
===File pop===
If you want to include a link to a file on the lesson page for students to refer to, upload it here.
===Progress bar===
Choose this to show a bar at the bottom of the page showing how far into the lesson the student has got.
* For lessons containing '''only''' ''Content pages'', once a lesson has been taken to the end, if that same lesson is re-taken, the progress bar will not be "reset", i.e. it will show a 100% progress from page 1!

* For lessons containing ''Question pages'' and set to "Re-take" '''Yes''', the progress bar is always "reset" at 0% upon re-take.

* Note that the Lesson Progress bar only works correctly for lessons with a "straightforward" navigation, such as page 1 -> page 2 -> page n -> end of lesson. It is not guaranteed to work with pages "jumping all over the place".

===Display ongoing score===
Choose this to let students see their score as they work through the lesson.
===Display left menu===
Choose this when you want to show a list of the content page titles in the Lesson to the student. Only those pages which have "Display in menu?" checked will display. The left menu will not display question pages.

===Minimum grade to display menu===
Choose this if you want the student to go through the lesson once and get a grade before they can (on review) see and navigate through all the different pages.
===Slideshow===

Slideshow height, width and background colour are set for the whole site by an administrator in ''Settings > Site administration > Plugins > Activity modules > Lesson''.

===Maximum Number of Answers===
Here you can set the default number of selection boxes available when you add or edit a question or content page. For instance, if you are only going to use Multiple Choice questions with 3 answers in your lesson, you might select 3. You can change the default here at any time to display more or less question answers or content choices.
:''Note:'' This only impacts the editing screen. Changing from 4 to 2 will not remove or hide any answers previously entered from the student.

===Use default feedback===
Every Moodle site has a standard response (feedback) when a student selects a correct or wrong answer in a lesson. Select "No" if you only what you put as a response for a specific question's answer to display. In this case, when you leave the response to a question blank, the student will not see any comment about their answer. The typical Moodle standard responses are: "That's the correct answer" or "That's the wrong answer".

===Link to next activity===
Choose this to give students a link to another activity when they reach the end of the lesson. ''(Note: this can also be achieved using [[Conditional activities]])''
==Availability==
(These settings are collapsed by default)
{|
|[[File:lessontimelimit.png|thumb|470px|Availability settings expanded]]
|}
===Available from/Deadline===
Here you can set a start and end date and time for your Lesson.

===Time limit===

This allows you to set a time limit on the lesson which can now be seconds, minutes, hours, days or weeks. Students will see a countdown counter in a block as they work.

[[File:lessontimeremaining.png]]

The timer does not stop them doing the lesson when the time is up, but correct answers are no longer scored.

===Password protected lesson===
*Change to "Yes" and enter the password if you want students only to access it when they know the password.

==Prerequisite lesson==
*''Note: You will only see this setting if you have a course with prerequisite lessons upgraded from an earlier version of Moodle.''
*You will see a warning that prerequisites are due to be removed completely.
*Please use access restrictions instead. See [[Conditional activities]] for more information.

==Flow control==
(These settings are collapsed by default)
{|
|[[File:flowcontrol.png|thumb|450px|Flow control settings expanded]]
|}

===Allow Student Review===
This puts a "Review Lesson" button on the last screen of the lesson to encourage the students to navigate through the lesson again from the start.
:Note that the students will not be able to ''change'' their answers, only ''view'' them.

===Provide option to try a question again===
*This displays a button after an incorrectly answered question so that the student can try again (but not get credit for it)
:''TIP:'' Leave this off if you are using essay questions.
===Maximum Number of Attempts===
*Decide here how many times you want students to be able to attempt each question. When they reach the maximum, they will be taken automatically to the next page.
'''''Note:''''' this setting works in combination with the above setting, or independently.

*When 'provide an option to try again' is set to No, students will be able to retake the question as many times as it is set here, with a score penalty.

*When 'provide an option to try again' is set to Yes, then students will be able to retake the question as many times as it set here without a score penalty. In this case an extra dialogue appears.

Consequently when the relevant jump 'this page' is used in wrong answer while the 'provide an option to try again' is set to No and 'maximum number of attempts' is set to 1, a student that will answer wrongly will be moved into the next page, since he/she has the change to try the question just once.

'''''Tip:''''' Ensure you check lesson using a real student account, as the teacher preview or the 'switch role to student' may not give you the exact picture.

===Action after a Correct Answer===
Choose here where you want a student to be sent to if they get a question right. See [[Using Lesson]] for more details on this setting. The options are:
**the next part of the Lesson (default setting)
**a random, unexpected page
**a random page which they have not yet answered.
===Number of pages to show===
You only need this if you have set "Action after a correct answer" to show an unseen or unanswered page. Otherwise, all pages will be seen

==Grade==
(These settings are collapsed by default.)
{|
|[[File:lessongradetopass.png|thumb|450px|Grade settings expanded]]
|}

Set a grade and grade category here, along with a "Grade to pass" which may be connected with [[Activity completion]] and [[Conditional activities]] such that a student will not be able to access a follow up activity until they have obtained the required grade in the lesson.

===Practice lesson===

Practice lessons are now saved; this means they will appear in the reports .You must enable the "Retakes allowed" setting if you want students to be able to attempt a practice lesson several times.

'''Note''': If you are upgrading from an earlier version, be aware that all practice lessons will have " Re-takes allowed" set to "Yes" . If you are restoring a practice lesson made before this change, you may need to modify the "Re-takes allowed" setting if needed.

===Custom Scoring===
Use this to give a particular number score (negative or positive) to each answer
===Re-takes allowed===
Choose this if you want your students to be able to do the lesson more than once.
:Note that this setting only applies to lessons containing ''Question pages''. Lessons consisting '''only''' of ''Content pages'' can be re-taken even if 'Re-takes allowed' is set to ''No''.
====Handling of re-take====
If you allow your students to re-take the lesson, then decide here if the grade for all lesson attempts is the mean or the maximum.

:Note that the Question Analysis always uses the answers from the first tries of the lesson. Re-takes by students are ignored.

===Minimum Number of Questions===
Set the minimum number of questions that will be used to calculate a student's score. Students will be told how many they have answered and how many more they need to answer.
*If you are using Content pages, then set this to 0.
*If you use this setting, then add some explanatory text at the start of the lesson so the student knows the minimum number of questions they must answer to receive a grade.

==Common module settings==
*Visible
*ID number
*Group mode - this setting has no impact in the Lesson setting activity
*Groupings - this setting has no impact, other than showing the grouping as a label for the teacher next to a lesson.
See [[Common module settings]]

==Access restrictions==
[[Restrict access]] must be turned on in the site settings for this to appear.
(These settings are collapsed by default)

*Grade - limit to overall grade or specific grade on another activity
*Group - limit to specific group
*Groupings - limit to specific groupings
*User profile - limit based upon user profile fields
*Restriction set - nest restrictions

==Activity completion==
[[Activity completion]] must be turned on in the site settings for this to appear.
(These settings are collapsed by default)
*Completion tracking - 3 options
*Required view
*Required grade
*Required end reached
*Required time spent
*Expected completion on

==User and group overrides==

When a lesson has been created, it is possible to overrride certain settings for individuals and groups. The settings for this are located in the Lesson administration block:

[[File:lessonoverrides.png]]

It is possible to override passwords, availability/deadline, time limits and question retries and lesson retakes.
Selecting one of the options, for example 'User' will display a button to click. From the next screen you can choose the user or group to override and the settings you wish to override:

[[File:lessonoverrideuser.png]]

When the override is saved, it is displayed on a screen along with any other overrides previously set:

[[File:lessonoverrideexamples.png]]

==Site administration settings==

The lesson module has additional settings which may be changed by an administrator in ''Administration > Site administration > Plugins > Activity modules > Lesson''.

===Slideshow width===
Sets the width of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowwidth, Default 640.

===Slideshow height===
Sets the height of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowheight, Default 480.

===Slideshow background colour===
Background colour to for the slideshow if it is enabled.
*Variable name: lesson_slideshowbgcolor, Default #FFFFFF.

===Popup window width===
Sets the width of the popup displayed for a linked media file
*Variable name: lesson_mediawidth, Default 640.

===Popup window height===
Sets the height of the popup displayed for a linked media file
*Variable name: lesson_mediaheight, Default 480.

===Show close button:===
Displays a close button as part of the popup generated for a linked media file
*Variable name: lesson_mediaclose, Default No.

===Maximum number of answers===
Default Lesson activity maximum number answers per question and choices per content page for the site.
*Variable name: lesson_maxanswers, Default: 4.

===Action after correct answer===
The default action to take after a correct answer
*Variable name: lesson_defaultnextpage, Default: Normal - follow lesson path

==See also==
*[http://youtu.be/cUDV0WE5ZYY Moodle 2.x Lesson (part 1)] MoodleBites video on YouTube
*[http://youtu.be/Mfj-8w-Ze0A Moodle 2.x Lesson (part 2)] MoodleBites video on YouTube
*[http://youtu.be/jXjqHtgC9c0 Moodle 2.x Lesson (part 3)] MoodleBites video on YouTube

[[de:Lektion konfigurieren]]
[[fr:Ajouter/modifier une leçon]]
[[ja:レッスンの設定]]
[[es:Configuraciones de lección]]

Lesson settings

2015-12-08T16:00:40Z

Rcollman: /* Access restrictions */

{{Lesson}}
=Lesson administration settings=

This page explains the settings involved when first creating a lesson.
To add a lesson to your Moodle course page:
*With the editing turned on, in the section you wish to add your lesson, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu) and choose ''Lesson'' All settings may expanded by clicking the "Expand all" link top right.

==General==
{|
|[[File:lessonintro.png|thumb|500px|General settings expanded by default]]
|}

===Name===
Whatever you type here will form the link learners click on to view the lesson so it is helpful to give it a name that suggests its purpose.

===Description===

Add a description of your lesson here.

===Display description on the course page===
If this box is ticked, the description will appear on the course page just below the name of the lesson.

==Appearance==
(These settings are collapsed by default)
{|
|[[File:lessonappearance.png|thumb|404px|Appearance settings expanded]]
|}
===File pop===
If you want to include a link to a file on the lesson page for students to refer to, upload it here.
===Progress bar===
Choose this to show a bar at the bottom of the page showing how far into the lesson the student has got.
* For lessons containing '''only''' ''Content pages'', once a lesson has been taken to the end, if that same lesson is re-taken, the progress bar will not be "reset", i.e. it will show a 100% progress from page 1!

* For lessons containing ''Question pages'' and set to "Re-take" '''Yes''', the progress bar is always "reset" at 0% upon re-take.

* Note that the Lesson Progress bar only works correctly for lessons with a "straightforward" navigation, such as page 1 -> page 2 -> page n -> end of lesson. It is not guaranteed to work with pages "jumping all over the place".

===Display ongoing score===
Choose this to let students see their score as they work through the lesson.
===Display left menu===
Choose this when you want to show a list of the content page titles in the Lesson to the student. Only those pages which have "Display in menu?" checked will display. The left menu will not display question pages.

===Minimum grade to display menu===
Choose this if you want the student to go through the lesson once and get a grade before they can (on review) see and navigate through all the different pages.
===Slideshow===

Slideshow height, width and background colour are set for the whole site by an administrator in ''Settings > Site administration > Plugins > Activity modules > Lesson''.

===Maximum Number of Answers===
Here you can set the default number of selection boxes available when you add or edit a question or content page. For instance, if you are only going to use Multiple Choice questions with 3 answers in your lesson, you might select 3. You can change the default here at any time to display more or less question answers or content choices.
:''Note:'' This only impacts the editing screen. Changing from 4 to 2 will not remove or hide any answers previously entered from the student.

===Use default feedback===
Every Moodle site has a standard response (feedback) when a student selects a correct or wrong answer in a lesson. Select "No" if you only what you put as a response for a specific question's answer to display. In this case, when you leave the response to a question blank, the student will not see any comment about their answer. The typical Moodle standard responses are: "That's the correct answer" or "That's the wrong answer".

===Link to next activity===
Choose this to give students a link to another activity when they reach the end of the lesson. ''(Note: this can also be achieved using [[Conditional activities]])''
==Availability==
(These settings are collapsed by default)
{|
|[[File:lessontimelimit.png|thumb|470px|Availability settings expanded]]
|}
===Available from/Deadline===
Here you can set a start and end date and time for your Lesson.

===Time limit===

This allows you to set a time limit on the lesson which can now be seconds, minutes, hours, days or weeks. Students will see a countdown counter in a block as they work.

[[File:lessontimeremaining.png]]

The timer does not stop them doing the lesson when the time is up, but correct answers are no longer scored.

===Password protected lesson===
*Change to "Yes" and enter the password if you want students only to access it when they know the password.

==Prerequisite lesson==
*''Note: You will only see this setting if you have a course with prerequisite lessons upgraded from an earlier version of Moodle.''
*You will see a warning that prerequisites are due to be removed completely.
*Please use access restrictions instead. See [[Conditional activities]] for more information.

==Flow control==
(These settings are collapsed by default)
{|
|[[File:flowcontrol.png|thumb|450px|Flow control settings expanded]]
|}

===Allow Student Review===
This puts a "Review Lesson" button on the last screen of the lesson to encourage the students to navigate through the lesson again from the start.
:Note that the students will not be able to ''change'' their answers, only ''view'' them.

===Provide option to try a question again===
*This displays a button after an incorrectly answered question so that the student can try again (but not get credit for it)
:''TIP:'' Leave this off if you are using essay questions.
===Maximum Number of Attempts===
*Decide here how many times you want students to be able to attempt each question. When they reach the maximum, they will be taken automatically to the next page.
'''''Note:''''' this setting works in combination with the above setting, or independently.

*When 'provide an option to try again' is set to No, students will be able to retake the question as many times as it is set here, with a score penalty.

*When 'provide an option to try again' is set to Yes, then students will be able to retake the question as many times as it set here without a score penalty. In this case an extra dialogue appears.

Consequently when the relevant jump 'this page' is used in wrong answer while the 'provide an option to try again' is set to No and 'maximum number of attempts' is set to 1, a student that will answer wrongly will be moved into the next page, since he/she has the change to try the question just once.

'''''Tip:''''' Ensure you check lesson using a real student account, as the teacher preview or the 'switch role to student' may not give you the exact picture.

===Action after a Correct Answer===
Choose here where you want a student to be sent to if they get a question right. See [[Using Lesson]] for more details on this setting. The options are:
**the next part of the Lesson (default setting)
**a random, unexpected page
**a random page which they have not yet answered.
===Number of pages to show===
You only need this if you have set "Action after a correct answer" to show an unseen or unanswered page. Otherwise, all pages will be seen

==Grade==
(These settings are collapsed by default.)
{|
|[[File:lessongradetopass.png|thumb|450px|Grade settings expanded]]
|}

Set a grade and grade category here, along with a "Grade to pass" which may be connected with [[Activity completion]] and [[Conditional activities]] such that a student will not be able to access a follow up activity until they have obtained the required grade in the lesson.

===Practice lesson===

Practice lessons are now saved; this means they will appear in the reports .You must enable the "Retakes allowed" setting if you want students to be able to attempt a practice lesson several times.

'''Note''': If you are upgrading from an earlier version, be aware that all practice lessons will have " Re-takes allowed" set to "Yes" . If you are restoring a practice lesson made before this change, you may need to modify the "Re-takes allowed" setting if needed.

===Custom Scoring===
Use this to give a particular number score (negative or positive) to each answer
===Re-takes allowed===
Choose this if you want your students to be able to do the lesson more than once.
:Note that this setting only applies to lessons containing ''Question pages''. Lessons consisting '''only''' of ''Content pages'' can be re-taken even if 'Re-takes allowed' is set to ''No''.
====Handling of re-take====
If you allow your students to re-take the lesson, then decide here if the grade for all lesson attempts is the mean or the maximum.

:Note that the Question Analysis always uses the answers from the first tries of the lesson. Re-takes by students are ignored.

===Minimum Number of Questions===
Set here the minimum number of questions that will be used to calculate a student's score. Students will be told how many they have answered and how many more they need to answer.
*If you are using Content pages, then set this to 0.
*If you use this setting, then add some explanatory text at the start of the lesson so the student knows how many questions they must answer as a minimum. (They may answer more.

==Common module settings==
*Visible
*ID number
*Group mode - this setting has no impact in the Lesson setting activity
*Groupings - this setting has no impact, other than showing the grouping as a label for the teacher next to a lesson.
See [[Common module settings]]

==Access restrictions==
[[Restrict access]] must be turned on in the site settings for this to appear.
(These settings are collapsed by default)

*Grade - limit to overall grade or specific grade on another activity
*Group - limit to specific group
*Groupings - limit to specific groupings
*User profile - limit based upon user profile fields
*Restriction set - nest restrictions

==Activity completion==
[[Activity completion]] must be turned on in the site settings for this to appear.
(These settings are collapsed by default)
*Completion tracking - 3 options
*Required view
*Required grade
*Required end reached
*Required time spent
*Expected completion on

==User and group overrides==

When a lesson has been created, it is possible to overrride certain settings for individuals and groups. The settings for this are located in the Lesson administration block:

[[File:lessonoverrides.png]]

It is possible to override passwords, availability/deadline, time limits and question retries and lesson retakes.
Selecting one of the options, for example 'User' will display a button to click. From the next screen you can choose the user or group to override and the settings you wish to override:

[[File:lessonoverrideuser.png]]

When the override is saved, it is displayed on a screen along with any other overrides previously set:

[[File:lessonoverrideexamples.png]]

==Site administration settings==

The lesson module has additional settings which may be changed by an administrator in ''Administration > Site administration > Plugins > Activity modules > Lesson''.

===Slideshow width===
Sets the width of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowwidth, Default 640.

===Slideshow height===
Sets the height of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowheight, Default 480.

===Slideshow background colour===
Background colour to for the slideshow if it is enabled.
*Variable name: lesson_slideshowbgcolor, Default #FFFFFF.

===Popup window width===
Sets the width of the popup displayed for a linked media file
*Variable name: lesson_mediawidth, Default 640.

===Popup window height===
Sets the height of the popup displayed for a linked media file
*Variable name: lesson_mediaheight, Default 480.

===Show close button:===
Displays a close button as part of the popup generated for a linked media file
*Variable name: lesson_mediaclose, Default No.

===Maximum number of answers===
Default Lesson activity maximum number answers per question and choices per content page for the site.
*Variable name: lesson_maxanswers, Default: 4.

===Action after correct answer===
The default action to take after a correct answer
*Variable name: lesson_defaultnextpage, Default: Normal - follow lesson path

==See also==
*[http://youtu.be/cUDV0WE5ZYY Moodle 2.x Lesson (part 1)] MoodleBites video on YouTube
*[http://youtu.be/Mfj-8w-Ze0A Moodle 2.x Lesson (part 2)] MoodleBites video on YouTube
*[http://youtu.be/jXjqHtgC9c0 Moodle 2.x Lesson (part 3)] MoodleBites video on YouTube

[[de:Lektion konfigurieren]]
[[fr:Ajouter/modifier une leçon]]
[[ja:レッスンの設定]]
[[es:Configuraciones de lección]]

Lesson settings

2015-12-08T15:59:52Z

Rcollman: /* Restrict access/Activity completion */ seperated into two headings, added fields and links to more details.

{{Lesson}}
=Lesson administration settings=

This page explains the settings involved when first creating a lesson.
To add a lesson to your Moodle course page:
*With the editing turned on, in the section you wish to add your lesson, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu) and choose ''Lesson'' All settings may expanded by clicking the "Expand all" link top right.

==General==
{|
|[[File:lessonintro.png|thumb|500px|General settings expanded by default]]
|}

===Name===
Whatever you type here will form the link learners click on to view the lesson so it is helpful to give it a name that suggests its purpose.

===Description===

Add a description of your lesson here.

===Display description on the course page===
If this box is ticked, the description will appear on the course page just below the name of the lesson.

==Appearance==
(These settings are collapsed by default)
{|
|[[File:lessonappearance.png|thumb|404px|Appearance settings expanded]]
|}
===File pop===
If you want to include a link to a file on the lesson page for students to refer to, upload it here.
===Progress bar===
Choose this to show a bar at the bottom of the page showing how far into the lesson the student has got.
* For lessons containing '''only''' ''Content pages'', once a lesson has been taken to the end, if that same lesson is re-taken, the progress bar will not be "reset", i.e. it will show a 100% progress from page 1!

* For lessons containing ''Question pages'' and set to "Re-take" '''Yes''', the progress bar is always "reset" at 0% upon re-take.

* Note that the Lesson Progress bar only works correctly for lessons with a "straightforward" navigation, such as page 1 -> page 2 -> page n -> end of lesson. It is not guaranteed to work with pages "jumping all over the place".

===Display ongoing score===
Choose this to let students see their score as they work through the lesson.
===Display left menu===
Choose this when you want to show a list of the content page titles in the Lesson to the student. Only those pages which have "Display in menu?" checked will display. The left menu will not display question pages.

===Minimum grade to display menu===
Choose this if you want the student to go through the lesson once and get a grade before they can (on review) see and navigate through all the different pages.
===Slideshow===

Slideshow height, width and background colour are set for the whole site by an administrator in ''Settings > Site administration > Plugins > Activity modules > Lesson''.

===Maximum Number of Answers===
Here you can set the default number of selection boxes available when you add or edit a question or content page. For instance, if you are only going to use Multiple Choice questions with 3 answers in your lesson, you might select 3. You can change the default here at any time to display more or less question answers or content choices.
:''Note:'' This only impacts the editing screen. Changing from 4 to 2 will not remove or hide any answers previously entered from the student.

===Use default feedback===
Every Moodle site has a standard response (feedback) when a student selects a correct or wrong answer in a lesson. Select "No" if you only what you put as a response for a specific question's answer to display. In this case, when you leave the response to a question blank, the student will not see any comment about their answer. The typical Moodle standard responses are: "That's the correct answer" or "That's the wrong answer".

===Link to next activity===
Choose this to give students a link to another activity when they reach the end of the lesson. ''(Note: this can also be achieved using [[Conditional activities]])''
==Availability==
(These settings are collapsed by default)
{|
|[[File:lessontimelimit.png|thumb|470px|Availability settings expanded]]
|}
===Available from/Deadline===
Here you can set a start and end date and time for your Lesson.

===Time limit===

This allows you to set a time limit on the lesson which can now be seconds, minutes, hours, days or weeks. Students will see a countdown counter in a block as they work.

[[File:lessontimeremaining.png]]

The timer does not stop them doing the lesson when the time is up, but correct answers are no longer scored.

===Password protected lesson===
*Change to "Yes" and enter the password if you want students only to access it when they know the password.

==Prerequisite lesson==
*''Note: You will only see this setting if you have a course with prerequisite lessons upgraded from an earlier version of Moodle.''
*You will see a warning that prerequisites are due to be removed completely.
*Please use access restrictions instead. See [[Conditional activities]] for more information.

==Flow control==
(These settings are collapsed by default)
{|
|[[File:flowcontrol.png|thumb|450px|Flow control settings expanded]]
|}

===Allow Student Review===
This puts a "Review Lesson" button on the last screen of the lesson to encourage the students to navigate through the lesson again from the start.
:Note that the students will not be able to ''change'' their answers, only ''view'' them.

===Provide option to try a question again===
*This displays a button after an incorrectly answered question so that the student can try again (but not get credit for it)
:''TIP:'' Leave this off if you are using essay questions.
===Maximum Number of Attempts===
*Decide here how many times you want students to be able to attempt each question. When they reach the maximum, they will be taken automatically to the next page.
'''''Note:''''' this setting works in combination with the above setting, or independently.

*When 'provide an option to try again' is set to No, students will be able to retake the question as many times as it is set here, with a score penalty.

*When 'provide an option to try again' is set to Yes, then students will be able to retake the question as many times as it set here without a score penalty. In this case an extra dialogue appears.

Consequently when the relevant jump 'this page' is used in wrong answer while the 'provide an option to try again' is set to No and 'maximum number of attempts' is set to 1, a student that will answer wrongly will be moved into the next page, since he/she has the change to try the question just once.

'''''Tip:''''' Ensure you check lesson using a real student account, as the teacher preview or the 'switch role to student' may not give you the exact picture.

===Action after a Correct Answer===
Choose here where you want a student to be sent to if they get a question right. See [[Using Lesson]] for more details on this setting. The options are:
**the next part of the Lesson (default setting)
**a random, unexpected page
**a random page which they have not yet answered.
===Number of pages to show===
You only need this if you have set "Action after a correct answer" to show an unseen or unanswered page. Otherwise, all pages will be seen

==Grade==
(These settings are collapsed by default.)
{|
|[[File:lessongradetopass.png|thumb|450px|Grade settings expanded]]
|}

Set a grade and grade category here, along with a "Grade to pass" which may be connected with [[Activity completion]] and [[Conditional activities]] such that a student will not be able to access a follow up activity until they have obtained the required grade in the lesson.

===Practice lesson===

Practice lessons are now saved; this means they will appear in the reports .You must enable the "Retakes allowed" setting if you want students to be able to attempt a practice lesson several times.

'''Note''': If you are upgrading from an earlier version, be aware that all practice lessons will have " Re-takes allowed" set to "Yes" . If you are restoring a practice lesson made before this change, you may need to modify the "Re-takes allowed" setting if needed.

===Custom Scoring===
Use this to give a particular number score (negative or positive) to each answer
===Re-takes allowed===
Choose this if you want your students to be able to do the lesson more than once.
:Note that this setting only applies to lessons containing ''Question pages''. Lessons consisting '''only''' of ''Content pages'' can be re-taken even if 'Re-takes allowed' is set to ''No''.
====Handling of re-take====
If you allow your students to re-take the lesson, then decide here if the grade for all lesson attempts is the mean or the maximum.

:Note that the Question Analysis always uses the answers from the first tries of the lesson. Re-takes by students are ignored.

===Minimum Number of Questions===
Set here the minimum number of questions that will be used to calculate a student's score. Students will be told how many they have answered and how many more they need to answer.
*If you are using Content pages, then set this to 0.
*If you use this setting, then add some explanatory text at the start of the lesson so the student knows how many questions they must answer as a minimum. (They may answer more.

==Common module settings==
*Visible
*ID number
*Group mode - this setting has no impact in the Lesson setting activity
*Groupings - this setting has no impact, other than showing the grouping as a label for the teacher next to a lesson.
See [[Common module settings]]

==Access restrictions==
[[Restrict access]] must be turned on in the site settings for this to appear.
(These settings are collapsed by default)

*Grade - limit to overall grade or specific grade on another activity
*Group - limit to specific group
*Groupings - limit to specific groupings
*User profile - limit based upon user profile fields
*Restriction set - nest restrictions
*The Restrict access and Activity completion settings are visible if [[Conditional activities]] and [[Activity completion]] have been enabled in the site and the course.

==Activity completion==
[[Activity completion]] must be turned on in the site settings for this to appear.
(These settings are collapsed by default)
*Completion tracking - 3 options
*Required view
*Required grade
*Required end reached
*Required time spent
*Expected completion on

==User and group overrides==

When a lesson has been created, it is possible to overrride certain settings for individuals and groups. The settings for this are located in the Lesson administration block:

[[File:lessonoverrides.png]]

It is possible to override passwords, availability/deadline, time limits and question retries and lesson retakes.
Selecting one of the options, for example 'User' will display a button to click. From the next screen you can choose the user or group to override and the settings you wish to override:

[[File:lessonoverrideuser.png]]

When the override is saved, it is displayed on a screen along with any other overrides previously set:

[[File:lessonoverrideexamples.png]]

==Site administration settings==

The lesson module has additional settings which may be changed by an administrator in ''Administration > Site administration > Plugins > Activity modules > Lesson''.

===Slideshow width===
Sets the width of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowwidth, Default 640.

===Slideshow height===
Sets the height of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowheight, Default 480.

===Slideshow background colour===
Background colour to for the slideshow if it is enabled.
*Variable name: lesson_slideshowbgcolor, Default #FFFFFF.

===Popup window width===
Sets the width of the popup displayed for a linked media file
*Variable name: lesson_mediawidth, Default 640.

===Popup window height===
Sets the height of the popup displayed for a linked media file
*Variable name: lesson_mediaheight, Default 480.

===Show close button:===
Displays a close button as part of the popup generated for a linked media file
*Variable name: lesson_mediaclose, Default No.

===Maximum number of answers===
Default Lesson activity maximum number answers per question and choices per content page for the site.
*Variable name: lesson_maxanswers, Default: 4.

===Action after correct answer===
The default action to take after a correct answer
*Variable name: lesson_defaultnextpage, Default: Normal - follow lesson path

==See also==
*[http://youtu.be/cUDV0WE5ZYY Moodle 2.x Lesson (part 1)] MoodleBites video on YouTube
*[http://youtu.be/Mfj-8w-Ze0A Moodle 2.x Lesson (part 2)] MoodleBites video on YouTube
*[http://youtu.be/jXjqHtgC9c0 Moodle 2.x Lesson (part 3)] MoodleBites video on YouTube

[[de:Lektion konfigurieren]]
[[fr:Ajouter/modifier une leçon]]
[[ja:レッスンの設定]]
[[es:Configuraciones de lección]]

Lesson settings

2015-12-08T15:36:35Z

Rcollman: /* Common module settings */ groups and groupings in this area have little impact on a Lesson's functions

{{Lesson}}
=Lesson administration settings=

This page explains the settings involved when first creating a lesson.
To add a lesson to your Moodle course page:
*With the editing turned on, in the section you wish to add your lesson, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu) and choose ''Lesson'' All settings may expanded by clicking the "Expand all" link top right.

==General==
{|
|[[File:lessonintro.png|thumb|500px|General settings expanded by default]]
|}

===Name===
Whatever you type here will form the link learners click on to view the lesson so it is helpful to give it a name that suggests its purpose.

===Description===

Add a description of your lesson here.

===Display description on the course page===
If this box is ticked, the description will appear on the course page just below the name of the lesson.

==Appearance==
(These settings are collapsed by default)
{|
|[[File:lessonappearance.png|thumb|404px|Appearance settings expanded]]
|}
===File pop===
If you want to include a link to a file on the lesson page for students to refer to, upload it here.
===Progress bar===
Choose this to show a bar at the bottom of the page showing how far into the lesson the student has got.
* For lessons containing '''only''' ''Content pages'', once a lesson has been taken to the end, if that same lesson is re-taken, the progress bar will not be "reset", i.e. it will show a 100% progress from page 1!

* For lessons containing ''Question pages'' and set to "Re-take" '''Yes''', the progress bar is always "reset" at 0% upon re-take.

* Note that the Lesson Progress bar only works correctly for lessons with a "straightforward" navigation, such as page 1 -> page 2 -> page n -> end of lesson. It is not guaranteed to work with pages "jumping all over the place".

===Display ongoing score===
Choose this to let students see their score as they work through the lesson.
===Display left menu===
Choose this when you want to show a list of the content page titles in the Lesson to the student. Only those pages which have "Display in menu?" checked will display. The left menu will not display question pages.

===Minimum grade to display menu===
Choose this if you want the student to go through the lesson once and get a grade before they can (on review) see and navigate through all the different pages.
===Slideshow===

Slideshow height, width and background colour are set for the whole site by an administrator in ''Settings > Site administration > Plugins > Activity modules > Lesson''.

===Maximum Number of Answers===
Here you can set the default number of selection boxes available when you add or edit a question or content page. For instance, if you are only going to use Multiple Choice questions with 3 answers in your lesson, you might select 3. You can change the default here at any time to display more or less question answers or content choices.
:''Note:'' This only impacts the editing screen. Changing from 4 to 2 will not remove or hide any answers previously entered from the student.

===Use default feedback===
Every Moodle site has a standard response (feedback) when a student selects a correct or wrong answer in a lesson. Select "No" if you only what you put as a response for a specific question's answer to display. In this case, when you leave the response to a question blank, the student will not see any comment about their answer. The typical Moodle standard responses are: "That's the correct answer" or "That's the wrong answer".

===Link to next activity===
Choose this to give students a link to another activity when they reach the end of the lesson. ''(Note: this can also be achieved using [[Conditional activities]])''
==Availability==
(These settings are collapsed by default)
{|
|[[File:lessontimelimit.png|thumb|470px|Availability settings expanded]]
|}
===Available from/Deadline===
Here you can set a start and end date and time for your Lesson.

===Time limit===

This allows you to set a time limit on the lesson which can now be seconds, minutes, hours, days or weeks. Students will see a countdown counter in a block as they work.

[[File:lessontimeremaining.png]]

The timer does not stop them doing the lesson when the time is up, but correct answers are no longer scored.

===Password protected lesson===
*Change to "Yes" and enter the password if you want students only to access it when they know the password.

==Prerequisite lesson==
*''Note: You will only see this setting if you have a course with prerequisite lessons upgraded from an earlier version of Moodle.''
*You will see a warning that prerequisites are due to be removed completely.
*Please use access restrictions instead. See [[Conditional activities]] for more information.

==Flow control==
(These settings are collapsed by default)
{|
|[[File:flowcontrol.png|thumb|450px|Flow control settings expanded]]
|}

===Allow Student Review===
This puts a "Review Lesson" button on the last screen of the lesson to encourage the students to navigate through the lesson again from the start.
:Note that the students will not be able to ''change'' their answers, only ''view'' them.

===Provide option to try a question again===
*This displays a button after an incorrectly answered question so that the student can try again (but not get credit for it)
:''TIP:'' Leave this off if you are using essay questions.
===Maximum Number of Attempts===
*Decide here how many times you want students to be able to attempt each question. When they reach the maximum, they will be taken automatically to the next page.
'''''Note:''''' this setting works in combination with the above setting, or independently.

*When 'provide an option to try again' is set to No, students will be able to retake the question as many times as it is set here, with a score penalty.

*When 'provide an option to try again' is set to Yes, then students will be able to retake the question as many times as it set here without a score penalty. In this case an extra dialogue appears.

Consequently when the relevant jump 'this page' is used in wrong answer while the 'provide an option to try again' is set to No and 'maximum number of attempts' is set to 1, a student that will answer wrongly will be moved into the next page, since he/she has the change to try the question just once.

'''''Tip:''''' Ensure you check lesson using a real student account, as the teacher preview or the 'switch role to student' may not give you the exact picture.

===Action after a Correct Answer===
Choose here where you want a student to be sent to if they get a question right. See [[Using Lesson]] for more details on this setting. The options are:
**the next part of the Lesson (default setting)
**a random, unexpected page
**a random page which they have not yet answered.
===Number of pages to show===
You only need this if you have set "Action after a correct answer" to show an unseen or unanswered page. Otherwise, all pages will be seen

==Grade==
(These settings are collapsed by default.)
{|
|[[File:lessongradetopass.png|thumb|450px|Grade settings expanded]]
|}

Set a grade and grade category here, along with a "Grade to pass" which may be connected with [[Activity completion]] and [[Conditional activities]] such that a student will not be able to access a follow up activity until they have obtained the required grade in the lesson.

===Practice lesson===

Practice lessons are now saved; this means they will appear in the reports .You must enable the "Retakes allowed" setting if you want students to be able to attempt a practice lesson several times.

'''Note''': If you are upgrading from an earlier version, be aware that all practice lessons will have " Re-takes allowed" set to "Yes" . If you are restoring a practice lesson made before this change, you may need to modify the "Re-takes allowed" setting if needed.

===Custom Scoring===
Use this to give a particular number score (negative or positive) to each answer
===Re-takes allowed===
Choose this if you want your students to be able to do the lesson more than once.
:Note that this setting only applies to lessons containing ''Question pages''. Lessons consisting '''only''' of ''Content pages'' can be re-taken even if 'Re-takes allowed' is set to ''No''.
====Handling of re-take====
If you allow your students to re-take the lesson, then decide here if the grade for all lesson attempts is the mean or the maximum.

:Note that the Question Analysis always uses the answers from the first tries of the lesson. Re-takes by students are ignored.

===Minimum Number of Questions===
Set here the minimum number of questions that will be used to calculate a student's score. Students will be told how many they have answered and how many more they need to answer.
*If you are using Content pages, then set this to 0.
*If you use this setting, then add some explanatory text at the start of the lesson so the student knows how many questions they must answer as a minimum. (They may answer more.

==Common module settings==
*Visible
*ID number
*Group mode - this setting has no impact in the Lesson setting activity
*Groupings - this setting has no impact, other than showing the grouping as a label for the teacher next to a lesson.
See [[Common module settings]]

==Restrict access/Activity completion==
(These settings are collapsed by default)

*The Restrict access and Activity completion settings are visible if [[Conditional activities]] and [[Activity completion]] have been enabled in the site and the course.
*Note that in addition to the standard activity completion conditions, the Lesson also has 'Require end reached' and 'Require time spent' criteria .
*To learn more about the Lesson completion conditions, see [[Activity completion settings]].

==User and group overrides==

When a lesson has been created, it is possible to overrride certain settings for individuals and groups. The settings for this are located in the Lesson administration block:

[[File:lessonoverrides.png]]

It is possible to override passwords, availability/deadline, time limits and question retries and lesson retakes.
Selecting one of the options, for example 'User' will display a button to click. From the next screen you can choose the user or group to override and the settings you wish to override:

[[File:lessonoverrideuser.png]]

When the override is saved, it is displayed on a screen along with any other overrides previously set:

[[File:lessonoverrideexamples.png]]

==Site administration settings==

The lesson module has additional settings which may be changed by an administrator in ''Administration > Site administration > Plugins > Activity modules > Lesson''.

===Slideshow width===
Sets the width of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowwidth, Default 640.

===Slideshow height===
Sets the height of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowheight, Default 480.

===Slideshow background colour===
Background colour to for the slideshow if it is enabled.
*Variable name: lesson_slideshowbgcolor, Default #FFFFFF.

===Popup window width===
Sets the width of the popup displayed for a linked media file
*Variable name: lesson_mediawidth, Default 640.

===Popup window height===
Sets the height of the popup displayed for a linked media file
*Variable name: lesson_mediaheight, Default 480.

===Show close button:===
Displays a close button as part of the popup generated for a linked media file
*Variable name: lesson_mediaclose, Default No.

===Maximum number of answers===
Default Lesson activity maximum number answers per question and choices per content page for the site.
*Variable name: lesson_maxanswers, Default: 4.

===Action after correct answer===
The default action to take after a correct answer
*Variable name: lesson_defaultnextpage, Default: Normal - follow lesson path

==See also==
*[http://youtu.be/cUDV0WE5ZYY Moodle 2.x Lesson (part 1)] MoodleBites video on YouTube
*[http://youtu.be/Mfj-8w-Ze0A Moodle 2.x Lesson (part 2)] MoodleBites video on YouTube
*[http://youtu.be/jXjqHtgC9c0 Moodle 2.x Lesson (part 3)] MoodleBites video on YouTube

[[de:Lektion konfigurieren]]
[[fr:Ajouter/modifier une leçon]]
[[ja:レッスンの設定]]
[[es:Configuraciones de lección]]

Common module settings

2015-12-08T14:28:07Z

Rcollman: rewrite so generic for all activities. Re-order to match 3.0, add groupings

{{Activities}}
On the settings page for many modules, there is a section called "Common module settings". This refers to settings that are common to many modules.

==Visible==
Choose whether to Show or Hide the activity

==ID number==

Setting an ID number provides a way of identifying the activityfor grade calculation purposes. If the activity is not included in any grade calculation then the ID number field can be left blank.

The ID number can also be set on the edit grade calculation page in the [[Gradebook]], though it can only be edited on the update activity page of the module in a course context.

The ID number may also be used by other modules and plugins.

==Group mode==
[[Groups]] are set up on the course level.
When course group mode is turned on and force is set to no, the [[Groups|group mode]] can be one of three levels on the activity level: no groups, separate groups or visible groups.

;No groups
:There are no groups and all students submit their individual activities in one area.

;Separate groups
:Students submit their activity and teachers/trainers can sort submissions by Group or view All Participants.

;Visible groups
:All students submits their assignment within a single Assignment area but may choose which Group to associate their submission with before uploading. Teachers/trainers can sort submissions by Group or view All Participants.

==Groupings==
[[Groupings]] are a collection of groups that are set up on the course level.

==See also==
Common module settings are used in
*[[Adding/editing an assignment]]
*[[Adding/editing a chat]]
*[[Adding/editing a choice]]
*[[Adding/editing a database]]
*[[Adding/editing a forum]]
*[[Adding/editing a glossary]]
*[[Adding/editing a lesson]]
*[[SCORM module]]
*[[Adding/editing a survey]] does not mention at all
*[[Adding/editing a quiz]]
*[[Adding/editing a wiki]]
Other areas
*[[Groupings]]
*[[Grade export]]
*[[Grade calculations#Assigning ID numbers|Assigning module ID numbers for Grade calculations]]

[[ja:共通モジュール設定]]
[[es:Configuraciones comunes del módulo]]

Lesson settings

2015-12-08T14:00:12Z

Rcollman: /* Common module settings */ show common module settings - result of forum question

{{Lesson}}
=Lesson administration settings=

This page explains the settings involved when first creating a lesson.
To add a lesson to your Moodle course page:
*With the editing turned on, in the section you wish to add your lesson, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu) and choose ''Lesson'' All settings may expanded by clicking the "Expand all" link top right.

==General==
{|
|[[File:lessonintro.png|thumb|500px|General settings expanded by default]]
|}

===Name===
Whatever you type here will form the link learners click on to view the lesson so it is helpful to give it a name that suggests its purpose.

===Description===

Add a description of your lesson here.

===Display description on the course page===
If this box is ticked, the description will appear on the course page just below the name of the lesson.

==Appearance==
(These settings are collapsed by default)
{|
|[[File:lessonappearance.png|thumb|404px|Appearance settings expanded]]
|}
===File pop===
If you want to include a link to a file on the lesson page for students to refer to, upload it here.
===Progress bar===
Choose this to show a bar at the bottom of the page showing how far into the lesson the student has got.
* For lessons containing '''only''' ''Content pages'', once a lesson has been taken to the end, if that same lesson is re-taken, the progress bar will not be "reset", i.e. it will show a 100% progress from page 1!

* For lessons containing ''Question pages'' and set to "Re-take" '''Yes''', the progress bar is always "reset" at 0% upon re-take.

* Note that the Lesson Progress bar only works correctly for lessons with a "straightforward" navigation, such as page 1 -> page 2 -> page n -> end of lesson. It is not guaranteed to work with pages "jumping all over the place".

===Display ongoing score===
Choose this to let students see their score as they work through the lesson.
===Display left menu===
Choose this when you want to show a list of the content page titles in the Lesson to the student. Only those pages which have "Display in menu?" checked will display. The left menu will not display question pages.

===Minimum grade to display menu===
Choose this if you want the student to go through the lesson once and get a grade before they can (on review) see and navigate through all the different pages.
===Slideshow===

Slideshow height, width and background colour are set for the whole site by an administrator in ''Settings > Site administration > Plugins > Activity modules > Lesson''.

===Maximum Number of Answers===
Here you can set the default number of selection boxes available when you add or edit a question or content page. For instance, if you are only going to use Multiple Choice questions with 3 answers in your lesson, you might select 3. You can change the default here at any time to display more or less question answers or content choices.
:''Note:'' This only impacts the editing screen. Changing from 4 to 2 will not remove or hide any answers previously entered from the student.

===Use default feedback===
Every Moodle site has a standard response (feedback) when a student selects a correct or wrong answer in a lesson. Select "No" if you only what you put as a response for a specific question's answer to display. In this case, when you leave the response to a question blank, the student will not see any comment about their answer. The typical Moodle standard responses are: "That's the correct answer" or "That's the wrong answer".

===Link to next activity===
Choose this to give students a link to another activity when they reach the end of the lesson. ''(Note: this can also be achieved using [[Conditional activities]])''
==Availability==
(These settings are collapsed by default)
{|
|[[File:lessontimelimit.png|thumb|470px|Availability settings expanded]]
|}
===Available from/Deadline===
Here you can set a start and end date and time for your Lesson.

===Time limit===

This allows you to set a time limit on the lesson which can now be seconds, minutes, hours, days or weeks. Students will see a countdown counter in a block as they work.

[[File:lessontimeremaining.png]]

The timer does not stop them doing the lesson when the time is up, but correct answers are no longer scored.

===Password protected lesson===
*Change to "Yes" and enter the password if you want students only to access it when they know the password.

==Prerequisite lesson==
*''Note: You will only see this setting if you have a course with prerequisite lessons upgraded from an earlier version of Moodle.''
*You will see a warning that prerequisites are due to be removed completely.
*Please use access restrictions instead. See [[Conditional activities]] for more information.

==Flow control==
(These settings are collapsed by default)
{|
|[[File:flowcontrol.png|thumb|450px|Flow control settings expanded]]
|}

===Allow Student Review===
This puts a "Review Lesson" button on the last screen of the lesson to encourage the students to navigate through the lesson again from the start.
:Note that the students will not be able to ''change'' their answers, only ''view'' them.

===Provide option to try a question again===
*This displays a button after an incorrectly answered question so that the student can try again (but not get credit for it)
:''TIP:'' Leave this off if you are using essay questions.
===Maximum Number of Attempts===
*Decide here how many times you want students to be able to attempt each question. When they reach the maximum, they will be taken automatically to the next page.
'''''Note:''''' this setting works in combination with the above setting, or independently.

*When 'provide an option to try again' is set to No, students will be able to retake the question as many times as it is set here, with a score penalty.

*When 'provide an option to try again' is set to Yes, then students will be able to retake the question as many times as it set here without a score penalty. In this case an extra dialogue appears.

Consequently when the relevant jump 'this page' is used in wrong answer while the 'provide an option to try again' is set to No and 'maximum number of attempts' is set to 1, a student that will answer wrongly will be moved into the next page, since he/she has the change to try the question just once.

'''''Tip:''''' Ensure you check lesson using a real student account, as the teacher preview or the 'switch role to student' may not give you the exact picture.

===Action after a Correct Answer===
Choose here where you want a student to be sent to if they get a question right. See [[Using Lesson]] for more details on this setting. The options are:
**the next part of the Lesson (default setting)
**a random, unexpected page
**a random page which they have not yet answered.
===Number of pages to show===
You only need this if you have set "Action after a correct answer" to show an unseen or unanswered page. Otherwise, all pages will be seen

==Grade==
(These settings are collapsed by default.)
{|
|[[File:lessongradetopass.png|thumb|450px|Grade settings expanded]]
|}

Set a grade and grade category here, along with a "Grade to pass" which may be connected with [[Activity completion]] and [[Conditional activities]] such that a student will not be able to access a follow up activity until they have obtained the required grade in the lesson.

===Practice lesson===

Practice lessons are now saved; this means they will appear in the reports .You must enable the "Retakes allowed" setting if you want students to be able to attempt a practice lesson several times.

'''Note''': If you are upgrading from an earlier version, be aware that all practice lessons will have " Re-takes allowed" set to "Yes" . If you are restoring a practice lesson made before this change, you may need to modify the "Re-takes allowed" setting if needed.

===Custom Scoring===
Use this to give a particular number score (negative or positive) to each answer
===Re-takes allowed===
Choose this if you want your students to be able to do the lesson more than once.
:Note that this setting only applies to lessons containing ''Question pages''. Lessons consisting '''only''' of ''Content pages'' can be re-taken even if 'Re-takes allowed' is set to ''No''.
====Handling of re-take====
If you allow your students to re-take the lesson, then decide here if the grade for all lesson attempts is the mean or the maximum.

:Note that the Question Analysis always uses the answers from the first tries of the lesson. Re-takes by students are ignored.

===Minimum Number of Questions===
Set here the minimum number of questions that will be used to calculate a student's score. Students will be told how many they have answered and how many more they need to answer.
*If you are using Content pages, then set this to 0.
*If you use this setting, then add some explanatory text at the start of the lesson so the student knows how many questions they must answer as a minimum. (They may answer more.

==Common module settings==
*Visible
*ID number
*Group mode
*Groupings
See [[Common module settings]]

==Restrict access/Activity completion==
(These settings are collapsed by default)

*The Restrict access and Activity completion settings are visible if [[Conditional activities]] and [[Activity completion]] have been enabled in the site and the course.
*Note that in addition to the standard activity completion conditions, the Lesson also has 'Require end reached' and 'Require time spent' criteria .
*To learn more about the Lesson completion conditions, see [[Activity completion settings]].

==User and group overrides==

When a lesson has been created, it is possible to overrride certain settings for individuals and groups. The settings for this are located in the Lesson administration block:

[[File:lessonoverrides.png]]

It is possible to override passwords, availability/deadline, time limits and question retries and lesson retakes.
Selecting one of the options, for example 'User' will display a button to click. From the next screen you can choose the user or group to override and the settings you wish to override:

[[File:lessonoverrideuser.png]]

When the override is saved, it is displayed on a screen along with any other overrides previously set:

[[File:lessonoverrideexamples.png]]

==Site administration settings==

The lesson module has additional settings which may be changed by an administrator in ''Administration > Site administration > Plugins > Activity modules > Lesson''.

===Slideshow width===
Sets the width of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowwidth, Default 640.

===Slideshow height===
Sets the height of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowheight, Default 480.

===Slideshow background colour===
Background colour to for the slideshow if it is enabled.
*Variable name: lesson_slideshowbgcolor, Default #FFFFFF.

===Popup window width===
Sets the width of the popup displayed for a linked media file
*Variable name: lesson_mediawidth, Default 640.

===Popup window height===
Sets the height of the popup displayed for a linked media file
*Variable name: lesson_mediaheight, Default 480.

===Show close button:===
Displays a close button as part of the popup generated for a linked media file
*Variable name: lesson_mediaclose, Default No.

===Maximum number of answers===
Default Lesson activity maximum number answers per question and choices per content page for the site.
*Variable name: lesson_maxanswers, Default: 4.

===Action after correct answer===
The default action to take after a correct answer
*Variable name: lesson_defaultnextpage, Default: Normal - follow lesson path

==See also==
*[http://youtu.be/cUDV0WE5ZYY Moodle 2.x Lesson (part 1)] MoodleBites video on YouTube
*[http://youtu.be/Mfj-8w-Ze0A Moodle 2.x Lesson (part 2)] MoodleBites video on YouTube
*[http://youtu.be/jXjqHtgC9c0 Moodle 2.x Lesson (part 3)] MoodleBites video on YouTube

[[de:Lektion konfigurieren]]
[[fr:Ajouter/modifier une leçon]]
[[ja:レッスンの設定]]
[[es:Configuraciones de lección]]

Certificate reports

2015-11-25T18:29:30Z

Rcollman: Reworded reports. Site wide reports needs updating.

{{Certificate}}
A teacher can view and download a report of all certificates issued in their course. They and their students can download a copy of the certificate when the Save Certificates issue option is "yes".

==View and download certificate reports==
The teacher can see a list of all certificates by clicking on the certificate link. On the Summary of previously received certificate page, select the "View issued certificates" in the upper right corner. This will present a list of certificates, showing student name, Email address, Date Received, Grade (if any) and Code.

If the certificate setting Save Certificates was set to yes, they and their students can download a copy of the certificate for a students.

This page also allows downloading a report in ODS, Excel and in text formats. For example the Excel file has Surname, First name, Email address, Group, Date Received, Grade and Code columns.

==Site wide reports==
{{Update}}
*[http://moodle.org/mod/data/view.php?d=13&rid=2505 Kaalgat updated Modules and plugins for 2.1].

[[es:Reportes de certificado]]

Add/edit certificate module

2015-11-25T18:10:18Z

Rcollman: /* Examples of certificates */ put pictures in gallery format

{{Certificate}}
To create a new Certificate select Certificate from the Activities list when viewing a course, with editing turn on. You can customise your Certificate using the following settings:

== General Settings ==
''Settings > Certificate administration > Edit settings''

===Certificate Name===
The Certificate Name will appear on the course home page and will typically tell the users the purpose or type of Certificate being issued. It is possible to have many different certificates in one course.

===Introduction===
This text will be displayed to users when they open the Certificate activity. An introduction should be descriptive and tell the user the purpose or requirements of the certificate.

==Issue Options==

===Email Teachers===

If the Email Teachers option is set to Yes then all users with a Teacher/Trainer role within the course will receive an autogenerated email whenever a student receives a Certificate.

===Email Others===
If there are users within a course that do not have Teacher/Trainer access rights but should be notified when a user receives a Certificate you can enter thier email address in this field. When entering multiple addresses, they should be separated with a comma.

===Delivery===

The Delivery option allows you to choose how students view/receive their Certificate. There are three options:

;Open in Browser
:Opens the Certificate in a new browser window.

;Force Download
:Opens the browser file download window. (Note: Internet Explorer does not currently support the open option from the download window. The save option must be chosen first.)

;Email Certificate
:Choosing this option sends the Certificate to the student as an email attachment (PDF).

===Save Certificates===

By selecting "yes", the Save Certificates option will keep a copy of each student's Certificate in the course files moddata folder. A link to each student's saved Certificate will also be displayed in the teacher View Issued Certificates report. By selecting "no", a new certificate will be created every time a student views it and no copy will be saved.

==Text Options==

===Print Date===
There are three options. Do not print, print the date the Certificate was issued to the user, or print the course end date.

===Date Format===
The options for a date format are: "January 1, 2000", "January 1st, 2000", "1 January 2000", "January 2000" and "User's language Date Format".

===Print Code===

A unique 10-digit code of random letters and numbers can be printed on the Certificate that is specific to a user and the certificate. This number can then be verified by comparing it to the code number displayed in the teacher View Issued Certificates report.

===Print Grade===

You can choose to print either the total course grade, or the grade of a selected course activity of a user on the Certificate. The grade items are listed in the dropdown menu in the order in which they appear in the Gradebook.

Please note: Once a user has received their Certificate, their grade on the Certificate will not change even if their course grade changes.

===Grade Format===

There are three available formats if you choose to print a grade on the Certificate:

;Percentage Grade
:Prints the grade as a percentage.

;Points Grade
:Prints the point value of the grade.

;Letter Grade
:Prints the percentage grade as a letter.

===Print Outcome===

You can choose any course Outcome name and result on the Certificate. For example 'Assignment Outcome: Proficient'

===Print Credit Hours===
You may enter a number in this field. For example, if you entered 5, then the certificate would show "Credit Hours: 5". By editing the language, it might say "CEUs: 5" or "Days of Participation: 5".

===Print Teacher Name(s)===

If you wish to include the course Teacher name on the Certificate, select Yes under Print Teacher Name(s) and ensure the required staff have been assigned Teacher/Trainer roles at the Certificate Module level.

===Custom Text===
Additional text may be added to the Certificate via the Custom Text field. By default, this text is placed in the lower left of the Certificate.
You can use the text box to enter html, insert links and insert an image,

The following html tags are available:

:<nowiki> < br > and < p ></nowiki>
:<nowiki> < b >, < i > and < u ></nowiki>
:<nowiki> < img > (src and width (or height) are mandatory)</nowiki>
:<nowiki>< a > (href is mandatory)</nowiki>
:<nowiki> < font > possible attributes are - colour: hex colour code and face: arial, times, courier, helvetica, symbol
</nowiki>

==Design Options==
All of the design options can be customized. This includes changing positions of the images or text, adding or changing images.

===Certificate Type===
The certificate type determines what and where things (if selected) will be printed. The Certificate activity comes with 2 paper sizes, with 2 font options
*A4 embedded (fonts)
*A4 non-embedded
*Letter embedded
*Letter non-embedded

If you created any custom certificate types, they will appear on this pulldown menu.

===Orientation===
Select either landscape or portrait. The code for each of these page orientations are located in each of the certificate types.

===Border Image===
Select the border image that you want around the Certificate edges or select No border. By default there are two different border images each in 4 different colors.

===Border Lines===
Instead of, or in addition to a Border Image you can select for a simple three line Border Line around the edge of the Certificate. By default there the line colours are "no" (none), black, blue, brown and green.

===Watermark Image===
A Watermark file can be placed in the background of a Certificate. A Watermark could be a specific logo, seal, crest etc. By default two Watermark Images are included, a sample school crest and a Fleur de lis .

===Signature Image===
This option allows you to print a digital signature or print a line for a written signature on the Certificate.

===Seal or Logo Image===
This option allows you to select a seal or logo to print on the Certificate from a repository of options. By default five seal images and an example logo image are available.

==Common Module Settings==
These may vary according to advanced options and site settings.

===Visible===
If you choose Show, then students in the course will be able to see this Certificate activity and attempt to generate a Certificate. If you choose Hide, then only users with teacher or administrative permissions in the course or Certificate activity will be able to see it.

===ID number===
Reference number used by gradebook and grade calculations. Typically this is left blank.

===Group mode===
A Certificate activity can have the following three Group options:
*No groups - The issue of the Certificate will not consider groups
*Separate groups - Each group can only see their own Certificate activity but others are invisible
*Visible groups - Each group can see their own Certificate as well as see the Certificate activity of other groups.

===Grouping===

==Restrict access==
This feature has to be enabled on the site level under ''Site administration > advanced settings > Enable conditional access''. See [[Conditional activities]] for more information.
===Allow access dates===
*Allow access from
*Allow access until

===Grade condition===
Select the unit or the Course total option.
Choose the minimum required percentage and the max (leave blank if it 100%) grade

:You can set the "lock" on several activities. However best practice is to daisy chain the activities by their conditions. Thus if you had a series of 10 grade conditional activities, each one would be dependent upon the one immediately preceding it. In this example, certificate would set the condition on the 10th activity.

==Activity completion ==
This feature has to be enabled on the site level under "advanced settings". Please see [[Activity completion]] for more information about the features below.
*Completion tracking
*Require view
*Expect completed

==Examples of certificates==

<gallery caption="Both these examples are in blue. Other border colors are black, brown and green. Click on image to enlarge" widths="200px" heights="100px" perrow="3">
Image:Certificate 1.gif|Standard certificate - few options turned on.
Image:Certificate199 example.png|Standard certificate - many options turned on.
</gallery>

==See also==
[[Certificate module]]

[[Category:Certificate]]

[[es:Añadir/editar certificado]]

Add/edit certificate module

2015-11-25T17:41:53Z

Rcollman: /* Common Module Settings */ put in screen order

{{Certificate}}
To create a new Certificate select Certificate from the Activities list when viewing a course, with editing turn on. You can customise your Certificate using the following settings:

== General Settings ==
''Settings > Certificate administration > Edit settings''

===Certificate Name===
The Certificate Name will appear on the course home page and will typically tell the users the purpose or type of Certificate being issued. It is possible to have many different certificates in one course.

===Introduction===
This text will be displayed to users when they open the Certificate activity. An introduction should be descriptive and tell the user the purpose or requirements of the certificate.

==Issue Options==

===Email Teachers===

If the Email Teachers option is set to Yes then all users with a Teacher/Trainer role within the course will receive an autogenerated email whenever a student receives a Certificate.

===Email Others===
If there are users within a course that do not have Teacher/Trainer access rights but should be notified when a user receives a Certificate you can enter thier email address in this field. When entering multiple addresses, they should be separated with a comma.

===Delivery===

The Delivery option allows you to choose how students view/receive their Certificate. There are three options:

;Open in Browser
:Opens the Certificate in a new browser window.

;Force Download
:Opens the browser file download window. (Note: Internet Explorer does not currently support the open option from the download window. The save option must be chosen first.)

;Email Certificate
:Choosing this option sends the Certificate to the student as an email attachment (PDF).

===Save Certificates===

By selecting "yes", the Save Certificates option will keep a copy of each student's Certificate in the course files moddata folder. A link to each student's saved Certificate will also be displayed in the teacher View Issued Certificates report. By selecting "no", a new certificate will be created every time a student views it and no copy will be saved.

==Text Options==

===Print Date===
There are three options. Do not print, print the date the Certificate was issued to the user, or print the course end date.

===Date Format===
The options for a date format are: "January 1, 2000", "January 1st, 2000", "1 January 2000", "January 2000" and "User's language Date Format".

===Print Code===

A unique 10-digit code of random letters and numbers can be printed on the Certificate that is specific to a user and the certificate. This number can then be verified by comparing it to the code number displayed in the teacher View Issued Certificates report.

===Print Grade===

You can choose to print either the total course grade, or the grade of a selected course activity of a user on the Certificate. The grade items are listed in the dropdown menu in the order in which they appear in the Gradebook.

Please note: Once a user has received their Certificate, their grade on the Certificate will not change even if their course grade changes.

===Grade Format===

There are three available formats if you choose to print a grade on the Certificate:

;Percentage Grade
:Prints the grade as a percentage.

;Points Grade
:Prints the point value of the grade.

;Letter Grade
:Prints the percentage grade as a letter.

===Print Outcome===

You can choose any course Outcome name and result on the Certificate. For example 'Assignment Outcome: Proficient'

===Print Credit Hours===
You may enter a number in this field. For example, if you entered 5, then the certificate would show "Credit Hours: 5". By editing the language, it might say "CEUs: 5" or "Days of Participation: 5".

===Print Teacher Name(s)===

If you wish to include the course Teacher name on the Certificate, select Yes under Print Teacher Name(s) and ensure the required staff have been assigned Teacher/Trainer roles at the Certificate Module level.

===Custom Text===
Additional text may be added to the Certificate via the Custom Text field. By default, this text is placed in the lower left of the Certificate.
You can use the text box to enter html, insert links and insert an image,

The following html tags are available:

:<nowiki> < br > and < p ></nowiki>
:<nowiki> < b >, < i > and < u ></nowiki>
:<nowiki> < img > (src and width (or height) are mandatory)</nowiki>
:<nowiki>< a > (href is mandatory)</nowiki>
:<nowiki> < font > possible attributes are - colour: hex colour code and face: arial, times, courier, helvetica, symbol
</nowiki>

==Design Options==
All of the design options can be customized. This includes changing positions of the images or text, adding or changing images.

===Certificate Type===
The certificate type determines what and where things (if selected) will be printed. The Certificate activity comes with 2 paper sizes, with 2 font options
*A4 embedded (fonts)
*A4 non-embedded
*Letter embedded
*Letter non-embedded

If you created any custom certificate types, they will appear on this pulldown menu.

===Orientation===
Select either landscape or portrait. The code for each of these page orientations are located in each of the certificate types.

===Border Image===
Select the border image that you want around the Certificate edges or select No border. By default there are two different border images each in 4 different colors.

===Border Lines===
Instead of, or in addition to a Border Image you can select for a simple three line Border Line around the edge of the Certificate. By default there the line colours are "no" (none), black, blue, brown and green.

===Watermark Image===
A Watermark file can be placed in the background of a Certificate. A Watermark could be a specific logo, seal, crest etc. By default two Watermark Images are included, a sample school crest and a Fleur de lis .

===Signature Image===
This option allows you to print a digital signature or print a line for a written signature on the Certificate.

===Seal or Logo Image===
This option allows you to select a seal or logo to print on the Certificate from a repository of options. By default five seal images and an example logo image are available.

==Common Module Settings==
These may vary according to advanced options and site settings.

===Visible===
If you choose Show, then students in the course will be able to see this Certificate activity and attempt to generate a Certificate. If you choose Hide, then only users with teacher or administrative permissions in the course or Certificate activity will be able to see it.

===ID number===
Reference number used by gradebook and grade calculations. Typically this is left blank.

===Group mode===
A Certificate activity can have the following three Group options:
*No groups - The issue of the Certificate will not consider groups
*Separate groups - Each group can only see their own Certificate activity but others are invisible
*Visible groups - Each group can see their own Certificate as well as see the Certificate activity of other groups.

===Grouping===

==Restrict access==
This feature has to be enabled on the site level under ''Site administration > advanced settings > Enable conditional access''. See [[Conditional activities]] for more information.
===Allow access dates===
*Allow access from
*Allow access until

===Grade condition===
Select the unit or the Course total option.
Choose the minimum required percentage and the max (leave blank if it 100%) grade

:You can set the "lock" on several activities. However best practice is to daisy chain the activities by their conditions. Thus if you had a series of 10 grade conditional activities, each one would be dependent upon the one immediately preceding it. In this example, certificate would set the condition on the 10th activity.

==Activity completion ==
This feature has to be enabled on the site level under "advanced settings". Please see [[Activity completion]] for more information about the features below.
*Completion tracking
*Require view
*Expect completed

==Examples of certificates==
Both these examples are in blue. Other border colors are black, brown and green.
[[Image:Certificate 1.gif|thumb|left|Standard certificate]] [[Image:Certificate199 example.png|thumb|right|Customized certificate]]

==See also==
[[Certificate module]]

[[Category:Certificate]]

[[es:Añadir/editar certificado]]

Add/edit certificate module

2015-11-25T17:15:07Z

Rcollman: /* Seal or Logo Image */

{{Certificate}}
To create a new Certificate select Certificate from the Activities list when viewing a course, with editing turn on. You can customise your Certificate using the following settings:

== General Settings ==
''Settings > Certificate administration > Edit settings''

===Certificate Name===
The Certificate Name will appear on the course home page and will typically tell the users the purpose or type of Certificate being issued. It is possible to have many different certificates in one course.

===Introduction===
This text will be displayed to users when they open the Certificate activity. An introduction should be descriptive and tell the user the purpose or requirements of the certificate.

==Issue Options==

===Email Teachers===

If the Email Teachers option is set to Yes then all users with a Teacher/Trainer role within the course will receive an autogenerated email whenever a student receives a Certificate.

===Email Others===
If there are users within a course that do not have Teacher/Trainer access rights but should be notified when a user receives a Certificate you can enter thier email address in this field. When entering multiple addresses, they should be separated with a comma.

===Delivery===

The Delivery option allows you to choose how students view/receive their Certificate. There are three options:

;Open in Browser
:Opens the Certificate in a new browser window.

;Force Download
:Opens the browser file download window. (Note: Internet Explorer does not currently support the open option from the download window. The save option must be chosen first.)

;Email Certificate
:Choosing this option sends the Certificate to the student as an email attachment (PDF).

===Save Certificates===

By selecting "yes", the Save Certificates option will keep a copy of each student's Certificate in the course files moddata folder. A link to each student's saved Certificate will also be displayed in the teacher View Issued Certificates report. By selecting "no", a new certificate will be created every time a student views it and no copy will be saved.

==Text Options==

===Print Date===
There are three options. Do not print, print the date the Certificate was issued to the user, or print the course end date.

===Date Format===
The options for a date format are: "January 1, 2000", "January 1st, 2000", "1 January 2000", "January 2000" and "User's language Date Format".

===Print Code===

A unique 10-digit code of random letters and numbers can be printed on the Certificate that is specific to a user and the certificate. This number can then be verified by comparing it to the code number displayed in the teacher View Issued Certificates report.

===Print Grade===

You can choose to print either the total course grade, or the grade of a selected course activity of a user on the Certificate. The grade items are listed in the dropdown menu in the order in which they appear in the Gradebook.

Please note: Once a user has received their Certificate, their grade on the Certificate will not change even if their course grade changes.

===Grade Format===

There are three available formats if you choose to print a grade on the Certificate:

;Percentage Grade
:Prints the grade as a percentage.

;Points Grade
:Prints the point value of the grade.

;Letter Grade
:Prints the percentage grade as a letter.

===Print Outcome===

You can choose any course Outcome name and result on the Certificate. For example 'Assignment Outcome: Proficient'

===Print Credit Hours===
You may enter a number in this field. For example, if you entered 5, then the certificate would show "Credit Hours: 5". By editing the language, it might say "CEUs: 5" or "Days of Participation: 5".

===Print Teacher Name(s)===

If you wish to include the course Teacher name on the Certificate, select Yes under Print Teacher Name(s) and ensure the required staff have been assigned Teacher/Trainer roles at the Certificate Module level.

===Custom Text===
Additional text may be added to the Certificate via the Custom Text field. By default, this text is placed in the lower left of the Certificate.
You can use the text box to enter html, insert links and insert an image,

The following html tags are available:

:<nowiki> < br > and < p ></nowiki>
:<nowiki> < b >, < i > and < u ></nowiki>
:<nowiki> < img > (src and width (or height) are mandatory)</nowiki>
:<nowiki>< a > (href is mandatory)</nowiki>
:<nowiki> < font > possible attributes are - colour: hex colour code and face: arial, times, courier, helvetica, symbol
</nowiki>

==Design Options==
All of the design options can be customized. This includes changing positions of the images or text, adding or changing images.

===Certificate Type===
The certificate type determines what and where things (if selected) will be printed. The Certificate activity comes with 2 paper sizes, with 2 font options
*A4 embedded (fonts)
*A4 non-embedded
*Letter embedded
*Letter non-embedded

If you created any custom certificate types, they will appear on this pulldown menu.

===Orientation===
Select either landscape or portrait. The code for each of these page orientations are located in each of the certificate types.

===Border Image===
Select the border image that you want around the Certificate edges or select No border. By default there are two different border images each in 4 different colors.

===Border Lines===
Instead of, or in addition to a Border Image you can select for a simple three line Border Line around the edge of the Certificate. By default there the line colours are "no" (none), black, blue, brown and green.

===Watermark Image===
A Watermark file can be placed in the background of a Certificate. A Watermark could be a specific logo, seal, crest etc. By default two Watermark Images are included, a sample school crest and a Fleur de lis .

===Signature Image===
This option allows you to print a digital signature or print a line for a written signature on the Certificate.

===Seal or Logo Image===
This option allows you to select a seal or logo to print on the Certificate from a repository of options. By default five seal images and an example logo image are available.

==Common Module Settings==
These may vary according to advanced options and site settings.

===Group mode===
A Certificate activity can have the following three Group options:
*No groups - The issue of the Certificate will not groups based
*Separate groups - Each group can only see their own Certificate activity but others are invisible
*Visible groups - Each group can see their own Certificate as well as see the Certificate activity of other groups.

===Groupings===
If you have groupings of groups.

===Visible===
If you choose Show, then students in the course will be able to see this Certificate activity and attempt to generate a Certificate. If you choose Hide, then only users with teacher or administrative permissions in the course or Certificate activity will be able to see it.

===ID number===
Reference number.

==Restrict access==
This feature has to be enabled on the site level under ''Site administration > advanced settings > Enable conditional access''. See [[Conditional activities]] for more information.
===Allow access dates===
*Allow access from
*Allow access until

===Grade condition===
Select the unit or the Course total option.
Choose the minimum required percentage and the max (leave blank if it 100%) grade

:You can set the "lock" on several activities. However best practice is to daisy chain the activities by their conditions. Thus if you had a series of 10 grade conditional activities, each one would be dependent upon the one immediately preceding it. In this example, certificate would set the condition on the 10th activity.

==Activity completion ==
This feature has to be enabled on the site level under "advanced settings". Please see [[Activity completion]] for more information about the features below.
*Completion tracking
*Require view
*Expect completed

==Examples of certificates==
Both these examples are in blue. Other border colors are black, brown and green.
[[Image:Certificate 1.gif|thumb|left|Standard certificate]] [[Image:Certificate199 example.png|thumb|right|Customized certificate]]

==See also==
[[Certificate module]]

[[Category:Certificate]]

[[es:Añadir/editar certificado]]

Add/edit certificate module

2015-11-25T17:14:27Z

Rcollman: /* Signature Image */

{{Certificate}}
To create a new Certificate select Certificate from the Activities list when viewing a course, with editing turn on. You can customise your Certificate using the following settings:

== General Settings ==
''Settings > Certificate administration > Edit settings''

===Certificate Name===
The Certificate Name will appear on the course home page and will typically tell the users the purpose or type of Certificate being issued. It is possible to have many different certificates in one course.

===Introduction===
This text will be displayed to users when they open the Certificate activity. An introduction should be descriptive and tell the user the purpose or requirements of the certificate.

==Issue Options==

===Email Teachers===

If the Email Teachers option is set to Yes then all users with a Teacher/Trainer role within the course will receive an autogenerated email whenever a student receives a Certificate.

===Email Others===
If there are users within a course that do not have Teacher/Trainer access rights but should be notified when a user receives a Certificate you can enter thier email address in this field. When entering multiple addresses, they should be separated with a comma.

===Delivery===

The Delivery option allows you to choose how students view/receive their Certificate. There are three options:

;Open in Browser
:Opens the Certificate in a new browser window.

;Force Download
:Opens the browser file download window. (Note: Internet Explorer does not currently support the open option from the download window. The save option must be chosen first.)

;Email Certificate
:Choosing this option sends the Certificate to the student as an email attachment (PDF).

===Save Certificates===

By selecting "yes", the Save Certificates option will keep a copy of each student's Certificate in the course files moddata folder. A link to each student's saved Certificate will also be displayed in the teacher View Issued Certificates report. By selecting "no", a new certificate will be created every time a student views it and no copy will be saved.

==Text Options==

===Print Date===
There are three options. Do not print, print the date the Certificate was issued to the user, or print the course end date.

===Date Format===
The options for a date format are: "January 1, 2000", "January 1st, 2000", "1 January 2000", "January 2000" and "User's language Date Format".

===Print Code===

A unique 10-digit code of random letters and numbers can be printed on the Certificate that is specific to a user and the certificate. This number can then be verified by comparing it to the code number displayed in the teacher View Issued Certificates report.

===Print Grade===

You can choose to print either the total course grade, or the grade of a selected course activity of a user on the Certificate. The grade items are listed in the dropdown menu in the order in which they appear in the Gradebook.

Please note: Once a user has received their Certificate, their grade on the Certificate will not change even if their course grade changes.

===Grade Format===

There are three available formats if you choose to print a grade on the Certificate:

;Percentage Grade
:Prints the grade as a percentage.

;Points Grade
:Prints the point value of the grade.

;Letter Grade
:Prints the percentage grade as a letter.

===Print Outcome===

You can choose any course Outcome name and result on the Certificate. For example 'Assignment Outcome: Proficient'

===Print Credit Hours===
You may enter a number in this field. For example, if you entered 5, then the certificate would show "Credit Hours: 5". By editing the language, it might say "CEUs: 5" or "Days of Participation: 5".

===Print Teacher Name(s)===

If you wish to include the course Teacher name on the Certificate, select Yes under Print Teacher Name(s) and ensure the required staff have been assigned Teacher/Trainer roles at the Certificate Module level.

===Custom Text===
Additional text may be added to the Certificate via the Custom Text field. By default, this text is placed in the lower left of the Certificate.
You can use the text box to enter html, insert links and insert an image,

The following html tags are available:

:<nowiki> < br > and < p ></nowiki>
:<nowiki> < b >, < i > and < u ></nowiki>
:<nowiki> < img > (src and width (or height) are mandatory)</nowiki>
:<nowiki>< a > (href is mandatory)</nowiki>
:<nowiki> < font > possible attributes are - colour: hex colour code and face: arial, times, courier, helvetica, symbol
</nowiki>

==Design Options==
All of the design options can be customized. This includes changing positions of the images or text, adding or changing images.

===Certificate Type===
The certificate type determines what and where things (if selected) will be printed. The Certificate activity comes with 2 paper sizes, with 2 font options
*A4 embedded (fonts)
*A4 non-embedded
*Letter embedded
*Letter non-embedded

If you created any custom certificate types, they will appear on this pulldown menu.

===Orientation===
Select either landscape or portrait. The code for each of these page orientations are located in each of the certificate types.

===Border Image===
Select the border image that you want around the Certificate edges or select No border. By default there are two different border images each in 4 different colors.

===Border Lines===
Instead of, or in addition to a Border Image you can select for a simple three line Border Line around the edge of the Certificate. By default there the line colours are "no" (none), black, blue, brown and green.

===Watermark Image===
A Watermark file can be placed in the background of a Certificate. A Watermark could be a specific logo, seal, crest etc. By default two Watermark Images are included, a sample school crest and a Fleur de lis .

===Signature Image===
This option allows you to print a digital signature or print a line for a written signature on the Certificate.

===Seal or Logo Image===
This option allows you to select a seal or logo to print on the Certificate from a repository of options. By default four seal images and an example logo image are available.

==Common Module Settings==
These may vary according to advanced options and site settings.

===Group mode===
A Certificate activity can have the following three Group options:
*No groups - The issue of the Certificate will not groups based
*Separate groups - Each group can only see their own Certificate activity but others are invisible
*Visible groups - Each group can see their own Certificate as well as see the Certificate activity of other groups.

===Groupings===
If you have groupings of groups.

===Visible===
If you choose Show, then students in the course will be able to see this Certificate activity and attempt to generate a Certificate. If you choose Hide, then only users with teacher or administrative permissions in the course or Certificate activity will be able to see it.

===ID number===
Reference number.

==Restrict access==
This feature has to be enabled on the site level under ''Site administration > advanced settings > Enable conditional access''. See [[Conditional activities]] for more information.
===Allow access dates===
*Allow access from
*Allow access until

===Grade condition===
Select the unit or the Course total option.
Choose the minimum required percentage and the max (leave blank if it 100%) grade

:You can set the "lock" on several activities. However best practice is to daisy chain the activities by their conditions. Thus if you had a series of 10 grade conditional activities, each one would be dependent upon the one immediately preceding it. In this example, certificate would set the condition on the 10th activity.

==Activity completion ==
This feature has to be enabled on the site level under "advanced settings". Please see [[Activity completion]] for more information about the features below.
*Completion tracking
*Require view
*Expect completed

==Examples of certificates==
Both these examples are in blue. Other border colors are black, brown and green.
[[Image:Certificate 1.gif|thumb|left|Standard certificate]] [[Image:Certificate199 example.png|thumb|right|Customized certificate]]

==See also==
[[Certificate module]]

[[Category:Certificate]]

[[es:Añadir/editar certificado]]

Add/edit certificate module

2015-11-25T17:11:43Z

Rcollman: /* Certificate Type */

{{Certificate}}
To create a new Certificate select Certificate from the Activities list when viewing a course, with editing turn on. You can customise your Certificate using the following settings:

== General Settings ==
''Settings > Certificate administration > Edit settings''

===Certificate Name===
The Certificate Name will appear on the course home page and will typically tell the users the purpose or type of Certificate being issued. It is possible to have many different certificates in one course.

===Introduction===
This text will be displayed to users when they open the Certificate activity. An introduction should be descriptive and tell the user the purpose or requirements of the certificate.

==Issue Options==

===Email Teachers===

If the Email Teachers option is set to Yes then all users with a Teacher/Trainer role within the course will receive an autogenerated email whenever a student receives a Certificate.

===Email Others===
If there are users within a course that do not have Teacher/Trainer access rights but should be notified when a user receives a Certificate you can enter thier email address in this field. When entering multiple addresses, they should be separated with a comma.

===Delivery===

The Delivery option allows you to choose how students view/receive their Certificate. There are three options:

;Open in Browser
:Opens the Certificate in a new browser window.

;Force Download
:Opens the browser file download window. (Note: Internet Explorer does not currently support the open option from the download window. The save option must be chosen first.)

;Email Certificate
:Choosing this option sends the Certificate to the student as an email attachment (PDF).

===Save Certificates===

By selecting "yes", the Save Certificates option will keep a copy of each student's Certificate in the course files moddata folder. A link to each student's saved Certificate will also be displayed in the teacher View Issued Certificates report. By selecting "no", a new certificate will be created every time a student views it and no copy will be saved.

==Text Options==

===Print Date===
There are three options. Do not print, print the date the Certificate was issued to the user, or print the course end date.

===Date Format===
The options for a date format are: "January 1, 2000", "January 1st, 2000", "1 January 2000", "January 2000" and "User's language Date Format".

===Print Code===

A unique 10-digit code of random letters and numbers can be printed on the Certificate that is specific to a user and the certificate. This number can then be verified by comparing it to the code number displayed in the teacher View Issued Certificates report.

===Print Grade===

You can choose to print either the total course grade, or the grade of a selected course activity of a user on the Certificate. The grade items are listed in the dropdown menu in the order in which they appear in the Gradebook.

Please note: Once a user has received their Certificate, their grade on the Certificate will not change even if their course grade changes.

===Grade Format===

There are three available formats if you choose to print a grade on the Certificate:

;Percentage Grade
:Prints the grade as a percentage.

;Points Grade
:Prints the point value of the grade.

;Letter Grade
:Prints the percentage grade as a letter.

===Print Outcome===

You can choose any course Outcome name and result on the Certificate. For example 'Assignment Outcome: Proficient'

===Print Credit Hours===
You may enter a number in this field. For example, if you entered 5, then the certificate would show "Credit Hours: 5". By editing the language, it might say "CEUs: 5" or "Days of Participation: 5".

===Print Teacher Name(s)===

If you wish to include the course Teacher name on the Certificate, select Yes under Print Teacher Name(s) and ensure the required staff have been assigned Teacher/Trainer roles at the Certificate Module level.

===Custom Text===
Additional text may be added to the Certificate via the Custom Text field. By default, this text is placed in the lower left of the Certificate.
You can use the text box to enter html, insert links and insert an image,

The following html tags are available:

:<nowiki> < br > and < p ></nowiki>
:<nowiki> < b >, < i > and < u ></nowiki>
:<nowiki> < img > (src and width (or height) are mandatory)</nowiki>
:<nowiki>< a > (href is mandatory)</nowiki>
:<nowiki> < font > possible attributes are - colour: hex colour code and face: arial, times, courier, helvetica, symbol
</nowiki>

==Design Options==
All of the design options can be customized. This includes changing positions of the images or text, adding or changing images.

===Certificate Type===
The certificate type determines what and where things (if selected) will be printed. The Certificate activity comes with 2 paper sizes, with 2 font options
*A4 embedded (fonts)
*A4 non-embedded
*Letter embedded
*Letter non-embedded

If you created any custom certificate types, they will appear on this pulldown menu.

===Orientation===
Select either landscape or portrait. The code for each of these page orientations are located in each of the certificate types.

===Border Image===
Select the border image that you want around the Certificate edges or select No border. By default there are two different border images each in 4 different colors.

===Border Lines===
Instead of, or in addition to a Border Image you can select for a simple three line Border Line around the edge of the Certificate. By default there the line colours are "no" (none), black, blue, brown and green.

===Watermark Image===
A Watermark file can be placed in the background of a Certificate. A Watermark could be a specific logo, seal, crest etc. By default two Watermark Images are included, a sample school crest and a Fleur de lis .

===Signature Image===
This option allows you to print a digital signature or print a line for a written signature, on the Certificate.

===Seal or Logo Image===
This option allows you to select a seal or logo to print on the Certificate from a repository of options. By default four seal images and an example logo image are available.

==Common Module Settings==
These may vary according to advanced options and site settings.

===Group mode===
A Certificate activity can have the following three Group options:
*No groups - The issue of the Certificate will not groups based
*Separate groups - Each group can only see their own Certificate activity but others are invisible
*Visible groups - Each group can see their own Certificate as well as see the Certificate activity of other groups.

===Groupings===
If you have groupings of groups.

===Visible===
If you choose Show, then students in the course will be able to see this Certificate activity and attempt to generate a Certificate. If you choose Hide, then only users with teacher or administrative permissions in the course or Certificate activity will be able to see it.

===ID number===
Reference number.

==Restrict access==
This feature has to be enabled on the site level under ''Site administration > advanced settings > Enable conditional access''. See [[Conditional activities]] for more information.
===Allow access dates===
*Allow access from
*Allow access until

===Grade condition===
Select the unit or the Course total option.
Choose the minimum required percentage and the max (leave blank if it 100%) grade

:You can set the "lock" on several activities. However best practice is to daisy chain the activities by their conditions. Thus if you had a series of 10 grade conditional activities, each one would be dependent upon the one immediately preceding it. In this example, certificate would set the condition on the 10th activity.

==Activity completion ==
This feature has to be enabled on the site level under "advanced settings". Please see [[Activity completion]] for more information about the features below.
*Completion tracking
*Require view
*Expect completed

==Examples of certificates==
Both these examples are in blue. Other border colors are black, brown and green.
[[Image:Certificate 1.gif|thumb|left|Standard certificate]] [[Image:Certificate199 example.png|thumb|right|Customized certificate]]

==See also==
[[Certificate module]]

[[Category:Certificate]]

[[es:Añadir/editar certificado]]

Add/edit certificate module

2015-11-25T16:30:56Z

Rcollman: /* Print Credit Hours */ reword, give examples

{{Certificate}}
To create a new Certificate select Certificate from the Activities list when viewing a course, with editing turn on. You can customise your Certificate using the following settings:

== General Settings ==
''Settings > Certificate administration > Edit settings''

===Certificate Name===
The Certificate Name will appear on the course home page and will typically tell the users the purpose or type of Certificate being issued. It is possible to have many different certificates in one course.

===Introduction===
This text will be displayed to users when they open the Certificate activity. An introduction should be descriptive and tell the user the purpose or requirements of the certificate.

==Issue Options==

===Email Teachers===

If the Email Teachers option is set to Yes then all users with a Teacher/Trainer role within the course will receive an autogenerated email whenever a student receives a Certificate.

===Email Others===
If there are users within a course that do not have Teacher/Trainer access rights but should be notified when a user receives a Certificate you can enter thier email address in this field. When entering multiple addresses, they should be separated with a comma.

===Delivery===

The Delivery option allows you to choose how students view/receive their Certificate. There are three options:

;Open in Browser
:Opens the Certificate in a new browser window.

;Force Download
:Opens the browser file download window. (Note: Internet Explorer does not currently support the open option from the download window. The save option must be chosen first.)

;Email Certificate
:Choosing this option sends the Certificate to the student as an email attachment (PDF).

===Save Certificates===

By selecting "yes", the Save Certificates option will keep a copy of each student's Certificate in the course files moddata folder. A link to each student's saved Certificate will also be displayed in the teacher View Issued Certificates report. By selecting "no", a new certificate will be created every time a student views it and no copy will be saved.

==Text Options==

===Print Date===
There are three options. Do not print, print the date the Certificate was issued to the user, or print the course end date.

===Date Format===
The options for a date format are: "January 1, 2000", "January 1st, 2000", "1 January 2000", "January 2000" and "User's language Date Format".

===Print Code===

A unique 10-digit code of random letters and numbers can be printed on the Certificate that is specific to a user and the certificate. This number can then be verified by comparing it to the code number displayed in the teacher View Issued Certificates report.

===Print Grade===

You can choose to print either the total course grade, or the grade of a selected course activity of a user on the Certificate. The grade items are listed in the dropdown menu in the order in which they appear in the Gradebook.

Please note: Once a user has received their Certificate, their grade on the Certificate will not change even if their course grade changes.

===Grade Format===

There are three available formats if you choose to print a grade on the Certificate:

;Percentage Grade
:Prints the grade as a percentage.

;Points Grade
:Prints the point value of the grade.

;Letter Grade
:Prints the percentage grade as a letter.

===Print Outcome===

You can choose any course Outcome name and result on the Certificate. For example 'Assignment Outcome: Proficient'

===Print Credit Hours===
You may enter a number in this field. For example, if you entered 5, then the certificate would show "Credit Hours: 5". By editing the language, it might say "CEUs: 5" or "Days of Participation: 5".

===Print Teacher Name(s)===

If you wish to include the course Teacher name on the Certificate, select Yes under Print Teacher Name(s) and ensure the required staff have been assigned Teacher/Trainer roles at the Certificate Module level.

===Custom Text===
Additional text may be added to the Certificate via the Custom Text field. By default, this text is placed in the lower left of the Certificate.
You can use the text box to enter html, insert links and insert an image,

The following html tags are available:

:<nowiki> < br > and < p ></nowiki>
:<nowiki> < b >, < i > and < u ></nowiki>
:<nowiki> < img > (src and width (or height) are mandatory)</nowiki>
:<nowiki>< a > (href is mandatory)</nowiki>
:<nowiki> < font > possible attributes are - colour: hex colour code and face: arial, times, courier, helvetica, symbol
</nowiki>

==Design Options==
All of the design options can be customized. This includes changing positions of the images or text, adding or changing images.

===Certificate Type===
The certificate type determines what and where things (if selected) will be printed. Certificate comes with 2 paper size types with 2 font options
*A4 embedded (fonts)
*A4 non-embedded
*Letter embedded
*Letter non-embedded

If you created any custom types, they will appear on this pulldown menu.

===Orientation===
Select either landscape or portrait. The code for each of these page orientations are located in each of the certificate types.

===Border Image===
Select the border image that you want around the Certificate edges or select No border. By default there are two different border images each in 4 different colors.

===Border Lines===
Instead of, or in addition to a Border Image you can select for a simple three line Border Line around the edge of the Certificate. By default there the line colours are "no" (none), black, blue, brown and green.

===Watermark Image===
A Watermark file can be placed in the background of a Certificate. A Watermark could be a specific logo, seal, crest etc. By default two Watermark Images are included, a sample school crest and a Fleur de lis .

===Signature Image===
This option allows you to print a digital signature or print a line for a written signature, on the Certificate.

===Seal or Logo Image===
This option allows you to select a seal or logo to print on the Certificate from a repository of options. By default four seal images and an example logo image are available.

==Common Module Settings==
These may vary according to advanced options and site settings.

===Group mode===
A Certificate activity can have the following three Group options:
*No groups - The issue of the Certificate will not groups based
*Separate groups - Each group can only see their own Certificate activity but others are invisible
*Visible groups - Each group can see their own Certificate as well as see the Certificate activity of other groups.

===Groupings===
If you have groupings of groups.

===Visible===
If you choose Show, then students in the course will be able to see this Certificate activity and attempt to generate a Certificate. If you choose Hide, then only users with teacher or administrative permissions in the course or Certificate activity will be able to see it.

===ID number===
Reference number.

==Restrict access==
This feature has to be enabled on the site level under ''Site administration > advanced settings > Enable conditional access''. See [[Conditional activities]] for more information.
===Allow access dates===
*Allow access from
*Allow access until

===Grade condition===
Select the unit or the Course total option.
Choose the minimum required percentage and the max (leave blank if it 100%) grade

:You can set the "lock" on several activities. However best practice is to daisy chain the activities by their conditions. Thus if you had a series of 10 grade conditional activities, each one would be dependent upon the one immediately preceding it. In this example, certificate would set the condition on the 10th activity.

==Activity completion ==
This feature has to be enabled on the site level under "advanced settings". Please see [[Activity completion]] for more information about the features below.
*Completion tracking
*Require view
*Expect completed

==Examples of certificates==
Both these examples are in blue. Other border colors are black, brown and green.
[[Image:Certificate 1.gif|thumb|left|Standard certificate]] [[Image:Certificate199 example.png|thumb|right|Customized certificate]]

==See also==
[[Certificate module]]

[[Category:Certificate]]

[[es:Añadir/editar certificado]]

Add/edit certificate module

2015-11-25T16:06:45Z

Rcollman: /* Print Code */

{{Certificate}}
To create a new Certificate select Certificate from the Activities list when viewing a course, with editing turn on. You can customise your Certificate using the following settings:

== General Settings ==
''Settings > Certificate administration > Edit settings''

===Certificate Name===
The Certificate Name will appear on the course home page and will typically tell the users the purpose or type of Certificate being issued. It is possible to have many different certificates in one course.

===Introduction===
This text will be displayed to users when they open the Certificate activity. An introduction should be descriptive and tell the user the purpose or requirements of the certificate.

==Issue Options==

===Email Teachers===

If the Email Teachers option is set to Yes then all users with a Teacher/Trainer role within the course will receive an autogenerated email whenever a student receives a Certificate.

===Email Others===
If there are users within a course that do not have Teacher/Trainer access rights but should be notified when a user receives a Certificate you can enter thier email address in this field. When entering multiple addresses, they should be separated with a comma.

===Delivery===

The Delivery option allows you to choose how students view/receive their Certificate. There are three options:

;Open in Browser
:Opens the Certificate in a new browser window.

;Force Download
:Opens the browser file download window. (Note: Internet Explorer does not currently support the open option from the download window. The save option must be chosen first.)

;Email Certificate
:Choosing this option sends the Certificate to the student as an email attachment (PDF).

===Save Certificates===

By selecting "yes", the Save Certificates option will keep a copy of each student's Certificate in the course files moddata folder. A link to each student's saved Certificate will also be displayed in the teacher View Issued Certificates report. By selecting "no", a new certificate will be created every time a student views it and no copy will be saved.

==Text Options==

===Print Date===
There are three options. Do not print, print the date the Certificate was issued to the user, or print the course end date.

===Date Format===
The options for a date format are: "January 1, 2000", "January 1st, 2000", "1 January 2000", "January 2000" and "User's language Date Format".

===Print Code===

A unique 10-digit code of random letters and numbers can be printed on the Certificate that is specific to a user and the certificate. This number can then be verified by comparing it to the code number displayed in the teacher View Issued Certificates report.

===Print Grade===

You can choose to print either the total course grade, or the grade of a selected course activity of a user on the Certificate. The grade items are listed in the dropdown menu in the order in which they appear in the Gradebook.

Please note: Once a user has received their Certificate, their grade on the Certificate will not change even if their course grade changes.

===Grade Format===

There are three available formats if you choose to print a grade on the Certificate:

;Percentage Grade
:Prints the grade as a percentage.

;Points Grade
:Prints the point value of the grade.

;Letter Grade
:Prints the percentage grade as a letter.

===Print Outcome===

You can choose any course Outcome name and result on the Certificate. For example 'Assignment Outcome: Proficient'

===Print Credit Hours===

Where a Credit system is in place within a course, the total Credit Hours a user has received may be included on the issued Certificate.

===Print Teacher Name(s)===

If you wish to include the course Teacher name on the Certificate, select Yes under Print Teacher Name(s) and ensure the required staff have been assigned Teacher/Trainer roles at the Certificate Module level.

===Custom Text===
Additional text may be added to the Certificate via the Custom Text field. By default, this text is placed in the lower left of the Certificate.
You can use the text box to enter html, insert links and insert an image,

The following html tags are available:

:<nowiki> < br > and < p ></nowiki>
:<nowiki> < b >, < i > and < u ></nowiki>
:<nowiki> < img > (src and width (or height) are mandatory)</nowiki>
:<nowiki>< a > (href is mandatory)</nowiki>
:<nowiki> < font > possible attributes are - colour: hex colour code and face: arial, times, courier, helvetica, symbol
</nowiki>

==Design Options==
All of the design options can be customized. This includes changing positions of the images or text, adding or changing images.

===Certificate Type===
The certificate type determines what and where things (if selected) will be printed. Certificate comes with 2 paper size types with 2 font options
*A4 embedded (fonts)
*A4 non-embedded
*Letter embedded
*Letter non-embedded

If you created any custom types, they will appear on this pulldown menu.

===Orientation===
Select either landscape or portrait. The code for each of these page orientations are located in each of the certificate types.

===Border Image===
Select the border image that you want around the Certificate edges or select No border. By default there are two different border images each in 4 different colors.

===Border Lines===
Instead of, or in addition to a Border Image you can select for a simple three line Border Line around the edge of the Certificate. By default there the line colours are "no" (none), black, blue, brown and green.

===Watermark Image===
A Watermark file can be placed in the background of a Certificate. A Watermark could be a specific logo, seal, crest etc. By default two Watermark Images are included, a sample school crest and a Fleur de lis .

===Signature Image===
This option allows you to print a digital signature or print a line for a written signature, on the Certificate.

===Seal or Logo Image===
This option allows you to select a seal or logo to print on the Certificate from a repository of options. By default four seal images and an example logo image are available.

==Common Module Settings==
These may vary according to advanced options and site settings.

===Group mode===
A Certificate activity can have the following three Group options:
*No groups - The issue of the Certificate will not groups based
*Separate groups - Each group can only see their own Certificate activity but others are invisible
*Visible groups - Each group can see their own Certificate as well as see the Certificate activity of other groups.

===Groupings===
If you have groupings of groups.

===Visible===
If you choose Show, then students in the course will be able to see this Certificate activity and attempt to generate a Certificate. If you choose Hide, then only users with teacher or administrative permissions in the course or Certificate activity will be able to see it.

===ID number===
Reference number.

==Restrict access==
This feature has to be enabled on the site level under ''Site administration > advanced settings > Enable conditional access''. See [[Conditional activities]] for more information.
===Allow access dates===
*Allow access from
*Allow access until

===Grade condition===
Select the unit or the Course total option.
Choose the minimum required percentage and the max (leave blank if it 100%) grade

:You can set the "lock" on several activities. However best practice is to daisy chain the activities by their conditions. Thus if you had a series of 10 grade conditional activities, each one would be dependent upon the one immediately preceding it. In this example, certificate would set the condition on the 10th activity.

==Activity completion ==
This feature has to be enabled on the site level under "advanced settings". Please see [[Activity completion]] for more information about the features below.
*Completion tracking
*Require view
*Expect completed

==Examples of certificates==
Both these examples are in blue. Other border colors are black, brown and green.
[[Image:Certificate 1.gif|thumb|left|Standard certificate]] [[Image:Certificate199 example.png|thumb|right|Customized certificate]]

==See also==
[[Certificate module]]

[[Category:Certificate]]

[[es:Añadir/editar certificado]]

Add/edit certificate module

2015-11-25T16:05:57Z

Rcollman: /* Date Format */ List options

{{Certificate}}
To create a new Certificate select Certificate from the Activities list when viewing a course, with editing turn on. You can customise your Certificate using the following settings:

== General Settings ==
''Settings > Certificate administration > Edit settings''

===Certificate Name===
The Certificate Name will appear on the course home page and will typically tell the users the purpose or type of Certificate being issued. It is possible to have many different certificates in one course.

===Introduction===
This text will be displayed to users when they open the Certificate activity. An introduction should be descriptive and tell the user the purpose or requirements of the certificate.

==Issue Options==

===Email Teachers===

If the Email Teachers option is set to Yes then all users with a Teacher/Trainer role within the course will receive an autogenerated email whenever a student receives a Certificate.

===Email Others===
If there are users within a course that do not have Teacher/Trainer access rights but should be notified when a user receives a Certificate you can enter thier email address in this field. When entering multiple addresses, they should be separated with a comma.

===Delivery===

The Delivery option allows you to choose how students view/receive their Certificate. There are three options:

;Open in Browser
:Opens the Certificate in a new browser window.

;Force Download
:Opens the browser file download window. (Note: Internet Explorer does not currently support the open option from the download window. The save option must be chosen first.)

;Email Certificate
:Choosing this option sends the Certificate to the student as an email attachment (PDF).

===Save Certificates===

By selecting "yes", the Save Certificates option will keep a copy of each student's Certificate in the course files moddata folder. A link to each student's saved Certificate will also be displayed in the teacher View Issued Certificates report. By selecting "no", a new certificate will be created every time a student views it and no copy will be saved.

==Text Options==

===Print Date===
There are three options. Do not print, print the date the Certificate was issued to the user, or print the course end date.

===Date Format===
The options for a date format are: "January 1, 2000", "January 1st, 2000", "1 January 2000", "January 2000" and "User's language Date Format".

===Print Code===

A user unique 10-digit code of random letters and numbers can be printed on the Certificate. This number can then be verified by comparing it to the code number displayed in the teacher View Issued Certificates report.

===Print Grade===

You can choose to print either the total course grade, or the grade of a selected course activity of a user on the Certificate. The grade items are listed in the dropdown menu in the order in which they appear in the Gradebook.

Please note: Once a user has received their Certificate, their grade on the Certificate will not change even if their course grade changes.

===Grade Format===

There are three available formats if you choose to print a grade on the Certificate:

;Percentage Grade
:Prints the grade as a percentage.

;Points Grade
:Prints the point value of the grade.

;Letter Grade
:Prints the percentage grade as a letter.

===Print Outcome===

You can choose any course Outcome name and result on the Certificate. For example 'Assignment Outcome: Proficient'

===Print Credit Hours===

Where a Credit system is in place within a course, the total Credit Hours a user has received may be included on the issued Certificate.

===Print Teacher Name(s)===

If you wish to include the course Teacher name on the Certificate, select Yes under Print Teacher Name(s) and ensure the required staff have been assigned Teacher/Trainer roles at the Certificate Module level.

===Custom Text===
Additional text may be added to the Certificate via the Custom Text field. By default, this text is placed in the lower left of the Certificate.
You can use the text box to enter html, insert links and insert an image,

The following html tags are available:

:<nowiki> < br > and < p ></nowiki>
:<nowiki> < b >, < i > and < u ></nowiki>
:<nowiki> < img > (src and width (or height) are mandatory)</nowiki>
:<nowiki>< a > (href is mandatory)</nowiki>
:<nowiki> < font > possible attributes are - colour: hex colour code and face: arial, times, courier, helvetica, symbol
</nowiki>

==Design Options==
All of the design options can be customized. This includes changing positions of the images or text, adding or changing images.

===Certificate Type===
The certificate type determines what and where things (if selected) will be printed. Certificate comes with 2 paper size types with 2 font options
*A4 embedded (fonts)
*A4 non-embedded
*Letter embedded
*Letter non-embedded

If you created any custom types, they will appear on this pulldown menu.

===Orientation===
Select either landscape or portrait. The code for each of these page orientations are located in each of the certificate types.

===Border Image===
Select the border image that you want around the Certificate edges or select No border. By default there are two different border images each in 4 different colors.

===Border Lines===
Instead of, or in addition to a Border Image you can select for a simple three line Border Line around the edge of the Certificate. By default there the line colours are "no" (none), black, blue, brown and green.

===Watermark Image===
A Watermark file can be placed in the background of a Certificate. A Watermark could be a specific logo, seal, crest etc. By default two Watermark Images are included, a sample school crest and a Fleur de lis .

===Signature Image===
This option allows you to print a digital signature or print a line for a written signature, on the Certificate.

===Seal or Logo Image===
This option allows you to select a seal or logo to print on the Certificate from a repository of options. By default four seal images and an example logo image are available.

==Common Module Settings==
These may vary according to advanced options and site settings.

===Group mode===
A Certificate activity can have the following three Group options:
*No groups - The issue of the Certificate will not groups based
*Separate groups - Each group can only see their own Certificate activity but others are invisible
*Visible groups - Each group can see their own Certificate as well as see the Certificate activity of other groups.

===Groupings===
If you have groupings of groups.

===Visible===
If you choose Show, then students in the course will be able to see this Certificate activity and attempt to generate a Certificate. If you choose Hide, then only users with teacher or administrative permissions in the course or Certificate activity will be able to see it.

===ID number===
Reference number.

==Restrict access==
This feature has to be enabled on the site level under ''Site administration > advanced settings > Enable conditional access''. See [[Conditional activities]] for more information.
===Allow access dates===
*Allow access from
*Allow access until

===Grade condition===
Select the unit or the Course total option.
Choose the minimum required percentage and the max (leave blank if it 100%) grade

:You can set the "lock" on several activities. However best practice is to daisy chain the activities by their conditions. Thus if you had a series of 10 grade conditional activities, each one would be dependent upon the one immediately preceding it. In this example, certificate would set the condition on the 10th activity.

==Activity completion ==
This feature has to be enabled on the site level under "advanced settings". Please see [[Activity completion]] for more information about the features below.
*Completion tracking
*Require view
*Expect completed

==Examples of certificates==
Both these examples are in blue. Other border colors are black, brown and green.
[[Image:Certificate 1.gif|thumb|left|Standard certificate]] [[Image:Certificate199 example.png|thumb|right|Customized certificate]]

==See also==
[[Certificate module]]

[[Category:Certificate]]

[[es:Añadir/editar certificado]]

Add/edit certificate module

2015-11-25T16:02:18Z

Rcollman: delete to references to See Bug Notes this page

{{Certificate}}
To create a new Certificate select Certificate from the Activities list when viewing a course, with editing turn on. You can customise your Certificate using the following settings:

== General Settings ==
''Settings > Certificate administration > Edit settings''

===Certificate Name===
The Certificate Name will appear on the course home page and will typically tell the users the purpose or type of Certificate being issued. It is possible to have many different certificates in one course.

===Introduction===
This text will be displayed to users when they open the Certificate activity. An introduction should be descriptive and tell the user the purpose or requirements of the certificate.

==Issue Options==

===Email Teachers===

If the Email Teachers option is set to Yes then all users with a Teacher/Trainer role within the course will receive an autogenerated email whenever a student receives a Certificate.

===Email Others===
If there are users within a course that do not have Teacher/Trainer access rights but should be notified when a user receives a Certificate you can enter thier email address in this field. When entering multiple addresses, they should be separated with a comma.

===Delivery===

The Delivery option allows you to choose how students view/receive their Certificate. There are three options:

;Open in Browser
:Opens the Certificate in a new browser window.

;Force Download
:Opens the browser file download window. (Note: Internet Explorer does not currently support the open option from the download window. The save option must be chosen first.)

;Email Certificate
:Choosing this option sends the Certificate to the student as an email attachment (PDF).

===Save Certificates===

By selecting "yes", the Save Certificates option will keep a copy of each student's Certificate in the course files moddata folder. A link to each student's saved Certificate will also be displayed in the teacher View Issued Certificates report. By selecting "no", a new certificate will be created every time a student views it and no copy will be saved.

==Text Options==

===Print Date===
There are three options. Do not print, print the date the Certificate was issued to the user, or print the course end date.

===Date Format===

If the Print Date is set to Date Received or the Course End Date, the format of the date can be configured.

===Print Code===

A user unique 10-digit code of random letters and numbers can be printed on the Certificate. This number can then be verified by comparing it to the code number displayed in the teacher View Issued Certificates report.

===Print Grade===

You can choose to print either the total course grade, or the grade of a selected course activity of a user on the Certificate. The grade items are listed in the dropdown menu in the order in which they appear in the Gradebook.

Please note: Once a user has received their Certificate, their grade on the Certificate will not change even if their course grade changes.

===Grade Format===

There are three available formats if you choose to print a grade on the Certificate:

;Percentage Grade
:Prints the grade as a percentage.

;Points Grade
:Prints the point value of the grade.

;Letter Grade
:Prints the percentage grade as a letter.

===Print Outcome===

You can choose any course Outcome name and result on the Certificate. For example 'Assignment Outcome: Proficient'

===Print Credit Hours===

Where a Credit system is in place within a course, the total Credit Hours a user has received may be included on the issued Certificate.

===Print Teacher Name(s)===

If you wish to include the course Teacher name on the Certificate, select Yes under Print Teacher Name(s) and ensure the required staff have been assigned Teacher/Trainer roles at the Certificate Module level.

===Custom Text===
Additional text may be added to the Certificate via the Custom Text field. By default, this text is placed in the lower left of the Certificate.
You can use the text box to enter html, insert links and insert an image,

The following html tags are available:

:<nowiki> < br > and < p ></nowiki>
:<nowiki> < b >, < i > and < u ></nowiki>
:<nowiki> < img > (src and width (or height) are mandatory)</nowiki>
:<nowiki>< a > (href is mandatory)</nowiki>
:<nowiki> < font > possible attributes are - colour: hex colour code and face: arial, times, courier, helvetica, symbol
</nowiki>

==Design Options==
All of the design options can be customized. This includes changing positions of the images or text, adding or changing images.

===Certificate Type===
The certificate type determines what and where things (if selected) will be printed. Certificate comes with 2 paper size types with 2 font options
*A4 embedded (fonts)
*A4 non-embedded
*Letter embedded
*Letter non-embedded

If you created any custom types, they will appear on this pulldown menu.

===Orientation===
Select either landscape or portrait. The code for each of these page orientations are located in each of the certificate types.

===Border Image===
Select the border image that you want around the Certificate edges or select No border. By default there are two different border images each in 4 different colors.

===Border Lines===
Instead of, or in addition to a Border Image you can select for a simple three line Border Line around the edge of the Certificate. By default there the line colours are "no" (none), black, blue, brown and green.

===Watermark Image===
A Watermark file can be placed in the background of a Certificate. A Watermark could be a specific logo, seal, crest etc. By default two Watermark Images are included, a sample school crest and a Fleur de lis .

===Signature Image===
This option allows you to print a digital signature or print a line for a written signature, on the Certificate.

===Seal or Logo Image===
This option allows you to select a seal or logo to print on the Certificate from a repository of options. By default four seal images and an example logo image are available.

==Common Module Settings==
These may vary according to advanced options and site settings.

===Group mode===
A Certificate activity can have the following three Group options:
*No groups - The issue of the Certificate will not groups based
*Separate groups - Each group can only see their own Certificate activity but others are invisible
*Visible groups - Each group can see their own Certificate as well as see the Certificate activity of other groups.

===Groupings===
If you have groupings of groups.

===Visible===
If you choose Show, then students in the course will be able to see this Certificate activity and attempt to generate a Certificate. If you choose Hide, then only users with teacher or administrative permissions in the course or Certificate activity will be able to see it.

===ID number===
Reference number.

==Restrict access==
This feature has to be enabled on the site level under ''Site administration > advanced settings > Enable conditional access''. See [[Conditional activities]] for more information.
===Allow access dates===
*Allow access from
*Allow access until

===Grade condition===
Select the unit or the Course total option.
Choose the minimum required percentage and the max (leave blank if it 100%) grade

:You can set the "lock" on several activities. However best practice is to daisy chain the activities by their conditions. Thus if you had a series of 10 grade conditional activities, each one would be dependent upon the one immediately preceding it. In this example, certificate would set the condition on the 10th activity.

==Activity completion ==
This feature has to be enabled on the site level under "advanced settings". Please see [[Activity completion]] for more information about the features below.
*Completion tracking
*Require view
*Expect completed

==Examples of certificates==
Both these examples are in blue. Other border colors are black, brown and green.
[[Image:Certificate 1.gif|thumb|left|Standard certificate]] [[Image:Certificate199 example.png|thumb|right|Customized certificate]]

==See also==
[[Certificate module]]

[[Category:Certificate]]

[[es:Añadir/editar certificado]]