Note: You are currently viewing documentation for Moodle 2.5. Up-to-date documentation for the latest stable version of Moodle may be available here: Cloze editor module.

Cloze editor module: Difference between revisions

From MoodleDocs
m (tidy up spelling)
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Infobox plugin
{{Infobox plugin
|type = Activity module, Cloze editor  
|type = Other, Activity module, Cloze editor  
|entry = http://code.google.com/p/moodle-cloze-editor21/downloads/list
|entry = http://code.google.com/p/moodle-cloze-editor21/downloads/list
|tracker = https://moodle.org/plugins/view.php?plugin=other_cloze
|tracker = https://moodle.org/plugins/view.php?plugin=other_cloze
|discussion = https://moodle.org/plugins/view.php?plugin=other_cloze
|discussion = https://moodle.org/mod/forum/discuss.php?d=181570
|maintainer = [[User:Andreas Glombitza|Andreas Glombitza]]
|maintainer = [[User:Andreas Glombitza|Andreas Glombitza]]
|float = right
|float = right
}}
}}
An interface that integrates with Moodles existing HTML editor (HTMLArea in 1.9 and TinyMCE in 2.x) to support teachers in creating CLOZE (Embedded answers) questions in the GIFT syntax.
An interface that integrates with Moodle's existing HTML editor (HTMLArea in 1.9 and [[TinyMCE]] in 2.x) to support teachers in creating [[Cloze]] (Embedded answers) questions in the [[GIFT]] syntax.


