From: Wolfram Schneider <wosch@indexdata.dk>
Date: Wed, 10 Jul 2013 15:26:59 +0000 (+0000)
Subject: document jQuery plugin
X-Git-Tag: 0.9.1~276
X-Git-Url: http://sru.miketaylor.org.uk/?a=commitdiff_plain;h=d272101c1ff6e10e0d027e296727fcb905079bbf;p=mkws-moved-to-github.git

document jQuery plugin
---

diff --git a/tools/htdocs/README b/tools/htdocs/README
index 0c4d98d..56afebc 100644
--- a/tools/htdocs/README
+++ b/tools/htdocs/README
@@ -94,6 +94,26 @@ Here is an example of all possible options
 
 Note: the mkws_config object which must be loaded before the mkws.js and pz2api.js files.
 
+
+jQuery plugin
+------------------
+
+The jQuery plugin version, consisting of a single line of JavaScript code
+
+  <script>jQuery.pazpar2();</script>
+
+put the code in your page at the position where the metasearch should occours.
+
+Here is an example of all possible options
+
+  jQuery.pazpar2({"layout": "popup", 	/* "table", "div", "popup", default is table */
+		  "id_button": "input#mkwsButton", /* submit button id in search field */
+		  "id_popup": "#mkwsPopup",        /* interal id of popup window */
+		  "width": 880,		/* popup width, should be at least  800 */ 
+		  "height": 760 	/* popup height, should be at least 600 */
+  });
+
+
 Supported Browsers
 ------------------