X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fmkws-manual.markdown;h=5c0916d30c119ba2528f52573b29fc7bb6f9c744;hb=313a15df7e666a96019886a7e1ca02c4eaa51387;hp=ef0666e3acf1a135527c11f458fc33fab1c0fb22;hpb=30c1759f3d924bc1b9772ae1de5e36a4edf9c88c;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index ef0666e..5c0916d 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -371,24 +371,21 @@ output locale specific text via the mkws-translate helper like so: Example ------- -Rather than use the included AJAX helpers to render record details inline, -here's a Records template that will link directly to the source via the address -provided in the metadata as the first element of `md-electronic-url`: - - For a more involved example where markup for multiple widgets is decorated with @@ -397,8 +394,8 @@ employed, take a look at the source of [topic.html](http://example.indexdata.com/topic.html?q=water). -Refinements -=========== +Some Refinements +================ Message of the day @@ -407,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 -`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 @@ -422,23 +419,28 @@ in a popup. The key part of such an application is this invocation of the MKWS jQuery plugin: -
-
-
+
-
-
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 --------------------------------------- -By default, MKWS configures itself to use a demonstration account on a -service hosted by mkws.indexdata.com. This account (username `demo`, +MKWS configures itself to use an account on a service hosted by +`sp-mkws.indexdata.com`. By default, it sends no authentication +credentials, allowing the appropriate account to be selected on the +basis of referring URL or IP address. + +TODO REWRITE +This account (username `demo`, password `demo`) provides access to about a dozen free data sources. Authentication onto this service is via an authentication URL on the same MKWS server, so no explicit configuration is needed. @@ -852,7 +854,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_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 @@ -860,6 +863,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 -------------------------------------------------------