==Download==
==Download==
You can download specific versions for Moodle 1.9, 2.0, 2.1 and 2.4 (also works with 2.5) from [http://code.google.com/p/moodle-cloze-editor21/downloads/list Google code].
You can download specific versions for Moodle 1.9, 2.0, 2.1 and for 2.4 up to 2.7 from [http://code.google.com/p/moodle-cloze-editor21/downloads/list Google code].


==Overview==
==Overview==


The integration (PHP/javascript) is essentially a new button in the HTML editor which brings up an interface that helps create CLOZE questions in the correct syntay. Works in all languages - uses Moodle's existing language strings mostly, except for four strings:
The integration (PHP/javascript) is essentially a new button in the HTML editor which brings up an interface that helps create CLOZE questions in the correct syntax. It will also read and edit existing CLOZE items (which you have selected with your cursor).


    for the 1.9 version, English/German/French/Spanish are included
Here's a demonstrator (which can also be used to create your own CLOZE quizzes):
    for the Moodle 2.x version, translations are currently not included, so that these four strings will be displayed in English


==For Moodle 1.9==
http://goo.gl/zxRQmN
==Installation instructions==
===Installation for Moodle 1.9 version===


Here's a demonstrator (of the 1.9 version):
# Unzip
# copy to your '''moodleroot''' directory, keeping the directory structure


http://www.pellic.com/mod/resource/view.php?id=2507
The following files in your origina Moodle installation will be overwritten with mod'd files (so make sure to BACK THEM UP before):


   
  lib/weblib.php *
lib/editor/htmlarea/htmlarea.php
lib/editor/htmlarea/dialog.js


INSTALLATION for Moodle 1.9 version
* Overwriting the '''weblib.php''' file is OPTIONAL:


1. Unzip
* If you choose to include this modified '''weblib.php''' file, the CLOZE-editor button will only show for teachers, and only in question-interfaces. In any other editor instances, and for students, it will be hidden. This is very convenient :)
2. copy to your moodleroot directory, keeping the directory structure


The following files in your installation will be overwritten with mod'd files from the Moodle 1.912 standard package (so make sure to BACK THEM UP):
* If you refrain from overwriting the '''weblib.php''' file, the cloze editor plugin will still work, but the editor button will be visible in EVERY editor instance for teachers, but not for students. This might be disconcertirg for some teachers :(


lib/weblib.php *
===Installation for Moodle 2.0 and 2.1===
lib/editor/htmlarea/htmlarea.php
lib/editor/htmlarea/dialog.js


* Overwriting weblib.php is OPTIONAL:
# Unzip.
# Copy the contents of the directory to the directory '''lib/editor/tinymce''' on your Moodle installation, keeping the directory structure.
# Visit ' Administration > Site Administration > Notifications '
# Finish the installation process by clicking on the 'Upgrade Moodle database now' button.


If you choose to include this modified weblib.php, the CLOZE-editor button will only show for teachers, and only in question-interfaces. In any other editor instances, and for students, it will be hidden.
The following files in your installation will be OVERWRITTEN with mod'd files (so make sure to BACK THEM UP):


If you refrain from overwriting weblib.php, it will still work, but the editor button will be visible in EVERY editor instance for teachers, but not for students.
lib/editor/tinymce/lib.php
lib/editor/tinymce/land/en/editor_tinymce.php


===Installation for Moodle 2.4 and higher versions===
==For Moodle 2.x==
# Unzip
Installation for Moodle 2.x version
# Copy the contents of the directory to the directory '''lib/editor/tinymce/plugins''' on your Moodle installation, keeping the directory structure.
# Visit ' Administration > Site Administration > Notifications '
# Finish the installation process by clicking on the 'Upgrade Moodle database now' button.


1. Unzip
===Installation for Moodle 2.5 and higher versions===
2. copy to the contents of the directory to the directory lib/editor/tinymce on your Moodle installation, keeping the directory structure.
As of Moodle version 2.5, the plugin can be deployed from within Moodle, by uploading the cloze editor ZIP file (see https://docs.moodle.org/25/en/Installing_add-ons#Installing_via_uploaded_ZIP_file).
# Download the cloze editor ZIP-package
# In your Moodle "Site Administration" menu, go to "Plugins/Install add-ons"
# Select "Editor TinyMCE / tinymce (tinymce)" as "Plugin type"
# Upload and select the cloze editor ZIP-package for Moodle 2.4+ (which you previously downloaded)
# Follow Moodle's instructions to finish the installation process


The following files in your installation will be OVERWIRTTEN with mod'd files (so make sure to BACK THEM UP):
==Using the cloze editor==
 
* We will be asking the students to choose the correct word used in a poem by Emily Dickinson:
lib/editor/tinymce/lib.php
lib/editor/tinymce/land/en/editor_tinymce.php
 
==Using the cloze editor button==
* The cloze editor button is a small yellow question mark in the HTML editor.
* The cloze editor button is a small yellow question mark in the HTML editor.
* Write a small text in the HTML editor
[[File:Cloze editor symbol.png]]
[[File:CLOZE screen 1b.png]]
* Write a small text (e.g, the poem) in the HTML editor
* Select a word to be replaced by a CLOZE
[[File:to make a prairie_1.png|400px]]
* Click on the small yellow question mark
* Select a word to be replaced by a CLOZE (in this case, '''bee''')
* Choose the type of CLOZE sub-question format
[[File:to make a prairie_2.png|400px]]
[[File:CLOZE screen 6.png]]
* Click on the small yellow question mark [[File:Cloze editor symbol small.png]]
* Fill in the correct answer
* Choose the type of CLOZE sub-question format that you want (in this case, a drop-down menu in-line in the text)
[[File:CLOZE screen 2.png]]
[[File:to make a prairie_3.png|400px]]
* The correct answer has been placed automatically.
* Check it and write some feedback if you want
[[File:to make a prairie_3.png|400px]]
* Fill in the wrong answers (if any)
* Fill in the wrong answers (if any)
[[File:CLOZE screen 3.png]]
[[File:to make a prairie_4.png|400px]]
* Click on the 'Insert' button
* Click on the 'Insert' button to process
[[File:CLOZE screen 4.png]]
[[File:to make a prairie_5.png|400px]]
* The correct CLOZE syntax will be shown
* The correct CLOZE syntax will be shown within the editor window
[[File:CLOZE screen 5.png]]
[[File:to make a prairie_6.png|400px]]
* Save the question
* Save the question
* Check that the question works as intended
* Check that the question works as intended
[[File:to make a prairie_7.png|400px]]
===Editing existing CLOZE items===
* Select an existing CLOZE item with your cursor (including the curly outer brackets). Then click on the small yellow question mark. The editor will come up, with the fields correctly populated for this item.


==The cloze editor button and Moodle roles==
==The cloze editor button and Moodle roles==


The CLOZE-editor button will only show for teachers. For students, it will be hidden.
* The CLOZE-editor button will only show for teachers.
Once installed, all teachers will see the cloze editor button every time they use the HTML editor, even when they are writing anything else not related to a cloze question (e.g: a forum post).
* For students, it will be hidden.
* Once installed, all teachers will see the cloze editor button every time they use the HTML editor, even when they are writing something else not related to a cloze question (e.g: a forum post).


==Other languages==
==Other languages==


If you make a language customization, you can have the cloze editor in your preferred language.
* If you make a [[Language customization]], you can have the cloze editor in your preferred language.
There is a mexican spanish translation of the English language strings of this add-on.
* The following image shows a mexican spanish translation of the English language strings of this add-on.
[[File:tinymce_clozeeditor.pdf]]
[[File:cloze editor language customization.png|600px]]
 
* And here are the translated strings being used inside the plugin:
[[File:Cloze editor in spanish.png]]
[[File:Cloze editor in spanish.png|400px]]


==See also==
==See also==

Latest revision as of 11:03, 27 February 2014

Cloze editor module
Type Other, Activity module, Cloze editor
Downloads http://code.google.com/p/moodle-cloze-editor21/downloads/list
Issues https://moodle.org/plugins/view.php?plugin=other_cloze
Discussion https://moodle.org/mod/forum/discuss.php?d=181570
Maintainer(s) Andreas Glombitza

An interface that integrates with Moodle's existing HTML editor (HTMLArea in 1.9 and TinyMCE in 2.x) to support teachers in creating Cloze (Embedded answers) questions in the GIFT syntax.

Download

You can download specific versions for Moodle 1.9, 2.0, 2.1 and for 2.4 up to 2.7 from Google code.

Overview

The integration (PHP/javascript) is essentially a new button in the HTML editor which brings up an interface that helps create CLOZE questions in the correct syntax. It will also read and edit existing CLOZE items (which you have selected with your cursor).

Here's a demonstrator (which can also be used to create your own CLOZE quizzes):

http://goo.gl/zxRQmN

Installation instructions

Installation for Moodle 1.9 version

  1. Unzip
  2. copy to your moodleroot directory, keeping the directory structure

The following files in your origina Moodle installation will be overwritten with mod'd files (so make sure to BACK THEM UP before):

lib/weblib.php *
lib/editor/htmlarea/htmlarea.php
lib/editor/htmlarea/dialog.js
* Overwriting the weblib.php file is OPTIONAL:
  • If you choose to include this modified weblib.php file, the CLOZE-editor button will only show for teachers, and only in question-interfaces. In any other editor instances, and for students, it will be hidden. This is very convenient :)
  • If you refrain from overwriting the weblib.php file, the cloze editor plugin will still work, but the editor button will be visible in EVERY editor instance for teachers, but not for students. This might be disconcertirg for some teachers :(

Installation for Moodle 2.0 and 2.1

  1. Unzip.
  2. Copy the contents of the directory to the directory lib/editor/tinymce on your Moodle installation, keeping the directory structure.
  3. Visit ' Administration > Site Administration > Notifications '
  4. Finish the installation process by clicking on the 'Upgrade Moodle database now' button.

The following files in your installation will be OVERWRITTEN with mod'd files (so make sure to BACK THEM UP):

lib/editor/tinymce/lib.php
lib/editor/tinymce/land/en/editor_tinymce.php

Installation for Moodle 2.4 and higher versions

  1. Unzip
  2. Copy the contents of the directory to the directory lib/editor/tinymce/plugins on your Moodle installation, keeping the directory structure.
  3. Visit ' Administration > Site Administration > Notifications '
  4. Finish the installation process by clicking on the 'Upgrade Moodle database now' button.

Installation for Moodle 2.5 and higher versions

As of Moodle version 2.5, the plugin can be deployed from within Moodle, by uploading the cloze editor ZIP file (see https://docs.moodle.org/25/en/Installing_add-ons#Installing_via_uploaded_ZIP_file).

  1. Download the cloze editor ZIP-package
  2. In your Moodle "Site Administration" menu, go to "Plugins/Install add-ons"
  3. Select "Editor TinyMCE / tinymce (tinymce)" as "Plugin type"
  4. Upload and select the cloze editor ZIP-package for Moodle 2.4+ (which you previously downloaded)
  5. Follow Moodle's instructions to finish the installation process

Using the cloze editor

  • We will be asking the students to choose the correct word used in a poem by Emily Dickinson:
  • The cloze editor button is a small yellow question mark in the HTML editor.

Cloze editor symbol.png

  • Write a small text (e.g, the poem) in the HTML editor

to make a prairie 1.png

  • Select a word to be replaced by a CLOZE (in this case, bee)

to make a prairie 2.png

  • Click on the small yellow question mark Cloze editor symbol small.png
  • Choose the type of CLOZE sub-question format that you want (in this case, a drop-down menu in-line in the text)

to make a prairie 3.png

  • The correct answer has been placed automatically.
  • Check it and write some feedback if you want

to make a prairie 3.png

  • Fill in the wrong answers (if any)

to make a prairie 4.png

  • Click on the 'Insert' button to process

to make a prairie 5.png

  • The correct CLOZE syntax will be shown within the editor window

to make a prairie 6.png

  • Save the question
  • Check that the question works as intended

to make a prairie 7.png

Editing existing CLOZE items

  • Select an existing CLOZE item with your cursor (including the curly outer brackets). Then click on the small yellow question mark. The editor will come up, with the fields correctly populated for this item.

The cloze editor button and Moodle roles

  • The CLOZE-editor button will only show for teachers.
  • For students, it will be hidden.
  • Once installed, all teachers will see the cloze editor button every time they use the HTML editor, even when they are writing something else not related to a cloze question (e.g: a forum post).

Other languages

  • If you make a Language customization, you can have the cloze editor in your preferred language.
  • The following image shows a mexican spanish translation of the English language strings of this add-on.

cloze editor language customization.png

  • And here are the translated strings being used inside the plugin:

Cloze editor in spanish.png

See also