X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2FREADME.markdown;h=a4f43c46fb2f38c3f955abbc553a1247876531ef;hb=9baee7482d7bb195764a7014564d6e324fca566d;hp=a05948b2f7442e21f333d30a6474b6f3e3e3f047;hpb=93790660d03d6a675bf0f8d9a862ea9afe2de1b8;p=mkws-moved-to-github.git diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown index a05948b..a4f43c4 100644 --- a/tools/htdocs/README.markdown +++ b/tools/htdocs/README.markdown @@ -1,121 +1,34 @@ -% An embryonic MasterKey Widget Set +% The MasterKey Widget Set % Mike Taylor; Wolfram Schneider % 10 July 2013 -This directory contains an embryonic MasterKey Widget Set. The initial -version was based on the "jsdemo" application distributed with -pazpar2, but it is now far removed from those beginnnings. +Introduction +------------ +This is the MasterKey Widget Set. The initial version was based on the +"jsdemo" application distributed with pazpar2, but it is now far +removed from those beginnnings. -How this works --------------- - -The goal is to make it that as much of the searching functionality as -possible is hosted on +As much of the searching functionality as possible is hosted on so that very simple websites such as can have MasterKey searching with minimal effort. -The following files are hosted on mkws.indexdata.com: +The following files are hosted on `mkws.indexdata.com`: * `mkws.js` -* `mkwsStyle.css` -* `/libjs-pz2/pz2api.1.js` - -The following files make up an application: - -* `index.html` -* `favicon.ico` [_optional_] -* `robots.txt` [_optional_] - - -Configuring a client --------------------- - -The application's HTML must contains the following elements as well as -whatever makes up the application itself: - -Prerequisites: - - - - - -(Yes, we're using JQuery. We use it only in the most trivial ways, and -could probably get rid of it without too much pain. I'd like to have -mkws.js automatically pull in pz2api.1.js, too, so you don't need to -do so many things, but that's not quite trivial.) - -Then the following special
s can be added (with no content), and -will be filled in by MKWS: -
-- switch between record and target views -
-- switch between English, Danish and German -
-- search box and button -
-- result list, including pager/sorting -
-- target list, including status -
-- summary statistics - -At present, MKWS will not work correctly if any of these is -missing. One of the TODOs is to fix it so that it doesn't try to use -whatever is not there, and just uses what is. - - -You can configure and control the client with the JavaScript mkws_config object. - -Here is an example of all possible options - - -Note: the mkws_config object which must be loaded before the mkws.js and pz2api.js files. - - -jQuery plugin ------------------- - -The jQuery plugin version, consisting of a single line of JavaScript code - - - -put the code in your page at the position where the metasearch should occours. - -Here is an example of all possible options - - jQuery.pazpar2({"layout": "popup", /* "table", "div", "popup", default is table */ - "id_button": "input#mkwsButton", /* submit button id in search field */ - "id_popup": "#mkwsPopup", /* interal id of popup window */ - "width": 880, /* popup width, should be at least 800 */ - "height": 760 /* popup height, should be at least 600 */ - }); +* `/pazpar2/js/pz2.js` +* `mkws-complete.js` -- a single file consisting of `mkws.js`, + jQuery (which it uses), Handlebars (ditto) and `pz2.js` +* `mkws.css` Supported Browsers ------------------ -Any modern HTML5 browser will work fine. JavaScript must be enabled. +Any modern browser will work fine. JavaScript must be enabled. * IE8 or later * Firefox 17 or later @@ -127,20 +40,75 @@ Any modern HTML5 browser will work fine. JavaScript must be enabled. Not supported: IE6, IE7 -New Features since jsdemo --------------------------- -- multilinguality: English (default), Danish, German -- depends on the new pazpar2 JS library libjs-pz2/pz2api.1.js - which will make the development of pazpar2 plugins faster and - easier to share code between projects -- supports basic pazpar2 and service-proxy requests -- simplified HTML -- the search page is fully configurable by a JSON object +Configuring a client +-------------------- -What next? ----------- +The application's HTML must contains the following elements as well as +whatever makes up the application itself: + +Prerequisites: + +~~~ + + +~~~ + +Then the following special `
`s can be added (with no content), and +will be filled in by MKWS: + +* `
` -- switch between record and target views +* `
` -- switch between English, Danish and German +* `
` -- search box and button +* `
` -- result list, including pager/sorting +* `
` -- target list, including status +* `
` -- summary statistics + +You can configure and control the client by creating an `mkws_config` +object _before_ loading the widget-set. Here is an example of all +possible options: -Main areas of work: -* Make MKWS robust to missing widgets -* Clean up the code +~~~ + +~~~ + +Checklist before doing a release +--------------------------------- +- open the site, e.g. http://mkws-dev.indexdata.com/index-mike.html +- open the debug/error console in your browser (alt-cmd-J, shift-cmd-J) +- check the language links ("de", "da", "en") +- run a search with few, but not to few results, e.g.: freebsd +- check "Targets" | "Records" links +- check "Next" and "Prev" links +- click on the first hit and display details, click on an "URL" to jump to + the local catalog or full text +- limit search to a "Source" +- limit search to an "Author" +- sort results by "Title" and "newest" +- what else? + + +- - - + +Copyright 2013 IndexData ApS.