Accessibility Toolkit

2021-05-14T19:19:32Z

Ghenrick:

User tours

2016-06-29T14:04:33Z

Ghenrick:

{{Site appearance}}
The User tours plugin allows administrators to create user tours of Moodle, which are visual and positional step by step guides. Tours can be created for a wide range of purposes: to guide new users around the interface, to introduce new features, highlight important information, and more. It is also enabled to cater for multilingual content if required using the multi-lang filters.

==Usage==
Once a user tour has been created and enabled, the first time that any user views a page which matches that user tour’s page (path) settings, the user tour will automatically start to display, starting with the first step. Each tour step will display its title and content, along with three button options:
*Prev - to return to the previous step in the tour
*Next - to go to the next step in the tour
*End Tour - to exit out of the tour completely

Any time a user wishes to re-run the page's tour, they can click on the "Reset user tour on this page" link at the bottom of the page.
[[File:usertour_in_action_screenshot.png|thumb|600px|center]]

==Creating User tours==
#Ensure that the user tours plugin is installed and enabled on your moodle site
#Login to your Moodle site as administrator
# Go to ''Administration > Site administration > Appearance > User tours''.
#You will now see a list of your existing user tours, along with three button options:
##Create a new tour - click on this to create a new tour
##Import tour - click on this to upload a tour file (in .json format)
##Tour repository - click on this to browse the user tours currently listed on our [https://moodle.net/mod/data/view.php?id=17 Moodle.net tour database]
[[File:usertour_listing_page.png|thumb|600px|center]]
#For each of your existing tours, you can click either directly on its name or on its View action icon to view its current listed steps
#Each tour can be individually enabled or disabled as required in its settings page.
#Please note: this plugin does allow you to have multiple tours created for the same page destination, however you should only have one enabled per page at any given time.
#Each tour has the following Actions options:
##View - to view and edit the individual steps in the tour
##Edit - to edit the tour settings, such as its name, page (specified page to which it is applied) and whether it is enabled or not. Tours will be displayed on any page whose URL matches the specified path value, for instance:
###/my/% - to match the Dashboard
###/course/view.php?id=2 - to match a specific course
###/mod/forum/view.php% - to match the forum discussion list
###/user/profile.php% - to match the user profile page
##Export - to export the tour’s full details and steps as a .json file
##Delete - to delete the tour entirely
#Each tour will be configured with default step settings which you can edit in the settings page:
##Placement: Top, Bottom (Default), Left, Right. This determines where the step shows relative to its matching block or CSS selector on the page.
##Show if target not found: No (Default), Yes. This determines whether the step is shown or not when the target has not been found.
##Show with backdrop: No (Default), Yes. If yes, the step appears surrounded by a darkened backdrop to emphasis its content and location.
##Move on click: No (Default), Yes. If yes, the tour continues to the next step when the user clicks within the block or area targeted by the current step.

==Adding steps to your User tour==
#In your User tour's View page, you can add, edit, re-order and delete steps for your tour. Either click directly on its name or on its View action icon to view the currently listed steps.
#For instance, here are the initial steps for a sample tour for the Dashboard page.
[[File:usertour steps page.png|thumb|600px|center]]
#Each individual step has the following Actions options:
##Move Up and/or Down as relevant for re-ordering
##Edit - to edit the step settings
##Delete - to delete the step entirely
#To add a new step:
##Click on the 'New step' link.
##Select the appropriate type, or area, of the page to highlight:
###Block - to display next to a matching block on the page
###CSS Selector - to display next to a matching selector on the page
###Display in the middle of the page
##For blocks, select the relevant block from the dropdown
##For CSS selectors, type in the relevant selector to identify the target
##Add the title and content
##For all types, select whether to display the step with a darkened backdrop
##For blocks or selectors, select the Placement option for where to place the display
##For blocks or selectors, select whether to display the step if its target isn’t found
##For blocks or selectors, select whether to move on click, ie move to next step when target is clicked
##Click on 'Save changes'
##Your new step should now appear at the end of your tour’s current listed steps

==Multi-language capability==

If your Moodle site is already set up or intending to be enabled for multi-lingual usage, tours are completely compatible with this requirement. Using the multi-lang filter formatting, each tour step’s titles and content, displayed to the user, can be edited to cater for multi-lingual requirements. Please see [[Multi-language_content_filter]] for further detailed instructions on how to enable, format and submit multi-lingual strings for your Moodle site.

