X-Git-Url: http://git.indexdata.com/cgi-bin?a=blobdiff_plain;f=doc%2Fmkws-manual.markdown;h=85d1d51df3ddf7bcc59d36f2af7598705d4d8af9;hb=600063fbaaaf588db44d426045c15ebe28a53812;hp=ef54044e2313aeed74b6a008144934cddf0e28e9;hpb=22c49596b24a5e05c9940e17546b7e2b67eb1fc7;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index ef54044..85d1d51 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -419,48 +419,49 @@ 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, [popup.html](http://example.indexdata.com/popup.html). - -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`, -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. - -In order to search in a customised set of targets, including -subscription resources, it's necessary to create an account with -Index Data's hosted Service Proxy, and protect that account with -authentication tokens (to prevent unauthorised use of subscription -resources). For information on how to do this, see the next section. +The relevant properties (`popup_width`, etc.) are documented +[below](#jquery-ui-popup-invocation) +in the reference section. MKWS target selection ===================== +Introduction +------------ + MKWS accesses targets using the Pazpar2 metasearching engine. Although Pazpar2 can be used directly, using a statically configured set of targets, this usage is unusual. More often, Pazpar2 is fronted by the Service Proxy (SP), which manages authentication, sessions, target -selection, etc. - -This document assumes the SP is used, and explains how to go about -making a set of targets (a "library") available, how to connect your -MKWS application to that library, and how to choose which of the -available targets to use. +selection, etc. This document assumes the SP is used, and explains how +to go about making a set of targets (a "library") available, how to +connect your MKWS application to that library, and how to choose which +of the available targets to use. + +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. + +If no account has been set up to recognise the referring URL of the +application or the IP address of the client, then a default "MKWS +Demo" account is used. This account (which can also be explicitly +chosen by using the username `mkws`, password `mkws`) provides access +to about a dozen free data sources. +In order to search in a customised set of targets, including +subscription resources, it's necessary to create an account with +Index Data's hosted Service Proxy, and protect that account with +authentication tokens (to prevent unauthorised use of subscription +resources). Maintaining the library ----------------------- @@ -849,7 +850,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 @@ -857,6 +859,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 -------------------------------------------------------