X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2FREADME.markdown;h=49d415ddb77d088673371e41e3989ce5b0715587;hb=42ca1c4a0ca09e45e4cc56e91f1cf69584839d94;hp=3710885afad1d4c79c05aae4cf337a75807ceb37;hpb=049fa40f6cc7f7cf5f6b1617098c803b2f4c5bdc;p=mkws-moved-to-github.git diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown index 3710885..49d415d 100644 --- a/tools/htdocs/README.markdown +++ b/tools/htdocs/README.markdown @@ -25,8 +25,24 @@ The following files are hosted on `mkws.indexdata.com`: * `mkws.css` -Configuring a client --------------------- +Supported Browsers +------------------ + +Any modern browser will work fine. JavaScript must be enabled. + +* IE8 or later +* Firefox 17 or later +* Google Chrome 27 or later +* Safari 6 or later +* Opera 12 or later +* iOS 6.x (iPhone, iPad) +* Android 4.x + +Not supported: IE6, IE7 + + +Configuring a client (short version) +------------------------------------ The application's HTML must contains the following elements as well as whatever makes up the application itself: @@ -61,7 +77,7 @@ possible options: show_perpage: true, /* true, false: show/hide perpage menu */ lang_options: ["en", "de", "da"], /* display languages links for given languages, [] for all */ - facets: ["sources", "subjects", "authors"], + facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */ sort_default: "relevance", /* "relevance", "title:1", "date:0", "date:1" */ query_width: 50, /* 5..50 */ @@ -77,79 +93,10 @@ possible options: ~~~ -jQuery plugin ------------------- - -The jQuery plugin version can be used by a single line of JavaScript code: - -~~~ - -~~~ - -put the code in your page at the position where the metasearch should occur. - -Here is an example of all possible options - -~~~ - jQuery.pazpar2({ - "layout": "popup", /* "table" [default], "div", "popup" */ - "id_button": "input#mkwsButton", /* submit button id in search field */ - "id_popup": "#mkwsPopup", /* internal id of popup window */ - "width": 880, /* popup width, should be at least 800 */ - "height": 760 /* popup height, should be at least 600 */ - }); -~~~ - - -Supported Browsers ------------------- - -Any modern HTML5 browser will work fine. JavaScript must be enabled. - -* IE8 or later -* Firefox 17 or later -* Google Chrome 27 or later -* Safari 6 or later -* Opera 12 or later -* iOS 6.x (iPhone, iPad) -* Android 4.x - -Not supported: IE6, IE7 - - -New Features since jsdemo --------------------------- - -- Supports basic pazpar2 and service-proxy requests -- Simplified HTML -- The search page is fully configurable by a JSON object - - -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? - - - -What next? ----------- - -Main areas of work: +For much more detail, see +[the MKWS whitepaper](whitepaper.html). -* Make MKWS robust to missing widgets -* Clean up the code - - - -Copyright 2013 IndexData ApS. +Copyright 2013 IndexData ApS.