tools/htdocs/index.html

   1 <html>
   2   <head>
   3     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   4     <title>MKWS: the MasterKey Widget Set</title>
   5     <style type="text/css">
   6       body {
   7       font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Sans-Serif;
   8       }
   9       h1 { font-weight: normal; color: #606060 }
  10       h2 { font-size: 100% }
  11       .pane { background: #eee; border-radius: 1em;
  12               padding: 0.25em 1em; margin: 0.75em; }
  13       pre { background: #ddd; padding: 0.5em; }
  14     </style>
  15   </head>
  16   <body>
  17     <img src="images/mkws-logo-300px.png" alt="MKWS logo" =
  18          style="float:right; margin: 1.5em"/>
  19     <h1>MKWS: the MasterKey Widget Set</h1>
  20
  21     <div class="pane">
  22       <h2>Add metasearching to your web-site painlessly</h2>
  23       <p>
  24         The MasterKey Widget Set provides the easiest possible way to
  25         enhance an existing web-site with customised searching across
  26         multiple sources, ranking and merging the results.
  27       </p>
  28       <p>
  29         All you need to do is pull in our JavaScript and optional
  30         stylesheet, then add <tt>&lt;div&gt;</tt>s to your page that
  31         have special <tt>id</tt> attributes. We do the rest.
  32       </p>
  33     </div>
  34
  35     <div class="pane">
  36       <h2>Example</h2>
  37       <p>
  38         Here is a completely functional (though ugly) MKWS-based
  39         searching application:
  40       </p>
  41       <blockquote>
  42         <pre>
  43 &lt;script type="text/javascript"
  44         src="http://mkws.indexdata.com/mkws-complete.js">&lt;/script>
  45 &lt;div id="mkwsSearch">&lt;/div>
  46 &lt;div id="mkwsResults">&lt;/div></pre>
  47       </blockquote>
  48       <p>
  49         That's it. A complete metasearching application. Everything
  50         else is refinement.
  51       </p>
  52     </div>
  53
  54     <div class="pane">
  55       <h2>Documentation</h2>
  56       <ul>
  57         <li>
  58           The <a href="README.html">README</a> -- mostly technical details.
  59         </li>
  60         <li>
  61           The <a href="whitepaper.html">whitepaper, including a
  62           reference section.</a>
  63           This is a much better introduction.
  64         </li>
  65       </ul>
  66     </div>
  67
  68     <div class="pane">
  69       <h2>Tools</h2>
  70       <ul>
  71         <li>
  72           <a href="mkws.js">mkws.js</a>
  73           --
  74           JavaScript code that powers the MasterKey Widget Set
  75         </li>
  76         <li>
  77           <a href="/pazpar2/js/pz2.js">/pazpar2/js/pz2.js</a>
  78           --
  79           Low-level JavaScript library for access to the MasterKey web
  80           service.
  81         </li>
  82         <li>
  83           <a href="mkws-complete.js"
  84              >mkws-complete.js</a>
  85           --
  86           A single large JavaScript file containing everything needed for
  87           MKWS to work: the widget-set itself, the API library, and any
  88           additional prerequisites such as jQuery.
  89         </li>
  90         <li>
  91           <a href="mkws.css">mkws.css</a>
  92           --
  93           A stylesheet which styles only MasterKey widgets, and does not
  94           otherwise interfere with application-site's styles.
  95         </li>
  96       </ul>
  97     </div>
  98
  99     <div class="pane">
 100       <h2>For examples of how to use the widget-set, see:</h2>
 101       <ul>
 102         <li>
 103           A very simple application at
 104           <a href="http://example.indexdata.com/"
 105              >http://example.indexdata.com/</a>.
 106           It's worth viewing the source to see how small it is.
 107         </li>
 108         <li>
 109           <a href="http://example.indexdata.com/language.html"
 110              >A more detailed version</a>
 111           that contains a configuration structure instead of accepting
 112           the defaults. Includes a custom translation option to present
 113           the application in Arabic.
 114         </li>
 115         <li>
 116           The
 117           <a href="http://example.indexdata.com/jquery.html"
 118              >jQuery plugin</a>
 119           version, consisting of a single line of JavaScript code.
 120         </li>
 121         <li>
 122           An application that
 123           <a href="http://example.indexdata.com/lowlevel.html"
 124              >uses lower-level MKWS components</a>
 125           rather than the all-in-one <tt>#mkwsResults</tt> division,
 126           allowing it to use a rather different layout.
 127         </li>
 128         <li>
 129           An application that specifies how to display brief and full records
 130           <a href="http://example.indexdata.com/templates.html"
 131              >using Handlebar templates</a>.
 132           (Read about
 133           <a href="http://handlebarsjs.com/"
 134              >the templating language</a>.)
 135         </li>
 136         <li>
 137           <a href="http://example.indexdata.com/mobile.html"
 138              >A version suitable for mobile devices</a>,
 139           with a responsive design that moves components around
 140           depending on the screen size.
 141         </li>
 142         <li>
 143           <a href="http://example.indexdata.com/popup.html"
 144              >A version that uses a jQuery popup</a>.
 145         </li>
 146         <li>
 147           <a href="http://example.indexdata.com/dict.html"
 148              >An application that uses MKWS to find dictionary
 149             definitions of words when you highlight them</a>.
 150         </li>
 151         <li>
 152           <a href="http://example.indexdata.com/auto.html"
 153              >An application that runs an automatic search on load</a>.
 154         </li>
 155         <li>
 156           <a href="http://example.indexdata.com/localauth.html"
 157              >An application that uses a local authentication regime</a>,
 158           and the corresponding
 159           <a href="http://example.indexdata.com/apache-config.txt"
 160              >Apache2 configuration stanza</a>.
 161         </li>
 162         <li>
 163           An existing web-site,
 164           <a href="http://sagp.miketaylor.org.uk/"
 165              >The Self-Appointed Grammar Police</a>,
 166           which has been fitted with an MKWS searching widget.
 167           (See also the MKWS-widget customisations in
 168           <a href="http://sagp.miketaylor.org.uk/style.css"
 169              >that site's stylesheet</a>.)
 170         </li>
 171         <li>
 172           Another existing web-site,
 173           <a href="http://zthes.z3950.org/"
 174              >The Zthes specifications</a>,
 175           which has been fitted with a popup MKWS search-box.
 176         </li>
 177       </ul>
 178     </div>
 179
 180     <div class="pane">
 181       <h2>The set of targets can be maintained:</h2>
 182       <ul>
 183         <li>
 184           Use the main
 185           <a href="http://mk2.indexdata.com/console/"
 186              >MasterKey Admin Console</a>,
 187           and act as the "MK Demo" library administrator.
 188         </li>
 189       </ul>
 190     </div>
 191   </body>
 192 </html>