X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Findex.markdown;h=07be7c49865b857b9e9dde35ea5478b533ed1df1;hb=ea10a33a813a755347bf2012d31c24015e25e108;hp=66107d67461175c0f22d4fa755e372f10cc50594;hpb=25a4a41b23b627aca2760bdb21dbd53915ca3304;p=mkws-moved-to-github.git diff --git a/doc/index.markdown b/doc/index.markdown index 66107d6..07be7c4 100644 --- a/doc/index.markdown +++ b/doc/index.markdown @@ -20,8 +20,7 @@ A minimal example Here is a completely functional (though ugly) MKWS-based searching application: - +
@@ -31,9 +30,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,12 +49,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` +* 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 +62,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 --------