aboutsummaryrefslogtreecommitdiff
path: root/mod/embed/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'mod/embed/README.txt')
-rw-r--r--mod/embed/README.txt16
1 files changed, 15 insertions, 1 deletions
diff --git a/mod/embed/README.txt b/mod/embed/README.txt
index f81d5b14a..9cc21d949 100644
--- a/mod/embed/README.txt
+++ b/mod/embed/README.txt
@@ -6,4 +6,18 @@ http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
The embed plugin requires Elgg 1.5 (or prior to the Elgg 1.5
release, Elgg revision 2634 or above) and the file plugin.
-To insert into the active editor, use elggEmbedInsert(html). \ No newline at end of file
+To insert into the active editor, use elggEmbedInsert(html, textAreaName).
+
+The default behavior searches for all textareas with name textAreaName and
+inserts the content into them.
+
+If you need to use special embed code to insert content into a custom textarea
+(like tinyMce, FCK, etc), extend (nb: EXTEND, not override) the embed/custom_insert_js
+view with your custom JS. The vars available to you are:
+ str content The content to insert.
+ str textAreaName The name of the textarea to receive the content.
+
+It is important to correctly extend this view for compatibility across
+multiple plugins and textarea states. Your custom JS should run without
+error no matter plugin order or rich text editor status. See TinyMCE as
+an example of how to losely extend this function. \ No newline at end of file