From: Wolfram Schneider Date: Wed, 18 Dec 2013 14:15:07 +0000 (+0000) Subject: Merge branch 'master' of ssh://git.indexdata.com:222/home/git/private/mkws X-Git-Tag: 0.9.1~34 X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=commitdiff_plain;h=1fd20fb02019b453808dc4abf2773bd3940b705c;hp=f5cd3564e369d5df7493b768047419c1ecf07da5 Merge branch 'master' of ssh://git.indexdata.com:222/home/git/private/mkws --- diff --git a/examples/htdocs/minimal.html b/examples/htdocs/minimal.html new file mode 100644 index 0000000..318a0cb --- /dev/null +++ b/examples/htdocs/minimal.html @@ -0,0 +1,3 @@ + +
+
diff --git a/notes/pre-release-checklist b/notes/pre-release-checklist new file mode 100644 index 0000000..500318d --- /dev/null +++ b/notes/pre-release-checklist @@ -0,0 +1,14 @@ +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? diff --git a/tools/htdocs/.gitignore b/tools/htdocs/.gitignore index 6ea129e..9ef368c 100644 --- a/tools/htdocs/.gitignore +++ b/tools/htdocs/.gitignore @@ -1,4 +1,6 @@ handlebars-v1.1.2.js +jquery-1.10.0.min.js +jquery.json-2.4.js mkws-complete.js README.html README.odt diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown index 548cec8..95f03f0 100644 --- a/tools/htdocs/README.markdown +++ b/tools/htdocs/README.markdown @@ -1,4 +1,4 @@ -% An embryonic MasterKey Widget Set +% The MasterKey Widget Set % Mike Taylor; Wolfram Schneider % 10 July 2013 @@ -6,13 +6,9 @@ Introduction ------------ -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. - - -How this works --------------- +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. As much of the searching functionality as possible is hosted on @@ -22,15 +18,31 @@ can have MasterKey searching with minimal effort. The following files are hosted on `mkws.indexdata.com`: -* `mkws.css` * `mkws.js` * `/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` -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: @@ -52,111 +64,39 @@ will be filled in by MKWS: * `
` -- target list, including status * `
` -- summary statistics -At present, MKWS may not work correctly if some of these are -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 by creating an `mkws_config` object _before_ loading the widget-set. Here is an example of all 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 */ - }); + ~~~ +For much more detail, see +[the MKWS whitepaper](whitepaper.html). -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: - -* Make MKWS robust to missing widgets -* Clean up the code - - - -\(c) 2013 by IndexData ApS, +Copyright 2013 IndexData ApS. diff --git a/tools/htdocs/images/mkws-logo-300px.jpeg b/tools/htdocs/images/mkws-logo-300px.jpeg new file mode 100644 index 0000000..bc7586f Binary files /dev/null and b/tools/htdocs/images/mkws-logo-300px.jpeg differ diff --git a/tools/htdocs/images/mkws-logo-300px.png b/tools/htdocs/images/mkws-logo-300px.png new file mode 100644 index 0000000..dbee439 Binary files /dev/null and b/tools/htdocs/images/mkws-logo-300px.png differ diff --git a/tools/htdocs/images/mkws-logo-48x48-light.png b/tools/htdocs/images/mkws-logo-48x48-light.png new file mode 100644 index 0000000..fc50562 Binary files /dev/null and b/tools/htdocs/images/mkws-logo-48x48-light.png differ diff --git a/tools/htdocs/images/mkws-logo-48x48.jpeg b/tools/htdocs/images/mkws-logo-48x48.jpeg new file mode 100644 index 0000000..dab205f Binary files /dev/null and b/tools/htdocs/images/mkws-logo-48x48.jpeg differ diff --git a/tools/htdocs/images/mkws-logo-48x48.png b/tools/htdocs/images/mkws-logo-48x48.png new file mode 100644 index 0000000..c037748 Binary files /dev/null and b/tools/htdocs/images/mkws-logo-48x48.png differ diff --git a/tools/htdocs/index.html b/tools/htdocs/index.html index d39035b..96a8c24 100644 --- a/tools/htdocs/index.html +++ b/tools/htdocs/index.html @@ -6,155 +6,230 @@ body { font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Sans-Serif; } - h1 { color: #606060 } - p { font-weight: bold } + h1 { font-weight: normal; color: #606060 } + h2 { font-size: 100% } + .pane { padding: 0em 1em; margin: 0.75em; + border: 0.5em solid #eee; + border-radius: 1em; + background-image: url('images/mkws-logo-48x48-light.png'); + background-repeat: no-repeat; + background-position: right top; + background-color: #eee; + } + .nologo { background-image: none } + pre { background: #ddd; padding: 0.5em; } + MKWS logo

MKWS: the MasterKey Widget Set

-

- This site contains tools, not content: -

-
    -
  • - mkws.js - -- - JavaScript code that powers the MasterKey Widget Set -
    • -
  • - /pazpar2/js/pz2.js - -- - Low-level JavaScript library for access to the MasterKey web - service. -
    • -
  • - mkws-complete.js - -- - A single large JavaScript file containing everything needed for - MKWS to work: the widget-set itself, the API library, and any - additional prerequisites such as jQuery. -
    • -
  • - mkws.css - -- - A stylesheet which styles only MasterKey widgets, and does not - otherwise interfere with application-site's styles. - -
    • -
-

- For examples of how to use the widget-set, see: -

- -

- The set of targets can be maintained: -

-
    -
  • - Use the main + + + +
    +

    Example

    +

    + Here is a completely functional (though ugly) MKWS-based + searching application: +

    +
    + 
    +<script type="text/javascript"
+        src="http://mkws.indexdata.com/mkws-complete.js"></script>
+<div id="mkwsSearch"></div>
+<div id="mkwsResults"></div>
    +
    +

    + That's it. A complete metasearching application. Everything + else is refinement. +

    +
    + +
    +

    Documentation

    + +
    + +
    +

    Tools

    +

    + Here are the files that this web-site provides: +

    +
      +
    • + mkws.js + -- + JavaScript code that powers the MasterKey Widget Set +
      • +
    • + pazpar2/js/pz2.js + -- + Low-level JavaScript library for access to the MasterKey web + service. +
      • +
    • + handlebars-v1.1.2.js + -- + A local copy of + the Handlebars templating library, + since it doesn't like to be hotlinked. +
      • +
    • + mkws-complete.js + -- + A single large JavaScript file containing everything needed for + MKWS to work: the widget-set itself, the API library, and + the prerequisites jQuery and Handlebars. +
      • +
    • + mkws.css + -- + A stylesheet which styles only MasterKey widgets, and does not + otherwise interfere with application-site's styles. +
      • +
    +

    + (This domain also hosts two web-service endpoints that are used by + running MKWS-based applications: + /service-proxy-auth + is used to authenticate new sessions and + /service-proxy/ + is the main endpoint for searching and retrieval. But there is + no need to use these directly: the widgets take care of that.) +

    • +
+ + +
+

Examples using the widget-set

+

+ It's worth viewing the source of these to see how small they + are and how various things are done. +

+ +
+ +
+

Target maintainance

+

+ The set of targets provided by MKWS by default can be + maintained using + MKAdmin + by users with appropriate credentials. + Go to MasterKey Admin Console, + >the main console and act as the "MK Demo" library administrator. - - -

- Documentation: +

+
+ +

+ Copyright © 2013 IndexData ApS. + http://indexdata.com

- diff --git a/tools/images/644px-Zahnrad.jpg b/tools/images/644px-Zahnrad.jpg new file mode 100644 index 0000000..a01a705 Binary files /dev/null and b/tools/images/644px-Zahnrad.jpg differ diff --git a/tools/images/README b/tools/images/README new file mode 100644 index 0000000..1604c32 --- /dev/null +++ b/tools/images/README @@ -0,0 +1,2 @@ +644px-Zahnrad.jpg is a CC0 (public domain) image from +http://commons.wikimedia.org/wiki/File:Zahnrad.jpg diff --git a/tools/images/fresco-icon.png b/tools/images/fresco-icon.png new file mode 100644 index 0000000..b70d0c4 Binary files /dev/null and b/tools/images/fresco-icon.png differ diff --git a/tools/images/mkws-logo.jpeg b/tools/images/mkws-logo.jpeg new file mode 100644 index 0000000..f099b4c Binary files /dev/null and b/tools/images/mkws-logo.jpeg differ diff --git a/tools/images/mkws-logo.xcf b/tools/images/mkws-logo.xcf new file mode 100644 index 0000000..38b1a4c Binary files /dev/null and b/tools/images/mkws-logo.xcf differ