Note: You are currently viewing documentation for Moodle 3.7. Up-to-date documentation for the latest stable version of Moodle may be available here: RememberMe.

RememberMe: Difference between revisions

From MoodleDocs
RememberMe
Type Block
Set N/A
Downloads N/A
Issues N/A
Discussion N/A
Maintainer(s) Pro Plug
No edit summary
No edit summary
Line 16: Line 16:
== Installation ==
== Installation ==


The plugin directory must be moved into ''.../moodle/blocks/''. There are several ways to achieve this.


You can install directly from the Moodle plugins directory. To do this, log into your Moodle as admin, go to ''Site administration > Plugins > Install plugins''
and click the button 'Install plugins from Moodle plugins directory'. Search for the plugin and click the install button.
You can also use the ''Install plugins'' page to upload and install the plugin after you have downloaded it from the Moodle plugins directory.
Simply drag and drop the ZIP file containing the RememberMe directory into the given field, or use the 'Choose a file...' button.
Alternatively, you can do it manually. Download the ZIP from the Moodle plugins directory, unzip it and move or copy the uncompressed folder into ''.../moodle/blocks/''.
Then, log into your Moodle as admin and go to ''Settings > Site administration > Notifications''.
You should get a notification about a new plugin beeing installed.
For more in-depth step-by-step instructions about installing block plugins, see [https://docs.moodle.org/37/en/Installing_plugins]


== Usage ==
== Usage ==

Revision as of 16:33, 20 June 2016

Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.


Overview

RememberMe is a block type plugin for Moodle v2.0 made by students of the Berlin School of Economics and Law. It periodically checks if a user has not logged in for a specified amount of time and if so, it sends a reminder email to this user. Both the time without log-in required to trigger the reminder, as well as the content of the email can be customised.

Installation

The plugin directory must be moved into .../moodle/blocks/. There are several ways to achieve this.

You can install directly from the Moodle plugins directory. To do this, log into your Moodle as admin, go to Site administration > Plugins > Install plugins and click the button 'Install plugins from Moodle plugins directory'. Search for the plugin and click the install button.

You can also use the Install plugins page to upload and install the plugin after you have downloaded it from the Moodle plugins directory. Simply drag and drop the ZIP file containing the RememberMe directory into the given field, or use the 'Choose a file...' button.

Alternatively, you can do it manually. Download the ZIP from the Moodle plugins directory, unzip it and move or copy the uncompressed folder into .../moodle/blocks/. Then, log into your Moodle as admin and go to Settings > Site administration > Notifications. You should get a notification about a new plugin beeing installed.

For more in-depth step-by-step instructions about installing block plugins, see [1]

Usage

List of important parameters:
'$xml' → Shows the path to the data „settings.xml“
'text'→ contains the reminder text for the Email
'login' → contains the count of days for the variable 'days'
'$days' → exports the count of days, which is necessary to trigger the function
'lastaccess' → contains the Unix- Timestamp of the user's previous activities
'$seconds' → calculates, after what time span the function is triggered
'$date' → exports the present time in Unix-Timestamp-Format
'time' → present Unix- time in seconds

The settings file ("settings.xml") allows for customisation of the amount of days that should pass before a message is sent and the contents of the message.
To do the first, you simply need to change the value for <login>.
The text in the message can be changed by editing the presets <text1> and <text2>.

Technical Details