X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Findex.markdown;h=5a0727bb63d548ae8d855788b31a3df12c9b4a15;hb=0c89d53214ae11af36e7ce08b3d2c99cc8521a53;hp=b8a0ab1a7280b50079de6669903a1f38475985f2;hpb=2b3681ab03441fd5465f90b12b18fd847c3731d2;p=mkws-moved-to-github.git diff --git a/doc/index.markdown b/doc/index.markdown index b8a0ab1..5a0727b 100644 --- a/doc/index.markdown +++ b/doc/index.markdown @@ -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 ----- @@ -49,8 +54,8 @@ Here are the files that this web-site provides: 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` +* 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 @@ -58,21 +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 --------