MoodleDocs - User contributions [en]

User tours

2017-03-20T23:19:06Z

Abarbary: /* How is it set up? */

{{Site appearance}}
{{New features}}

User tours are step-by-step guides to various areas of Moodle. The [[Multi-language_content_filter| multi-lang filter]] allow for tours to display in different languages. Watch the screencast [https://youtu.be/hhLVvyP3DU0 User tours] to see a demonstration.

==How is it set up?==
* As an administrator, access 'User tours' from Site administration, Appearance.
*Here you see any existing user tours and have the option to create a new tour, import a tour or browse user tours on the [https://moodle.net/mod/data/view.php?id=17 Moodle.net User tours repository]. (An administrator and a teacher tour have been added to new and upgraded sites to introduce the [[Boost theme]] and get you started.)
[[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.
'''Note:''' ''You can have multiple tours created for the same page destination, but you should only have one per page enabled at one time.''
*Icons against each tour allow you to view, edit, export or delete it.
*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
#FRONTPAGE to use the tour on your site's home page.
*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.
'''Note:''' ''If you want users to be able to fill in forms as they work through the tour, then don't use a backdrop.''
*Tour filters allow you to choose the role(s) and theme(s) for which the tour will be displayed.

==How do I add steps to a tour ?==
* Either click directly on its name or on its View action icon to view the currently listed steps.
*Here are the initial steps for a sample tour for the Dashboard page:
[[File:usertour steps page.png|thumb|600px|center]]
*Click on the 'New step' link and select what you want to highlight:
#Block - to display next to a matching block on the page. Select the block you want from the dropdown. (''Note you can select blocks which are not available on your chosen area. If they are later added, then the tour will display that step.)''
#CSS Selector - to display next to a matching selector on the page. Type in the relevant selector. (See examples below.)
#Display in the middle of the page
*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'

==How do user tours work?==
[[File:usertours01.png|thumb|600px|center]]
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.

==Help with CSS selectors==
If you wish to use CSS selectors as part of your user tour, your browser's developer tools will be very useful in helping you create these selectors:
*[https://developer.chrome.com/devtools#dom-and-styles Google Chrome]
*[https://developer.mozilla.org/en-US/docs/Tools/DOM_Property_Viewer Mozilla Firefox]
*[https://developer.microsoft.com/en-us/microsoft-edge/platform/documentation/f12-devtools-guide/ Microsoft Edge]
*[https://developer.apple.com/library/content/documentation/AppleApplications/Conceptual/Safari_Developer_Guide/ResourcesandtheDOM/ResourcesandtheDOM.html#//apple_ref/doc/uid/TP40007874-CH3-SW1 Apple Safari]

===Example of a very simple CSS selector===

[[File:CSS_selector_for_user_picture_in_a_user_tour.png|400px]]

The settings above will produce this in the user tour:

[[File:user picture chosen by CSS selector in a user tour.png|400px]]

* How did we know that .userpicture would select just the Moodle user picture?
* By looking at the page with an HTML inspector in Firefox, as described in the 'Help with CSS selectors' section below.

===Other simple CSS selector examples===
'''.breadcrumb''' These site links (known as breadcrumbs) will always show where you are in the site and how to return to a main page, such as your Dashboard or your course main page.

'''.usermenu''' This is the user menu. It contains links to your Dashboard, Messages, Profile, and your Preferences.

'''[value="Customise this page"]''' Add your own blocks of content by clicking here!

==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.

Please remember to go to '' Dashboard ► Site administration ► Plugins ► Filters ► Manage filters '' in order to enable the [[Multi-language_content_filter]] before importing any multi-language user tours into your site, or the users will see ALL the texts in ALL the languages simultaneously, as the following image illustrates:

[[File:Multilang user tour when multilang filter NOT properly configured.png|300px]]

When properly configured, a multi-language user tour will be automatically displayed in the user's preferred language, as seen in the following Dashboard tours starting pages in Spanish, English and French (in the same server):

[[File:Multilang user tour in Spanish.png|300px]]

[[File:Multilang user tour in English.png|300px]]

[[File:Multilang user tour in French.png|300px]]

==Translating user tours==
See [https://docs.moodle.org/dev/Translating_User_tours_from_Moodle.net how to translate user tours] in the developer's documentation..

==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 User tours repository] 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].

==User tour capabilities==

There is just one capability, which is allowed for the default role of manager:

* [[Capabilities/tool/usertours:managetours|Create, edit and remove user tours]]

==See also==

* [http://jsonlint.com/ JSONLint - a JSON validator] useful for checking the workings of a JSON file

[[es:Tours para Usuarios]]
[[fr:Visites guidées]]
[[de:Geführte Touren]]

Completion Progress block

2016-10-04T00:20:21Z

Abarbary: /* Global settings */

{{Infobox plugin
|type = Block, Completion Progress
|entry = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|tracker = https://tracker.moodle.org/issues/?jql=project%20%3D%20CONTRIB%20AND%20component%20%3D%20%22Block%3A%20Completion%20Progress%22
|discussion = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Completion_Progress_bar_in_block_-_with_details.png|A progress bar for a student]]

* The Completion Progress is a time-management tool for students.
* It visually shows what activities/resources a student is supposed to interact with in a course.
* It is colour-coded so students can quickly see what they have and have not completed/viewed.
* The block relies on completion settings of activities/resources in the course and when they should be completed by.
* Ordering can be based on expected completion times or on the ordering of activities in the course.
* There is an Overview page allowing teachers to see the progress of all students in a class, which is helpful for finding students at risk.
* Adding the Completion Progress block to the [[Dashboard]] shows users a combined view of their progress from all courses they are enrolled in (where the block is set up).

[[Image:Completion_Progress_Overview_of_students_with_messaging.png|right|thumb|The overview page]]

== Installation ==

* Download the latest version of the block from [https://moodle.org/plugins/block_completion_progress its entry on the Plugins directory] or using its [https://github.com/deraadt/moodle-block_completion_progress Git repository].
* The Completion Progress block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).
* In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

== Global settings ==

The Completion Progress block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Completion Progress.
[[Image:Completion_Progress_Global_settings.png|thumb|Global settings]]
* ''When wrapping, limit rows to...'' The progress bar shown in the block can be wrapped. This setting allows some control of how long the bar should be before wrapping. The default is 16.
* ''Default presentation for long bars'' The bar can be displayed by squeezing all segments, wrapping segments over multiple lines or allowing the bar to scroll. The default is to Squeeze.
* ''Course name to show on Dashboard'' The block can be added to the dashboard and combines visible Completion Progress block content from the courses a user is enrolled in. By default, the course name shown for each relevant course, is the short course name, but some institutions/organisations may not think this is appropriate in relation to their course naming scheme, so a long course name can be selected.
* ''Colours'' By default, the colours used in the block are red, blue, yellow and green. In certain cultures these colours may not have the same meaning. Also, institutions/organisations may wish to use colours that match their theme.
* ''Show inactive students in Overview'' In most cases, inactive students are not wanted in course lists, such as the Overview page associated with the block. However, in some cases, such as ongoing courses, inactive students might need to be visible on the Overview page.

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

The block uses a number of capabilities that are added when the block is installed.

[[Image:Completion_Progress_Capabilities.png|thumb|Capabilities]]

* ''Add a Completion Progress block to My home'' (block/completion_progress:myaddinstance) Controls whether the Completion Progress block can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users.
* ''Add a new Completion Progress block'' (block/completion_progress:addinstance) Controls whether the Completion Progress block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''View course overview of Completion Progress for all students'' (block/completion_progress:overview) Controls whether the Overview page and the button on the Completion Progress block used to access the Overview page can be viewed by a user. By default, this is allowed for the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''Show the bar in the Completion Progress block'' (block/completion_progress:showbar) Controls whether the bar in the Completion Progress block is shown to a user. The reason for not showing this to certain users is that this might not be relevant and possibly annoying. By default, this is shown to the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Student (student)
** (and Admins)

== Setting up a Completion Progress block in a course ==

In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

Once the block is installed on your site, you can use it in a course as follows.
# Turn editing on
# Create your activities/resources as normal
# Set completion settings for each activity you want to appear in the bar, including an expected by date
# Add the Completion Progress block to your page ([[Blocks|How to add a block]])
# Move your block into a prominent position (click and drag the block title)
# Choose to:
#(Optional) Configure how the block should appear

Hidden items will not appear in the Completion Progress block until they are unhidden. This is useful for a scheduled release of activities.

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_completion_progress Block in Plugins Directory]
* [https://tracker.moodle.org/issues/?jql=project%20%3D%20CONTRIB%20AND%20component%20%3D%20%22Block%3A%20Completion%20Progress%22 Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_completion_progress Git repository]

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

[[es:Bloque de Progreso de Finalización]]

IMS Enterprise

2012-07-17T23:03:41Z

Abarbary:

{{Enrolment}}
Location: IMS Enterprise file edit settings link in ''Site administration > Plugins > Enrolments > Manage enrol plugins''

'''IMS Enterprise''' is an international standard XML file format which may be used to specify enrolments/unenrolments in courses, as well as course information and user information.

==Format overview==

Below is a simple guide to the basic structure of a typical IMS Enterprise data file. Much more information is available on the [http://www.imsglobal.org/enterprise/ IMS Enterprise official website].

You may like to read the [http://cvs.moodle.org/contrib/plugins/enrol/imsenterprise/entv1p1_conformance_summary.html?view=co conformance summary] which describes which IMS data elements this plugin can process.

==Basic guide to IMS Enterprise file format==

For any IMS-style enrolment you need a <group> tag which specifies the course, a <person> tag which specifies the user account, and a <membership> tag containing <member> tags which specify a person's role within a given course.

Remember that the numeric keys used in the Moodle databases are not the interoperable data - a student data system is never going to know in advance that Joe is the 20th user added to the Moodle database - so those aren't the keys exchanged in this type of data.

Typically a course would have a reference code as well as a name, so let's assume its code is MOODLE101. If you require a new course to be placed in a category other than the default, you can specify that using the <orgunit> tag. To define your course you could use

<group>
<sourcedid>
<source>MyDataSystem</source>
<id>MOODLE101</id>
</sourcedid>
<description>
<short>Moodle 101</short>
<long>Moodle 101: Course Name</long>
</description>
<org>
<orgunit>CATEGORY</orgunit>
</org>
</description>
</group>

The enrolment script will look for a course with code MOODLE101, and (optionally) create it if it doesn't exist. Similarly for the person - let's assume it's "jmoodle":

<person>
<sourcedid>
<source>MyDataSystem</source>
<id>jmoodle</id>
</sourcedid>
<userid>jmoodle</userid>
<name>
<fn>Joe Moodle</fn>
<n>
<family>MOODLE</family>
<given>JOE</given>
</n>
</name>
</person>

If Joe doesn't already have an account, the script can (optionally) create an account for him.

Let's now look at the membership, adding the person to the course:

<membership>
<sourcedid>
<source>MyDataSystem</source>
<id>MOODLE101</id>
</sourcedid>
<member>
<sourcedid>
<source>MyDataSystem</source>
<id>jmoodle</id>
</sourcedid>
<role roletype="01">
<status>1</status>
<extension><cohort>unit 2</cohort></extension>
</role>
</member>
</membership>

The IMS Enterprise specification does offer a facility for specifying start/end dates for enrolments, so those can be included using the <timeframe> tag if needed.

If a person is already added to a group within the course, the script won't actually modify that. If they are not grouped, however, then the specified grouping will be applied.

==Automatic creation of new courses==

If required, the IMS Enterprise enrolment plugin can create new courses for any it finds in the IMS data but not in Moodle's database.

Courses are first queried by their "idnumber" - an alphanumeric field in Moodle's course table, which can specify the code used to identify the course in the Student Information System (for example). If that is not found, the course table is searched for the "short description", which in Moodle is the short course identifier as displayed in the breadcrumbs etc. (In some systems these two fields may well be identical.) Only when that search has failed can the plugin optionally create new courses.

Any newly-generated courses are HIDDEN when created. This is to prevent the possibility of students wandering into completely empty courses that the teacher may be unaware of.

==Unenrolling students/teachers==

If required, the Enterprise data can add as well as remove course enrolments - for students and for teachers. If this setting is turned on, then Moodle will carry out unenrolments when specified in the data. Note, as of Moodle 2, you must use IMSEnterprise to remove members that have been added by the plugin. You cannot manually delete a member.

There are three ways of unenrolling students within the IMS data:

* A <member> element which specifies the given student and course, and with the "recstatus" attribute of the <role> element set to 3 (which means "delete"). THIS IS NOT YET IMPLEMENTED IN THE MOODLE PLUGIN.
* A <member> element which specifies the given student and course, and with the <status> element set to 0 (which means "inactive").

The third method is slightly different. It does not require this config setting to be activated, and can be specified well in advance of the unenrolment date:

* A <member> element which specifies a <timeframe> for the enrolment can specify the begin and/or end dates for enrolment of this particular student. These dates are loaded into Moodle's enrolment data table if present, and so after the end-date, a student will no longer be able to access that particular course.

==See also==

* [http://www.imsglobal.org/enterprise/ IMS Enterprise specification] - the official site
* [http://cvs.moodle.org/contrib/plugins/enrol/imsenterprise/entv1p1_conformance_summary.html?view=co Conformance summary] - summarises the parts of the specification which Moodle makes use of
* [https://studydirect.sussex.ac.uk/downloads/imsenterprise.php Minted IMS Enterprise enrolment plugin] - An extension of the ims enterprise enrolment plugin developed in the [http://www.sussex.ac.uk/minted minted project]

[[fr:Fichier IMS Enterprise]]
[[de:Einschreibung über IMS Enterprise Datei]]