Add link to developer guide.

[mkws-moved-to-github.git] / doc / index.markdown

diff --git a/doc/index.markdown b/doc/index.markdown
index 1dff908..7690717 100644 (file)
--- 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,
 sources, ranking and merging the results.
 
 All you need to do is pull in our JavaScript and optional stylesheet,

-then add `<div>`s to your page that have special `id` attributes. We
+then add `<div>`s to your page that have special `class` attributes. We

 do the rest.
 
 A minimal example
 do the rest.
 
 A minimal example

@@ -22,8 +22,8 @@ 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 id="mkwsSearch"></div>
-       <div id="mkwsResults"></div>
+       <div class="mkwsSearch"></div>
+       <div class="mkwsResults"></div>

 
 That's it. A complete metasearching application. Everything
 else is refinement.
 
 That's it. A complete metasearching application. Everything
 else is refinement.

@@ -34,6 +34,7 @@ Documentation
 * The <a href="README.html">README</a> -- mostly technical details.
 * The <a href="mkws-manual.html">MKWS manual, including a reference section.</a>
   This is a much better introduction.
 * The <a href="README.html">README</a> -- mostly technical details.
 * The <a href="mkws-manual.html">MKWS manual, including a reference section.</a>
   This is a much better introduction.

+* The <a href="mkws-developer.html">MKWS developers' guide.</a>

 
 Tools
 -----
 
 Tools
 -----

@@ -45,10 +46,12 @@ Here are the files that this web-site provides:
 * <a href="pazpar2/js/pz2.js">pazpar2/js/pz2.js</a> --
   Low-level JavaScript library for access to the MasterKey web
   service.
 * <a href="pazpar2/js/pz2.js">pazpar2/js/pz2.js</a> --
   Low-level JavaScript library for access to the MasterKey web
   service.

-* <a href="handlebars-v1.1.2.js">handlebars-v1.1.2.js</a> --
+* <a href="handlebars-v2.0.0.js">handlebars-v2.0.0.js</a> --

   A local copy of
   <a href="http://handlebarsjs.com/">the Handlebars templating library</a>,
   since it doesn't like to be hotlinked.
   A local copy of
   <a href="http://handlebarsjs.com/">the Handlebars templating library</a>,
   since it doesn't like to be hotlinked.

+* Local copy of <a href="jquery-1.10.0.min.js">jquery-1.10.0.min.js</a>
+* Local copy of <a href="jquery.json-2.4.js">jquery.json-2.4.js</a>

 * <a href="mkws-complete.js">mkws-complete.js</a> --
   A single large JavaScript file containing everything needed for
   MKWS to work: the widget-set itself, the API library, and
 * <a href="mkws-complete.js">mkws-complete.js</a> --
   A single large JavaScript file containing everything needed for
   MKWS to work: the widget-set itself, the API library, and

@@ -57,19 +60,12 @@ Here are the files that this web-site provides:
   A stylesheet which styles only MasterKey widgets, and does not
   otherwise interfere with application-site's styles.
 
   A stylesheet which styles only MasterKey widgets, and does not
   otherwise interfere with application-site's styles.
 

+

 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>
 
 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
 --------
 
 Versions
 --------