==Sharing is caring==

We really hope that you are able to create some really powerful tours to help guide your users around your site. We certainly think you will and we encourage you to share any of the tours you create with others.

We've created a [https://moodle.net/mod/data/view.php?id=17 Moodle.net tour database] where you can share your creations and also find inspiration from the ideas of others.

This work was paid for and sponsored by the kind folk of [http://www.dcu.ie/ Dublin City University].

[[es:Tours para Usuarios]]

File:usertour in action screenshot.png

2016-06-22T20:39:42Z

Ghenrick: Ghenrick uploaded a new version of File:usertour in action screenshot.png

Sample of User tour in action displaying step on dashboard

2016-04-08T16:39:02Z

Ghenrick:

Viewing live choice results

2016-04-08T16:36:10Z

Ghenrick:

{{Choice}}

=Moodle choice live results=
Setting up a Moodle web service to view live choice results in real time!.

[[File:choice_res_choice_results.png|600px|thumb|center|Example of choice results view]]

==Initial set up==
You will need to configure the following components for this, as follows:
1) Configurations for your Moodle site
2) A separate PHP script page which calls your Moodle site via Moodle web services
3) A chartjs (or similar online graphing application) installation for displaying the choice results in visual graphs online

==Moodle site configurations==

1) Ensure your site is ready for web services:
This is at Site administration -> Advanced features where you need to enable and save the "Enable web services" setting

[[File:choice_res_enable_ws.png|600px|thumb|center|Enabling web services]]

2) Ensure your site is ready for web services protocols
This is at Site administration -> Plugins -> Web services -> Manage protocols where you need to enable and save either of the protocols you wish to use (for this guide, we will be using the REST protocol)

[[File:choice_res_enable_protocols.png|600px|thumb|center|Enabling REST protocol]]

3) Ensure your site settings are ready for mobile access, thus allowing choice submissions from users via mobile devices
This is at Site administration -> Plugins -> Web services -> Mobile where you need to enable and save "Enable web services for mobile devices"

[[File:choice_res_enable_mobile.png|600px|thumb|center|Enabling mobile access]]

4) Add a new user - call them "Choice View User" or something similar.
See https://docs.moodle.org/en/Managing_accounts for further details on this operation.

5) Add a new role - call it "Choice WS Role" or something similar.
This is at Site administration -> Users -> Permissions -> Define roles.
On the first Adding a new role page, leave "Use role or archetype" set at "No role" and click on Continue
For Context types where this role may be assigned - assign to System

[[File:choice_res_add_role1.png|600px|thumb|center|Add custom role]]

In capabilities - filter for the word service - click on Allow for Web service: REST protocol, or whichever protocol you're using

[[File:choice_res_add_role2.png|600px|thumb|center|Add capability]]

Finally click on "Create this role"
See https://docs.moodle.org/en/Creating_custom_roles for further details on this operation.

6) Assign your new user to the new role.
This is at Site administration -> Users -> Permissions -> Assign system roles.
Click on your new role
Search for your new user (you may need to filter by the user name)
Select your user in the list and click on Add to assign the user to the role

[[File:choice_res_assign_user.png|600px|thumb|center|Assign role]]

When you reload the Assign system roles page, your new user should be listed in the Users with role column for the role.

7) Create the web service to be called for the choice results
This is at Site administration -> Plugins -> Web services -> External services
Add the web service, call it Choice View or something similar, click on Enabled, click on Authorised users only and finally click on Add Service.

[[File:choice_res_add_ws.png|600px|thumb|center|Add web service]]

Next, add two functions to the web service, by searching for the Choice functions (you may need to filter by the word choice):
- mod_choice_get_choice_results
- mod_choice_get_choices_by_courses

[[File:choice_res_add_functions.png|600px|thumb|center|Add functions]]

8) Add your new user to the web service Authorised users list
This is at Site administration -> Plugins -> Web services -> External services
To add authorised users, click on the Authorised users link for your Choice View web service, this is similar to the interface where you assigned your user to the Choice View role.
Search for your new user (you may need to filter by the user name)
Select your user in the list and click on Add to assign the user to the Authorised users list

9) Create a web service token to authenticate the expected HTTP(S) requests
This is at Site administration -> Plugins -> Web services -> Manage tokens
Click on Add
Search for the user you created for the Choice View
In the Service dropdown, select the Choice View service you also just created
Add an IP restriction if needed
Add a time restriction if needed
Click on Save changes and copy the resulting token

