Heatmap block - Revision history

Mudrd8mz: Text replacement - "(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}"

2017-10-26T12:22:23Z

Text replacement - "<mediaplayer>(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}"

← Older revision		Revision as of 12:22, 26 October 2017
Line 58:		Line 58:
	===Videos===		===Videos===

	~~<mediaplayer>~~https://www.youtube.com/watch?v=jqZP0T0rR4U~~</mediaplayer>~~		{{MediaPlayer \| url = https://www.youtube.com/watch?v=jqZP0T0rR4U}}

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

Deraadt: /* Capabilities (Controlling who sees parts of the block) */

2016-03-18T04:50:30Z

Capabilities (Controlling who sees parts of the block)

← Older revision		Revision as of 04:50, 18 March 2016
Line 33:		Line 33:

	The block uses a number of capabilities that are added when the block is installed.		The block uses a number of capabilities that are added when the block is installed.
	[[Image:Heatmap_capabilities.png\|thumb\|~~Global settings~~]]		[[Image:Heatmap_capabilities.png\|thumb\|Capabilities]]
	* ''Add a new Heatmap block'' (block/heatmap:addinstance)<br>Controls whether the Heatmap block can be added to a course page. By default, this is allowed for the following archetypal roles.		* ''Add a new Heatmap block'' (block/heatmap:addinstance)<br>Controls whether the Heatmap block can be added to a course page. By default, this is allowed for the following archetypal roles.
	** Teacher (editingteacher)		** Teacher (editingteacher)

Deraadt: Removing capability for the Dashboard as it was removed from the block

2016-03-18T04:45:00Z

Removing capability for the Dashboard as it was removed from the block

← Older revision		Revision as of 04:45, 18 March 2016
Line 34:		Line 34:
	The block uses a number of capabilities that are added when the block is installed.		The block uses a number of capabilities that are added when the block is installed.
	[[Image:Heatmap_capabilities.png\|thumb\|Global settings]]		[[Image:Heatmap_capabilities.png\|thumb\|Global settings]]
	* ''Add a Heatmap block to the Dashboard'' (block/heatmap:myaddinstance)<br>Leave this off for all users. The block won't work on the Dashboard.
	* ''Add a new Heatmap block'' (block/heatmap:addinstance)<br>Controls whether the Heatmap block can be added to a course page. By default, this is allowed for the following archetypal roles.		* ''Add a new Heatmap block'' (block/heatmap:addinstance)<br>Controls whether the Heatmap block can be added to a course page. By default, this is allowed for the following archetypal roles.
	** Teacher (editingteacher)		** Teacher (editingteacher)

Germanvaleroelizondo: Added link to spanish translation of page

2016-03-16T16:06:16Z

Added link to spanish translation of page

← Older revision		Revision as of 16:06, 16 March 2016
Line 63:		Line 63:
	[[Category:Contributed code]]		[[Category:Contributed code]]
	[[Category:Block]]		[[Category:Block]]

			[[es:Bloque Heatmap]]

Deraadt: Created page with "{{Infobox plugin |type = Block |entry = https://moodle.org/plugins/view.php?plugin=block_heatmap |tracker = https://tracker.moodle.org/browse/CONTRIB/component/15738 |discussi..."

2016-03-08T02:12:04Z

Created page with "{{Infobox plugin |type = Block |entry = https://moodle.org/plugins/view.php?plugin=block_heatmap |tracker = https://tracker.moodle.org/browse/CONTRIB/component/15738 |discussi..."

New page

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_heatmap
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/15738
|discussion = https://moodle.org/mod/forum/discuss.php?d=329136
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Heatmap_in_course.png|thumb|right|A heatmap applied to a course]]
* The Heatmap block overlays a heatmap onto a course to highlight activities with more or less activity.
* Counts of visits and unique users to each activity is also shown.
* The Heatmap can be toggled off when it is not needed.

== Installation ==

The Heatmap block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).

== Global settings ==

The Heatmap block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Heatmap.
[[Image:Heatmap_global_settings.png|thumb|Global settings]]
* ''Cache lifespan'' A cache is used to retain results and reduce impact on the log table. The lifespan of the cache can be controlled. A longer-lived cache means the burden of querying the log table is reduced. A shorter-lived cache will show more recent results.
* ''Check for activity'' You can limit the timespan that is covered by the log entries queried by the block can be controlled. You can choose to search back to the start of the course (default) or to the beginning of the log. This option can be changed if courses are re-run and teachers want to see beyond the start of the current instance. Searching further back in the log may cause additional load.
* ''What to show on course page'' Two things can be added to course pages: a background colour for activities with visits and icons showing the count of visits and count of unique users. You can select to show both (default) or one or the other.

'''Note: Changes to cache-related settings may not appear immediately in the user interface unless you also purge caches after saving these settings.'''

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.
[[Image:Heatmap_capabilities.png|thumb|Global settings]]
* ''Add a Heatmap block to the Dashboard'' (block/heatmap:myaddinstance) Leave this off for all users. The block won't work on the Dashboard.
* ''Add a new Heatmap block'' (block/heatmap:addinstance) Controls whether the Heatmap block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** (and Admins)
* ''View the Heatmap'' (block/heatmap:view) Controls who can see the Heatmap block and subsequently the overlay of the heatmap on the course. This is something that will usually be relevant to Teachers, so it is hidden from students.
** Teacher (editingteacher)
** Manager (manager)
** (and Admins)

== Setting up a Heatmap in a course ==

Once the Heatmap block is installed, you can use it in a course as follows.
# Turn editing on
# Add the Heatmap block to your page ([[Blocks|How to add a block]])
# Toggle the Heatmap off and on as needed

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_heatmap Entry in Plugins repository]
* [https://tracker.moodle.org/browse/CONTRIB/component/15738 Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_heatmap Git repository]

===Videos===

<mediaplayer>https://www.youtube.com/watch?v=jqZP0T0rR4U</mediaplayer>

[[Category:Contributed code]]
[[Category:Block]]