Document templating MKWS-279
[mkws-moved-to-github.git] / doc / index.markdown
index dd68254..07be7c4 100644 (file)
@@ -20,8 +20,7 @@ A minimal 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>
+       <script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
        <div class="mkwsSearch"></div>
        <div class="mkwsResults"></div>
 
@@ -31,9 +30,14 @@ else is refinement.
 Documentation
 -------------
 
+* This file.
+  [<a href="index.pdf">PDF version</a>]
 * The <a href="README.html">README</a> -- mostly technical details.
+  [<a href="README.pdf">PDF version</a>]
 * The <a href="mkws-manual.html">MKWS manual, including a reference section.</a>
-  This is a much better introduction.
+  [<a href="mkws-manual.pdf">PDF version</a>]
+* The <a href="mkws-developer.html">MKWS developers' guide.</a>
+  [<a href="mkws-developer.pdf">PDF version</a>]
 
 Tools
 -----
@@ -58,21 +62,15 @@ Here are the files that this web-site provides:
 * <a href="mkws.css">mkws.css</a> --
   A stylesheet which styles only MasterKey widgets, and does not
   otherwise interfere with application-site's styles.
-
+* <a href="mkws-jquery.js">mkws-jquery.js</a> --
+  An experimental jQuery plugin that provides an MKWS-based
+  metasearching applet.
 
 Minified versions of the MKWS JavaScript files are also available:
 
 * <a href="mkws.min.js">mkws.min.js</a>
 * <a href="mkws-complete.min.js">mkws-complete.min.js</a>
 
-(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
 --------