[[File:choice_res_add_token.png|600px|thumb|center|Add token]]

10) Enrol your new user, "Choice View User", as a teacher in all courses from where you want to access the choice activities. This is needed so that the web service will be able to access the choice activity details using your user's token.

==PHP script page for displaying results==
This page will access your Moodle site choice activities and display their results with visual graphs.
Copy our sample PHP script code to wherever you want it hosted and called from.
It will need http or https access to your Moodle site where the choice activities are hosted.
It will also need to have some level of security if it’s going to be a publicly accessible URL as the PHP script itself contains details of a REST web service login with access to your Moodle site. We would suggest a htaccess login or similar.
Edit and save the sample PHP script code to add your Moodle site URL and Choice View token values to where the code states "<yourURL>" and "<yourtoken>" respectively.

[[File:choice_res_code.png|600px|thumb|center|Code configuration]]

The script code will also need access to an installation of chartjs, or other graphing application, in order to display the graphs, please see http://www.chartjs.org/ for more details. You will then also need to edit the script code to add the server directory location of your chartjs installation to where the code states "<yourchartjslocation>".

To reveal the results, just type in the URL of your PHP script code into your browser.

The web service will now display all course accessible choice activities in the page dropdown, displaying the one which was first created initially. If you know the choice id from the database already, you can instead add the parameter to the URL as follows: "?choiceid=X".

One final point, the sample PHP script code is set with a simple reload of the page every 5 seconds so that the displayed graph updates with the latest results regularly. This reload could be more elegantly processed if needed, using AJAX for instance.

==Sample Code==

<code php>
<?php

$url="<yourURL>";
$function="mod_choice_get_choice_results";
$function2="mod_choice_get_choices_by_courses";
$token="<yourtoken>";

// Grabs choice details including title
$ch2 = curl_init();
curl_setopt($ch2, CURLOPT_URL, "$url/webservice/rest/server.php?wsfunction=$function2&wstoken=$token&moodlewsrestformat=json");
curl_setopt($ch2, CURLOPT_RETURNTRANSFER, 1);
$result2 = json_decode(curl_exec($ch2));

if (isset($_REQUEST['choiceid'])) {
$choiceid=intval($_REQUEST['choiceid']);
} else if (count($result2->choices) > 0) { // accessible choices found
$choiceid=intval($result2->choices[0]->id);
} else {
$choiceid = 0; // default value
}
if ($choiceid < 1) {
echo("invalid id");
}
$colour="249,128,18"; // Moodle orange, change as required.

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "$url/webservice/rest/server.php?wsfunction=$function&wstoken=$token&choiceid=$choiceid&moodlewsrestformat=json");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = json_decode(curl_exec($ch));

$graph_title = "";
$dropdown = "<select name='choiceid' onchange='this.form.submit()'>\n";
$dropdown .= "<option value='0'>Select</option>\n";

foreach ($result2->choices as $choice) {
$dropdown .= "<option value='{$choice->id}'";
if ($choice->id == $choiceid) {
$graph_title = $choice->name;
$dropdown .= " selected";
}
$dropdown .= ">{$choice->name}</option>\n";
}
$dropdown .= "</select>\n";

// data for bar graph
$chart = new stdClass();
$data = array();
$labels = array();
foreach ($result->options as $a) {
$data[] = $a->numberofuser;
$labels[] = $a->text." (".round($a->percentageamount,1)."%)";
}
$chart->labels = $labels;
$dataset = new stdClass();
$dataset->data = $data;
$dataset->fillColor = "rgba({$colour},0.5)";
$dataset->strokeColor = "rgba({$colour},0.8)";
$dataset->highlightFill = "rgba({$colour},0.75)";
$dataset->highlightStroke = "rgba({$colour},1)";
$chart->datasets = array($dataset);

curl_close($ch);

?>
<!doctype html>
<html>
<head>
<meta http-equiv="refresh" content="5" >
<title>Bar Chart</title>
<script src="<yourchartjslocation>"></script>
</head>
<body>
<center>
<h1><?php echo($graph_title); ?></h1>
<div id="canvas-holder">
<canvas id="chart-area" width="900" height="600"/>
</div>

<form><?php echo($dropdown); ?><noscript><input type="submit" value="Submit"></noscript></form>

