Note: You are currently viewing documentation for Moodle 1.9. Up-to-date documentation for the latest stable version is available here: Cloze editor module.

Cloze editor module: Difference between revisions

From MoodleDocs
m (tidy up)
(tidy up)
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:


==Download==
==Download==
You can download specific versions for Moodle 1.9, 2.0, 2.1 and 2.4 (also works with 2.5, 2.6 and 2.7) 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 syntay. Works in all languages - uses Moodle's existing language strings mostly, except for four strings:


    for the 1.9 version, English/German/French/Spanish are included
* For the 1.9 version, English/German/French/Spanish translations for these strings are included
    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==
==For Moodle 1.9==
Line 17: Line 16:


http://www.pellic.com/mod/resource/view.php?id=2507
http://www.pellic.com/mod/resource/view.php?id=2507
   
   
INSTALLATION for Moodle 1.9 version
===Installation for Moodle 1.9 version===
 
1. Unzip
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):
# Unzip
# copy to your '''moodleroot''' directory, keeping the directory structure


lib/weblib.php *
The following files in your origina Moodle installation will be overwritten with mod'd files (so make sure to BACK THEM UP before):
lib/editor/htmlarea/htmlarea.php
lib/editor/htmlarea/dialog.js


* Overwriting weblib.php is OPTIONAL:
lib/weblib.php *
lib/editor/htmlarea/htmlarea.php
lib/editor/htmlarea/dialog.js


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.
* Overwriting the '''weblib.php''' file is OPTIONAL:


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.
* 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 :(
   
   
==For Moodle 2.4 and higher==
Installation for Moodle 2.x version
* Download the ZIP file from [https://moodle-cloze-editor21.googlecode.com/files/clozeeditor.zip https://moodle-cloze-editor21.googlecode.com/files/clozeeditor.zip] .
* Unzip.
* copy the clozeeditor directory to the directory lib/editor/tinymce/plugins on your Moodle installation, keeping the directory structure.
* Visit the 'Administration > Site Administration > Notifications' page.
* Install the add-on.
* If your Moodle site uses other languages beside English, see 'Other languages' below.


==Using the cloze editor==
==Using the cloze editor==
Line 51: Line 40:
[[File:Cloze editor symbol.png]]
[[File:Cloze editor symbol.png]]
* Write a small text (e.g, the poem) in the HTML editor
* Write a small text (e.g, the poem) in the HTML editor
[[File:to make a prairie_1.png]]
[[File:to make a prairie_1.png|400px]]
* Select a word to be replaced by a CLOZE (in this case, '''bee''')
* Select a word to be replaced by a CLOZE (in this case, '''bee''')
[[File:to make a prairie_2.png]]
[[File:to make a prairie_2.png|400px]]
* Click on the small yellow question mark [[File:Cloze editor symbol small.png]]
* Click on the small yellow question mark [[File: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)
* Choose the type of CLOZE sub-question format that you want (in this case, a drop-down menu in-line in the text)
[[File:to make a prairie_3.png]]
[[File:to make a prairie_3.png|400px]]
* The correct answer has been placed automatically.
* The correct answer has been placed automatically.
* Check it and write some feedback if you want
* Check it and write some feedback if you want
[[File:to make a prairie_3.png]]
[[File:to make a prairie_3.png|400px]]
* Fill in the wrong answers (if any)
* Fill in the wrong answers (if any)
[[File:to make a prairie_4.png]]
[[File:to make a prairie_4.png|400px]]
* Click on the 'Insert' button to process
* Click on the 'Insert' button to process
[[File:to make a prairie_5.png]]
[[File:to make a prairie_5.png|400px]]
* The correct CLOZE syntax will be shown within the editor window
* The correct CLOZE syntax will be shown within the editor window
[[File:to make a prairie_6.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]]
[[File:to make a prairie_7.png|400px]]


==The cloze editor button and Moodle roles==
==The cloze editor button and Moodle roles==
Line 80: Line 69:
* 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.
* The following image shows 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:cloze editor language customization.png]]
[[File:cloze editor language customization.png|600px]]
* And here are the translated strings being used inside the plugin:
* 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==
* [[Embedded Answers (Cloze) question type]]
* [[Embedded Answers (Cloze) question type]]
* [https://moodle.org/plugins/view.php?plugin=other_cloze Cloze editor add-on] in the Moodle plugin database
* [https://moodle.org/plugins/view.php?plugin=other_cloze Cloze editor add-on] in the Moodle plugin database
* [https://docs.moodle.org/dev/TinyMCE_plugins https://docs.moodle.org/dev/TinyMCE_plugins] in the Moodle DEV documentation
* [https://tracker.moodle.org/browse/MDL-39013 https://tracker.moodle.org/browse/MDL-39013] tracker issue asking (vote)  to integrate this useful feature into Moodle core.


[[Category:Questions]]
[[Category:Questions]]

Latest revision as of 16:52, 26 February 2014

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 syntay. Works in all languages - uses Moodle's existing language strings mostly, except for four strings:

  • For the 1.9 version, English/German/French/Spanish translations for these strings are included

For Moodle 1.9

Here's a demonstration of the 1.9 version:

http://www.pellic.com/mod/resource/view.php?id=2507

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 :(


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

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