mirror of
https://github.com/moodle/moodle.git
synced 2025-02-24 12:03:12 +01:00
81 lines
2.3 KiB
Plaintext
81 lines
2.3 KiB
Plaintext
editorObject README
|
|
===================
|
|
|
|
Quick specs
|
|
===========
|
|
|
|
Quick specs for new editor intergration class.
|
|
This new intergration method lets user to choose which editor to use if
|
|
user chooses to use WYSIWYG editor (HTMLArea or TinyMCE).
|
|
|
|
There are legacy code for backward compatibilty in case that modules are not
|
|
upgraded for both editors. In such case only HTMLArea is available.
|
|
Structure implemented with factory design pattern:
|
|
|
|
* /lib
|
|
o editorlib.php
|
|
* /lib/editor
|
|
o htmlarea
|
|
+ htmlarea.class.php
|
|
o tinymce
|
|
+ tinymce.class.php
|
|
|
|
Usage:
|
|
|
|
Editor scripts must be loaded before print_header() function call and
|
|
only required variable is course id. To load editor you can use wrapper
|
|
function located in moodlelib.php called loadeditor().
|
|
|
|
if ( $usehtmleditor = can_use_html_editor() ) {
|
|
$editor = loadeditor($course->id);
|
|
}
|
|
|
|
This will push needed scripts to global $CFG->editorsrc array which will be
|
|
printed out in /lib/javascript.php.
|
|
And at the bottom of the page before print_footer() function,
|
|
we'll startup the editor almost as usual:
|
|
|
|
if ( $usehtmleditor ) {
|
|
$editor->use_html_editor();
|
|
}
|
|
|
|
After $editor->use_html_editor() -method is called $CFG->editorsrc array is cleared,
|
|
so these scripts are loaded only when necessary.
|
|
|
|
Special usage
|
|
=============
|
|
|
|
In some rare cases programmer needs to force certain settings. If you don't want to
|
|
take care of both editor's settings you can force your module to use one editor only.
|
|
In that case you'll have to pass an associative array as an argument
|
|
for loadeditor function:
|
|
|
|
|
|
$args = array('courseid' => $course->id, 'name' => 'tinymce');
|
|
$editor = loadeditor($args);
|
|
|
|
Then you can define settings for the editor that you wish to use. For setting up new
|
|
settings use setconfig() method:
|
|
|
|
Tiny example1:
|
|
|
|
$editor->setconfig('mode','exact');
|
|
$editor->setconfig('elements','mytextarea');
|
|
$editor->setconfig('plugins','advhr,table,flash');
|
|
|
|
// Merge config to defaults and startup the editor.
|
|
$editor->starteditor('merge');
|
|
|
|
Tiny example2:
|
|
|
|
$args['mode'] = 'exact';
|
|
$args['elements'] = 'mytextarea';
|
|
|
|
$args['plugins'] = 'advhr,table,flash';
|
|
|
|
// merge config to defaults and startup the editor.
|
|
$editor->starteditor('merge');
|
|
|
|
To be continue...
|
|
|
|
$Id$ |