X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2FREADME;h=6d857738c5d07ce945c925575ca9f898c1c8f5a9;hb=e89e37de61956896123aafaabfb92e28ceb03462;hp=0c4d98db1aa337e607a079a4c3ab9b889aebaa28;hpb=578f70911f1f3af6128946bb98b655cb97c58af0;p=mkws-moved-to-github.git diff --git a/tools/htdocs/README b/tools/htdocs/README index 0c4d98d..6d85773 100644 --- a/tools/htdocs/README +++ b/tools/htdocs/README @@ -1,128 +1,5 @@ -An embryonic MasterKey Widget Set -================================= +Subdirectories: -This directory contains an embryonic MasterKey Widget Set, based -initially on "jsdemo" though now far removed from those beginnnings. - - -How this works --------------- - -The goal is to make it that as much of the searching functionality as -possible is hosted on - http://mkws.indexdata.com/ -so that very simple websites such as - http://example.indexdata.com/ -can have MasterKey searching with minimal effort. - -The following files must be hosted on mkws.indexdata.com: - mkws.js - mkwsStyle.css - /libjs-pz2/pz2api.1.js (*) - -The following files make up the application: - index.html - favicon.ico [optional] - robots.txt [optional] - -(At present, the client application's configuruation also needs an -Alias for /service-proxy/, to avoid cross-site scripting issues. We -will fix this.) - -(*) if you don't have already installed libjs-pz2 on the machine, you can -do it by installing a debian package or check it out from GIT: -$ git clone ssh://git.indexdata.com:222/home/git/pub/libjs-pz2 - -Configuring a client --------------------- - -The application's HTML must contains the following elements as well as -whatever makes up the application itself: - -Prerequisites: - - - - - -(Yes, we're using JQuery. We use it only in the most trivial ways, and -could probably get rid of it without too much pain. I'd like to have -mkws.js automatically pull in pz2api.1.js, too, so you don't need to -do so many things, but that's not quite trivial.) - -Then the following special