From: Mike Taylor Date: Thu, 22 Aug 2013 16:01:30 +0000 (+0100) Subject: Rolling X-Git-Tag: 0.9.1~226 X-Git-Url: http://git.indexdata.com/?a=commitdiff_plain;h=bd56ce4e56c941950d9158847cc9d1acc92deef5;p=mkws-moved-to-github.git Rolling --- diff --git a/tools/htdocs/whitepaper.markdown b/tools/htdocs/whitepaper.markdown index 6998d08..5f0724c 100644 --- a/tools/htdocs/whitepaper.markdown +++ b/tools/htdocs/whitepaper.markdown @@ -55,19 +55,85 @@ The following is a complete MKWS-based searching application: -
-
-
-
+Go ahead, try it! You don't even need a web-server. Just copy and +paste this HTML into a file on your computer -- `/tmp/magic.html`, +say -- and point your web-browser at it: +`file:///tmp/magic.html`. Just like that, you have working +metasearching. + + +Explanation +----------- + +If you know any HTML, the structure of the file will be familar to +you: the `` element at the top level contains a `` and a +``. In addition to whatever else you might want to put on your +page, you can add MKWS elements. + +These fall into two categories. First, the prerequisites in the HTML +header, which are loaded from the tool site mkws.indexdata.com: + +* `mkws-complete.js` + contains all the JavaScript needed by the widget-set. + +* `mkwsStyle.css` + provides the default CSS styling + +Second, the `
` elements with special IDs that begin `mkws` can be +provided. These are filled in by the MKWS code, and provide the +components of the searching UI. The very simple application above has +only two such components: a search box and a results area. But more +are supported. The main `
`s are: + +* `mkwsSearch` -- provides the search box and button. + +* `mkwsResults` -- provides the results area, including a list of + brief records (which open out into full versions when clicked), + paging for large results sets, facets for refining a search, sorting + facilities, etc. + +* `mkwsLang` -- provides links to switch between one of several + different UI languages. By default, English, Danish and German are + provided. + +* `mkwsSwitch` -- + +* `mkwsTargets` -- +* `mkwsStat` -- + +### different HTML structure + More sophisticated applications will not simply place the `
`s together, but position them carefully within an existing page framework -- such as a Drupal template, an OPAC or a SharePoint page. +Breaking up mkwsResults + +### configuration object + +resposive resize + +### overriding styles + +### use jQuery popup + +### Authentication setups + +Configuring targets + +### Reference + +Configuration object + +jQuery plugin invocation + +The structure of the HTML generated by the MKWS widgets + - - - Copyright (C) 2013 by IndexData ApS,