<script>
var pieData = <?php echo json_encode($chart); ?>;

window.onload = function(){
var ctx = document.getElementById('chart-area').getContext('2d');
window.myPie = new Chart(ctx).Bar(pieData, {animationSteps : 1, responsive: false});
};
</script>
</center>
</body>
</html>

</code>
[[Category:Quick guide]]

Viewing live choice results

2016-04-08T16:33:35Z

Ghenrick:

File:choice res code.png

2016-04-08T16:32:58Z

Ghenrick:

Viewing live choice results

2016-04-08T16:31:37Z

2016-04-08T16:17:12Z

Ghenrick: How to set up a Moodle web service to view live choice results in real time.

{{Choice}}

=Moodle choice live results=
Setting up a Moodle web service to view live choice results in real time!.

==Initial set up==
You will need to configure the following components for this, as follows:
1) Configurations for your Moodle site
2) A separate PHP script page which calls your Moodle site via Moodle web services
3) A chartjs (or similar online graphing application) installation for displaying the choice results in visual graphs online

==Moodle site configurations==

1) Ensure your site is ready for web services:
This is at Site administration -> Advanced features where you need to enable and save the "Enable web services" setting

Add image

2) Ensure your site is ready for web services protocols
This is at Site administration -> Plugins -> Web services -> Manage protocols where you need to enable and save either of the protocols you wish to use (for this guide, we will be using the REST protocol)

Add image

3) Ensure your site settings are ready for mobile access, thus allowing choice submissions from users via mobile devices
This is at Site administration -> Plugins -> Web services -> Mobile where you need to enable and save "Enable web services for mobile devices"
Add image

4) Add a new user - call them "Choice View User" or something similar.
See https://docs.moodle.org/en/Managing_accounts for further details on this operation.

5) Add a new role - call it "Choice WS Role" or something similar.
This is at Site administration -> Users -> Permissions -> Define roles.
On the first Adding a new role page, leave "Use role or archetype" set at "No role" and click on Continue
For Context types where this role may be assigned - assign to System
Add image

In capabilities - filter for the word service - click on Allow for Web service: REST protocol, or whichever protocol you're using
Add image

Finally click on "Create this role"
See https://docs.moodle.org/en/Creating_custom_roles for further details on this operation.

6) Assign your new user to the new role.
This is at Site administration -> Users -> Permissions -> Assign system roles.
Click on your new role
Search for your new user (you may need to filter by the user name)
Select your user in the list and click on Add to assign the user to the role
Add image

When you reload the Assign system roles page, your new user should be listed in the Users with role column for the role.

7) Create the web service to be called for the choice results
This is at Site administration -> Plugins -> Web services -> External services
Add the web service, call it Choice View or something similar, click on Enabled, click on Authorised users only and finally click on Add Service.
Add image

Next, add two functions to the web service, by searching for the Choice functions (you may need to filter by the word choice):
- mod_choice_get_choice_results
- mod_choice_get_choices_by_courses
Add image

8) Add your new user to the web service Authorised users list
This is at Site administration -> Plugins -> Web services -> External services
To add authorised users, click on the Authorised users link for your Choice View web service, this is similar to the interface where you assigned your user to the Choice View role.
Search for your new user (you may need to filter by the user name)
Select your user in the list and click on Add to assign the user to the Authorised users list

9) Create a web service token to authenticate the expected HTTP(S) requests
This is at Site administration -> Plugins -> Web services -> Manage tokens
Click on Add
Search for the user you created for the Choice View
In the Service dropdown, select the Choice View service you also just created
Add an IP restriction if needed
Add a time restriction if needed
Click on Save changes and copy the resulting token
Add image

10) Enrol your new user, "Choice View User", as a teacher in all courses from where you want to access the choice activities. This is needed so that the web service will be able to access the choice activity details using your user's token.

==PHP script page for displaying results==
This page will access your Moodle site choice activities and display their results with visual graphs.
Copy our sample PHP script code to wherever you want it hosted and called from.
It will need http or https access to your Moodle site where the choice activities are hosted.
It will also need to have some level of security if it’s going to be a publicly accessible URL as the PHP script itself contains details of a REST web service login with access to your Moodle site. We would suggest a htaccess login or similar.
Edit and save the sample PHP script code to add your Moodle site URL and Choice View token values to where the code states "<yourURL>" and "<yourtoken>" respectively.
Add image

