copyright: bit media e-solutions GmbH, [email protected]
license: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Use this link to download the installable plugin .zip file: https://github.com/EEXCESS/moodle-atto_eexcesseditor/raw/master/docs/MoodleAttoEditorPlugin.zip

Moodle EEXCESS plugin

Short description

It is a tool that provides you recommendations from cultural and scientific databases in a Moodle environment (http://www.moodle.org) . Technically it consists of two plugins:

• Moodle Server plugin https://purl.org/eexcess/components/moodle-server-plugin
• Moodle Atto Editor plugin https://purl.org/eexcess/components/moodle-atto-editor-plugin

As it mainly makes sense to install both plugins, this documentation contains installation and usage instructions for both.

Installation instruction

Moodle Server plugin

Necessary steps:

1. Download plugin Repository with plugin.
2. Go to Site administration/Plugins/Install plugins. Click the button Chose a file and chose folder with plugin. After, click the button install plugin from the ZIP file.
3. Click the button install plugin.
4. Click the button Upgrade Moodle database now.
5. Click continue.
6. Change the settings if it is necessary and click the button Save changes.
7. Installing EEXCESS plugin finished.

After the installation, add block EEXCESS on page

.

After the click on button show/hide Search-bar

EEXCESS Search-Bar will appear on the bottom.

Moodle Atto Editor plugin

You also need to install the excess atto editor plugin, for inserting citations in atto text editor.

Necessary steps:

1. Download plugin Repository with plugin.
2. Go to Site administration/Plugins/Install plugins. Click the button Chose a file and chose folder with plugin. After, click the button install plugin from the ZIP file.
3. Click the button install plugin.
4. Click the button Upgrade Moodle database now.
5. Click continue.
6. Installing EEXCESS plugin finished.

After installation, buttonfor change and insert citation) will appear in toolbar atto.

Usage instruction

Content consumption

For search: you can select any text on any page in the Moodle site (except inside a text editor). The EEXESS image gets animated while the system is looking for recommendations. As soon as recommendations are found the animation stops and button with results will appear on search bar Clicking the button opens the recommendation display.

Content creation

When you are writing a text (e.g. a forum post) the system gets active as soon as you finish a paragraph (by pressiong Return). The EEXCESS image gets animated while the system is looking for recommendations. As soon as recommendations are found the animation stops and button with results will appear on search bar. Clicking the button with results of the page opens the recommendation display. Now the recommendation display contains 3 elements to enrich your text in the editor:

Search Results

These elements serve to:

• Embed an image

• Embed a citation (according to the selected preferred citation style)

Dashboard

These elements serve to:

• Embed an image

  

• Embed a citation (according to the selected preferred citation style)

  

• Embed a screenshot of the visualization (not available for all visualization types)

  

Facet Scape

These elements serve to:

• Embed an image

• Embed a citation (according to the selected preferred citation style)

Settings

Administrator settings:

Go to Site administration/Plugins/Blocks/EEXCESS has 3 options:

• Change EEXCESS citation.
• Change base url for recommendations.
• Add image license.

User settings:

In EEXCESS block go to Interests to add interests tags.

In EEXCESS block go to Citation to change the citation style.

In EEXCESS block go to Image License to add Image License.