X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Findex.markdown;h=5a0727bb63d548ae8d855788b31a3df12c9b4a15;hb=0c89d53214ae11af36e7ce08b3d2c99cc8521a53;hp=15874569809ac7416ebca4d3b102bd0b9590f443;hpb=7307cbb1eb60bd08e24190251c9f4b5750782abc;p=mkws-moved-to-github.git diff --git a/doc/index.markdown b/doc/index.markdown index 1587456..5a0727b 100644 --- a/doc/index.markdown +++ b/doc/index.markdown @@ -11,7 +11,7 @@ an existing web-site with customised searching across multiple sources, ranking and merging the results. All you need to do is pull in our JavaScript and optional stylesheet, -then add `
`s to your page that have special `id` attributes. We +then add `
`s to your page that have special `class` attributes. We do the rest. A minimal example @@ -22,8 +22,8 @@ searching application: -
-
+
+
That's it. A complete metasearching application. Everything else is refinement. @@ -31,9 +31,14 @@ else is refinement. Documentation ------------- +* This file. + [PDF version] * The README -- mostly technical details. + [PDF version] * The MKWS manual, including a reference section. - This is a much better introduction. + [PDF version] +* The MKWS developers' guide. + [PDF version] Tools ----- @@ -45,10 +50,12 @@ Here are the files that this web-site provides: * pazpar2/js/pz2.js -- Low-level JavaScript library for access to the MasterKey web service. -* handlebars-v1.1.2.js -- +* handlebars-v2.0.0.js -- A local copy of the Handlebars templating library, since it doesn't like to be hotlinked. +* Local copy of jquery-1.10.0.min.js +* Local copy of jquery.json-2.4.js * mkws-complete.js -- A single large JavaScript file containing everything needed for MKWS to work: the widget-set itself, the API library, and @@ -56,20 +63,15 @@ Here are the files that this web-site provides: * mkws.css -- A stylesheet which styles only MasterKey widgets, and does not otherwise interfere with application-site's styles. +* mkws-jquery.js -- + An experimental jQuery plugin that provides an MKWS-based + metasearching applet. Minified versions of the MKWS JavaScript files are also available: * mkws.min.js * mkws-complete.min.js -(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.) - Versions -------- @@ -173,7 +175,7 @@ We can set that up for you: email us on info@indexdata.com. -

+- - - + Copyright (©) 2013-2014 Index Data ApS. `http://indexdata.com` -