The script code will also need access to an installation of chartjs, or other graphing application, in order to display the graphs, please see http://www.chartjs.org/ for more details. You will then also need to edit the script code to add the server directory location of your chartjs installation to where the code states "<yourchartjslocation>".

To reveal the results, just type in the URL of your PHP script code into your browser.

The web service will now display all course accessible choice activities in the page dropdown, displaying the one which was first created initially. If you know the choice id from the database already, you can instead add the parameter to the URL as follows: "?choiceid=X".

One final point, the sample PHP script code is set with a simple reload of the page every 5 seconds so that the displayed graph updates with the latest results regularly. This reload could be more elegantly processed if needed, using AJAX for instance.

*ADD SAMPLE CODE FILE* todo

[[Category:Quick guide]]

Plugin Review Criteria

2013-05-27T06:35:57Z

Ghenrick: Some criteria to consider when looking at a 3rd party Add-ons

{{Help}}
== Some Criteria to consider when looking at 3rd party Add-ons==
There are many great 3rd party plugins available for Moodle. However, it is important to assess the suitability and reliability of the plugin before adopting it.

This list is not exhaustive as there may be more or less questions depending on the individual installation and organisation.

This list was published originally by Gavin Henrick ([http://www.lts.ie/ Learning Technology Services]), see [http://www.somerandomthoughts.com/blog/2012/05/14/some-criteria-to-review-when-considering-a-plugin/ Some criteria to review when considering a plugin]

== Some initial questions==
*What is the purpose of the plugin?
*Is there nothing in the installation which can deliver this feature already?
*Is this the best solution for this requirement?
== Is it easy to install?==
*Is the source managed on svn/github
*Is it available in the Moodle.org plugins database
*Is the zip available to download into the correct folder name or does it need exploring to change
*Is it just a drop in and use notifications or is it more complex / require patches manual intervention
== Is the documentation good?==
*Has it got a Moodle Docs page
*Has it got good readme.txt
*Has it got good help files & instructions
== Is it easy for teacher to use?==
*For the most common use case is it logical in usage?
*Are the instructions for use correct and usable?
== Is it easy for student to use?==
*For the most common use case is it logical in usage?
*Are the instructions for use correct and usable?
== Does it do what it says?==
*Are the instructions for use correct and usable?
*Does it provide the functionality as described in a good sensible way, is it a "full feature" or an interim solution.
== Features==
*Does it have a roadmap of potential improvements /changes?
*Will it work on Mobile theme and on Web?
== Feedback==
*Are there any comments from users on the plugin site?
*Are there any reviews of the module?
*Are there any discussions on it in the forums?
== Author Background (experience/reliability check)==
*Are they active in Moodle community for a good period of time?
*Do they respond well to queries on bugs etc.?
*Do they work for an established Moodle development team (Moodle partner, the OU, or HQ for example)?

== Technical==
*Does it work properly with the different database types?
*Is the mod being updated regularly with new Moodle versions?
*Does the module follow good Moodle coding standards?
*Does it properly use language files or has it got hardcoded text?
*Does it properly follow accessibility guidelines?
*Does it properly follow css and theming approaches?
*Does it conflict with anything else naming wise?
*Does author regularly bug fix?
*Does it impact performance of Moodle in normal or high traffic usage?
*What resources will it require to be used?
*Does backup/restore work?
*Has it got unit tests?

== See Also==
*[http://www.somerandomthoughts.com/blog/2012/05/14/some-criteria-to-review-when-considering-a-plugin/ Some criteria to review when considering a plugin] Gavin Henrick - May 2012
*[http://www.moodleaddons.com/book/ Moodle Addons Book] Gavin Henrick, Michael de Raadt - May 2013

question/type/ddmarker

2012-02-20T10:21:15Z

Ghenrick: /* How To Documentation */

== Description ==

=== About Drag and Drop Marker ===

Drag and drop marker questions allow for multiple markers to be placed onto an image and the positioning of each marker to be assessed.

Drag and drop marker questions differ from Drag and drop onto image questions in that there are no predefined areas on the underlying image that are visible to the student.

This is a question type created and maintained by the Open University.

=== How To Documentation ===

The Open University maintain a set of documentation for the plugin here -> [http://labspace.open.ac.uk/mod/oucontent/view.php?id=470268&section=5.5.1 http://labspace.open.ac.uk/mod/oucontent/view.php?id=470268&section=5.5.1]