projects
/
mkws-moved-to-github.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (from parent 1:
60afd17
)
document that jQuery.pazpar2() plugin is gone
author
Wolfram Schneider
<wosch@indexdata.dk>
Thu, 10 Jul 2014 12:31:34 +0000
(12:31 +0000)
committer
Wolfram Schneider
<wosch@indexdata.dk>
Thu, 10 Jul 2014 12:31:34 +0000
(12:31 +0000)
doc/whitepaper.markdown
patch
|
blob
|
history
diff --git
a/doc/whitepaper.markdown
b/doc/whitepaper.markdown
index
55c56ec
..
484252e
100644
(file)
--- a/
doc/whitepaper.markdown
+++ b/
doc/whitepaper.markdown
@@
-84,7
+84,7
@@
header, which are loaded from the tool site mkws.indexdata.com:
contains all the JavaScript needed by the widget-set.
* `mkws.css`
contains all the JavaScript needed by the widget-set.
* `mkws.css`
- provides the default CSS styling
+ provides the default CSS styling
Second, within the HTML body, `<div>` elements with special IDs that
begin `mkws` can be provided. These are filled in by the MKWS code,
Second, within the HTML body, `<div>` elements with special IDs that
begin `mkws` can be provided. These are filled in by the MKWS code,
@@
-273,9
+273,14
@@
generally visible on the page is a search box, and the results appear
in a popup. The key part of such an application is this invocation of
the MKWS jQuery plugin:
in a popup. The key part of such an application is this invocation of
the MKWS jQuery plugin:
- <script type="text/javascript">
- jQuery.pazpar2({ "layout":"popup", width:800, height:500 });
- </script>
+ <div class="mkwsSearch"></div>
+ <div class="mkwsPopup" popup_width="1024" popup_height="650" popup_modal="0" popup_autoOpen="0" popup_button="input.mkwsButton">
+ <div class="mkwsSwitch"></div>
+ <div class="mkwsLang"></div>
+ <div class="mkwsResults"></div>
+ <div class="mkwsTargets"></div>
+ <div class="mkwsStat"></div>
+ </div>
The necessary scaffolding can be seen in an example application,
http://example.indexdata.com/index-popup.html
The necessary scaffolding can be seen in an example application,
http://example.indexdata.com/index-popup.html
@@
-350,7
+355,7
@@
Element Type Default Description
debug_level int 1 Level of debugging output to emit. 0 = none, 1 = messages, 2 = messages with
datestamps, 3 = messages with datestamps and stack-traces.
debug_level int 1 Level of debugging output to emit. 0 = none, 1 = messages, 2 = messages with
datestamps, 3 = messages with datestamps and stack-traces.
-facets array *Note 1* Ordered list of names of facets to display. Supported facet names are
+facets array *Note 1* Ordered list of names of facets to display. Supported facet names are
`xtargets`, `subject` and `author`.
lang string en Code of the default language to display the UI in. Supported language codes are `en` =
`xtargets`, `subject` and `author`.
lang string en Code of the default language to display the UI in. Supported language codes are `en` =
@@
-480,48
+485,43
@@
and
-### jQuery plugin invocation
+### jQuery UI popup invocation
-The MasterKey Widget Set can be invoked as a jQuery plugin rather than
-by providing an HTML skeleton explicitly. When this approach is used,
-the invocation is a single line of JavaScript:
+The MasterKey Widget Set can be invoked in a popup window on top of the page.
- <script>jQuery.pazpar2();</script>
+Note that when using the `popup` layout, facilities from the jQuery UI
+toolkit are used, so it's necessary to include both CSS and JavaScript
+from that toolkit. The relevant lines are:
-This code should be inserted in the page at the position where the
-metasearch should occur.
+ <script src="http://code.jquery.com/ui/1.10.3/jquery-ui.min.js"></script>
+ <link rel="stylesheet" type="text/css"
+ href="http://code.jquery.com/ui/1.10.3/themes/smoothness/jquery-ui.css" />
-When invoking this plugin, a key-value lookup table of named options
-may be passed in to modify the default behaviour, as in the exaple
-above. The available options are as follows:
+ <div class="mkwsSearch"></div>
+ <div class="mkwsPopup" popup_width="1024" popup_height="650" popup_modal="0" popup_autoOpen="0" popup_button="input.mkwsButton">
+ <div class="mkwsSwitch"></div>
+ <div class="mkwsLang"></div>
+ <div class="mkwsResults"></div>
+ <div class="mkwsTargets"></div>
+ <div class="mkwsStat"></div>
+ </div
---
Element Type Default Description
-------- ----- --------- ------------
---
Element Type Default Description
-------- ----- --------- ------------
-layout string popup Specifies how the user interface should
- appear. Options are `table` (the default,
- with facets at the bottom), `div` (with
- facets at the side) and `popup` (to
- obtain a popup window).
-
-width int 880 Width of the popup window (if used), in
+popup_width string 880 Width of the popup window (if used), in
pixels.
pixels.
-height int 760 Height of the popup window (if used), in
+popup_height string 760 Height of the popup window (if used), in
pixels.
pixels.
-id_button string input#mkwsButton (Never change this.)
+popup_button string input.mkwsButton (Never change this.)
-id_popup string #mkwsPopup (Never change this.)
----
+popup_modal string 0 Modal confirmation mode. Valid values are 0 or 1
-Note that when using the `popup` layout, facilities from the jQuery UI
-toolkit are used, so it's necessary to include both CSS and JavaScript
-from that toolkit. The relevant lines are:
+popup_autoOpen string 1 Open popup window on load. Valid values are 0 or 1
- <script src="http://code.jquery.com/ui/1.10.3/jquery-ui.min.js"></script>
- <link rel="stylesheet" type="text/css"
- href="http://code.jquery.com/ui/1.10.3/themes/smoothness/jquery-ui.css" />
+---
### The structure of the HTML generated by the MKWS widgets
### The structure of the HTML generated by the MKWS widgets