Date: Fri, 17 Apr 2015 07:22:06 -0300
Subject: [PATCH 3/3] Using a more generic approach to handle plugin
parameters.
---
README.md | 6 +++++-
index.html | 12 ++++++++++--
js/etherpad.js | 9 +++++++--
3 files changed, 22 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 37572bc..548133a 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,10 @@ The Etherpad jQuery Plugin easily allows you to embed and access a pad from Ethe
`$('#examplePadBasic').pad({'padId':'test','showChat':true});`
+### Sets the pad id, some plugin parameters and puts the pad in the div
+`$('#examplePadPlugins').pad({'padId':'test','plugins':{'pageview':'true'}});`
+
+
### Gets the padContents from Example #2 and writes it to the target div "exampleGetContents"
`$('#examplePadBasic').pad({'getContents':'exampleGetContents'});`
@@ -29,11 +33,11 @@ The Etherpad jQuery Plugin easily allows you to embed and access a pad from Ethe
'userColor' : false, // The background color of this authors text in hex format IE #000
'hideQRCode' : false, // Hide QR code
'alwaysShowChat' : false, // Always show the chat on the UI
-'pageview' : false, // Display page view when opening the pad (requires ep_page_view plugin)
'width' : 100, // The width of the embedded IFrame
'height' : 100, // The height of the embedded IFrame
'border' : 0, // The width of the border (make sure to append px to a numerical value)
'borderStyle' : 'solid', // The CSS style of the border [none, dotted, dashed, solid, double, groove, ridge, inset, outset]
+'plugins' : {}, // The options related to the plugins, not to the basic Etherpad configuration
'rtl' : false // Show text from right to left
diff --git a/index.html b/index.html
index b13b80d..5dde6c2 100644
--- a/index.html
+++ b/index.html
@@ -19,10 +19,14 @@ Example #1: Sets the pad id and puts the pad in the div
Example #2: Sets the pad id, some more parameters and puts the pad in the div
- $('#examplePadIntense').pad({'padId':'test','showChat':'true'});
+ $('#examplePadIntense').pad({'padId':'test2','showChat':'true'});
- Example #3: Gets the padContents from Example #2
+ Example #3: Sets the pad id, some plugin parameters and puts the pad in the div
+ $('#examplePadPlugins').pad({'padId':'test3','plugins':{'pageview':'true'}});
+
+
+ Example #4: Gets the padContents from Example #2
$('#examplePadIntense').pad({'getContents':'exampleGetContents'});
@@ -43,6 +47,7 @@ Available options and parameters
'height' : 100, // The height of the embedded IFrame
'border' : 0, // The width of the border (make sure to append px to a numerical value)
'borderStyle' : 'solid' // The CSS style of the border [none, dotted, dashed, solid, double, groove, ridge, inset, outset]
+ 'plugins' : {}, // The options related to the plugins, not to the basic Etherpad configuration
'rtl' : false // Show right to left text
@@ -52,6 +57,9 @@ Available options and parameters
// A slightly more intense example
$('#examplePadIntense').pad({'padId':'test2','showChat':'true'}); // sets the pad id and puts the pad in the div
+
+ // An example with plugin parameters
+ $('#examplePadPlugins').pad({'padId':'test3','plugins':{'pageview':'true'}}); // sets the pad id, some plugin parameters, and puts the pad in the div
If you are confused, view the source code for examples
diff --git a/js/etherpad.js b/js/etherpad.js
index c1862e9..73d066b 100644
--- a/js/etherpad.js
+++ b/js/etherpad.js
@@ -14,13 +14,13 @@
'userColor' : false,
'hideQRCode' : false,
'alwaysShowChat' : false,
- 'pageview' : false,
'width' : 100,
'height' : 100,
'border' : 0,
'borderStyle' : 'solid',
'toggleTextOn' : 'Disable Rich-text',
'toggleTextOff' : 'Enable Rich-text',
+ 'plugins' : {},
'rtl' : false
};
@@ -37,6 +37,11 @@
$.extend( settings, options );
}
+ var pluginParams = '';
+ for(var option in settings.plugins) {
+ pluginParams += '&' + option + '=' + settings.plugins[option]
+ }
+
var iFrameLink = '