projects
/
mkws-moved-to-github.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Merge branch 'master' of ssh://git.indexdata.com/home/git/pub/mkws
[mkws-moved-to-github.git]
/
doc
/
mkws-manual.markdown
diff --git
a/doc/mkws-manual.markdown
b/doc/mkws-manual.markdown
index
8d3fa98
..
66a666b
100644
(file)
--- a/
doc/mkws-manual.markdown
+++ b/
doc/mkws-manual.markdown
@@
-394,8
+394,8
@@
employed, take a look at the source of
[topic.html](http://example.indexdata.com/topic.html?q=water).
[topic.html](http://example.indexdata.com/topic.html?q=water).
-Refinements
-===========
+Some Refinements
+================
Message of the day
Message of the day
@@
-404,9
+404,9
@@
Message of the day
Some applications might like to open with content in the area that
will subsequently be filled with result-records -- a message of the
day, a welcome message or a help page. This can be done by placing an
Some applications might like to open with content in the area that
will subsequently be filled with result-records -- a message of the
day, a welcome message or a help page. This can be done by placing an
-`mkws-motd` division anywhere on the page. It will be moved into the
-`mkws-results` area and initially displayed, but will be hidden when a
-search is made.
+`mkws-motd` division anywhere on the page. It will initially be moved
+into the `mkws-results` area and displayed, but will be hidden as soon
+as the first search is made.
Popup results with jQuery UI
Popup results with jQuery UI
@@
-419,16
+419,16
@@
in a popup. The key part of such an application is this invocation of
the MKWS jQuery plugin:
<div class="mkws-search"></div>
the MKWS jQuery plugin:
<div class="mkws-search"></div>
- <div class="mkws-popup" popup_width="1024" popup_height="650" popup_modal="0" popup_autoOpen="0" popup_button="input.mkwsButton">
- <div class="mkws-switch"></div>
- <div class="mkws-lang"></div>
+ <div class="mkws-popup" popup_width="1024" popup_height="650" popup_modal="0" popup_autoOpen="0">
<div class="mkws-results"></div>
<div class="mkws-results"></div>
- <div class="mkws-targets"></div>
- <div class="mkws-stat"></div>
</div>
The necessary scaffolding can be seen in an example application,
</div>
The necessary scaffolding can be seen in an example application,
-http://example.indexdata.com/index-popup.html
+[popup.html](http://example.indexdata.com/popup.html).
+
+The relevant properties (`popup_width`, etc.) are documented
+[below](#jquery-ui-popup-invocation)
+in the reference section.
Authentication and target configuration
Authentication and target configuration
@@
-849,7
+849,8
@@
popup_width string 880 Width of the popup window (if used),
popup_height string 760 Height of the popup window (if used), in
pixels.
popup_height string 760 Height of the popup window (if used), in
pixels.
-popup_button string `input.mkwsButton` (Never change this.)
+popup_button string `input.mkwsButton` A click on this selector will trigger the
+ popup to open
popup_modal string 0 Modal confirmation mode. Valid values are 0 or 1
popup_modal string 0 Modal confirmation mode. Valid values are 0 or 1
@@
-857,6
+858,8
@@
popup_autoOpen string 1 Open popup window on load. Valid val
----
----
+You can have more than one mkws-popup widgets on a page. Please use a different
+popup_button value to address the right ones.
The structure of the HTML generated by the MKWS widgets
-------------------------------------------------------
The structure of the HTML generated by the MKWS widgets
-------------------------------------------------------